Namespace: types

Namespaces

• Sequencer
• RPC

Enumerations

• SIMULATION_FLAG
• TransactionStatus
• TransactionType
• EntryPointType

Interfaces

• EstimateFee
• EstimateFeeDetails
• DeployContractResponse
• Uint256
• CallStruct
• Program
• ProviderOptions
• GetBlockResponse
• GetCodeResponse
• CommonTransactionResponse
• InvokeTransactionResponse
• ContractEntryPoint
• DeclareTransactionResponse
• CommonTransactionReceiptResponse
• MessageToL1
• Event
• MessageToL2
• InvokeTransactionReceiptResponse
• EstimateFeeResponse
• InvokeFunctionResponse
• DeclareContractResponse
• StateUpdateResponse
• InvocationsSignerDetails
• DeclareSignerDetails
• StarkNetDomain
• TypedData

Type Aliases

EstimateFeeBulk

Ƭ EstimateFeeBulk: EstimateFee[]

Defined in

src/types/account.ts:8

---

AccountInvocationsFactoryDetails

Ƭ AccountInvocationsFactoryDetails: Object

Type declaration

Name	Type
versions	bigint[]
nonce?	BigNumberish
blockIdentifier?	BlockIdentifier

Defined in

src/types/account.ts:10

---

MultiDeployContractResponse

Ƭ MultiDeployContractResponse: Object

Type declaration

Name	Type
contract_address	string[]
transaction_hash	string

Defined in

src/types/account.ts:27

---

DeployContractUDCResponse

Ƭ DeployContractUDCResponse: Object

Type declaration

Name	Type
contract_address	string
transaction_hash	string
address	string
deployer	string
unique	string
classHash	string
calldata_len	string
calldata	string[]
salt	string

Defined in

src/types/account.ts:32

---

DeclareDeployUDCResponse

Ƭ DeclareDeployUDCResponse: Object

Type declaration

Name	Type
declare	{ class_hash: BigNumberish } & Partial<DeclareTransactionReceiptResponse>
deploy	DeployContractUDCResponse

Defined in

src/types/account.ts:44

---

SimulateTransactionDetails

Ƭ SimulateTransactionDetails: Object

Type declaration

Name	Type
nonce?	BigNumberish
blockIdentifier?	BlockIdentifier
skipValidate?	boolean
skipExecute?	boolean

Defined in

src/types/account.ts:51

---

AsyncContractFunction

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

Type parameters

Name	Type
T	any

Type declaration

▸ (...args): Promise<T>

Parameters

Name	Type
...args	ArgsOrCalldataWithOptions

Returns

Promise<T>

Defined in

src/types/contract.ts:3

---

ContractFunction

Ƭ ContractFunction: (...args: ArgsOrCalldataWithOptions) => any

Type declaration

▸ (...args): any

Parameters

Name	Type
...args	ArgsOrCalldataWithOptions

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

Name	Type
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

Name	Type
classHash	BigNumberish
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

Name	Type
contract	CompiledContract | string
constructorCalldata?	RawCalldata
addressSalt?	string

Defined in

src/types/lib/index.ts:56

---

DeployAccountContractPayload

Ƭ DeployAccountContractPayload: Object

Type declaration

Name	Type
classHash	string
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

Name	Type
contract	CompiledContract | string
classHash?	string
casm?	CompiledSierraCasm
compiledClassHash?	string

Defined in

src/types/lib/index.ts:76

---

CompleteDeclareContractPayload

Ƭ CompleteDeclareContractPayload: Object

Type declaration

Name	Type
contract	CompiledContract | string
classHash	string
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

Name	Type
contract	ContractClass
senderAddress	string
signature?	Signature
compiledClassHash?	string

Defined in

src/types/lib/index.ts:93

---

CallDetails

Ƭ CallDetails: Object

Type declaration

Name	Type
contractAddress	string
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

Name	Type
nonce?	BigNumberish
maxFee?	BigNumberish
version?	BigNumberish

Defined in

src/types/lib/index.ts:112

---

Details

Ƭ Details: Object

Contain all additional details params

Type declaration

Name	Type
nonce	BigNumberish
maxFee	BigNumberish
version	BigNumberish
chainId	StarknetChainId

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

Name	Type
element	any
type	string

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

Name	Type
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

Name	Type
retryInterval?	number
successStates?	TransactionStatus[]

Defined in

src/types/lib/index.ts:201

---

getSimulateTransactionOptions

Ƭ getSimulateTransactionOptions: Object

Type declaration

