Skip to main content
Version: 5.14.1

Namespace: types

Namespaces​

Enumerations​

Interfaces​

Type Aliases​

EstimateFeeBulk​

Ζ¬ EstimateFeeBulk: EstimateFee[]

Defined in​

src/types/account.ts:8


AccountInvocationsFactoryDetails​

Ζ¬ AccountInvocationsFactoryDetails: Object

Type declaration​

NameType
versionsbigint[]
nonce?BigNumberish
blockIdentifier?BlockIdentifier

Defined in​

src/types/account.ts:10


MultiDeployContractResponse​

Ζ¬ MultiDeployContractResponse: Object

Type declaration​

NameType
contract_addressstring[]
transaction_hashstring

Defined in​

src/types/account.ts:27


DeployContractUDCResponse​

Ζ¬ DeployContractUDCResponse: Object

Type declaration​

NameType
contract_addressstring
transaction_hashstring
addressstring
deployerstring
uniquestring
classHashstring
calldata_lenstring
calldatastring[]
saltstring

Defined in​

src/types/account.ts:32


DeclareDeployUDCResponse​

Ζ¬ DeclareDeployUDCResponse: Object

Type declaration​

NameType
declare{ class_hash: BigNumberish } & Partial<DeclareTransactionReceiptResponse>
deployDeployContractUDCResponse

Defined in​

src/types/account.ts:44


SimulateTransactionDetails​

Ζ¬ SimulateTransactionDetails: Object

Type declaration​

NameType
nonce?BigNumberish
blockIdentifier?BlockIdentifier
skipValidate?boolean
skipExecute?boolean

Defined in​

src/types/account.ts:51


AsyncContractFunction​

Ζ¬ AsyncContractFunction<T>: (...args: ArgsOrCalldataWithOptions) => Promise<T>

Type parameters​

NameType
Tany

Type declaration​

β–Έ (...args): Promise<T>

Parameters​
NameType
...argsArgsOrCalldataWithOptions
Returns​

Promise<T>

Defined in​

src/types/contract.ts:3


ContractFunction​

Ζ¬ ContractFunction: (...args: ArgsOrCalldataWithOptions) => any

Type declaration​

β–Έ (...args): any

Parameters​
NameType
...argsArgsOrCalldataWithOptions
Returns​

any

Defined in​

src/types/contract.ts:4


Result​

Ζ¬ Result: { [key: string]: any; } | Result[] | bigint | string | boolean

Defined in​

src/types/contract.ts:5


Calldata​

Ζ¬ Calldata: string[] & { __compiled__?: boolean }

Compiled calldata ready to be sent decimal-string array

Defined in​

src/types/contract.ts:18


ArgsOrCalldata​

Ζ¬ ArgsOrCalldata: RawArgsArray | [Calldata] | Calldata

Defined in​

src/types/contract.ts:20


ArgsOrCalldataWithOptions​

Ζ¬ ArgsOrCalldataWithOptions: ArgsOrCalldata & ContractOptions

Defined in​

src/types/contract.ts:21


ContractOptions​

Ζ¬ ContractOptions: Object

Type declaration​

NameType
blockIdentifier?BlockIdentifier
parseRequest?boolean
parseResponse?boolean
formatResponse?{ [key: string]: any; }
maxFee?BigNumberish
nonce?BigNumberish
signature?Signature
addressSalt?string

Defined in​

src/types/contract.ts:22


CallOptions​

Ζ¬ CallOptions: Pick<ContractOptions, "blockIdentifier" | "parseRequest" | "parseResponse" | "formatResponse">

Defined in​

src/types/contract.ts:33


InvokeOptions​

Ζ¬ InvokeOptions: Pick<ContractOptions, "maxFee" | "nonce" | "signature" | "parseRequest">

Defined in​

src/types/contract.ts:38


WeierstrassSignatureType​

Ζ¬ WeierstrassSignatureType: SignatureType

Defined in​

src/types/lib/index.ts:5


ArraySignatureType​

Ζ¬ ArraySignatureType: string[]

