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.

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

docs: replace payment pointer with wallet address #1951

Merged
merged 8 commits into from
Oct 18, 2023

Conversation

njlie
Copy link
Contributor

@njlie njlie commented Sep 21, 2023

Changes proposed in this pull request

  • Replaces all instances of 'payment pointer' with 'wallet address in docs that live on Rafiki's Github.

Context

Checklist

  • Related issues linked using fixes #number
  • Tests added/updated
  • Documentation added
  • Make sure that all checks pass
  • Postman collection updated

@github-actions github-actions bot added type: localenv Local playground pkg: documentation Changes in the documentation package. type: documentation (archived) Improvements or additions to documentation labels Sep 21, 2023
@njlie njlie requested review from momerath42 and omertoast and removed request for momerath42 September 22, 2023 08:13
README.md Outdated
@@ -15,7 +15,7 @@ This includes

Rafiki is made up of several components including an Interledger connector, a high-throughput accounting database called [TigerBeetle](https://rafiki.dev/concepts/accounting/tigerbeetle/), and several APIs:

- the [Admin API](https://rafiki.dev/apis/backend/schema/) to create [peering relationships](https://rafiki.dev/concepts/interledger-protocol/peering/), add supported [assets](https://rafiki.dev/concepts/asset/), and issue [payment pointers](https://rafiki.dev/reference/glossary/#payment-pointer)
- the [Admin API](https://rafiki.dev/apis/backend/schema/) to create [peering relationships](https://rafiki.dev/concepts/interledger-protocol/peering/), add supported [assets](https://rafiki.dev/concepts/asset/), and issue [wallet addresses](https://rafiki.dev/reference/glossary/#payment-pointer)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does the article/url need to be renamed here? https://rafiki.dev/reference/glossary/#payment-pointer

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess /reference/glossary#payment-pointer is referenced many places, not just here.

Copy link
Contributor

@BlairCurrey BlairCurrey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this was missed because of the newline char:

On the [primary instance](http://localhost:3001) execute the following command to create a payment
pointer ID:

@njlie
Copy link
Contributor Author

njlie commented Sep 27, 2023

I think this was missed because of the newline char:

On the [primary instance](http://localhost:3001) execute the following command to create a payment
pointer ID:

Good catch @BlairCurrey!

@github-actions github-actions bot added type: tests Testing related pkg: backend Changes in the backend package. pkg: frontend Changes in the frontend package. type: source Changes business logic pkg: mock-ase labels Sep 27, 2023
@github-actions github-actions bot removed type: tests Testing related pkg: backend Changes in the backend package. pkg: frontend Changes in the frontend package. type: source Changes business logic pkg: mock-ase labels Sep 27, 2023
@@ -230,11 +230,11 @@ Example Successful Response
```
{
"data": {
"createPaymentPointer": {
"createWalletAddress": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this be a new mutation or removing the old one?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be a new mutation, in https://github.com/interledger/rafiki/tree/nl-rename-all-payment-pointer the createPaymentPointer mutation will be refactored to createWalletAddress.

@@ -135,9 +135,9 @@ The Rafiki `backend` exposes the [Open Payments](/reference/glossary#open-paymen

The Open Payments Auth Server requires integration with an Identity Provider to handle user authentication and consent. For more information on how to integrate an Identity Provider with the reference implementation of the Open Payments Auth Server, see the docs in the `auth` package.

## Issuing Payment Pointers
## Issuing s
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Issuing s
## Issuing Wallet Addresses

Comment on lines 123 to 124
| `wallet_address.not_found` | A requested wallet address was not found |
| `wallet_address.web_monetization` | Web Monetization payments received via STREAM. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same thing as 👇 , are we renaming the existing webhooks or just adding new ones, and deprecating the payment pointer ones?

Copy link
Contributor Author

@njlie njlie Sep 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same deal, https://github.com/interledger/rafiki/tree/nl-rename-all-payment-pointer should rename the existing ones. This PR will just handle docs changes. Though I see now that Web Monetization may not make sense for a wallet address with a non-ILP payment method.

@github-actions github-actions bot added pkg: auth Changes in the GNAP auth package. pkg: mock-ase labels Oct 11, 2023
@njlie njlie requested a review from mkurapov October 11, 2023 21:16
Copy link
Contributor

@mkurapov mkurapov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the classic "LGTM" comment

LGTM (minus one small thing)

@@ -95,13 +95,13 @@ components:
title: client
type: string
description: |-
Payment pointer of the client instance that is making this request.
Wallet address of the client instance that is making this request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should generate the typescript types from the api spec

@njlie njlie force-pushed the nl-rename-all-payment-pointer branch from cc37144 to 5804314 Compare October 12, 2023 22:17
Base automatically changed from nl-rename-all-payment-pointer to nl-open-payments-updates October 17, 2023 15:47
@github-actions github-actions bot removed type: tests Testing related pkg: frontend Changes in the frontend package. type: source Changes business logic pkg: auth Changes in the GNAP auth package. type: localenv Local playground pkg: mock-ase pkg: documentation Changes in the documentation package. type: documentation (archived) Improvements or additions to documentation labels Oct 17, 2023
Copy link
Member

@sabineschaller sabineschaller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good to go now :-)

@njlie njlie merged commit cbe70ae into nl-open-payments-updates Oct 18, 2023
11 of 16 checks passed
@njlie njlie deleted the nl-docs-replace-pp branch October 18, 2023 15:02
sabineschaller added a commit that referenced this pull request Oct 26, 2023
* feat(backend): rename "payment pointer" tables & columns to use "wallet address" (#1937)

Co-authored-by: Nathan Lie <nathanlie@Nathans-MacBook-Pro.local>

* feat(backend, mock-ase): rename payment pointer to wallet address in rafiki code (#2029)

* fix(backend): rename paymentPointerId column in combinedPaymentsView to walletAddressId (#2043)

* docs: replace payment pointer with wallet address (#1951)

* feat(backend): remove connections route (#1940) (#2051)

Co-authored-by: Ömer Talha Özdemir <omer@fynbos.dev>

* feat(backend): unauthenticated get incoming payment (#1952) (#2052)

Co-authored-by: Ömer Talha Özdemir <omer@fynbos.dev>
Co-authored-by: Blair Currey <12960453+BlairCurrey@users.noreply.github.com>

* feat(auth): fix auth tests for access tokens (#2053)

* feat(backend): remove payment pointer from url, retrieve it from request query or body (#2042)

* refactor(backend): swap connection for methods (#2054)

Co-authored-by: Nathan Lie <lie4nathan@gmail.com>

* fix(backend): resolve breaking build after main rebase (#2085)

* fix(backend): combined_payment, ilp service tests (#2094)

* fix(backend): combined_payment, ilp service tests

* chore(backend): format

* fix(backend): bad test refactor

* fix(postman): invalid json (#2096)

* fix: fetch walletAddress graph in quote and outgoing payment service (#2099)

* fix(postman): env var usage (#2107)

* feat(backend): add quotes route to exceptions in wallet address middleware (#2108)

* chore: formatting

* fix(backend): fix GET /incoming-payments (#2111)

* fix(backend): remove wallet address from OP response id and fix receiver service (#2115)

* fix: remove wallet address from op resource urls

* feat: return auth server url in public incoming payment and fix receiver service

* fix: quote issue

* fix: walletAddress middleware

* chore: update postman

* fix: listing

* chore: remove console.log

* fix: progress towards making listing work

* fix(backend): fix create remote incoming payment (#2121)

* fix(postman): misc postman fixes

* fix(postman): complete incoming payment (#2126)

* fix: file name correction (#2127)

* fix: GET resource lists, use op client (#2122)

* fix(postman): update list urls

* fix(openapi): rm defaults for first, last

* refactor(postman): query param order for readability

* fix(backend): update to new open-payments pkgs

* fix(backend): use op client to get authServer

* fix(backend): rm old code

* fix(backend): receiver tests

* chore: cleanup

* feat: make list query parameter configurable

* chore: update OP package and fix types

---------

Co-authored-by: Sabine Schaller <sabine@interledger.org>

* fix(postman): additional fixes

* fix: wallet address on the fly creation (#2129)

* chore: update postman environments

* Postman: update description for P2P example

* Postman: Remove finalizationReason from getGrants API + fix createWalletAddress

* chore: bump open-payments package in auth

* chore: update last few remaining mentions of payment pointers

* chore(postman): remove references to payment pointer

* chore: update another reference to pp

---------

Co-authored-by: Nathan Lie <nathanlie@Nathans-MacBook-Pro.local>
Co-authored-by: Ömer Talha Özdemir <omer@fynbos.dev>
Co-authored-by: Blair Currey <12960453+BlairCurrey@users.noreply.github.com>
Co-authored-by: Sabine Schaller <sabine@interledger.org>
Co-authored-by: Sarah Jones <sarah38186@gmail.com>
Co-authored-by: Max Kurapov <maxkurapov@gmail.com>
Co-authored-by: Max Kurapov <max@interledger.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: backend Changes in the backend package.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants