Skip to content

Commit 387117e

Browse files
Pasniczyaurelienshz
authored andcommitted
Add Mainnet apps documentation
1 parent f94b593 commit 387117e

File tree

8 files changed

+82
-0
lines changed

8 files changed

+82
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,5 @@ Please refer to:
7676
* [the full Payments documentation](./payments.md) to learn about the complete payment flow
7777
* [the Platform API documentation](./platform_API.md) to learn how to confirm the payment and acknowledge it from your
7878
server
79+
* [the client SDK documentation](./SDK_reference.md) to learn about Pi Apps SDK and provided methods in detail
7980
* the Demo App (coming soon!) to view an example of how you can implement the various required flows in your app's code.

developer_portal.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Pi Developer Portal
2+
3+
With the help of Pi SDK and Pi API, you can create applications that run within the Pi browser, which can be used by other Pioneers. Pi Developer Portal is where you can register and configure your apps so that it can be connected to the Pi Blockchain.
4+
5+
## How to register your app
6+
7+
1. The Pi Developer Portal can be accessed using the Pi Browser. Go to `pi://develop.pi` to visit the Pi Developer Portal. To register a new app, click on `New App` button at the bottom of the page.
8+
9+
<div style="text-align:center;">
10+
<img src="./img/dev_portal_main_1.png" alt="drawing" width="200"/>
11+
</div>
12+
13+
2. You can fill in the required fields. One important field is selecting the host network that the app is connecting to. Depending on this option, Pi SDK will automatically connect your app to the corresponding network. An app can only connect to one network at a time, and once you register the app, this option cannot be changed.
14+
15+
<div style="text-align:center;">
16+
<img src="./img/dev_portal_new_1.png" alt="drawing" width="200"/>
17+
</div>
18+
19+
> When the app is connecting to the Pi Testnet, you can maintain a list of whitelisted users. Your testnet app will only be accessible by users you allowed, and if you leave this field empty, anyone can access your test app.
20+
21+
<div style="text-align:center;">
22+
<img src="./img/dev_portal_new_2.png" alt="drawing" width="200"/>
23+
</div>
24+
25+
> When the app is connecting to the Pi Mainnet, you can pair one of your testnet apps to the mainnet app. More specific usage is coming soon in the future.
26+
27+
> When you're hosting the app on your server, you will also need to provide the url. Notice that you'll be asked to verify the ownership of the url after you register the app. After you filled in the required fields, you can submit to register your app by clicking on `Submit` button at the bottom of the page.
28+
29+
<div style="text-align:center;">
30+
<img src="./img/dev_portal_new_3.png" alt="drawing" width="200"/>
31+
</div>
32+
33+
3. After you register your app, you can see your apps in the main page. If you selected the paired app for your mainnet app, it will show like the following.
34+
35+
<div style="text-align:center;">
36+
<img src="./img/dev_portal_main_2.png" alt="drawing" width="200"/>
37+
</div>
38+
<br>
39+
40+
## Testnet app in the Pi Browser
41+
42+
If you registered your app to connect to the Pi Testnet and if you visit your app in the Pi Browser, it will show the black and yellow stripe at the top to indicate that this app is connected to the Pi Testnet.
43+
44+
<div style="text-align:center;">
45+
<img src="./img/testnet_indicator.png" alt="drawing" width="200"/>
46+
</div>
47+
48+
49+
## Legacy Project created before 26/07/2022
50+
51+
Projects that existed prior to the launch of the Pi Mainnet SDK will point to the Pi Testnet
52+
- This cannot be changed or updated
53+
- It is best practice to create new Developer Portal Projects
54+
55+
### Developers and Teams with previously created Legacy Projects
56+
57+
1. Create a new Developer Portal Project
58+
- Select Mainnet - This will be the Mainnet Version of the App
59+
- URL
60+
- This project should contain the desired URL that Pioneers will access the app with through the Pi Browser
61+
- URL ownership will be determined through verification process
62+
- Payment Wallet
63+
- Until developer/app wallets are created the wallet address of the developer who creates the new project page will be used to process all transactions
64+
- If the project page creator does not have a Pi Wallet Address which has been created in a Mainnet Migration all transactions will fail.
65+
2. Create a second new Developer Project Page
66+
- Select Testnet - This will be for testing purposes
67+
- URL
68+
- Cannot be the same as the Mainnet URL
69+
- Must be owned by the developer as well
70+
- Set the desired access permissions
71+
- This project can be linked to the previously created Mainnet Project from step 1
72+
3. Link Mainnet Project to the Brainstorm project (if applicable)
73+
- As of July 2022 it is possible to link only one developer portal project to a brainstorm project
74+
75+
### Special Considerations
76+
- If an app team has no members with a Mainnet Wallet
77+
- Please reach out to the Pi CT through the <a href="https://pinetwork.atlassian.net/servicedesk/customer/portal/1/group/3/create/20" target="_blank">Pi Support Portal</a>
78+
- For the question “What does your question relate to? ”
79+
- Select “Pi Mainnet SDK Wallet”
80+
- Submit contact information
81+
- A member of the Pi CT will follow up

img/dev_portal_main_1.png

245 KB
Loading

img/dev_portal_main_2.png

648 KB
Loading

img/dev_portal_new_1.png

146 KB
Loading

img/dev_portal_new_2.png

120 KB
Loading

img/dev_portal_new_3.png

508 KB
Loading

img/testnet_indicator.png

1.39 MB
Loading

0 commit comments

Comments
 (0)