Defined in​

src/types/lib/index.ts:6


Signature​

Ζ¬ Signature: ArraySignatureType | WeierstrassSignatureType

Defined in​

src/types/lib/index.ts:7


BigNumberish​

Ζ¬ BigNumberish: string | number | bigint

Defined in​

src/types/lib/index.ts:9


RawCalldata​

Ζ¬ RawCalldata: BigNumberish[]

BigNumberish array use CallData.compile() to convert to Calldata

Defined in​

src/types/lib/index.ts:25


HexCalldata​

Ζ¬ HexCalldata: string[]

Hexadecimal-string array

Defined in​

src/types/lib/index.ts:30


AllowArray​

Ζ¬ AllowArray<T>: T | T[]

Type parameters​

Name
T

Defined in​

src/types/lib/index.ts:32


OptionalPayload​

Ζ¬ OptionalPayload<T>: { payload: T } | T

Type parameters​

Name
T

Defined in​

src/types/lib/index.ts:34


RawArgs​

Ζ¬ RawArgs: RawArgsObject | RawArgsArray

Defined in​

src/types/lib/index.ts:36


RawArgsObject​

Ζ¬ RawArgsObject: Object

Index signature​

β–ͺ [inputName: string]: MultiType | MultiType[] | RawArgs

Defined in​

src/types/lib/index.ts:38


RawArgsArray​

Ζ¬ RawArgsArray: (MultiType | MultiType[] | RawArgs)[]

Defined in​

src/types/lib/index.ts:42


MultiType​

Ζ¬ MultiType: BigNumberish | Uint256 | object | boolean

Defined in​

src/types/lib/index.ts:44


UniversalDeployerContractPayload​

Ζ¬ UniversalDeployerContractPayload: Object

Type declaration​

NameType
classHashBigNumberish
salt?string
unique?boolean
constructorCalldata?RawArgs

Defined in​

src/types/lib/index.ts:46


DeployContractPayload​

Ζ¬ DeployContractPayload: Object

Deprecated

deprecated due to no direct deploy, unused - can be removed

Type declaration​

NameType
contractCompiledContract | string
constructorCalldata?RawCalldata
addressSalt?string

Defined in​

src/types/lib/index.ts:56


DeployAccountContractPayload​

Ζ¬ DeployAccountContractPayload: Object

Type declaration​

NameType
classHashstring
constructorCalldata?RawArgs
addressSalt?BigNumberish
contractAddress?string

Defined in​

src/types/lib/index.ts:62


DeployAccountContractTransaction​

Ζ¬ DeployAccountContractTransaction: Omit<DeployAccountContractPayload, "contractAddress"> & { signature?: Signature }

Defined in​

src/types/lib/index.ts:69


DeclareContractPayload​

Ζ¬ DeclareContractPayload: Object

Type declaration​

NameType
contractCompiledContract | string
classHash?string
casm?CompiledSierraCasm
compiledClassHash?string

Defined in​

src/types/lib/index.ts:76


CompleteDeclareContractPayload​

Ζ¬ CompleteDeclareContractPayload: Object

Type declaration​

NameType
contractCompiledContract | string
classHashstring
casm?CompiledSierraCasm
compiledClassHash?string

Defined in​

src/types/lib/index.ts:83


DeclareAndDeployContractPayload​

Ζ¬ DeclareAndDeployContractPayload: Omit<UniversalDeployerContractPayload, "classHash"> & DeclareContractPayload

Defined in​

src/types/lib/index.ts:90


DeclareContractTransaction​

Ζ¬ DeclareContractTransaction: Object

Type declaration​

NameType
contractContractClass
senderAddressstring
signature?Signature
compiledClassHash?string

Defined in​

src/types/lib/index.ts:93


CallDetails​

Ζ¬ CallDetails: Object

Type declaration​

NameType
contractAddressstring
calldata?RawArgs
entrypoint?string

Defined in​

src/types/lib/index.ts:100


Invocation​

Ζ¬ Invocation: CallDetails & { signature?: Signature }

