Add endpoints for getting receipts from Access API

.gitignore

@@ -13,3 +13,6 @@
 # Gradle temp files
 protobuf/.gradle
 protobuf/build
+
+# agent plans
+/docs/plans

openapi/access.yaml

@@ -428,6 +428,66 @@ paths:
           $ref: '#/components/responses/404NotFound'
         '500':
           $ref: '#/components/responses/500InternalServerError'
+  /execution_receipts:
+    get:
+      summary: Get Execution Receipts by Block ID
+      description: Get all execution receipts for the provided block ID.
+      tags:
+        - Execution Receipts
+      parameters:
+        - name: block_id
+          in: query
+          schema:
+            $ref: '#/components/schemas/Identifier'
+          required: true
+          description: The ID of the block.
+        - $ref: '#/components/parameters/expandParam'
+        - $ref: '#/components/parameters/selectParam'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ExecutionReceipt'
+        '400':
+          $ref: '#/components/responses/400BadRequest'
+        '404':
+          $ref: '#/components/responses/404NotFound'
+        '500':
+          $ref: '#/components/responses/500InternalServerError'
+  /execution_receipts/results/{id}:
+    get:
+      summary: Get Execution Receipts by Result ID
+      description: Get all execution receipts for the provided execution result ID.
+      tags:
+        - Execution Receipts
+      parameters:
+        - name: id
+          in: path
+          schema:
+            $ref: '#/components/schemas/Identifier'
+          required: true
+          description: The ID of the execution result.
+        - $ref: '#/components/parameters/expandParam'
+        - $ref: '#/components/parameters/selectParam'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ExecutionReceipt'
+        '400':
+          $ref: '#/components/responses/400BadRequest'
+        '404':
+          $ref: '#/components/responses/404NotFound'
+        '500':
+          $ref: '#/components/responses/500InternalServerError'
   /accounts/{address}:
     get:
       summary: Get an Account By Address
@@ -1333,6 +1393,37 @@ components:
           $ref: '#/components/schemas/Metadata'
         _links:
           $ref: '#/components/schemas/Links'
+    ExecutionReceipt:
+      type: object
+      required:
+        - executor_id
+        - result_id
+        - executor_signature
+        - _expandable
+      properties:
+        executor_id:
+          description: Node ID of the execution node who produced the receipt.
+          $ref: '#/components/schemas/Identifier'
+        result_id:
+          $ref: '#/components/schemas/Identifier'
+        spocks:
+          type: array
+          items:
+            type: string
+            format: byte
+        executor_signature:
+          type: string
+          format: byte
+        execution_result:
+          $ref: '#/components/schemas/ExecutionResult'
+        _expandable:
+          type: object
+          properties:
+            execution_result:
+              type: string
+              format: uri
+        metadata:
+          $ref: '#/components/schemas/Metadata'
     BlockEvents:
       type: object
       properties:

openapi/go-client-generated/.swagger-codegen/VERSION

@@ -1 +1 @@
-3.0.75
+3.0.78

openapi/go-client-generated/README.md

