From 0b2813d855235a5e3468575f57e680bcb88222f8 Mon Sep 17 00:00:00 2001 From: Max Kurapov Date: Sat, 19 Oct 2024 16:50:11 +0200 Subject: [PATCH] docs: preliminary test wallet updates (#510) * docs: update before you begin page * docs: update OP enabled wallets page * docs: update interactive grant guide page with new test wallet urls * docs: update before you begin page with KYC details * chore: formatting * docs: update before you begin page with KYC details --- .../docs/guides/create-interactive-grant.mdx | 14 +++--- .../src/content/docs/resources/op-wallets.mdx | 6 +-- .../docs/snippets/before-you-begin.mdx | 45 +++++++++---------- docs/src/partials/before-you-begin.mdx | 2 +- 4 files changed, 31 insertions(+), 36 deletions(-) diff --git a/docs/src/content/docs/guides/create-interactive-grant.mdx b/docs/src/content/docs/guides/create-interactive-grant.mdx index b1c29ca6..d1aa8a7c 100644 --- a/docs/src/content/docs/guides/create-interactive-grant.mdx +++ b/docs/src/content/docs/guides/create-interactive-grant.mdx @@ -107,14 +107,14 @@ Once your client receives the authorization server’s response, it must send th ```json { "interact": { - "redirect": "https://auth.rafiki.money/4CF492MLVMSW9MKMXKHQ", + "redirect": "https://auth.interledger-test.dev/4CF492MLVMSW9MKMXKHQ", "finish": "4105340a-05eb-4290-8739-f9e2b463bfa7" }, "continue": { "access_token": { "value": "33OMUKMKSKU80UPRY5NM" }, - "uri": "https://auth.rafiki.money/continue/4CF492MLVMSW9MKMXKHQ", + "uri": "https://auth.interledger-test.dev/continue/4CF492MLVMSW9MKMXKHQ", "wait": 30 } } @@ -145,7 +145,7 @@ Add the authorization server’s interaction reference, as the `interact_ref` va Issue the request to the `continue uri` supplied in the authorization server’s initial grant response. For example: -`POST https://auth.rafiki.money/continue/4CF492MLVMSW9MKMXKHQ` +`POST https://auth.interledger-test.dev/continue/4CF492MLVMSW9MKMXKHQ` A successful continuation response from the authorization server provides your client with an access token and other information necessary to continue the transaction. @@ -154,7 +154,7 @@ A successful continuation response from the authorization server provides your c { "access_token": { "value": "OS9M2PMHKUR64TB8N6BW7OZB8CDFONP219RP1LT0", - "manage": "https://auth.rafiki.money/token/dd17a202-9982-4ed9-ae31-564947fb6379", + "manage": "https://auth.interledger-test.dev/token/dd17a202-9982-4ed9-ae31-564947fb6379", "expires_in": 3600, "access": [ { @@ -166,9 +166,9 @@ A successful continuation response from the authorization server provides your c "list", "list-all" ], - "identifier": "https://ilp.rafiki.money/alice", + "identifier": "https://ilp.interledger-test.dev/alice", "limits": { - "receiver": "https://ilp.rafiki.money/bob/incoming-payments/48884225-b393-4872-90de-1b737e2491c2", + "receiver": "https://ilp.interledger-test.dev/bob/incoming-payments/48884225-b393-4872-90de-1b737e2491c2", "interval": "R12/2019-08-24T14:15:22Z/P1M", "debitAmount": { "value": "500", @@ -183,7 +183,7 @@ A successful continuation response from the authorization server provides your c "access_token": { "value": "33OMUKMKSKU80UPRY5NM" }, - "uri": "https://auth.rafiki.money/continue/4CF492MLVMSW9MKMXKHQ", + "uri": "https://auth.interledger-test.dev/continue/4CF492MLVMSW9MKMXKHQ", "wait": 30 } } diff --git a/docs/src/content/docs/resources/op-wallets.mdx b/docs/src/content/docs/resources/op-wallets.mdx index c286abde..be846863 100644 --- a/docs/src/content/docs/resources/op-wallets.mdx +++ b/docs/src/content/docs/resources/op-wallets.mdx @@ -8,11 +8,11 @@ The following digital wallet providers supply Open Payments-enabled accounts. ## Open Payments-enabled wallet providers -### Rafiki.Money (test wallet) +### Test wallet -Rafiki.Money is a test wallet provider offering an ILP-enabled wallet that developers can use to test their Open Payments integrations. Rafiki.Money is offered as part of the Interledger testnet. +The Interledger Foundation has a test wallet offering an ILP-enabled wallet that developers can use to test their Open Payments integrations. -Sign up for an account at rafiki.money. +Sign up for an account at wallet.interledger-test.dev. ### Fynbos diff --git a/docs/src/content/docs/snippets/before-you-begin.mdx b/docs/src/content/docs/snippets/before-you-begin.mdx index 1003ca3b..ac0ce402 100644 --- a/docs/src/content/docs/snippets/before-you-begin.mdx +++ b/docs/src/content/docs/snippets/before-you-begin.mdx @@ -1,49 +1,44 @@ --- -title: Rafiki.Money +title: Test Wallet --- import { LinkOut } from '@interledger/docs-design-system' -Before working with our code snippets, we recommend creating a wallet account on Rafiki.Money, a test wallet provider that's part of the Interledger testnet. +Before working with our code snippets, we recommend creating a wallet account on the test wallet that's part of the Interledger testnet. -Rafiki.Money lets you create developer keys and wallet accounts, funded with play money, for making Interledger transactions via the Open Payments APIs. +The test wallet lets you create developer keys and wallet accounts, funded with play money, for making Interledger transactions via the Open Payments APIs. -## Create an account on Rafiki.Money +## Create an account on the test wallet -1. Go to rafiki.money. +1. Go to wallet.interledger-test.dev. 2. Click **Create an account** at the bottom right of the screen. 3. Enter your e-mail address, a password, confirm the password and click the arrowhead. -4. Go to your inbox and look for an e-mail sent by `tech@interledger.org` with the subject "[Rafiki.Money] Verify your account" and click **Confirm my email address.**
Confirm email address -5. Click **Login to your account** at the email verification screen.
Log in with new account at rafiki.money +4. Go to your inbox and look for an e-mail sent by `tech@interledger.org` with the subject "[Test.Wallet] Verify your account" and click **Confirm my email address.**
+5. Click **Login to your account** at the email verification screen. 6. Log in with your credentials. -7. Enter any First and Last name on the Complete KYC screen and click **Get Wallet Account.** Note that since this is a test environment, the country, city and address fields will already be filled in.
Get wallet account at rafiki.money -8. Click **Verify your identity** on the pop-up window.
Identity verification at rafiki.money -9. Click **Verify Account** at the Complete KYC screen. Note that since this is a test environment "Passport" will be selected as the verification method and images will be uploaded by default.
Verify account at rafiki.money -10. Click **Go to your account overview** on the pop-up window.
Account overview dashboard on rafiki.money +7. Complete the KYC steps, and liveness check. The only real information you need to share is your email address and phone number. All other information can be fictitious. If a photo is required, you can upload anything as long as it's not blank. -You're now ready to create a Rafiki.Money test wallet and add money to it! +You're now ready to create a test wallet and add money to it! ## Create a wallet account -The first time you access rafiki.money, you'll be guided through creating a new wallet account. +1. You can create a wallet account by clicking **New Account.** +2. Enter a name for the account, choose an asset code (the currency) from the drop-down menu and click **Create account.** +3. Click **View Account.** +4. Click **Add payment pointer.** +5. Enter a Payment Pointer name and a Public name and then click **Create.** +6. Click **Deposit**. +7. Enter an amount, then click **Deposit**. -1. If you've completed or skipped the onboarding guide, you can create a wallet account by clicking **New Account.**
Set up new account at rafiki.money -2. Enter a name for the account, choose an asset code from the drop-down menu and click **Create account.**
Enter name and create account on rafiki.money -3. Click **View Account.**
Click to view account created on rafiki.money -4. Click **Add payment pointer.**
Add a payment pointer for the new account on rafiki.money -5. Enter a Payment Pointer name and a Public name and then click **Create.**
Create payment pointer on rafiki.money -6. Click **Add money.**
Add money to payment pointer on rafiki.money -7. Fund your wallet by entering an amount, then click **Add money.**
Enter amount and add money to the payment pointer on rafiki.money - -Congratulations, you now have a funded Rafiki.Money wallet! +Congratulations, you now have a funded test wallet! ## Obtain a public-private key pair and key ID Before you can initialize an authenticated Open Payments client, you must obtain a public-private key pair and a key ID. -1. Sign in to rafiki.money. +1. Sign in to wallet.interledger-test.dev, if not already signed in. 2. Select **Settings > Developer Keys**. -3. Expand the drop-down menu for your wallet account.
Expanded account showing payment pointer and Generate public & private key button -4. Click **Generate public & private key**. Your key ID and public key appear on the site. A private key file named `private.key` automatically downloads to your machine. Expanded account showing key ID, option to show public key, and button to revoke public/private keys +3. Expand the drop-down menu for your wallet account. +4. Click **Generate public & private key**. Your key ID and public key appear on the site. A private key file named `private.key` automatically downloads to your machine. You can now use your keys and payment pointer to initialize an authenticated Open Payments client. diff --git a/docs/src/partials/before-you-begin.mdx b/docs/src/partials/before-you-begin.mdx index 5e8cf80a..58185876 100644 --- a/docs/src/partials/before-you-begin.mdx +++ b/docs/src/partials/before-you-begin.mdx @@ -1 +1 @@ -We recommend creating a wallet account on [Rafiki.Money](/snippets/before-you-begin), a test wallet provider that's part of the Interledger testnet. Creating an account allows you to test your client against the Open Payments APIs by using an ILP-enabled wallet funded with play money. +We recommend creating a wallet account on the [test wallet](/snippets/before-you-begin). Creating an account allows you to test your client against the Open Payments APIs by using an ILP-enabled wallet funded with play money.