Merge pull request #465 from AlvaroLuken/al/request-fee-payer

Add new endpoint page for alchemy_requestFeePayer

Author: SahilAujla

.github/workflows/sync-apis.yaml

@@ -154,6 +154,12 @@ jobs:
         working-directory: ./account-abstraction
         run: rdme openapi pm_getPaymasterStubData.yaml --key=$README_API_KEY --id=66c9270918cfbd0012803bb9
 
+      - name: Update AA API - alchemy_requestFeePayer
+        env:
+          README_API_KEY: ${{ secrets.README_API_KEY }}
+        working-directory: ./account-abstraction
+        run: rdme openapi alchemy_requestFeePayer.yaml --key=$README_API_KEY --id=67dc9614acaaf200248f71ea
+
     # Update Embedded Accounts API
       - name: Update Embedded Accounts API - accounts
         env:
@@ -2773,4 +2779,4 @@ jobs:
         env:
           README_API_KEY: ${{ secrets.README_API_KEY }}
         working-directory: ./zkSync
-        run: rdme openapi zks_L1ChainId.yaml --key=$README_API_KEY --id=65ef6dba72dd030072ccb501
+        run: rdme openapi zks_L1ChainId.yaml --key=$README_API_KEY --id=65ef6dba72dd030072ccb501

account-abstraction/alchemy_requestFeePayer.yaml

@@ -0,0 +1,65 @@
+openapi: 3.1.0
+info:
+  title: alchemy_requestFeePayer
+  version: '1.0'
+servers:
+  - url: 'https://solana-devnet.g.alchemy.com/v2/'
+    variables:
+      network:
+        enum:
+          - solana-mainnet
+          - solana-devnet
+        default: solana-mainnet
+x-sandbox:
+  category:
+    type:
+      $ref: '../components/sandbox.yaml#/Category'
+    value: gas-manager
+paths:
+  /{apiKey}:
+    $ref: '#/components/pathItems/path'
+components:
+  pathItems:
+    path:
+      post:
+        summary: alchemy_requestFeePayer
+        description: Request gas sponsorship for a `transaction` on Solana. Returns the `serializedTransaction`, including the `feePayer` signature.
+        tags: []
+        parameters:
+          - name: apiKey
+            in: path
+            schema:
+              type: string
+              default: docs-demo
+              description: |
+                <style>
+                  .custom-style {
+                    color: #048FF4;
+                  }
+                </style>
+                For higher throughput, <span class="custom-style"><a href="https://alchemy.com/?a=docs-demo" target="_blank">create your own API key</a></span>
+            required: true
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                $ref: ../evm_body.yaml#/alchemy_requestFeePayer
+        x-readme:
+          samples-languages:
+            - curl
+            - javascript
+            - python
+        responses:
+          '200':
+            description: Successful response
+            content:
+              application/json:
+                schema:
+                  $ref: ../evm_responses.yaml#/alchemy_requestFeePayer
+        operationId: alchemy-requestFeePayer
+        x-sandbox:
+          category:
+            type:
+              $ref: '../components/sandbox.yaml#/Category'
+            value: gas-manager

evm_body.yaml

@@ -2749,3 +2749,38 @@ pm_getPaymasterData:
                   webhookData:
                     type: string
                     description: Additional data you wish to include in the request, such as proof of humanity.
+
+alchemy_requestFeePayer:
+  allOf:
+    - $ref: '#/common_request_fields'
+    - type: object
+      properties:
+        method:
+          $ref: ./components/schemas.yaml#/Method
+          default: alchemy_requestFeePayer
+        params:
+          type: array
+          description: Parameters for requesting fee payer
+          minItems: 1
+          maxItems: 1
+          items:
+            type: array
+            minItems: 1
+            maxItems: 1
+            items:
+              type: object
+              properties:
+                webhookData:
+                  type: string
+                  description: Additional data you wish to include in the request, such as proof of humanity.
+                policyId:
+                  oneOf:
+                    - type: string
+                      format: uuid
+                    - type: array
+                      items:
+                        type: string
+                        format: uuid
+                serializedTransaction:
+                  type: string
+                  description: A base64-encoded serialized transaction missing signature fields. The `feePayer` field should be set to an address that is different than any other address included in the tx. The API will update the `feePayer` and add the signature to the `serializedTransaction`.

evm_examples.yaml

@@ -2948,3 +2948,13 @@ alchemy_requestGasAndPaymasterAndData:
         'preVerificationGas': '0xab9c',
       },
   }
+
+alchemy_requestFeePayer:
+  {
+    'jsonrpc': '2.0',
+    'method': 'alchemy_requestFeePayer',
+    'id': 1,
+    'result': {
+      'serializedTransaction': 'Ag0GtWZxxEAa5RRlVa9nlvoHlQipM/Xe27r8M+tU7UR3gFIX6inCTo22g1GGTMzKv+8O5d0UfCh1sv1ncCeTHwsAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgAIAAQORLBR6iVTq70gqvschURzPHFw9OqToL0kpKcKJq/fSDMnfsDRNlEHTg8DntRPI83TAVf3jUyJ23AiXAcWFBtckAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB/srKfEvAFKeLN9XFazboEjOa7AXHC5+zjZ6wCIFEgHAECAgEBDAIAAACAlpgAAAAAAAA=',
+    },
+  }

evm_responses.yaml

@@ -1928,3 +1928,18 @@ pm_getPaymasterData:
                   type: string
                   description: |
                     The data for the paymaster in the operation.
+
+alchemy_requestFeePayer:
+  allOf:
+    - $ref: '#/common_response_fields'
+    - type: object
+      properties:
+        result:
+          type: object
+          properties:
+            serializedTransaction:
+              type: string
+              description: The serialized transaction with the fee payer set.
+      example:
+        $ref: ./evm_examples.yaml#/alchemy_requestFeePayer
+