feat: rpc 0.2.0 types spec

starknet-io · Oct 23, 2022 · 25b2d29 · 25b2d29
1 parent 2b1b71e
commit 25b2d29
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 18 deletions.
diff --git a/src/provider/rpc.ts b/src/provider/rpc.ts
@@ -8,7 +8,6 @@ import {
   EstimateFeeResponse,
   GetBlockResponse,
   GetCodeResponse,
-  GetTransactionReceiptResponse,
   GetTransactionResponse,
   Invocation,
   InvocationsDetailsWithNonce,
@@ -186,17 +185,21 @@ export class RpcProvider implements ProviderInterface {
     return this.fetchEndpoint('starknet_getTransactionByBlockIdAndIndex', { block_id, index });
   }
 
-  public async getTransactionReceipt(txHash: string): Promise<GetTransactionReceiptResponse> {
+  public async getTransactionReceipt(txHash: string): Promise<RPC.TransactionReceipt> {
     return this.fetchEndpoint('starknet_getTransactionReceipt', { transaction_hash: txHash });
   }
 
-  public async getClass(classHash: RPC.Felt): Promise<RPC.ContractClass> {
-    return this.fetchEndpoint('starknet_getClass', { class_hash: classHash });
+  public async getClass(
+    classHash: RPC.Felt,
+    blockIdentifier: BlockIdentifier
+  ): Promise<RPC.ContractClass> {
+    const block_id = new Block(blockIdentifier).identifier;
+    return this.fetchEndpoint('starknet_getClass', { class_hash: classHash, block_id });
   }
 
   public async getClassAt(
     contractAddress: string,
-    blockIdentifier: BlockIdentifier
+    blockIdentifier: BlockIdentifier = 'pending'
   ): Promise<RPC.ContractClass> {
     const block_id = new Block(blockIdentifier).identifier;
     return this.fetchEndpoint('starknet_getClassAt', {
@@ -351,6 +354,17 @@ export class RpcProvider implements ProviderInterface {
     });
   }
 
+  /* 
+    sender_address: ADDRESS;
+    calldata: Array<FELT>;
+
+    type: TXN_TYPE;
+    max_fee: FELT;
+    version: NUM_AS_HEX;
+    signature: SIGNATURE;
+    nonce: FELT;
+   */
+
   // Methods from Interface
   public async callContract(
     call: Call,
@@ -391,6 +405,11 @@ export class RpcProvider implements ProviderInterface {
         // eslint-disable-next-line no-await-in-loop
         const res = await this.getTransactionReceipt(txHash);
 
+        if (!('status' in res)) {
+          const error = new Error('pending transaction');
+          throw error;
+        }
+
         if (res.status && successStates.includes(res.status)) {
           onchain = true;
         } else if (res.status && errorStates.includes(res.status)) {

diff --git a/src/types/api/openrpcv2.ts b/src/types/api/openrpcv2.ts
@@ -36,22 +36,22 @@ type EVENT = {
 };
 
 type COMMON_RECEIPT_PROPERTIES = {
-  transaction_hash?: TXN_HASH;
-  actual_fee?: FELT;
-  status?: TXN_STATUS;
+  transaction_hash: TXN_HASH;
+  actual_fee: FELT;
+  status: TXN_STATUS;
   block_hash?: BLOCK_HASH;
   block_number?: BLOCK_NUMBER;
-  type?: TXN_TYPE;
-  messages_sent: MSG_TO_L1;
-  events: EVENT;
+  type: TXN_TYPE;
+  messages_sent: Array<MSG_TO_L1>;
+  events: Array<EVENT>;
 };
 
 type PENDING_COMMON_RECEIPT_PROPERTIES = {
   transaction_hash: TXN_HASH;
   actual_fee: FELT;
   type?: TXN_TYPE;
-  messages_sent: MSG_TO_L1;
-  events: EVENT;
+  messages_sent: Array<MSG_TO_L1>;
+  events: Array<EVENT>;
 };
 
 type INVOKE_TXN_RECEIPT = COMMON_RECEIPT_PROPERTIES;
@@ -321,7 +321,7 @@ type FUNCTION_INVOCATION = FUNCTION_CALL & {
   call_type: CALL_TYPE;
   result: FELT;
   calls: NESTED_CALL;
-  events: EVENT;
+  events: Array<EVENT>;
   messages: MSG_TO_L1;
 };
 type NESTED_CALL = FUNCTION_INVOCATION;

diff --git a/src/types/api/rpc.ts b/src/types/api/rpc.ts
@@ -1,4 +1,4 @@
-import { ADDRESS, FELT, OPENRPC } from './openrpc';
+import { ADDRESS, FELT, OPENRPC } from './openrpcv2';
 
 export namespace RPC {
   export type Response = {
@@ -41,6 +41,5 @@ export namespace RPC {
   export type InvokedTransaction = OPENRPC.InvokedTransaction;
   export type DeclaredTransaction = OPENRPC.DeclaredTransaction;
   export type DeployedTransaction = OPENRPC.DeployedTransaction;
-
   export type Methods = OPENRPC.Methods;
 }
diff --git a/src/types/lib.ts b/src/types/lib.ts
@@ -81,17 +81,24 @@ export type FunctionAbi = {
   name: string;
   outputs: AbiEntry[];
   stateMutability?: 'view';
-  type: 'function' | 'constructor';
+  type: FUNCTION_ABI_TYPE;
 };
 
+enum FUNCTION_ABI_TYPE {
+  'function',
+  'l1_handler',
+}
+
 export type StructAbi = {
   members: (AbiEntry & { offset: number })[];
   name: string;
   size: number;
   type: 'struct';
 };
 
-export type Abi = Array<FunctionAbi | StructAbi>;
+export type Abi = Array<FunctionAbi | EventAbi | StructAbi>;
+
+type EventAbi = any; // TODO: define
 
 export type EntryPointsByType = object;
 export type Program = Record<any, any>;