feat: add get_block_traces support in sequencer

starknet-io · Jan 16, 2023 · b8dec62 · b8dec62
1 parent be7b792
commit b8dec62
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 0 deletions.
diff --git a/src/provider/sequencer.ts b/src/provider/sequencer.ts
@@ -587,4 +587,11 @@ export class SequencerProvider implements ProviderInterface {
       }
     ).then(this.responseParser.parseFeeSimulateTransactionResponse);
   }
+
+  // consider adding an optional trace retrieval parameter to the getBlock method
+  public async getBlockTraces(
+    blockIdentifier: BlockIdentifier = this.blockIdentifier
+  ): Promise<Sequencer.BlockTransactionTracesResponse> {
+    return this.fetchEndpoint('get_block_traces', { blockIdentifier });
+  }
 }
diff --git a/src/types/api/sequencer.ts b/src/types/api/sequencer.ts
@@ -260,6 +260,10 @@ export namespace Sequencer {
 
   export type EstimateFeeResponseBulk = AllowArray<EstimateFeeResponse>;
 
+  export type BlockTransactionTracesResponse = Array<
+    TransactionTraceResponse & { transaction_hash: string }
+  >;
+
   export type Endpoints = {
     get_contract_addresses: {
       QUERY: never;
@@ -394,5 +398,12 @@ export namespace Sequencer {
       REQUEST: EstimateFeeRequestBulk;
       RESPONSE: EstimateFeeResponseBulk;
     };
+    get_block_traces: {
+      QUERY: {
+        blockIdentifier: BlockIdentifier;
+      };
+      REQUEST: never;
+      RESPONSE: BlockTransactionTracesResponse;
+    };
   };
 }
diff --git a/www/docs/API/Provider/sequencerProvider.md b/www/docs/API/Provider/sequencerProvider.md
@@ -156,3 +156,44 @@ Gets the transaction trace from a tx hash.
   };
 }
 ```
+
+---
+
+### getBlockTraces()
+
+provider.**getBlockTraces**(blockIdentifier) => _Promise < BlockTransactionTracesResponse >_
+
+Gets the transaction traces of an entire block
+
+###### _BlockTransactionTracesResponse_
+
+```typescript
+
+Array<TransactionTraceResponse & { transaction_hash: string }>
+
+{
+  TransactionTraceResponse: {
+    validate_invocation?: FunctionInvocation;
+    function_invocation?: FunctionInvocation;
+    fee_transfer_invocation?: FunctionInvocation;
+    signature: Signature;
+  }
+
+  FunctionInvocation: {
+    caller_address: string;
+    contract_address: string;
+    calldata: {
+      [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
+    };
+    call_type?: string;
+    class_hash?: string;
+    selector?: string;
+    entry_point_type?: EntryPointType;
+    result: Array<any>;
+    execution_resources: ExecutionResources;
+    internal_calls: Array<FunctionInvocation>;
+    events: Array<any>;
+    messages: Array<any>;
+  };
+}
+```