feat: add wallet address to subresource requests (#305)

interledger · Oct 16, 2023 · 5809202 · 5809202
1 parent 32e089c
commit 5809202
Show file tree

Hide file tree

Showing 16 changed files with 263 additions and 126 deletions.
diff --git a/.changeset/clean-mice-sparkle.md b/.changeset/clean-mice-sparkle.md
@@ -0,0 +1,5 @@
+---
+'@interledger/open-payments': minor
+---
+
+Added "walletAddress" field to resource POST request bodies, added "wallet-address" query parameter to resource GET requests.
diff --git a/openapi/resource-server.yaml b/openapi/resource-server.yaml
@@ -137,6 +137,8 @@ paths:
               type: object
               additionalProperties: false
               properties:
+                walletAddress:
+                  $ref: ./schemas.yaml#/components/schemas/walletAddress
                 incomingAmount:
                   $ref: ./schemas.yaml#/components/schemas/amount
                   description: The maximum amount that should be paid into the wallet address under this incoming payment.
@@ -151,6 +153,7 @@ paths:
             examples:
               Create incoming payment for $25 to pay invoice INV2022-02-0137:
                 value:
+                  walletAddress: 'https://openpayments.guide/alice/'
                   incomingAmount:
                     value: '2500'
                     assetCode: USD
@@ -275,6 +278,7 @@ paths:
           $ref: '#/components/responses/403'
       description: List all incoming payments on the wallet address
       parameters:
+        - $ref: '#/components/parameters/wallet-address'
         - $ref: '#/components/parameters/cursor'
         - $ref: '#/components/parameters/first'
         - $ref: '#/components/parameters/last'
@@ -328,12 +332,15 @@ paths:
             examples:
               Create an outgoing payment based on a quote:
                 value:
+                  walletAddress: 'https://ilp.rafiki.money/alice/'
                   quoteId: 'https://ilp.rafiki.money/quotes/ab03296b-0c8b-4776-b94e-7ee27d868d4d'
                   metadata:
                     externalRef: INV2022-02-0137
             schema:
               type: object
               properties:
+                walletAddress:
+                  $ref: ./schemas.yaml#/components/schemas/walletAddress
                 quoteId:
                   type: string
                   format: uri
@@ -344,6 +351,7 @@ paths:
                   description: Additional metadata associated with the outgoing payment. (Optional)
               required:
                 - quoteId
+                - walletAddress
               additionalProperties: false
         description: |-
           A subset of the outgoing payments schema is accepted as input to create a new outgoing payment.
@@ -482,6 +490,7 @@ paths:
           $ref: '#/components/responses/403'
       description: List all outgoing payments on the wallet address
       parameters:
+        - $ref: '#/components/parameters/wallet-address'
         - $ref: '#/components/parameters/cursor'
         - $ref: '#/components/parameters/first'
         - $ref: '#/components/parameters/last'
@@ -531,10 +540,12 @@ paths:
             examples:
               Create quote for an `receiver` that is an Incoming Payment with an `incomingAmount`:
                 value:
+                  walletAddress: 'https://ilp.rafiki.money/alice'
                   receiver: 'https://ilp.rafiki.money/incoming-payments/37a0d0ee-26dc-4c66-89e0-01fbf93156f7'
                   method: ilp
               Create fixed-send amount quote for $25:
                 value:
+                  walletAddress: 'https://ilp.rafiki.money/alice'
                   receiver: 'https://ilp.rafiki.money/incoming-payments/37a0d0ee-26dc-4c66-89e0-01fbf93156f7'
                   method: ilp
                   debitAmount:
@@ -543,6 +554,7 @@ paths:
                     assetScale: 2
               Create fixed-receive amount quote for $25:
                 value:
+                  walletAddress: 'https://ilp.rafiki.money/alice'
                   receiver: 'https://ilp.rafiki.money/incoming-payments/37a0d0ee-26dc-4c66-89e0-01fbf93156f7'
                   method: ilp
                   receiveAmount:
@@ -553,16 +565,21 @@ paths:
               oneOf:
                 - description: Create quote for an `receiver` that is an Incoming Payment with an `incomingAmount`
                   properties:
+                    walletAddress:
+                      $ref: ./schemas.yaml#/components/schemas/walletAddress
                     receiver:
                       $ref: ./schemas.yaml#/components/schemas/receiver
                     method:
                       $ref: '#/components/schemas/payment-method'
                   required:
+                    - walletAddress
                     - receiver
                     - method
                   additionalProperties: false
                 - description: Create a quote with a fixed-receive amount
                   properties:
+                    walletAddress:
+                      $ref: ./schemas.yaml#/components/schemas/walletAddress
                     receiver:
                       $ref: ./schemas.yaml#/components/schemas/receiver
                     method:
@@ -571,12 +588,15 @@ paths:
                       description: The fixed amount that would be paid into the receiving wallet address given a successful outgoing payment.
                       $ref: ./schemas.yaml#/components/schemas/amount
                   required:
+                    - walletAddress
                     - receiver
                     - method
                     - receiveAmount
                   additionalProperties: false
                 - description: Create a quote with a fixed-send amount
                   properties:
+                    walletAddress:
+                      $ref: ./schemas.yaml#/components/schemas/walletAddress
                     receiver:
                       $ref: ./schemas.yaml#/components/schemas/receiver
                     method:
@@ -585,6 +605,7 @@ paths:
                       description: The fixed amount that would be sent from the sending wallet address given a successful outgoing payment.
                       $ref: ./schemas.yaml#/components/schemas/amount
                   required:
+                    - walletAddress
                     - receiver
                     - method
                     - debitAmount
@@ -1282,6 +1303,13 @@ components:
         type: string
       description: Sub-resource identifier
       required: true
+    wallet-address:
+      name: wallet-address
+      in: query
+      schema:
+        type: string
+      description: 'URL of a wallet address hosted by a Rafiki instance.'
+      required: true
     signature:
       name: Signature
       in: header

diff --git a/openapi/schemas.yaml b/openapi/schemas.yaml
@@ -46,3 +46,8 @@ components:
       examples:
         - 'https://ilp.rafiki.money/incoming-payments/08394f02-7b7b-45e2-b645-51d04e7c330c'
         - 'https://ilp.rafiki.money/connections/016da9d5-c9a4-4c80-a354-86b915a04ff8'
+    walletAddress:
+      title: Wallet Address
+      type: string
+      description: 'URL of a wallet address hosted by a Rafiki instance.'
+      format: uri
diff --git a/packages/open-payments/src/client/grant.ts b/packages/open-payments/src/client/grant.ts
@@ -1,6 +1,6 @@
 import { HttpMethod } from '@interledger/openapi'
 import {
-  ResourceRequestArgs,
+  GrantOrTokenRequestArgs,
   RouteDeps,
   UnauthenticatedResourceRequestArgs
 } from '.'
@@ -23,10 +23,10 @@ export interface GrantRoutes {
     args: Omit<GrantRequest, 'client'>
   ): Promise<PendingGrant | Grant>
   continue(
-    postArgs: ResourceRequestArgs,
+    postArgs: GrantOrTokenRequestArgs,
     args: GrantContinuationRequest
   ): Promise<Grant>
-  cancel(postArgs: ResourceRequestArgs): Promise<void>
+  cancel(postArgs: GrantOrTokenRequestArgs): Promise<void>
 }
 
 export const createGrantRoutes = (deps: GrantRouteDeps): GrantRoutes => {
@@ -62,7 +62,7 @@ export const createGrantRoutes = (deps: GrantRouteDeps): GrantRoutes => {
         requestGrantValidator
       ),
     continue: (
-      { url, accessToken }: ResourceRequestArgs,
+      { url, accessToken }: GrantOrTokenRequestArgs,
       args: GrantContinuationRequest
     ) =>
       post(
@@ -74,7 +74,7 @@ export const createGrantRoutes = (deps: GrantRouteDeps): GrantRoutes => {
         },
         continueGrantValidator
       ),
-    cancel: ({ url, accessToken }: ResourceRequestArgs) =>
+    cancel: ({ url, accessToken }: GrantOrTokenRequestArgs) =>
       deleteRequest(
         deps,
         {