Defined in​

src/types/lib/index.ts:106


Call​

Ζ¬ Call: CallDetails & { entrypoint: string }

Defined in​

src/types/lib/index.ts:108


CairoVersion​

Ζ¬ CairoVersion: "0" | "1"

Defined in​

src/types/lib/index.ts:110


InvocationsDetails​

Ζ¬ InvocationsDetails: Object

Type declaration​

NameType
nonce?BigNumberish
maxFee?BigNumberish
version?BigNumberish

Defined in​

src/types/lib/index.ts:112


Details​

Ζ¬ Details: Object

Contain all additional details params

Type declaration​

NameType
nonceBigNumberish
maxFeeBigNumberish
versionBigNumberish
chainIdStarknetChainId

Defined in​

src/types/lib/index.ts:121


InvocationsDetailsWithNonce​

Ζ¬ InvocationsDetailsWithNonce: InvocationsDetails & { nonce: BigNumberish }

Defined in​

src/types/lib/index.ts:128


AccountInvocationItem​

Ζ¬ AccountInvocationItem: { type: "DECLARE" } & DeclareContractTransaction | { type: "DEPLOY_ACCOUNT" } & DeployAccountContractTransaction | { type: "INVOKE_FUNCTION" } & Invocation & InvocationsDetailsWithNonce

items used by AccountInvocations

Defined in​

src/types/lib/index.ts:144


AccountInvocations​

Ζ¬ AccountInvocations: AccountInvocationItem[]

Complete invocations array with account details (internal type from account -> provider)

Defined in​

src/types/lib/index.ts:154


Invocations​

Ζ¬ Invocations: ({ type: "DECLARE" } & OptionalPayload<DeclareContractPayload> | { type: "DEPLOY" } & OptionalPayload<AllowArray<UniversalDeployerContractPayload>> | { type: "DEPLOY_ACCOUNT" } & OptionalPayload<DeployAccountContractPayload> | { type: "INVOKE_FUNCTION" } & OptionalPayload<AllowArray<Call>>)[]

Invocations array user provide to bulk method (simulate)

Defined in​

src/types/lib/index.ts:159


Status​

Ζ¬ Status: "NOT_RECEIVED" | "RECEIVED" | "PENDING" | "ACCEPTED_ON_L2" | "ACCEPTED_ON_L1" | "REJECTED"

Defined in​

src/types/lib/index.ts:166


Tupled​

Ζ¬ Tupled: Object

Type declaration​

NameType
elementany
typestring

Defined in​

src/types/lib/index.ts:181


BlockTag​

Ζ¬ BlockTag: "pending" | "latest"

Defined in​

src/types/lib/index.ts:183


BlockNumber​

Ζ¬ BlockNumber: BlockTag | null | number

Defined in​

src/types/lib/index.ts:184


BlockIdentifier​

Ζ¬ BlockIdentifier: BlockNumber | BigNumberish

Defined in​

src/types/lib/index.ts:188


Struct​

Ζ¬ Struct: Object

Index signature​

β–ͺ [k: string]: BigNumberish

Type declaration​

NameType
type"struct"

Defined in​

src/types/lib/index.ts:190


Args​

Ζ¬ Args: Object

Index signature​

