Skip to content

docs: Add wallet_address to Pi Platform SDK scopes #602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jdrains110-beep wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: Add wallet_address to Pi Platform SDK scopes #602

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7991f2e
Add wallet_address to scopes
CryptoGing Jan 20, 2023
c456f60
Potential fix for pull request finding
jdrains110-beep Apr 21, 2026
eb65fcd
Merge branch 'master' into CryptoGing-WalletAddress
jdrains110-beep Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions SDK_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ type AuthResult = {

Available scopes: `username`, `payments`, `wallet_address`

<br />
Comment thread
jdrains110-beep marked this conversation as resolved.
Here is a breakdown of various keys available on the `AuthResult['user']` object, and the scopes required for those keys
to be present:

Expand All @@ -73,6 +74,16 @@ to be present:
| `payments` | Required if your app needs to make payments between your app and the users | `payments` |
| `wallet_address` | The wallet address of the user who authenticates on your app. | `wallet_address` |

<br />
Comment thread
jdrains110-beep marked this conversation as resolved.

Here is a breakdown of scopes that do not add fields to `AuthResult['user']`, and the methods/flows that require them:

| Scope | Description | Methods Requiring Scope |
| -------------: | ------------- | :-------------: |
| `payments` | Gives permission to the app to create payments on the users behalf. This scope does not add any fields to `AuthResult['user']`. | `createPayment` |
| `wallet_address` | Allows app-to-user payment flows that require the user's public wallet address. This value is not returned on `AuthResult['user']` by `authenticate`. | `createPayment` - App to User Payments |

<br />
Comment thread
jdrains110-beep marked this conversation as resolved.
### `onIncompletePaymentFound`

Signature: `(payment: PaymentDTO) => void`
Expand Down