Feat: Multichain payment

.gitignore

@@ -11,6 +11,7 @@ bin/
 .env-issuer
 .env-ui
 resolvers_settings.yaml
+payments.yaml
 
 infrastructure/local/.vault/data
 infrastructure/local/.vault/plugins

Dockerfile

@@ -26,4 +26,5 @@ RUN apk add curl
 COPY --from=base ./service/api ./api
 COPY --from=base ./service/bin/* ./
 COPY --from=base ./service/pkg/credentials ./pkg/credentials
-COPY --from=base ./service/resolvers_settings.* ./
+COPY --from=base ./service/resolvers_settings.* ./
+COPY --from=base ./service/payment.* ./

README.md

@@ -102,6 +102,8 @@ a4a1d3ec9159   redis:6-alpine                  "docker-entrypoint.s…"   38 sec
 make private_key=<private-key> import-private-key-to-kms 
 ```
 
+**_TODO_**: Add section to configure payments
+
 then visit:
 * https://localhost:8088/ to access the UI (default username / password are: user-ui, password-ui). You can set them using env [vars](.env-ui.sample).
 * <PUBLICLY_ACCESSIBLE_URL_POINTING_TO_ISSUER_SERVER_PORT>:3001/ to access the API. (default username / password are: user-issuer, password-issuer)
@@ -139,6 +141,8 @@ then modify the file with the proper values. The most important fields to run th
 In this file you can define customizations for each type of blockchain and network. For this example, we only need to 
 define the RPCs. that will use.
 
+**_TODO_**: Add section to configure payments****
+
 4. Copy .env-ui sample file and fill the needed env variables:
 
 ```bash 

api/api.yaml

@@ -1292,6 +1292,192 @@ paths:
         '500':
           $ref: '#/components/responses/500'
 
+  /v2/identities/{identifier}/payment-request:
+    post:
+      summary: Create Payment Request
+      operationId: CreatePaymentRequest
+      description: Create a payment request for the provided identity.
+      tags:
+        - Payment
+      security:
+        - basicAuth: [ ]
+      parameters:
+        - $ref: '#/components/parameters/pathIdentifier'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreatePaymentRequest'
+      responses:
+        '201':
+          description: Payment Request Created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/BasicMessage'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '422':
+          $ref: '#/components/responses/422'
+        '500':
+          $ref: '#/components/responses/500'
+
+  /v2/payment/settings:
+    get:
+      summary: Return payment settings
+      operationId: GetPaymentSettings
+      description: Get the payment settings
+      tags:
+        - Payment
+      security:
+        - basicAuth: [ ]
+      responses:
+        '200':
+          description: Payment settings
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaymentSettings'
+
+  /v2/identities/{identifier}/payment/options:
+    get:
+      summary: Get Payment Options
+      operationId: GetPaymentOptions
+      description: Get the payment options for the provided identity.
+      tags:
+        - Payment
+      security:
+        - basicAuth: [ ]
+      parameters:
+        - $ref: '#/components/parameters/pathIdentifier'
+      responses:
+        '200':
+          description: Payment options
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaymentOptionsPaginated'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '500':
+          $ref: '#/components/responses/500'
+    post:
+      summary: Create Payment Option
+      operationId: CreatePaymentOption
+      description: Create a payment option for the provided identity.
+      tags:
+        - Payment
+      security:
+        - basicAuth: [ ]
+      parameters:
+        - $ref: '#/components/parameters/pathIdentifier'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PaymentOptionRequest'
+      responses:
+        '201':
+          description: Payment Option Created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UUIDResponse'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '422':
+          $ref: '#/components/responses/422'
+        '500':
+          $ref: '#/components/responses/500'
+
+  /v2/identities/{identifier}/payment/options/{id}:
+    get:
+      summary: Get Payment Option
+      operationId: GetPaymentOption
+      description: Get a specific payment option for the provided identity.
+      tags:
+        - Payment
+      security:
+        - basicAuth: [ ]
+      parameters:
+        - $ref: '#/components/parameters/pathIdentifier'
+        - $ref: '#/components/parameters/id'
+      responses:
+        '200':
+          description: Payment option
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaymentOption'
+        '400':
+          $ref: '#/components/responses/400'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+    delete:
+      summary: Delete Payment Option
+      operationId: DeletePaymentOption
+      description: Remove a specific payment option for the provided identity.
+      tags:
+        - Payment
+      security:
+        - basicAuth: [ ]
+      parameters:
+        - $ref: '#/components/parameters/pathIdentifier'
+        - $ref: '#/components/parameters/id'
+      responses:
+        '200':
+          description: Payment option deleted
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GenericMessage'
+        '400':
+          $ref: '#/components/responses/400'
+        '500':
+          $ref: '#/components/responses/500'
+
+
+  /v2/payment/verify/{recipient}:
+    post:
+      summary: Verify Payment
+      operationId: VerifyPayment
+      description: Verify a payment.
+      tags:
+        - Payment
+      security:
+        - basicAuth: [ ]
+      parameters:
+        - $ref: '#/components/parameters/pathRecipient'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/BasicMessage'
+      responses:
+        '200':
+          description: Payment verified
+          content:
+            application/json:
+              schema:
+                type: boolean
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '500':
+          $ref: '#/components/responses/500'
+
 components:
   securitySchemes:
     basicAuth:
@@ -1858,8 +2044,8 @@ components:
           type: object
           x-go-type: verifiable.W3CCredential
           x-go-type-import:
-              name: verifiable
-              path: "github.com/iden3/go-schema-processor/v2/verifiable"
+            name: verifiable
+            path: "github.com/iden3/go-schema-processor/v2/verifiable"
 
     AuthenticationResponse:
       type: object
@@ -1985,6 +2171,119 @@ components:
         to:
           type: string
 
+    PaymentSettings:
+      type: object
+      x-go-type: payments.Settings
+      x-go-type-import:
+        name: payments
+        path: "github.com/polygonid/sh-id-platform/internal/payments"
+
+    PaymentOptionsPaginated:
+      type: object
+      required: [ items, meta ]
+      properties:
+        items:
+          $ref: '#/components/schemas/PaymentOptions'
+        meta:
+          $ref: '#/components/schemas/PaginatedMetadata'
+
+    PaymentOptions:
+      type: array
+      items:
+        $ref: '#/components/schemas/PaymentOption'
+
+    PaymentOption:
+      type: object
+      required:
+        - id
+        - issuerID
+        - name
+        - description
+        - config
+        - modifiedAt
+        - createdAt
+      properties:
+        id:
+          type: string
+          x-go-type: uuid.UUID
+          x-go-type-import:
+            name: uuid
+            path: github.com/google/uuid
+        issuerID:
+          type: string
+        name:
+          type: string
+        description:
+          type: string
+        config:
+          type: object
+        modifiedAt:
+          $ref: '#/components/schemas/TimeUTC'
+        createdAt:
+          $ref: '#/components/schemas/TimeUTC'
+
+    PaymentOptionRequest:
+      type: object
+      required:
+        - id
+        - issuerID
+        - name
+        - description
+        - config
+        - modifiedAt
+        - createdAt
+      properties:
+        name:
+          type: string
+        description:
+          type: string
+        config:
+          type: object
+
+    BasicMessage:
+      type: object
+      required:
+        - body
+        - id
+        - typ
+        - type
+        - threadID
+        - from
+        - to
+      properties:
+        id:
+          type: string
+        typ:
+          type: string
+        type:
+          type: string
+        threadID:
+          type: string
+        body:
+          type: null
+        from:
+          type: string
+        to:
+          type: string
+
+    CreatePaymentRequest:
+      type: object
+      required:
+        - signingKey
+        - credentialType
+        - credentialContext
+        - userDID
+      properties:
+        signingKey:
+          type: string
+        credentialType:
+          type: string
+        credentialContext:
+          type: string
+        userDID:
+          type: string
+
+
     TimeUTC:
       type: string
       x-go-type: timeapi.Time
@@ -2287,6 +2586,14 @@ components:
       description: Issuer identifier
       schema:
         type: string
+
+    pathRecipient:
+      name: recipient
+      in: path
+      required: true
+      description: Payment recipient address
+      schema:
+        type: string
 
     pathClaim:
       name: id