starknet 4.7.0 → 4.9.0

package/src/types/api/sequencer.ts

@@ -5,13 +5,13 @@ import { BigNumberish } from '../../utils/number';
 import {
   Abi,
   BlockNumber,
+  ContractClass,
   EntryPointType,
   RawCalldata,
   Signature,
   Status,
   TransactionStatus,
 } from '../lib';
-import { ContractClass } from '../provider';
 
 export type GetTransactionStatusResponse = {
   tx_status: Status;
@@ -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,13 +66,22 @@ 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';
+    sender_address: string;
     contract_class: ContractClass;
+    signature?: Signature;
     nonce: BigNumberish;
-    sender_address: BigNumberish;
-    signature: Signature;
+    max_fee?: BigNumberish;
+    version?: BigNumberish;
   };
 
   export type DeployTransaction = {
@@ -90,6 +92,17 @@ export namespace Sequencer {
     nonce?: BigNumberish;
   };
 
+  export type DeployAccountTransaction = {
+    type: 'DEPLOY_ACCOUNT';
+    class_hash: string;
+    contract_address_salt: BigNumberish;
+    constructor_calldata: string[];
+    signature?: Signature;
+    max_fee?: BigNumberish;
+    version?: BigNumberish;
+    nonce?: BigNumberish;
+  };
+
   export type InvokeFunctionTransaction = {
     type: 'INVOKE_FUNCTION';
     contract_address: string;
@@ -101,7 +114,11 @@ export namespace Sequencer {
     version?: BigNumberish;
   };
 
-  export type Transaction = DeclareTransaction | DeployTransaction | InvokeFunctionTransaction;
+  export type Transaction =
+    | DeclareTransaction
+    | DeployTransaction
+    | InvokeFunctionTransaction
+    | DeployAccountTransaction;
 
   export type AddTransactionResponse = {
     transaction_hash: string;
@@ -197,6 +214,7 @@ export namespace Sequencer {
     status: Status;
     gas_price: string;
     sequencer_address: string;
+    starknet_version: string;
   };
 
   export type CallContractTransaction = Omit<
@@ -208,10 +226,16 @@ export namespace Sequencer {
     result: string[];
   };
 
-  export type EstimateFeeTransaction = Omit<
-    InvokeFunctionTransaction,
-    'max_fee' | 'entry_point_type'
-  >;
+  export type InvokeEstimateFee = Omit<InvokeFunctionTransaction, 'max_fee' | 'entry_point_type'>;
+  export type DeclareEstimateFee = Omit<DeclareTransaction, 'max_fee'>;
+  export type DeployAccountEstimateFee = Omit<DeployAccountTransaction, 'max_fee'>;
+  export type DeployEstimateFee = DeployTransaction;
+
+  export type EstimateFeeRequest =
+    | InvokeEstimateFee
+    | DeclareEstimateFee
+    | DeployEstimateFee
+    | DeployAccountEstimateFee;
 
   // Support 0.9.1 changes in a backward-compatible way
   export type EstimateFeeResponse =
@@ -307,7 +331,7 @@ export namespace Sequencer {
       QUERY: {
         blockIdentifier: BlockIdentifier;
       };
-      REQUEST: EstimateFeeTransaction;
+      REQUEST: EstimateFeeRequest;
       RESPONSE: EstimateFeeResponse;
     };
     get_class_by_hash: {
@@ -340,5 +364,10 @@ export namespace Sequencer {
       REQUEST: never;
       RESPONSE: any;
     };
+    estimate_message_fee: {
+      QUERY: any;
+      REQUEST: any;
+      RESPONSE: EstimateFeeResponse;
+    };
   };
 }

package/src/types/lib.ts

@@ -1,10 +1,18 @@
 import type { ec as EC } from 'elliptic';
 
 import type { BigNumberish } from '../utils/number';
+import { RPC } from './api/rpc';
 
 export type KeyPair = EC.KeyPair;
 export type Signature = string[];
 export type RawCalldata = BigNumberish[];
+export type AllowArray<T> = T | T[];
+
+export interface ContractClass {
+  program: CompressedProgram;
+  entry_points_by_type: RPC.ContractClass['entry_points_by_type'];
+  abi?: Abi;
+}
 
 export type DeployContractPayload = {
   contract: CompiledContract | string;
@@ -12,9 +20,29 @@ export type DeployContractPayload = {
   addressSalt?: string;
 };
 
+export type DeployAccountContractPayload = {
+  classHash: BigNumberish;
+  constructorCalldata?: RawCalldata;
+  addressSalt?: BigNumberish;
+  contractAddress?: string;
+};
+
+export type DeployAccountContractTransaction = Omit<
+  DeployAccountContractPayload,
+  'contractAddress'
+> & {
+  signature?: Signature;
+};
+
 export type DeclareContractPayload = {
   contract: CompiledContract | string;
-  version?: BigNumberish;
+  classHash: BigNumberish; // Once the classHash is included in CompiledContract, this can be removed
+};
+
+export type DeclareContractTransaction = {
+  contractDefinition: ContractClass;
+  senderAddress: string;
+  signature?: Signature;
 };
 
 export type CallDetails = {
@@ -42,7 +70,7 @@ export type Status =
   | 'ACCEPTED_ON_L1'
   | 'REJECTED';
 export type TransactionStatus = 'TRANSACTION_RECEIVED';
-export type Type = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION';
+export type TransactionType = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION' | 'DEPLOY_ACCOUNT';
 export type EntryPointType = 'EXTERNAL';
 export type CompressedProgram = string;
 

package/src/types/provider.ts

@@ -4,8 +4,15 @@
  */
 import BN from 'bn.js';
 
-import { RPC } from './api/rpc';
-import { Abi, CompressedProgram, RawCalldata, Signature, Status } from './lib';
+import {
+  AllowArray,
+  Call,
+  DeclareContractPayload,
+  DeployAccountContractPayload,
+  RawCalldata,
+  Signature,
+  Status,
+} from './lib';
 
 export interface GetBlockResponse {
   timestamp: number;
@@ -15,6 +22,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 {
@@ -43,12 +54,6 @@ export interface ContractEntryPoint {
   selector: string;
 }
 
-export interface ContractClass {
-  program: CompressedProgram;
-  entry_points_by_type: RPC.ContractClass['entry_points_by_type'];
-  abi?: Abi;
-}
-
 export interface DeclareTransactionResponse extends CommonTransactionResponse {
   contract_class?: any;
   sender_address?: string;
@@ -60,7 +65,7 @@ export type GetTransactionReceiptResponse =
 
 export interface CommonTransactionReceiptResponse {
   transaction_hash: string;
-  status: Status;
+  status?: Status;
   actual_fee?: string;
   status_data?: string;
 }
@@ -82,8 +87,9 @@ export interface MessageToL2 {
 }
 
 export interface InvokeTransactionReceiptResponse extends CommonTransactionReceiptResponse {
-  messages_sent: Array<MessageToL1>;
-  events: Array<Event>;
+  /** @deprecated Use l2_to_l1_messages */
+  messages_sent?: Array<MessageToL1>;
+  events?: Array<Event>;
   l1_origin_message?: MessageToL2;
 }
 
@@ -112,3 +118,17 @@ export interface DeclareContractResponse {
 export type CallContractResponse = {
   result: Array<string>;
 };
+
+export type EstimateFeeAction =
+  | {
+      type: 'INVOKE';
+      payload: AllowArray<Call>;
+    }
+  | {
+      type: 'DECLARE';
+      payload: DeclareContractPayload;
+    }
+  | {
+      type: 'DEPLOY_ACCOUNT';
+      payload: DeployAccountContractPayload;
+    };

package/src/types/signer.ts

@@ -1,7 +1,24 @@
 import { StarknetChainId } from '../constants';
-import { InvocationsDetails } from './lib';
+import { BigNumberish } from '../utils/number';
+import { DeployAccountContractPayload, InvocationsDetails } from './lib';
 
 export interface InvocationsSignerDetails extends Required<InvocationsDetails> {
   walletAddress: string;
   chainId: StarknetChainId;
 }
+
+export interface DeclareSignerDetails {
+  // contractClass: ContractClass,  // Should be used once class hash is present in ContractClass
+  classHash: BigNumberish;
+  senderAddress: BigNumberish;
+  chainId: StarknetChainId;
+  maxFee: BigNumberish;
+  version: BigNumberish;
+  nonce: BigNumberish;
+}
+
+export type DeployAccountSignerDetails = Required<DeployAccountContractPayload> &
+  Required<InvocationsDetails> & {
+    contractAddress: BigNumberish;
+    chainId: StarknetChainId;
+  };

package/src/utils/hash.ts

@@ -15,7 +15,15 @@ import {
 import { RawCalldata } from '../types/lib';
 import { ec } from './ellipticCurve';
 import { addHexPrefix, buf2hex, removeHexPrefix, utf8ToArray } from './encode';
-import { BigNumberish, toBN, toFelt, toHex } from './number';
+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));
@@ -49,10 +57,25 @@ export function starknetKeccak(value: string): BN {
  * @returns hex selector of given abi function name
  */
 export function getSelectorFromName(funcName: string) {
-  // sometimes BigInteger pads the hex string with zeros, which isnt allowed in the starknet api
+  // sometimes BigInteger pads the hex string with zeros, which is not allowed in the starknet api
   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,6 +147,51 @@ export function calculateDeployTransactionHash(
   );
 }
 
+export function calculateDeclareTransactionHash(
+  // contractClass: ContractClass, // Should be used once class hash is present in ContractClass
+  classHash: BigNumberish,
+  senderAddress: BigNumberish,
+  version: BigNumberish,
+  maxFee: BigNumberish,
+  chainId: StarknetChainId,
+  nonce: BigNumberish
+): string {
+  return calculateTransactionHashCommon(
+    TransactionHashPrefix.DECLARE,
+    version,
+    senderAddress,
+    0,
+    [classHash],
+    maxFee,
+    chainId,
+    [nonce]
+  );
+}
+
+export function calculateDeployAccountTransactionHash(
+  contractAddress: BigNumberish,
+  classHash: BigNumberish,
+  constructorCalldata: BigNumberish[],
+  salt: BigNumberish,
+  version: BigNumberish,
+  maxFee: BigNumberish,
+  chainId: StarknetChainId,
+  nonce: BigNumberish
+) {
+  const calldata = [classHash, salt, ...constructorCalldata];
+
+  return calculateTransactionHashCommon(
+    TransactionHashPrefix.DEPLOY_ACCOUNT,
+    version,
+    contractAddress,
+    0,
+    calldata,
+    maxFee,
+    chainId,
+    [nonce]
+  );
+}
+
 export function calculateTransactionHash(
   contractAddress: BigNumberish,
   version: BigNumberish,

package/src/utils/merkle.ts

@@ -1,4 +1,5 @@
 import { pedersen } from './hash';
+import { toBN } from './number';
 
 export class MerkleTree {
   public leaves: string[];
@@ -22,7 +23,7 @@ export class MerkleTree {
     const newLeaves = [];
     for (let i = 0; i < leaves.length; i += 2) {
       if (i + 1 === leaves.length) {
-        newLeaves.push(leaves[i]);
+        newLeaves.push(MerkleTree.hash(leaves[i], '0x0'));
       } else {
         newLeaves.push(MerkleTree.hash(leaves[i], leaves[i + 1]));
       }
@@ -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]);
   }
 
@@ -52,9 +53,7 @@ export class MerkleTree {
         : this.branches.findIndex((b) => b.length === branch.length);
     const nextBranch = this.branches[currentBranchLevelIndex + 1] ?? [this.root];
     return this.getProof(
-      neededBranch === '0x0'
-        ? leaf
-        : MerkleTree.hash(isLeft ? leaf : neededBranch, isLeft ? neededBranch : leaf),
+      MerkleTree.hash(isLeft ? leaf : neededBranch, isLeft ? neededBranch : leaf),
       nextBranch,
       newHashPath
     );

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

@@ -6,7 +6,6 @@ import {
   CallContractResponse,
   EstimateFeeResponse,
   GetBlockResponse,
-  GetTransactionReceiptResponse,
   GetTransactionResponse,
 } from '../../types';
 import { RPC } from '../../types/api';
@@ -21,15 +20,14 @@ type GetTransactionByHashResponse = RPC.GetTransactionByHashResponse & {
   [key: string]: any;
 };
 
-type TransactionReceipt = RPC.TransactionReceipt & {
-  [key: string]: any;
-};
-
 export class RPCResponseParser
   implements
     Omit<
       ResponseParser,
-      'parseDeclareContractResponse' | 'parseDeployContractResponse' | 'parseInvokeFunctionResponse'
+      | 'parseDeclareContractResponse'
+      | 'parseDeployContractResponse'
+      | 'parseInvokeFunctionResponse'
+      | 'parseGetTransactionReceiptResponse'
     >
 {
   public parseGetBlockResponse(res: RpcGetBlockResponse): GetBlockResponse {
@@ -56,20 +54,6 @@ export class RPCResponseParser
     };
   }
 
-  public parseGetTransactionReceiptResponse(
-    res: TransactionReceipt
-  ): GetTransactionReceiptResponse {
-    return {
-      transaction_hash: res.transaction_hash,
-      actual_fee: res.actual_fee,
-      status: res.status,
-      status_data: res.status_data,
-      messages_sent: res.messages_sent,
-      l1_origin_message: res.l1_origin_message,
-      events: res.events,
-    };
-  }
-
   public parseFeeEstimateResponse(res: RPC.EstimateFeeResponse): EstimateFeeResponse {
     return {
       overall_fee: toBN(res.overall_fee),

package/src/utils/responseParser/sequencer.ts

@@ -19,12 +19,9 @@ import { ResponseParser } from '.';
 export class SequencerAPIResponseParser extends ResponseParser {
   public parseGetBlockResponse(res: Sequencer.GetBlockResponse): GetBlockResponse {
     return {
-      timestamp: res.timestamp,
-      block_hash: res.block_hash,
-      block_number: res.block_number,
+      ...res,
       new_root: res.state_root,
       parent_hash: res.parent_block_hash,
-      status: res.status,
       transactions: Object.values(res.transactions)
         .map((value) => 'transaction_hash' in value && value.transaction_hash)
         .filter(Boolean) as Array<string>,
@@ -35,6 +32,7 @@ export class SequencerAPIResponseParser extends ResponseParser {
     res: Sequencer.GetTransactionResponse
   ): GetTransactionResponse {
     return {
+      ...res,
       calldata: 'calldata' in res.transaction ? (res.transaction.calldata as Array<string>) : [],
       contract_address:
         'contract_address' in res.transaction ? res.transaction.contract_address : undefined,
@@ -62,12 +60,21 @@ export class SequencerAPIResponseParser extends ResponseParser {
   ): GetTransactionReceiptResponse {
     return {
       transaction_hash: res.transaction_hash,
-      actual_fee: 'actual_fee' in res ? res.actual_fee : undefined,
       status: res.status,
-      status_data: undefined,
       messages_sent: res.l2_to_l1_messages as any, // TODO: parse
       events: res.events as any,
-      l1_origin_message: undefined,
+      ...('block_hash' in res && { block_hash: res.block_hash }),
+      ...('block_number' in res && { block_number: res.block_number }),
+      ...('actual_fee' in res && { actual_fee: res.actual_fee }),
+      ...('transaction_index' in res && { transaction_index: res.transaction_index }),
+      ...('execution_resources' in res && { execution_resources: res.execution_resources }),
+      ...('l1_to_l2_consumed_message' in res && {
+        // eslint-disable-next-line @typescript-eslint/dot-notation
+        l1_to_l2_consumed_message: res['l1_to_l2_consumed_message'],
+      }),
+      ...('transaction_failure_reason' in res && {
+        transaction_failure_reason: res.transaction_failure_reason,
+      }),
     };
   }
 

package/types/api/openrpc.d.ts

@@ -17,7 +17,7 @@ declare type BLOCK_HASH = FELT;
 declare type TXN_HASH = FELT;
 declare type PROTOCOL_VERSION = string;
 declare type TXN_STATUS = 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
-declare type TXN_TYPE = 'DECLARE' | 'DEPLOY' | 'INVOKE' | 'L1_HANDLER';
+declare type TXN_TYPE = 'DECLARE' | 'DEPLOY' | 'DEPLOY_ACCOUNT' | 'INVOKE' | 'L1_HANDLER';
 declare type BLOCK_STATUS = 'PENDING' | 'ACCEPTED_ON_L2' | 'ACCEPTED_ON_L1' | 'REJECTED';
 declare enum BLOCK_TAG {
     'latest' = 0,
@@ -101,6 +101,15 @@ declare type DECLARE_TXN = COMMON_TXN_PROPERTIES & {
     class_hash: FELT;
     sender_address: ADDRESS;
 };
+declare type DEPLOY_ACCOUNT_TXN_REQUEST = COMMON_TXN_PROPERTIES & {
+    class_hash: FELT;
+    contract_address_salt: FELT;
+    constructor_calldata: Array<FELT>;
+};
+declare type DECLARE_TXN_REQUEST = COMMON_TXN_PROPERTIES & {
+    contract_class: CONTRACT_CLASS;
+    sender_address: ADDRESS;
+};
 declare type DEPLOY_TXN = {
     transaction_hash: TXN_HASH;
     class_hash: FELT;
@@ -352,7 +361,7 @@ export declare namespace OPENRPC {
         };
         starknet_estimateFee: {
             params: {
-                request: INVOKE_TXN;
+                request: INVOKE_TXN | DECLARE_TXN_REQUEST | DEPLOY_ACCOUNT_TXN_REQUEST;
                 block_id: BLOCK_ID;
             };
             result: FEE_ESTIMATE;
@@ -407,7 +416,11 @@ export declare namespace OPENRPC {
         starknet_addDeclareTransaction: {
             params: {
                 contract_class: CONTRACT_CLASS;
+                sender_address: ADDRESS;
+                signature: SIGNATURE;
+                max_fee: NUM_AS_HEX;
                 version: NUM_AS_HEX;
+                nonce: FELT;
             };
             result: DeclaredTransaction;
             errors: Errors.INVALID_CONTRACT_CLASS;
@@ -421,6 +434,15 @@ export declare namespace OPENRPC {
             result: DeployedTransaction;
             errors: Errors.INVALID_CONTRACT_CLASS;
         };
+        starknet_addDeployAccountTransaction: {
+            params: {
+                contract_address_salt: FELT;
+                constructor_calldata: Array<FELT>;
+                class_hash: FELT;
+            };
+            result: DeployedTransaction;
+            errors: Errors.INVALID_CONTRACT_CLASS;
+        };
         starknet_traceTransaction: {
             params: {
                 transaction_hash: TXN_HASH;