Skip to content
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

Patch 1 #334

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Patch 1 #334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7991f2e
Add wallet_address to scopes
CryptoGing Jan 20, 2023
3882d92
Create CryptoGing Wallet
Bocoi501 Apr 29, 2023
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
1 change: 1 addition & 0 deletions CryptoGing Wallet
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

13 changes: 12 additions & 1 deletion SDK_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ type AuthResult = {

### `scopes`

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

> **Not yet implemented**
>
Expand All @@ -67,6 +67,7 @@ Available scopes: `username`, `payments`.
> However, you should implement your app by only adding the scopes you need when calling `authenticate`.
> Scopes support will be added before the general release of the Pi platform.

<br />
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 @@ -75,6 +76,16 @@ to be present:
| `uid` | An app-local identifier for the user. This is specific to this user, and this app. It will change if the user revokes the permissions they granted to your app. | (none) |
| `username` | The user's Pi username. | `username` |

<br />

Here is a breakdown of scopes with no return and methods requiring them:

| Scope | Description | Methods Requiring Scope |
| -------------: | ------------- | :-------------: |
| `payments` | Gives permission to the app to create payments on the users behalf | `createPayment` |
| `wallet_address` | Gives the app access to the users public wallet address | `createPayment` - App to User Payments|

<br />
### `onIncompletePaymentFound`

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