starknet 4.6.0 → 4.8.0

package/src/types/api/openrpc.ts

@@ -8,26 +8,14 @@
  * TypeScript Representation of OpenRpc protocol types
  */
 
-/**
- * "type": "string",
- * "title": "Field element",
- * "$comment": "A field element, represented as a string of hex digits",
- * "description": "A field element. Represented as up to 63 hex digits and leading 4 bits zeroed.",
- * "pattern": "^0x0[a-fA-F0-9]{1,63}$"
- */
 export type FELT = string;
 export type ADDRESS = FELT;
-/**
- * "title": "An integer number in hex format (0x...)",
- * "pattern": "^0x[a-fA-F0-9]+$"
- */
 type NUM_AS_HEX = string;
 type SIGNATURE = Array<FELT>;
 type ETH_ADDRESS = string;
 type BLOCK_NUMBER = number;
 type BLOCK_HASH = FELT;
 type TXN_HASH = FELT;
-type CHAIN_ID = string;
 type PROTOCOL_VERSION = string;
 type TXN_STATUS = 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
 type TXN_TYPE = 'DECLARE' | 'DEPLOY' | 'INVOKE' | 'L1_HANDLER';
@@ -68,7 +56,6 @@ type PENDING_COMMON_RECEIPT_PROPERTIES = {
   actual_fee: FELT;
 };
 type INVOKE_TXN_RECEIPT = COMMON_RECEIPT_PROPERTIES & INVOKE_TXN_RECEIPT_PROPERTIES;
-// type L1_HANDLER_TXN_RECEIPT = COMMON_RECEIPT_PROPERTIES;
 type DECLARE_TXN_RECEIPT = COMMON_RECEIPT_PROPERTIES;
 type DEPLOY_TXN_RECEIPT = COMMON_RECEIPT_PROPERTIES;
 type PENDING_INVOKE_TXN_RECEIPT = PENDING_COMMON_RECEIPT_PROPERTIES & INVOKE_TXN_RECEIPT_PROPERTIES;
@@ -98,18 +85,19 @@ type PENDING_BLOCK_WITH_TX_HASHES = BLOCK_BODY_WITH_TX_HASHES & {
   sequencer_address: FELT;
   parent_hash: BLOCK_HASH;
 };