Name	Type
blockIdentifier?	BlockIdentifier
skipValidate?	boolean
skipExecute?	boolean

Defined in

src/types/lib/index.ts:206

---

getEstimateFeeBulkOptions

Ƭ getEstimateFeeBulkOptions: Object

Type declaration

Name	Type
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

Name	Type
name	string
type	"felt" | "felt*" | string

Defined in

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

---

FunctionAbi

Ƭ FunctionAbi: Object

Type declaration

Name	Type
inputs	AbiEntry[]
name	string
outputs	AbiEntry[]
stateMutability?	"view"
state_mutability?	string
type	FunctionAbiType

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

Name	Type
members	AbiEntry & { offset: number }[]
name	string
size	number
type	"struct"

Defined in

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

---

LegacyContractClass

Ƭ LegacyContractClass: Object

format produced after compressing 'program' property

Type declaration

Name	Type
program	CompressedProgram
entry_points_by_type	EntryPointsByType
abi	Abi

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

Name	Type
CONSTRUCTOR	ContractEntryPointFields[]
EXTERNAL	ContractEntryPointFields[]
L1_HANDLER	ContractEntryPointFields[]

Defined in

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

---

ContractEntryPointFields

Ƭ ContractEntryPointFields: Object

Type declaration

Name	Type
selector	string
offset	string
builtins?	Builtins

Defined in

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

---

CairoAssembly

Ƭ CairoAssembly: Object

SYSTEM TYPES

Type declaration

Name	Type
prime	string
compiler_version	string
bytecode	ByteCode
hints	any[]
pythonic_hints	PythonicHints
entry_points_by_type	EntryPointsByType

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

Name	Type
sierra_program	ByteCode
sierra_program_debug_info?	SierraProgramDebugInfo
contract_class_version	string
entry_points_by_type	SierraEntryPointsByType
abi	Abi

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

Name	Type
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

Name	Type
CONSTRUCTOR	SierraContractEntryPointFields[]
EXTERNAL	SierraContractEntryPointFields[]
L1_HANDLER	SierraContractEntryPointFields[]

Defined in

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

---

SierraContractEntryPointFields

Ƭ SierraContractEntryPointFields: Object

Type declaration

Name	Type
selector	string
function_idx	number

Defined in

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

---

RpcProviderOptions

Ƭ RpcProviderOptions: Object

Type declaration

Name	Type
nodeUrl	string
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

Name	Type
result	string[]

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

Name	Type
transaction_trace	Trace | TransactionTraceResponse
fee_estimation	EstimateFeeResponse | 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

Name	Type
name	string
type	"merkletree"
contains	string

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

Name	Type
tx_status	TransactionStatus
block_hash?	string
tx_failure_reason?	{ code: string ; error_message: string }
tx_failure_reason.code	string
tx_failure_reason.error_message	string

Defined in

src/types/api/sequencer.ts:17

---

GetContractAddressesResponse

Ƭ GetContractAddressesResponse: Object

Type declaration

Name	Type
Starknet	string
GpsStatementVerifier	string

Defined in

src/types/api/sequencer.ts:26

---

FunctionInvocation

Ƭ FunctionInvocation: Object

Type declaration

Name	Type
caller_address	string
contract_address	string
calldata	RawCalldata
call_type?	string
class_hash?	string
selector?	string
entry_point_type?	EXTERNAL
result	any[]
execution_resources	ExecutionResources
internal_calls	FunctionInvocation[]
events	any[]
messages	any[]

Defined in

src/types/api/sequencer.ts:31

---

ExecutionResources

Ƭ ExecutionResources: Object

Type declaration

Name	Type
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 }
builtin_instance_counter.pedersen_builtin	number
builtin_instance_counter.range_check_builtin	number
builtin_instance_counter.bitwise_builtin	number
builtin_instance_counter.output_builtin	number
builtin_instance_counter.ecdsa_builtin	number
builtin_instance_counter.ec_op_builtin?	number
n_memory_holes	number

Defined in

src/types/api/sequencer.ts:46

---

CallL1Handler

Ƭ CallL1Handler: Object

Type declaration

Name	Type
from_address	string
to_address	string
entry_point_selector	string
payload	string[]

Defined in

src/types/api/sequencer.ts:59

---

DeployedContractItem

Ƭ DeployedContractItem: Object

Type declaration

Name	Type
address	string
class_hash	string

Defined in

src/types/api/sequencer.ts:66

---

SequencerIdentifier

Ƭ SequencerIdentifier: { blockHash: string } | { blockNumber: BlockNumber }

Defined in

src/types/api/sequencer.ts:71