feat: ask for payment pointer from ASE #1501

mkurapov · 2023-06-08T16:28:30Z

Changes proposed in this pull request

Add payment_pointer.not_found webhook event
- Adds support for webhook in mock account servicing entity
Add polling utility functions

Context

When a payment pointer is requested but not found in Rafiki, we will now will publish a payment_pointer.not_found webhook event, and start polling for the ASE to create a payment pointer (via createPaymentPointer mutation). The polling timeout (and frequency) is configurable. This enables creation of payment pointers on the fly: giving a chance for the ASE to resolve any requested payment pointer that they may have in their system.

This can be demonstrated via a new seed user, Alice Smith, who doesn't have a payment pointer to start with:

but then upon GET https://happy-life-bank-backend/accounts/asmith one is created asynchronously:

This new payment pointer can be used via the {{asmithPaymentPointer}} Postman collection variable.

Considerations

Ideally, requests need to be rate-limited (per IP?): for a payment pointer that the ASE cannot resolve (the account doesn't exist), it's a bit of a heavy operation every GET request & can take up some resources.

Checklist

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

netlify · 2023-06-08T16:28:36Z

✅ Deploy Preview for brilliant-pasca-3e80ec canceled.

Name	Link
🔨 Latest commit	`a58ff7f`
🔍 Latest deploy log	https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/649597bc576434000816f152

mkurapov · 2023-06-08T16:29:04Z

packages/backend/src/tests/helpers.ts

@@ -0,0 +1,21 @@
+import { IAppConfig } from '../config/app'


copied from auth package

mkurapov · 2023-06-08T16:34:36Z

packages/backend/src/open_payments/payment_pointer/service.test.ts

+        'returns undefined if no payment pointer exists with url',
+        withConfigOverride(
+          () => config,
+          { paymentPointerLookupTimeoutMs: 1 },


purely so the tests run faster, and don't need to wait the 1.5s for the timeout

mkurapov · 2023-06-08T21:54:11Z

packages/backend/src/shared/utils.ts

+
+    response = await requestWithTimeout(
+      () => request(),
+      timeoutMs - elapsedTimeMs


timeoutMs - elapsedTimeMs essentially lets timeoutMs to be the maximum timeout for the polling period. i.e. we can break early without needing for the given request to complete before timing out

mkurapov · 2023-06-08T21:55:47Z

packages/backend/src/open_payments/payment_pointer/service.ts

+    data: {
+      paymentPointerUrl: url
+    }


We could also just return the payment pointer path here, i.e. just gfranklin instead of the full https://rafiki.money/gfranklin, but I think this keeps it consistent, we just let the ASE to the stripping of the string as they see fit

mkurapov · 2023-06-08T22:14:04Z

localenv/happy-life-bank/seed.yml

@@ -21,6 +21,12 @@ accounts:
    initialBalance: 2000
    path: accounts/planex
    postmanEnvVar: planexPaymentPointer
+  - name: 'Alice Smith'
+    path: accounts/asmith


maybe alias is better than path but just went with what was there originally

BlairCurrey

Tested locally and it works as described.

Ideally, requests need to be rate-limited (per IP?): for a payment pointer that the ASE cannot resolve (the account doesn't exist), it's a bit of a heavy operation every GET request & can take up some resources.

That does seem like a concern. We should probably create an issue to address this vulnerability (whether by rate limiting or other means) so it doesn't get lost

# Conflicts: # packages/backend/src/config/app.ts # packages/backend/src/index.ts # packages/backend/src/open_payments/payment_pointer/service.test.ts # packages/backend/src/open_payments/payment_pointer/service.ts # packages/documentation/docs/integration/deployment.md

mkurapov · 2023-06-23T12:07:48Z

packages/documentation/docs/integration/deployment.md

-| `EXCHANGE_RATES_LIFETIME`                              | `15_000`                                                    | milliseconds                                                                                                                |
-| `EXCHANGE_RATES_URL`                                   | `undefined`                                                 | endpoint on the Account Servicing Entity to request receiver fees                                                           |


Moved up to alphabetize

BlairCurrey · 2023-06-23T12:59:43Z

packages/backend/src/open_payments/payment_pointer/service.test.ts

@@ -37,7 +37,6 @@ describe('Open Payments Payment Pointer Service', (): void => {
  let paymentPointerService: PaymentPointerService
  let accountingService: AccountingService
  let knex: Knex
-  let config: IAppConfig


looks like we can remove line 48 as well (duplicate config = await deps.use('config') in beforeAll)

* feat: ask for payment pointer from ASE * docs: update language * docs: add webhook information * add webhook to OpenAPI * docs: update wording * feat(mase): allow for on the fly payment pointer creation * chore(mase): update webhook handler * docs: update wording, link to section * fix test * docs: alphabetize env vars in * chore: remove duplicate line

feat: ask for payment pointer from ASE

3720bdf

github-actions bot added pkg: backend Changes in the backend package. pkg: documentation Changes in the documentation package. type: documentation type: source Changes business logic type: tests Testing related labels Jun 8, 2023

mkurapov commented Jun 8, 2023

View reviewed changes

docs: update language

4a2bd9e

mkurapov commented Jun 8, 2023

View reviewed changes

mkurapov added 3 commits June 8, 2023 23:23

docs: add webhook information

926bc81

add webhook to OpenAPI

f57c69c

docs: update wording

ae6ff0c

mkurapov commented Jun 8, 2023

View reviewed changes

feat(mase): allow for on the fly payment pointer creation

8282e49

github-actions bot added the pkg: mock-ase label Jun 8, 2023

mkurapov commented Jun 8, 2023

View reviewed changes

chore(mase): update webhook handler

8d5d92c

mkurapov marked this pull request as ready for review June 8, 2023 22:17

mkurapov requested review from sabineschaller and BlairCurrey June 8, 2023 22:18

docs: update wording, link to section

89e8131

BlairCurrey previously approved these changes Jun 21, 2023

View reviewed changes

mkurapov dismissed BlairCurrey’s stale review via db1568b June 23, 2023 11:06

mkurapov added 2 commits June 23, 2023 13:34

fix test

0c1b8df

docs: alphabetize env vars in

64973c8

mkurapov commented Jun 23, 2023

View reviewed changes

mkurapov requested a review from BlairCurrey June 23, 2023 12:43

BlairCurrey reviewed Jun 23, 2023

View reviewed changes

chore: remove duplicate line

a58ff7f

BlairCurrey approved these changes Jun 23, 2023

View reviewed changes

mkurapov merged commit 22ef1dc into main Jun 23, 2023

mkurapov deleted the 1419/mk/fetch-payment-pointers branch June 23, 2023 14:11

mkurapov mentioned this pull request Jun 29, 2023

feat: only poll for payment pointers in the open payments middleware #1528

Merged

4 tasks

sabineschaller mentioned this pull request Aug 24, 2023

Allow incoming payment creation on non-existing payment pointers #1780

Closed

2 tasks

huijing added the type: documentation (archived) Improvements or additions to documentation label Oct 30, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: ask for payment pointer from ASE #1501

feat: ask for payment pointer from ASE #1501

Uh oh!

mkurapov commented Jun 8, 2023 •

edited

Loading

Uh oh!

netlify bot commented Jun 8, 2023 •

edited

Loading

Uh oh!

mkurapov Jun 8, 2023

Uh oh!

mkurapov Jun 8, 2023

Uh oh!

mkurapov Jun 8, 2023

Uh oh!

mkurapov Jun 8, 2023 •

edited

Loading

Uh oh!

mkurapov Jun 8, 2023

Uh oh!

BlairCurrey left a comment

Uh oh!

mkurapov Jun 23, 2023

Uh oh!

BlairCurrey Jun 23, 2023

Uh oh!

Uh oh!

		\| `EXCHANGE_RATES_LIFETIME` \| `15_000` \| milliseconds \|
		\| `EXCHANGE_RATES_URL` \| `undefined` \| endpoint on the Account Servicing Entity to request receiver fees \|

feat: ask for payment pointer from ASE #1501

feat: ask for payment pointer from ASE #1501

Uh oh!

Conversation

mkurapov commented Jun 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes proposed in this pull request

Context

Considerations

Checklist

Uh oh!

netlify bot commented Jun 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for brilliant-pasca-3e80ec canceled.

Uh oh!

mkurapov Jun 8, 2023

Choose a reason for hiding this comment

Uh oh!

mkurapov Jun 8, 2023

Choose a reason for hiding this comment

Uh oh!

mkurapov Jun 8, 2023

Choose a reason for hiding this comment

Uh oh!

mkurapov Jun 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mkurapov Jun 8, 2023

Choose a reason for hiding this comment

Uh oh!

BlairCurrey left a comment

Choose a reason for hiding this comment

Uh oh!

mkurapov Jun 23, 2023

Choose a reason for hiding this comment

Uh oh!

BlairCurrey Jun 23, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mkurapov commented Jun 8, 2023 •

edited

Loading

netlify bot commented Jun 8, 2023 •

edited

Loading

mkurapov Jun 8, 2023 •

edited

Loading