@@ -30,6 +30,8 @@ Class | Method | HTTP request | Description
 *BlocksApi* | [**BlocksIdPayloadGet**](docs/BlocksApi.md#blocksidpayloadget) | **Get** /blocks/{id}/payload | Get Block Payload by Block ID.
 *CollectionsApi* | [**CollectionsIdGet**](docs/CollectionsApi.md#collectionsidget) | **Get** /collections/{id} | Gets a Collection by ID
 *EventsApi* | [**EventsGet**](docs/EventsApi.md#eventsget) | **Get** /events | Get Events
+*ExecutionReceiptsApi* | [**ExecutionReceiptsGet**](docs/ExecutionReceiptsApi.md#executionreceiptsget) | **Get** /execution_receipts | Get Execution Receipts by Block ID
+*ExecutionReceiptsApi* | [**ExecutionReceiptsResultsIdGet**](docs/ExecutionReceiptsApi.md#executionreceiptsresultsidget) | **Get** /execution_receipts/results/{id} | Get Execution Receipts by Result ID
 *ExecutionResultsApi* | [**ExecutionResultsGet**](docs/ExecutionResultsApi.md#executionresultsget) | **Get** /execution_results | Get Execution Results by Block ID
 *ExecutionResultsApi* | [**ExecutionResultsIdGet**](docs/ExecutionResultsApi.md#executionresultsidget) | **Get** /execution_results/{id} | Get Execution Result by ID
 *NetworkApi* | [**NetworkParametersGet**](docs/NetworkApi.md#networkparametersget) | **Get** /network/parameters | Get Network Parameters
@@ -65,6 +67,8 @@ Class | Method | HTTP request | Description
  - [CompatibleRange](docs/CompatibleRange.md)
  - [Event](docs/Event.md)
  - [ExecuteScriptResponse](docs/ExecuteScriptResponse.md)
+ - [ExecutionReceipt](docs/ExecutionReceipt.md)
+ - [ExecutionReceiptExpandable](docs/ExecutionReceiptExpandable.md)
  - [ExecutionResult](docs/ExecutionResult.md)
  - [ExecutorMetadata](docs/ExecutorMetadata.md)
  - [HashingAlgorithm](docs/HashingAlgorithm.md)

openapi/go-client-generated/api/swagger.yaml

@@ -929,6 +929,144 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Error"
+  /execution_receipts:
+    get:
+      tags:
+      - Execution Receipts
+      summary: Get Execution Receipts by Block ID
+      description: Get all execution receipts for the provided block ID.
+      parameters:
+      - name: block_id
+        in: query
+        description: The ID of the block.
+        required: true
+        style: form
+        explode: true
+        schema:
+          $ref: "#/components/schemas/Identifier"
+      - name: expand
+        in: query
+        description: A comma-separated list indicating which properties of the content
+          to expand.
+        required: false
+        style: form
+        explode: false
+        schema:
+          minItems: 1
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+      - name: select
+        in: query
+        description: A comma-separated list indicating which properties of the content
+          to return.
+        required: false
+        style: form
+        explode: false
+        schema:
+          minItems: 1
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/ExecutionReceipt"
+                x-content-type: application/json
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /execution_receipts/results/{id}:
+    get:
+      tags:
+      - Execution Receipts
+      summary: Get Execution Receipts by Result ID
+      description: Get all execution receipts for the provided execution result ID.
+      parameters:
+      - name: id
+        in: path
+        description: The ID of the execution result.
+        required: true
+        style: simple
+        explode: false
+        schema:
+          $ref: "#/components/schemas/Identifier"
+      - name: expand
+        in: query
+        description: A comma-separated list indicating which properties of the content
+          to expand.
+        required: false
+        style: form
+        explode: false
+        schema:
+          minItems: 1
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+      - name: select
+        in: query
+        description: A comma-separated list indicating which properties of the content
+          to return.
+        required: false
+        style: form
+        explode: false
+        schema:
+          minItems: 1
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/ExecutionReceipt"
+                x-content-type: application/json
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "500":
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
   /accounts/{address}:
     get:
       tags:
@@ -2713,6 +2851,87 @@ components:
           transaction_index: transaction_index
           type: type
           event_index: event_index
+    ExecutionReceipt:
+      required:
+      - _expandable
+      - executor_id
+      - executor_signature
+      - result_id
+      type: object
+      properties:
+        executor_id:
+          $ref: "#/components/schemas/Identifier"
+        result_id:
+          $ref: "#/components/schemas/Identifier"
+        spocks:
+          type: array
+          items:
+            type: string
+            format: byte
+        executor_signature:
+          type: string
+          format: byte
+        execution_result:
+          $ref: "#/components/schemas/ExecutionResult"
+        _expandable:
+          $ref: "#/components/schemas/ExecutionReceipt__expandable"
+        metadata:
+          $ref: "#/components/schemas/Metadata"
+      example:
+        executor_signature: ""
+        spocks:
+        - ""
+        - ""
+        metadata:
+          executor_metadata:
+            execution_result_id: null
+            executor_ids:
+            - null
+            - null
+        result_id: null
+        execution_result:
+          metadata:
+            executor_metadata:
+              execution_result_id: null
+              executor_ids:
+              - null
+              - null
+          _links:
+            _self: _self
+          chunks:
+          - start_state: ""
+            index: index
+            number_of_transactions: number_of_transactions
+            collection_index: collection_index
+            end_state: ""
+            event_collection: ""
+            block_id: null
+            total_computation_used: total_computation_used
+          - start_state: ""
+            index: index
+            number_of_transactions: number_of_transactions
+            collection_index: collection_index
+            end_state: ""
+            event_collection: ""
+            block_id: null
+            total_computation_used: total_computation_used
+          id: null
+          previous_result_id: null
+          block_id: null
+          events:
+          - transaction_id: null
+            payload: ""
+            transaction_index: transaction_index
+            type: type
+            event_index: event_index
+          - transaction_id: null
+            payload: ""
+            transaction_index: transaction_index
+            type: type
+            event_index: event_index
+        _expandable:
+          execution_result: http://example.com/aeiou
+        executor_id: executor_id
     BlockEvents:
       type: object
       properties:
@@ -3080,6 +3299,14 @@ components:
       example:
         payload: payload
         execution_result: http://example.com/aeiou
+    ExecutionReceipt__expandable:
+      type: object
+      properties:
+        execution_result:
+          type: string
+          format: uri
+      example:
+        execution_result: http://example.com/aeiou
   responses:
     "400BadRequest":
       description: Bad Request