+// transaction_hash, nonce, type optional because of pathfinder not implemented
 type COMMON_TXN_PROPERTIES = {
-  transaction_hash: TXN_HASH;
+  transaction_hash?: TXN_HASH;
   max_fee: FELT;
   version: NUM_AS_HEX;
   signature: SIGNATURE;
-  nonce: FELT;
-  type: TXN_TYPE;
+  nonce?: FELT;
+  type?: TXN_TYPE;
 };
 type FUNCTION_CALL = {
-  contract_address: ADDRESS;
-  entry_point_selector: FELT;
-  calldata: Array<FELT>;
+  contract_address?: ADDRESS;
+  entry_point_selector?: FELT;
+  calldata?: Array<FELT>;
 };
 type INVOKE_TXN = COMMON_TXN_PROPERTIES & FUNCTION_CALL;
 type DECLARE_TXN = COMMON_TXN_PROPERTIES & {
@@ -138,6 +126,7 @@ type PENDING_BLOCK_WITH_TXS = BLOCK_BODY_WITH_TXS & {
   sequencer_address: FELT;
   parent_hash: BLOCK_HASH;
 };
+
 type CONTRACT_CLASS = {
   program: string; // A base64 representation of the compressed program code
   entry_points_by_type: {
@@ -234,6 +223,7 @@ type TRACE_ROOT = {
 };
 
 export namespace OPENRPC {
+  export type Nonce = FELT;
   export type BlockWithTxHashes = BLOCK_WITH_TX_HASHES | PENDING_BLOCK_WITH_TX_HASHES;
   export type BlockWithTxs = BLOCK_WITH_TXS | PENDING_BLOCK_WITH_TXS;
   export type StateUpdate = STATE_UPDATE;
@@ -248,7 +238,7 @@ export namespace OPENRPC {
     block_hash: BLOCK_HASH;
     block_number: BLOCK_NUMBER;
   };
-  export type ChainId = CHAIN_ID;
+  export type CHAIN_ID = string;
   export type PendingTransactions = Array<TXN>;
   export type ProtocolVersion = PROTOCOL_VERSION;
   export type SyncingStatus = false | SYNC_STATUS;
@@ -257,7 +247,6 @@ export namespace OPENRPC {
     page_number: number;
     is_last_page: boolean;
   };
-  export type Nonce = FELT;
   export type Trace = TRACE_ROOT;
   export type Traces = Array<{
     transaction_hash: FELT;
@@ -265,7 +254,7 @@ export namespace OPENRPC {
   }>;
   export type TransactionHash = TXN_HASH;
   export type BlockHash = BLOCK_HASH;
-  export type EventFilter = EVENT_FILTER;
+  export type EventFilter = EVENT_FILTER & RESULT_PAGE_REQUEST;
   export type InvokedTransaction = { transaction_hash: TXN_HASH };
   export type DeclaredTransaction = { transaction_hash: TXN_HASH; class_hash: FELT };
   export type DeployedTransaction = { transaction_hash: TXN_HASH; contract_address: FELT };
@@ -349,29 +338,35 @@ export namespace OPENRPC {
         | Errors.INVALID_BLOCK_ID;
     };
     starknet_blockNumber: {
+      params: {};
       result: BLOCK_NUMBER;
       errors: Errors.NO_BLOCKS;
     };
     starknet_blockHashAndNumber: {
+      params: {};
       result: BLOCK_HASH & BLOCK_NUMBER;
       errors: Errors.NO_BLOCKS;
     };
     starknet_chainId: {
+      params: {};
       result: CHAIN_ID;
     };
     starknet_pendingTransactions: {
+      params: {};
       result: PendingTransactions;
     };
     starknet_syncing: {
+      params: {};
       result: SyncingStatus;
     };
     starknet_getEvents: {
       params: { filter: EVENT_FILTER & RESULT_PAGE_REQUEST };
-      result: { events: EMITTED_EVENT; page_number: number; is_last_page: boolean };
+      result: Events;
       errors: Errors.PAGE_SIZE_TOO_BIG;
     };
+    // FROM RPC 0.2.0 Pathfinder exception
     starknet_getNonce: {
-      params: { contract_address: ADDRESS };
+      params: { contract_address: ADDRESS; block_id: BLOCK_ID };
       result: FELT;
       errors: Errors.CONTRACT_NOT_FOUND;
     };
@@ -397,7 +392,7 @@ export namespace OPENRPC {
     starknet_addDeployTransaction: {
       params: {
         contract_address_salt: FELT;
-        constructor_calldata: FELT;
+        constructor_calldata: Array<FELT>;
         contract_definition: CONTRACT_CLASS;
       };
       result: DeployedTransaction;

package/src/types/api/rpc.ts

@@ -11,9 +11,11 @@ export namespace RPC {
     };
   };
 
-  export type ChainId = OPENRPC.ChainId;
+  export type ChainId = OPENRPC.CHAIN_ID;
+  export type CallResponse = OPENRPC.CallResponse;
   export type ContractAddress = ADDRESS;
   export type Felt = FELT;
+  export type Nonce = OPENRPC.Nonce;
   export type ContractClass = OPENRPC.ContractClass;
   export type StateUpdate = OPENRPC.StateUpdate;
   export type Transaction = OPENRPC.Transaction;
@@ -40,131 +42,5 @@ export namespace RPC {
   export type DeclaredTransaction = OPENRPC.DeclaredTransaction;
   export type DeployedTransaction = OPENRPC.DeployedTransaction;
 
-  export type Methods = {
-    starknet_pendingTransactions: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: PendingTransactions;
-    };
-    starknet_blockHashAndNumber: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: BlockHashAndNumber;
-    };
-    starknet_getClassHashAt: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: Felt;
-    };
-    starknet_getStateUpdate: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: OPENRPC.StateUpdate;
-    };
-    starknet_getClass: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: OPENRPC.ContractClass;
-    };
-    starknet_getBlockWithTxHashes: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: GetBlockWithTxHashesResponse;
-    };
-    starknet_getBlockWithTxs: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: GetBlockWithTxs;
-    };
-    starknet_getNonce: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: OPENRPC.Nonce;
-    };
-    starknet_getStorageAt: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: GetStorageAtResponse;
-    };
-    starknet_getTransactionByHash: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: GetTransactionByHashResponse;
-    };
-    starknet_getTransactionByBlockIdAndIndex: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: GetTransactionByBlockIdAndIndex;
-    };
-    starknet_getTransactionReceipt: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: TransactionReceipt;
-    };
-    starknet_getBlockTransactionCount: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: GetTransactionCountResponse;
-    };
-    starknet_call: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: string[];
-    };
-    starknet_estimateFee: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: OPENRPC.EstimatedFee;
-    };
-    starknet_blockNumber: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: GetBlockNumberResponse;
-    };
-    starknet_chainId: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: OPENRPC.ChainId;
-    };
-    starknet_syncing: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: GetSyncingStatsResponse;
-    };
-    starknet_getEvents: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: GetEventsResponse;
-    };
-    starknet_addInvokeTransaction: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: OPENRPC.InvokedTransaction;
-    };
-    starknet_addDeployTransaction: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: OPENRPC.DeployedTransaction;
-    };
-    starknet_addDeclareTransaction: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: OPENRPC.DeclaredTransaction;
-    };
-    starknet_getClassAt: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: any;
-    };
-    starknet_traceTransaction: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: any;
-    };
-    starknet_traceBlockTransactions: {
-      QUERY: never;
-      REQUEST: any[];
-      RESPONSE: any;
-    };
-  };
+  export type Methods = OPENRPC.Methods;
 }