β–ͺ [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[]

Defined in​

src/types/lib/index.ts:194


ParsedStruct​

Ζ¬ ParsedStruct: Object

Index signature​

β–ͺ [key: string]: BigNumberish | ParsedStruct

Defined in​

src/types/lib/index.ts:197


waitForTransactionOptions​

Ζ¬ waitForTransactionOptions: Object

Type declaration​

NameType
retryInterval?number
successStates?TransactionStatus[]

Defined in​

src/types/lib/index.ts:201


getSimulateTransactionOptions​

Ζ¬ getSimulateTransactionOptions: Object

Type declaration​

NameType
blockIdentifier?BlockIdentifier
skipValidate?boolean
skipExecute?boolean

Defined in​

src/types/lib/index.ts:206


getEstimateFeeBulkOptions​

Ζ¬ getEstimateFeeBulkOptions: Object

Type declaration​

NameType
blockIdentifier?BlockIdentifier
skipValidate?boolean

Defined in​

src/types/lib/index.ts:212


ContractClass​

Ζ¬ ContractClass: LegacyContractClass | SierraContractClass

format produced after compressing compiled contract CompressedCompiledContract

Defined in​

src/types/lib/contract/index.ts:9


CompiledContract​

Ζ¬ CompiledContract: LegacyCompiledContract | CompiledSierra

format produced after compile .cairo to .json

Defined in​

src/types/lib/contract/index.ts:14


CairoContract​

Ζ¬ CairoContract: ContractClass | CompiledContract

Compressed or decompressed Cairo0 or Cairo1 Contract

Defined in​

src/types/lib/contract/index.ts:19


Abi​

Ζ¬ Abi: (FunctionAbi | EventAbi | StructAbi)[]

ABI

Defined in​

src/types/lib/contract/abi.ts:2


AbiEntry​

Ζ¬ AbiEntry: Object

Type declaration​

NameType
namestring
type"felt" | "felt*" | string

Defined in​

src/types/lib/contract/abi.ts:5


FunctionAbi​

Ζ¬ FunctionAbi: Object

Type declaration​

NameType
inputsAbiEntry[]
namestring
outputsAbiEntry[]
stateMutability?"view"
state_mutability?string
typeFunctionAbiType

Defined in​

src/types/lib/contract/abi.ts:14


AbiStructs​

Ζ¬ AbiStructs: Object

Index signature​

β–ͺ [name: string]: StructAbi

Defined in​

src/types/lib/contract/abi.ts:23


StructAbi​

Ζ¬ StructAbi: Object

Type declaration​

NameType
membersAbiEntry & { offset: number }[]
namestring
sizenumber
type"struct"

Defined in​

src/types/lib/contract/abi.ts:25


LegacyContractClass​

Ζ¬ LegacyContractClass: Object

format produced after compressing 'program' property

Type declaration​

NameType
programCompressedProgram
entry_points_by_typeEntryPointsByType
abiAbi

Defined in​

src/types/lib/contract/legacy.ts:7


LegacyCompiledContract​

Ζ¬ LegacyCompiledContract: Omit<LegacyContractClass, "program"> & { program: Program }

format produced after compile .cairo to .json

Defined in​

src/types/lib/contract/legacy.ts:16


Builtins​

Ζ¬ Builtins: string[]

SUBTYPES

Defined in​

src/types/lib/contract/legacy.ts:21


CompressedProgram​

Ζ¬ CompressedProgram: string

Defined in​

src/types/lib/contract/legacy.ts:22


EntryPointsByType​

Ζ¬ EntryPointsByType: Object

Type declaration​

NameType
CONSTRUCTORContractEntryPointFields[]
EXTERNALContractEntryPointFields[]
L1_HANDLERContractEntryPointFields[]

Defined in​

src/types/lib/contract/legacy.ts:24


ContractEntryPointFields​

Ζ¬ ContractEntryPointFields: Object

Type declaration​

NameType
selectorstring
offsetstring
builtins?Builtins

Defined in​

src/types/lib/contract/legacy.ts:30


CairoAssembly​

Ζ¬ CairoAssembly: Object

SYSTEM TYPES

Type declaration​

NameType
primestring
compiler_versionstring
bytecodeByteCode
hintsany[]
pythonic_hintsPythonicHints
entry_points_by_typeEntryPointsByType

Defined in​

src/types/lib/contract/sierra.ts:5


CompiledSierra​

Ζ¬ CompiledSierra: Object

format produced after starknet-compile .cairo to .json sierra_program is hex array

Type declaration​

NameType
sierra_programByteCode
sierra_program_debug_info?SierraProgramDebugInfo
contract_class_versionstring
entry_points_by_typeSierraEntryPointsByType
abiAbi

Defined in​

src/types/lib/contract/sierra.ts:19


SierraContractClass​

Ζ¬ SierraContractClass: Omit<CompiledSierra, "abi" | "sierra_program_debug_info"> & { sierra_program: string ; abi: string }

format produced after compressing 'sierra_program', stringifies 'abi' property and omit sierra_program_debug_info CompressedCompiledSierra

Defined in​

src/types/lib/contract/sierra.ts:31


CompiledSierraCasm​

Ζ¬ CompiledSierraCasm: CairoAssembly

Defined in​

src/types/lib/contract/sierra.ts:35


ByteCode​

Ζ¬ ByteCode: string[]

SUBTYPES

Defined in​

src/types/lib/contract/sierra.ts:38


PythonicHints​

Ζ¬ PythonicHints: [number, string[]][]

Defined in​

src/types/lib/contract/sierra.ts:39


SierraProgramDebugInfo​

Ζ¬ SierraProgramDebugInfo: Object

Type declaration​

NameType
type_names[number, string][]
libfunc_names[number, string][]
user_func_names[number, string][]

Defined in​

src/types/lib/contract/sierra.ts:41


SierraEntryPointsByType​

Ζ¬ SierraEntryPointsByType: Object

Type declaration​

NameType
CONSTRUCTORSierraContractEntryPointFields[]
EXTERNALSierraContractEntryPointFields[]
L1_HANDLERSierraContractEntryPointFields[]

Defined in​

src/types/lib/contract/sierra.ts:47


SierraContractEntryPointFields​

Ζ¬ SierraContractEntryPointFields: Object

Type declaration​

NameType
selectorstring
function_idxnumber

Defined in​

src/types/lib/contract/sierra.ts:53


RpcProviderOptions​

Ζ¬ RpcProviderOptions: Object

Type declaration​

NameType
nodeUrlstring
retries?number
headers?object
blockIdentifier?BlockIdentifier
chainId?StarknetChainId

Defined in​

src/types/provider/configuration.ts:9


SequencerHttpMethod​

Ζ¬ SequencerHttpMethod: "POST" | "GET"

Defined in​

src/types/provider/configuration.ts:17


SequencerProviderOptions​

Ζ¬ SequencerProviderOptions: { headers?: Record<string, string> ; blockIdentifier?: BlockIdentifier ; chainId?: StarknetChainId } & { network: NetworkName | StarknetChainId } | { baseUrl: string ; feederGatewayUrl?: string ; gatewayUrl?: string }

Defined in​

src/types/provider/configuration.ts:19


GetTransactionResponse​

Ζ¬ GetTransactionResponse: InvokeTransactionResponse & DeclareTransactionResponse

Defined in​

src/types/provider/response.ts:42


GetTransactionReceiptResponse​

Ζ¬ GetTransactionReceiptResponse: InvokeTransactionReceiptResponse | DeclareTransactionReceiptResponse

Defined in​

src/types/provider/response.ts:69


DeclareTransactionReceiptResponse​

Ζ¬ DeclareTransactionReceiptResponse: CommonTransactionReceiptResponse

Defined in​

src/types/provider/response.ts:103


CallContractResponse​

Ζ¬ CallContractResponse: Object

Type declaration​

NameType
resultstring[]

Defined in​

src/types/provider/response.ts:121


EstimateFeeAction​

Ζ¬ EstimateFeeAction: { type: INVOKE ; payload: AllowArray<Call> } | { type: DECLARE ; payload: DeclareContractPayload } | { type: DEPLOY_ACCOUNT ; payload: DeployAccountContractPayload } | { type: DEPLOY ; payload: UniversalDeployerContractPayload }

Defined in​

src/types/provider/response.ts:125


EstimateFeeResponseBulk​

Ζ¬ EstimateFeeResponseBulk: EstimateFeeResponse[]

Defined in​

src/types/provider/response.ts:143


Storage​

Ζ¬ Storage: Storage

Defined in​

src/types/provider/response.ts:145


Nonce​

Ζ¬ Nonce: Nonce

Defined in​

src/types/provider/response.ts:147


SimulationFlags​

Ζ¬ SimulationFlags: SimulationFlags

Defined in​

src/types/provider/response.ts:149


SimulatedTransaction​

Ζ¬ SimulatedTransaction: Object

Type declaration​

NameType
transaction_traceTrace | TransactionTraceResponse
fee_estimationEstimateFeeResponse | EstimateFeeResponse
suggestedMaxFee?string | bigint

Defined in​

src/types/provider/response.ts:151


SimulateTransactionResponse​

Ζ¬ SimulateTransactionResponse: SimulatedTransaction[]

Defined in​

src/types/provider/response.ts:157


ContractClassResponse​

Ζ¬ ContractClassResponse: LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">

Standardized type Cairo0 program compressed and Cairo1 sierra_program decompressed abi Abi CompiledSierra without '.sierra_program_debug_info'

Defined in​

src/types/provider/response.ts:181


DeployAccountSignerDetails​

Ζ¬ DeployAccountSignerDetails: Required<DeployAccountContractPayload> & Required<InvocationsDetails> & { contractAddress: BigNumberish ; chainId: StarknetChainId }

Defined in​

src/types/signer.ts:25


StarkNetMerkleType​

Ζ¬ StarkNetMerkleType: Object

Type declaration​

NameType
namestring
type"merkletree"
containsstring

Defined in​

src/types/typedData.ts:1


StarkNetType​

Ζ¬ StarkNetType: { name: string ; type: string } | StarkNetMerkleType

A single type, as part of a struct. The type field can be any of the EIP-712 supported types.

Note that the uint and int aliases like in Solidity, and fixed point numbers are not supported by the EIP-712 standard.

Defined in​

src/types/typedData.ts:13


GetTransactionStatusResponse​

Ζ¬ GetTransactionStatusResponse: Object

Type declaration​

NameType
tx_statusTransactionStatus
block_hash?string
tx_failure_reason?{ code: string ; error_message: string }
tx_failure_reason.codestring
tx_failure_reason.error_messagestring

Defined in​

src/types/api/sequencer.ts:17


GetContractAddressesResponse​

Ζ¬ GetContractAddressesResponse: Object

Type declaration​

NameType
Starknetstring
GpsStatementVerifierstring

Defined in​

src/types/api/sequencer.ts:26


FunctionInvocation​

Ζ¬ FunctionInvocation: Object

Type declaration​

NameType
caller_addressstring
contract_addressstring
calldataRawCalldata
call_type?string
class_hash?string
selector?string
entry_point_type?EXTERNAL
resultany[]
execution_resourcesExecutionResources
internal_callsFunctionInvocation[]
eventsany[]
messagesany[]

Defined in​

src/types/api/sequencer.ts:31


ExecutionResources​

Ζ¬ ExecutionResources: Object

Type declaration​

NameType
n_stepsnumber
builtin_instance_counter{ pedersen_builtin: number ; range_check_builtin: number ; bitwise_builtin: number ; output_builtin: number ; ecdsa_builtin: number ; ec_op_builtin?: number }
builtin_instance_counter.pedersen_builtinnumber
builtin_instance_counter.range_check_builtinnumber
builtin_instance_counter.bitwise_builtinnumber
builtin_instance_counter.output_builtinnumber
builtin_instance_counter.ecdsa_builtinnumber
builtin_instance_counter.ec_op_builtin?number
n_memory_holesnumber

Defined in​

src/types/api/sequencer.ts:46


CallL1Handler​

Ζ¬ CallL1Handler: Object

Type declaration​

NameType
from_addressstring
to_addressstring
entry_point_selectorstring
payloadstring[]

Defined in​

src/types/api/sequencer.ts:59


DeployedContractItem​

Ζ¬ DeployedContractItem: Object

Type declaration​

NameType
addressstring
class_hashstring

Defined in​

src/types/api/sequencer.ts:66


SequencerIdentifier​

Ζ¬ SequencerIdentifier: { blockHash: string } | { blockNumber: BlockNumber }

Defined in​

src/types/api/sequencer.ts:71