starknet 4.17.0 → 4.18.0

package/src/types/api/sequencer.ts

@@ -1,369 +0,0 @@
-import BN from 'bn.js';
-
-import { BlockIdentifier } from '../../provider/utils';
-import { BigNumberish } from '../../utils/number';
-import {
-  Abi,
-  BlockNumber,
-  ContractClass,
-  EntryPointType,
-  RawCalldata,
-  Signature,
-  Status,
-  TransactionStatus,
-} from '../lib';
-
-export type GetTransactionStatusResponse = {
-  tx_status: Status;
-  block_hash?: string;
-  tx_failure_reason?: {
-    code: string;
-    error_message: string;
-  };
-};
-
-export type GetContractAddressesResponse = {
-  Starknet: string;
-  GpsStatementVerifier: string;
-};
-
-export type FunctionInvocation = {
-  caller_address: string;
-  contract_address: string;
-  calldata: RawCalldata;
-  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>;
-};
-
-export type ExecutionResources = {
-  n_steps: number;
-  builtin_instance_counter: {
-    pedersen_builtin: number;
-    range_check_builtin: number;
-    bitwise_builtin: number;
-    output_builtin: number;
-    ecdsa_builtin: number;
-    ec_op_builtin?: number;
-  };
-  n_memory_holes: number;
-};
-
-export type GetTransactionTraceResponse = {
-  validate_invocation?: FunctionInvocation;
-  function_invocation?: FunctionInvocation;
-  fee_transfer_invocation?: FunctionInvocation;
-  signature: Signature;
-};
-
-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;
-    max_fee?: BigNumberish;
-    version?: BigNumberish;
-  };
-
-  export type DeployTransaction = {
-    type: 'DEPLOY';
-    contract_definition: ContractClass;
-    contract_address_salt: BigNumberish;
-    constructor_calldata: string[];
-    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;
-    signature?: Signature;
-    entry_point_type?: EntryPointType;
-    calldata?: RawCalldata;
-    nonce: BigNumberish;
-    max_fee?: BigNumberish;
-    version?: BigNumberish;
-  };
-
-  export type Transaction =
-    | DeclareTransaction
-    | DeployTransaction
-    | InvokeFunctionTransaction
-    | DeployAccountTransaction;
-
-  export type AddTransactionResponse = {
-    transaction_hash: string;
-    code?: TransactionStatus;
-    address?: string;
-    class_hash?: string;
-  };
-
-  export type GetCodeResponse = {
-    bytecode: string[];
-    abi: Abi;
-  };
-
-  export interface InvokeFunctionTransactionResponse extends InvokeFunctionTransaction {
-    transaction_hash: string;
-    entry_point_selector: string;
-  }
-
-  export type TransactionResponse =
-    | DeclareTransaction
-    | DeployTransaction
-    | InvokeFunctionTransactionResponse;
-
-  export type SuccessfulTransactionResponse = {
-    status: Status;
-    transaction: TransactionResponse;
-    block_hash: string;
-    block_number: BlockNumber;
-    transaction_index: number;
-  };
-
-  export type FailedTransactionResponse = {
-    status: 'REJECTED';
-    transaction_failure_reason: {
-      code: string;
-      error_message: string;
-    };
-    transaction: TransactionResponse;
-  };
-
-  export type GetTransactionResponse = SuccessfulTransactionResponse | FailedTransactionResponse;
-
-  export type TransactionReceiptResponse =
-    | SuccessfulTransactionReceiptResponse
-    | FailedTransactionReceiptResponse;
-
-  export type SuccessfulTransactionReceiptResponse = {
-    status: Status;
-    transaction_hash: string;
-    transaction_index: number;
-    block_hash: string;
-    block_number: BlockNumber;
-    l2_to_l1_messages: string[];
-    events: string[];
-    actual_fee: string;
-    execution_resources: ExecutionResources;
-  };
-
-  export type FailedTransactionReceiptResponse = {
-    status: 'REJECTED';
-    transaction_failure_reason: {
-      code: string;
-      error_message: string;
-    };
-    transaction_hash: string;
-    l2_to_l1_messages: string[];
-    events: string[];
-  };
-
-  export type GetBlockResponse = {
-    block_number: number;
-    state_root: string;
-    block_hash: string;
-    transactions: {
-      [txHash: string]: TransactionResponse;
-    };
-    timestamp: number;
-    transaction_receipts: {
-      [txHash: string]: {
-        block_hash: string;
-        transaction_hash: string;
-        l2_to_l1_messages: {
-          to_address: string;
-          payload: string[];
-          from_address: string;
-        }[];
-        block_number: BlockNumber;
-        status: Status;
-        transaction_index: number;
-      };
-    };
-    parent_block_hash: string;
-    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 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 =
-    | {
-        overall_fee: number;
-        gas_price: number;
-        gas_usage: number;
-      }
-    | {
-        amount: BN;
-        unit: string;
-      };
-
-  export type Endpoints = {
-    get_contract_addresses: {
-      QUERY: never;
-      REQUEST: never;
-      RESPONSE: GetContractAddressesResponse;
-    };
-    add_transaction: {
-      QUERY: never;
-      REQUEST: Transaction;
-      RESPONSE: AddTransactionResponse;
-    };
-    get_transaction: {
-      QUERY: {
-        transactionHash: string;
-      };
-      REQUEST: never;
-      RESPONSE: GetTransactionResponse;
-    };
-    get_transaction_status: {
-      QUERY: {
-        transactionHash: string;
-      };
-      REQUEST: never;
-      RESPONSE: GetTransactionStatusResponse;
-    };
-    get_transaction_trace: {
-      QUERY: {
-        transactionHash: string;
-      };
-      REQUEST: never;
-      RESPONSE: GetTransactionTraceResponse;
-    };
-    get_transaction_receipt: {
-      QUERY: {
-        transactionHash: string;
-      };
-      REQUEST: never;
-      RESPONSE: TransactionReceiptResponse;
-    };
-    get_nonce: {
-      QUERY: {
-        contractAddress: string;
-        blockIdentifier: BlockIdentifier;
-      };
-      REQUEST: never;
-      RESPONSE: BigNumberish;
-    };
-    get_storage_at: {
-      QUERY: {
-        contractAddress: string;
-        key: BigNumberish;
-        blockIdentifier: BlockIdentifier;
-      };
-      REQUEST: never;
-      RESPONSE: string;
-    };
-    get_code: {
-      QUERY: {
-        contractAddress: string;
-        blockIdentifier: BlockIdentifier;
-      };
-      REQUEST: never;
-      RESPONSE: GetCodeResponse;
-    };
-    get_block: {
-      QUERY: {
-        blockIdentifier: BlockIdentifier;
-      };
-      REQUEST: never;
-      RESPONSE: GetBlockResponse;
-    };
-    call_contract: {
-      QUERY: {
-        blockIdentifier: BlockIdentifier;
-      };
-      REQUEST: CallContractTransaction;
-      RESPONSE: CallContractResponse;
-    };
-    estimate_fee: {
-      QUERY: {
-        blockIdentifier: BlockIdentifier;
-      };
-      REQUEST: EstimateFeeRequest;
-      RESPONSE: EstimateFeeResponse;
-    };
-    get_class_by_hash: {
-      QUERY: {
-        classHash: string;
-      };
-      REQUEST: never;
-      RESPONSE: any;
-    };
-    get_class_hash_at: {
-      QUERY: {
-        contractAddress: string;
-        blockIdentifier?: BlockIdentifier;
-      };
-      REQUEST: never;
-      RESPONSE: string;
-    };
-    get_state_update: {
-      QUERY: {
-        blockHash: string;
-      };
-      REQUEST: never;
-      RESPONSE: any;
-    };
-    get_full_contract: {
-      QUERY: {
-        contractAddress: string;
-        blockIdentifier?: BlockIdentifier;
-      };
-      REQUEST: never;
-      RESPONSE: any;
-    };
-    estimate_message_fee: {
-      QUERY: any;
-      REQUEST: any;
-      RESPONSE: EstimateFeeResponse;
-    };
-  };
-}