package/src/types/api/sequencer.ts

@@ -27,15 +27,17 @@ export type GetContractAddressesResponse = {
   GpsStatementVerifier: string;
 };
 
-export type InvokeFunctionTrace = {
+export type FunctionInvocation = {
   caller_address: string;
   contract_address: string;
-  code_address: string;
-  selector: string;
   calldata: RawCalldata;
+  call_type?: string;
+  class_hash?: string;
+  selector?: string;
+  entry_point_type?: EntryPointType;
   result: Array<any>;
   execution_resources: ExecutionResources;
-  internal_call: Array<InvokeFunctionTrace>;
+  internal_calls: Array<FunctionInvocation>;
   events: Array<any>;
   messages: Array<any>;
 };
@@ -54,18 +56,9 @@ export type ExecutionResources = {
 };
 
 export type GetTransactionTraceResponse = {
-  function_invocation: {
-    caller_address: string;
-    contract_address: string;
-    code_address: string;
-    selector: string;
-    calldata: RawArgs;
-    result: Array<any>;
-    execution_resources: ExecutionResources;
-    internal_call: Array<any>;
-    events: Array<any>;
-    messages: Array<any>;
-  };
+  validate_invocation?: FunctionInvocation;
+  function_invocation?: FunctionInvocation;
+  fee_transfer_invocation?: FunctionInvocation;
   signature: Signature;
 };
 
@@ -73,6 +66,13 @@ export type RawArgs = {
   [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
 };
 
+export type CallL1Handler = {
+  from_address: string;
+  to_address: string;
+  entry_point_selector: string;
+  payload: Array<string>;
+};
+
 export namespace Sequencer {
   export type DeclareTransaction = {
     type: 'DECLARE';
@@ -95,9 +95,8 @@ export namespace Sequencer {
     contract_address: string;
     signature?: Signature;
     entry_point_type?: EntryPointType;
-    entry_point_selector: string;
     calldata?: RawCalldata;
-    nonce?: BigNumberish;
+    nonce: BigNumberish;
     max_fee?: BigNumberish;
     version?: BigNumberish;
   };
@@ -118,6 +117,7 @@ export namespace Sequencer {
 
   export interface InvokeFunctionTransactionResponse extends InvokeFunctionTransaction {
     transaction_hash: string;
+    entry_point_selector: string;
   }
 
   export type TransactionResponse =
@@ -197,17 +197,23 @@ export namespace Sequencer {
     status: Status;
     gas_price: string;
     sequencer_address: string;
+    starknet_version: string;
   };
 
   export type CallContractTransaction = Omit<
     InvokeFunctionTransaction,
     'type' | 'entry_point_type' | 'nonce'
-  >;
+  > & { entry_point_selector: string };
 
   export type CallContractResponse = {
     result: string[];
   };
 
+  export type EstimateFeeTransaction = Omit<
+    InvokeFunctionTransaction,
+    'max_fee' | 'entry_point_type'
+  >;
+
   // Support 0.9.1 changes in a backward-compatible way
   export type EstimateFeeResponse =
     | {
@@ -259,6 +265,14 @@ export namespace Sequencer {
       REQUEST: never;
       RESPONSE: TransactionReceiptResponse;
     };
+    get_nonce: {
+      QUERY: {
+        contractAddress: string;
+        blockIdentifier: BlockIdentifier;
+      };
+      REQUEST: never;
+      RESPONSE: BigNumberish;
+    };
     get_storage_at: {
       QUERY: {
         contractAddress: string;
@@ -294,7 +308,7 @@ export namespace Sequencer {
       QUERY: {
         blockIdentifier: BlockIdentifier;
       };
-      REQUEST: CallContractTransaction;
+      REQUEST: EstimateFeeTransaction;
       RESPONSE: EstimateFeeResponse;
     };
     get_class_by_hash: {
@@ -327,5 +341,10 @@ export namespace Sequencer {
       REQUEST: never;
       RESPONSE: any;
     };
+    estimate_message_fee: {
+      QUERY: any;
+      REQUEST: any;
+      RESPONSE: EstimateFeeResponse;
+    };
   };
 }

package/src/types/lib.ts

@@ -9,7 +9,7 @@ export type RawCalldata = BigNumberish[];
 export type DeployContractPayload = {
   contract: CompiledContract | string;
   constructorCalldata?: RawCalldata;
-  addressSalt?: BigNumberish;
+  addressSalt?: string;
 };
 
 export type DeclareContractPayload = {
@@ -17,14 +17,14 @@ export type DeclareContractPayload = {
   version?: BigNumberish;
 };
 
-export type Invocation = {
+export type CallDetails = {
   contractAddress: string;
-  entrypoint: string;
   calldata?: RawCalldata;
-  signature?: Signature;
 };
 
-export type Call = Omit<Invocation, 'signature'>;
+export type Invocation = CallDetails & { signature?: Signature };
+
+export type Call = CallDetails & { entrypoint: string };
 
 export type InvocationsDetails = {
   nonce?: BigNumberish;
@@ -32,6 +32,8 @@ export type InvocationsDetails = {
   version?: BigNumberish;
 };
 
+export type InvocationsDetailsWithNonce = InvocationsDetails & { nonce: BigNumberish };
+
 export type Status =
   | 'NOT_RECEIVED'
   | 'RECEIVED'

package/src/types/provider.ts

@@ -4,7 +4,8 @@
  */
 import BN from 'bn.js';
 
-import { Abi, CompressedProgram, EntryPointsByType, RawCalldata, Signature, Status } from './lib';
+import { RPC } from './api/rpc';
+import { Abi, CompressedProgram, RawCalldata, Signature, Status } from './lib';
 
 export interface GetBlockResponse {
   timestamp: number;
@@ -14,6 +15,10 @@ export interface GetBlockResponse {
   parent_hash: string;
   status: Status;
   transactions: Array<string>;
+  gas_price?: string;
+  sequencer_address?: string;
+  starknet_version?: string;
+  transaction_receipts?: any;
 }
 
 export interface GetCodeResponse {
@@ -44,7 +49,7 @@ export interface ContractEntryPoint {
 
 export interface ContractClass {
   program: CompressedProgram;
-  entry_points_by_type: EntryPointsByType;
+  entry_points_by_type: RPC.ContractClass['entry_points_by_type'];
   abi?: Abi;
 }
 

package/src/utils/hash.ts

@@ -15,9 +15,17 @@ import {
 import { RawCalldata } from '../types/lib';
 import { ec } from './ellipticCurve';
 import { addHexPrefix, buf2hex, removeHexPrefix, utf8ToArray } from './encode';
-import { BigNumberish, toBN, toFelt, toHex } from './number';
-
-export const transactionVersion = 0;
+import {
+  BigNumberish,
+  isHex,
+  isStringWholeNumber,
+  toBN,
+  toFelt,
+  toHex,
+  toHexString,
+} from './number';
+
+export const transactionVersion = 1;
 export const feeTransactionVersion = toBN(2).pow(toBN(128)).add(toBN(transactionVersion));
 
 export function keccakBn(value: BigNumberish): string {
@@ -53,6 +61,21 @@ export function getSelectorFromName(funcName: string) {
   return toHex(starknetKeccak(funcName));
 }
 
+/**
+ * Function to get hex selector from function name, decimal string or hex string
+ * @param value hex string | decimal string | string
+ * @returns Hex selector
+ */
+export function getSelector(value: string) {
+  if (isHex(value)) {
+    return value;
+  }
+  if (isStringWholeNumber(value)) {
+    return toHexString(value);
+  }
+  return getSelectorFromName(value);
+}
+
 const constantPoints = CONSTANT_POINTS.map((coords: string[]) =>
   ec.curve.point(coords[0], coords[1])
 );
@@ -124,22 +147,23 @@ export function calculateDeployTransactionHash(
   );
 }
 
-export function calculcateTransactionHash(
+export function calculateTransactionHash(
   contractAddress: BigNumberish,
   version: BigNumberish,
-  entryPointSelector: BigNumberish,
   calldata: BigNumberish[],
   maxFee: BigNumberish,
-  chainId: StarknetChainId
+  chainId: StarknetChainId,
+  nonce: BigNumberish
 ): string {
   return calculateTransactionHashCommon(
     TransactionHashPrefix.INVOKE,
     version,
     contractAddress,
-    entryPointSelector,
+    0,
     calldata,
     maxFee,
-    chainId
+    chainId,
+    [nonce]
   );
 }
 

package/src/utils/merkle.ts

@@ -1,4 +1,5 @@
 import { pedersen } from './hash';
+import { toBN } from './number';
 
 export class MerkleTree {
   public leaves: string[];
@@ -31,7 +32,7 @@ export class MerkleTree {
   }
 
   static hash(a: string, b: string) {
-    const [aSorted, bSorted] = [a, b].sort();
+    const [aSorted, bSorted] = [toBN(a), toBN(b)].sort((x: any, y: any) => (x.gte(y) ? 1 : -1));
     return pedersen([aSorted, bSorted]);
   }
 

package/src/utils/number.ts

@@ -61,3 +61,30 @@ export function bigNumberishArrayToDecimalStringArray(rawCalldata: BigNumberish[
 export function bigNumberishArrayToHexadecimalStringArray(rawCalldata: BigNumberish[]): string[] {
   return rawCalldata.map((x) => toHex(toBN(x)));
 }
+
+export const isStringWholeNumber = (value: string) => /^\d+$/.test(value);
+export const toHexString = (value: string) => toHex(toBN(value));
+
+export function getDecimalString(value: string) {
+  if (isHex(value)) {
+    return hexToDecimalString(value);
+  }
+  if (isStringWholeNumber(value)) {
+    return value;
+  }
+  throw new Error(`${value} need to be hex-string or whole-number-string`);
+}
+
+export function getHexString(value: string) {
+  if (isHex(value)) {
+    return value;
+  }
+  if (isStringWholeNumber(value)) {
+    return toHexString(value);
+  }
+  throw new Error(`${value} need to be hex-string or whole-number-string`);
+}
+
+export function getHexStringArray(value: Array<string>) {
+  return value.map((el) => getHexString(el));
+}

package/src/utils/responseParser/rpc.ts

@@ -4,13 +4,10 @@
  */
 import {
   CallContractResponse,
-  DeclareContractResponse,
-  DeployContractResponse,
   EstimateFeeResponse,
   GetBlockResponse,
   GetTransactionReceiptResponse,
   GetTransactionResponse,
-  InvokeFunctionResponse,
 } from '../../types';
 import { RPC } from '../../types/api';
 import { toBN } from '../number';
@@ -28,7 +25,13 @@ type TransactionReceipt = RPC.TransactionReceipt & {
   [key: string]: any;
 };
 
-export class RPCResponseParser extends ResponseParser {
+export class RPCResponseParser
+  implements
+    Omit<
+      ResponseParser,
+      'parseDeclareContractResponse' | 'parseDeployContractResponse' | 'parseInvokeFunctionResponse'
+    >
+{
   public parseGetBlockResponse(res: RpcGetBlockResponse): GetBlockResponse {
     return {
       timestamp: res.timestamp,
@@ -45,7 +48,6 @@ export class RPCResponseParser extends ResponseParser {
     return {
       calldata: res.calldata || [],
       contract_address: res.contract_address,
-      entry_point_selector: res.entry_point_selector,
       max_fee: res.max_fee,
       nonce: res.nonce,
       signature: res.signature || [],
@@ -81,24 +83,4 @@ export class RPCResponseParser extends ResponseParser {
       result: res,
     };
   }
-
-  public parseInvokeFunctionResponse(res: RPC.InvokedTransaction): InvokeFunctionResponse {
-    return {
-      transaction_hash: res.transaction_hash,
-    };
-  }
-
-  public parseDeployContractResponse(res: RPC.DeployedTransaction): DeployContractResponse {
-    return {
-      transaction_hash: res.transaction_hash,
-      contract_address: res.contract_address,
-    };
-  }
-
-  public parseDeclareContractResponse(res: RPC.DeclaredTransaction): DeclareContractResponse {
-    return {
-      transaction_hash: res.transaction_hash,
-      class_hash: res.class_hash,
-    };
-  }
 }