package/src/types/contract.ts

@@ -1,5 +0,0 @@
-export type AsyncContractFunction<T = any> = (...args: Array<any>) => Promise<T>;
-export type ContractFunction = (...args: Array<any>) => any;
-export interface Result extends Array<any> {
-  [key: string]: any;
-}

package/src/types/index.ts

@@ -1,8 +0,0 @@
-export * from './lib';
-export { Calldata, Overrides } from './api';
-export * from './signer';
-export * from './contract';
-export * from './account';
-export * from './provider';
-export * from './api/sequencer';
-export * from './api/rpc';

package/src/types/lib.ts

@@ -1,143 +0,0 @@
-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 type RawArgs =
-  | {
-      [inputName: string]: string | string[] | { type: 'struct'; [k: string]: BigNumberish };
-    }
-  | string[];
-
-export interface ContractClass {
-  program: CompressedProgram;
-  entry_points_by_type: RPC.ContractClass['entry_points_by_type'];
-  abi?: Abi;
-}
-
-export type UniversalDeployerContractPayload = {
-  classHash: BigNumberish;
-  salt?: string;
-  unique?: boolean;
-  constructorCalldata?: RawArgs;
-};
-
-export type DeployContractPayload = {
-  contract: CompiledContract | string;
-  constructorCalldata?: RawCalldata;
-  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;
-  classHash: BigNumberish; // Once the classHash is included in CompiledContract, this can be removed
-};
-
-export type DeclareDeployContractPayload = DeclareContractPayload &
-  UniversalDeployerContractPayload;
-
-export type DeclareContractTransaction = {
-  contractDefinition: ContractClass;
-  senderAddress: string;
-  signature?: Signature;
-};
-
-export type CallDetails = {
-  contractAddress: string;
-  calldata?: RawCalldata;
-};
-
-export type Invocation = CallDetails & { signature?: Signature };
-
-export type Call = CallDetails & { entrypoint: string };
-
-export type InvocationsDetails = {
-  nonce?: BigNumberish;
-  maxFee?: BigNumberish;
-  version?: BigNumberish;
-};
-
-export type InvocationsDetailsWithNonce = InvocationsDetails & { nonce: BigNumberish };
-
-export type Status =
-  | 'NOT_RECEIVED'
-  | 'RECEIVED'
-  | 'PENDING'
-  | 'ACCEPTED_ON_L2'
-  | 'ACCEPTED_ON_L1'
-  | 'REJECTED';
-export type TransactionStatus = 'TRANSACTION_RECEIVED';
-export type TransactionType = 'DECLARE' | 'DEPLOY' | 'INVOKE_FUNCTION' | 'DEPLOY_ACCOUNT';
-export type EntryPointType = 'EXTERNAL';
-export type CompressedProgram = string;
-
-export type AbiEntry = { name: string; type: 'felt' | 'felt*' | string };
-
-export type FunctionAbi = {
-  inputs: AbiEntry[];
-  name: string;
-  outputs: AbiEntry[];
-  stateMutability?: 'view';
-  type: FunctionAbiType;
-};
-
-enum FunctionAbiType {
-  'function',
-  'l1_handler',
-  'constructor',
-}
-
-export type StructAbi = {
-  members: (AbiEntry & { offset: number })[];
-  name: string;
-  size: number;
-  type: 'struct';
-};
-
-export type Abi = Array<FunctionAbi | EventAbi | StructAbi>;
-
-type EventAbi = any;
-
-export type EntryPointsByType = object;
-export type Program = Record<any, any>;
-export type BlockTag = 'pending' | 'latest';
-export type BlockNumber = BlockTag | null | number;
-
-export type CompiledContract = {
-  abi: Abi;
-  entry_points_by_type: EntryPointsByType;
-  program: Program;
-};
-
-export type CompressedCompiledContract = Omit<CompiledContract, 'program'> & {
-  program: CompressedProgram;
-};
-
-export type Struct = {
-  type: 'struct';
-  [k: string]: BigNumberish;
-};
-export type Args = {
-  [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[];
-};
-export type ParsedStruct = {
-  [key: string]: BigNumberish | ParsedStruct;
-};

package/src/types/provider.ts

@@ -1,134 +0,0 @@
-/**
- * Common interface response
- * Intersection (sequencer response ∩ (∪ rpc responses))
- */
-import BN from 'bn.js';
-
-import {
-  AllowArray,
-  Call,
-  DeclareContractPayload,
-  DeployAccountContractPayload,
-  RawCalldata,
-  Signature,
-  Status,
-  UniversalDeployerContractPayload,
-} from './lib';
-
-export interface GetBlockResponse {
-  timestamp: number;
-  block_hash: string;
-  block_number: number;
-  new_root: string;
-  parent_hash: string;
-  status: Status;
-  transactions: Array<string>;
-  gas_price?: string;
-  sequencer_address?: string;
-  starknet_version?: string;
-  transaction_receipts?: any;
-}
-
-export interface GetCodeResponse {
-  bytecode: string[];
-  // abi: string; // is not consistent between rpc and sequencer (is it?), therefore not included in the provider interface
-}
-
-export type GetTransactionResponse = InvokeTransactionResponse & DeclareTransactionResponse;
-
-export interface CommonTransactionResponse {
-  transaction_hash?: string;
-  version?: string;
-  signature?: Signature;
-  max_fee?: string;
-  nonce?: string;
-}
-
-export interface InvokeTransactionResponse extends CommonTransactionResponse {
-  contract_address?: string;
-  entry_point_selector?: string;
-  calldata: RawCalldata;
-}
-
-export interface ContractEntryPoint {
-  offset: string;
-  selector: string;
-}
-
-export interface DeclareTransactionResponse extends CommonTransactionResponse {
-  contract_class?: any;
-  sender_address?: string;
-}
-
-export type GetTransactionReceiptResponse =
-  | InvokeTransactionReceiptResponse
-  | DeclareTransactionReceiptResponse;
-
-export interface CommonTransactionReceiptResponse {
-  transaction_hash: string;
-  status?: Status;
-  actual_fee?: string;
-  status_data?: string;
-}
-
-export interface MessageToL1 {
-  to_address: string;
-  payload: Array<string>;
-}
-
-export interface Event {
-  from_address: string;
-  keys: Array<string>;
-  data: Array<string>;
-}
-
-export interface MessageToL2 {
-  from_address: string;
-  payload: Array<string>;
-}
-
-export interface InvokeTransactionReceiptResponse extends CommonTransactionReceiptResponse {
-  /** @deprecated Use l2_to_l1_messages */
-  messages_sent?: Array<MessageToL1>;
-  events?: Array<Event>;
-  l1_origin_message?: MessageToL2;
-}
-
-export type DeclareTransactionReceiptResponse = CommonTransactionReceiptResponse;
-
-export interface EstimateFeeResponse {
-  overall_fee: BN;
-  gas_consumed?: BN;
-  gas_price?: BN;
-}
-
-export interface InvokeFunctionResponse {
-  transaction_hash: string;
-}
-
-export interface DeclareContractResponse {
-  transaction_hash: string;
-  class_hash: string;
-}
-
-export type CallContractResponse = {
-  result: Array<string>;
-};
-
-export type EstimateFeeAction =
-  | {
-      type: 'INVOKE';
-      payload: AllowArray<Call>;
-    }
-  | {
-      type: 'DECLARE';
-      payload: DeclareContractPayload;
-    }
-  | {
-      type: 'DEPLOY_ACCOUNT';
-      payload: DeployAccountContractPayload;
-    }
-  | {
-      type: 'DEPLOY';
-      payload: UniversalDeployerContractPayload;
-    };

package/src/types/signer.ts

@@ -1,24 +0,0 @@
-import { StarknetChainId } from '../constants';
-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;
-  };