Namespace: types

Namespaces

• RPC

Enumerations

• OutsideExecutionVersion

Interfaces

• Uint256
• Uint512
• CallStruct
• Program
• ProviderOptions
• MessageToL1
• EstimateFeeResponse
• EstimateFee
• UniversalDetails
• EstimateFeeDetails
• DeployContractResponse
• OutsideExecutionOptions
• OutsideCall
• OutsideExecution
• OutsideTransaction

References

TypedDataRevision

Re-exports TypedDataRevision

---

StarknetEnumType

Re-exports StarknetEnumType

---

StarknetMerkleType

Re-exports StarknetMerkleType

---

StarknetType

Re-exports StarknetType

---

StarknetDomain

Re-exports StarknetDomain

---

TypedData

Re-exports TypedData

Type Aliases

WeierstrassSignatureType

Ƭ WeierstrassSignatureType: SignatureType

Defined in

src/types/lib/index.ts:8

---

ArraySignatureType

Ƭ ArraySignatureType: string[]

Defined in

src/types/lib/index.ts:9

---

Signature

Ƭ Signature: ArraySignatureType | WeierstrassSignatureType

Defined in

src/types/lib/index.ts:10

---

BigNumberish

Ƭ BigNumberish: string | number | bigint

Defined in

src/types/lib/index.ts:12

---

ByteArray

Ƭ ByteArray: Object

Type declaration

Name	Type
data	BigNumberish[]
pending_word	BigNumberish
pending_word_len	BigNumberish

Defined in

src/types/lib/index.ts:14

---

Calldata

Ƭ Calldata: string[] & { __compiled__?: true }

Compiled calldata ready to be sent

decimal-string array

Defined in

src/types/lib/index.ts:25

---

RawCalldata

Ƭ RawCalldata: BigNumberish[]

BigNumberish array

use CallData.compile() to convert to Calldata

Defined in

src/types/lib/index.ts:54

---

HexCalldata

Ƭ HexCalldata: string[]

Hexadecimal-string array

Defined in

src/types/lib/index.ts:59

---

AllowArray

Ƭ AllowArray<T>: T | T[]

Type parameters

Name
T

Defined in

src/types/lib/index.ts:61

---

OptionalPayload

Ƭ OptionalPayload<T>: { payload: T } | T

Type parameters

Name
T

Defined in

src/types/lib/index.ts:63

---

RawArgs

Ƭ RawArgs: RawArgsObject | RawArgsArray

Defined in

src/types/lib/index.ts:65

---

RawArgsObject

Ƭ RawArgsObject: Object

Index signature

▪ [inputName: string]: MultiType | MultiType[] | RawArgs

Defined in

src/types/lib/index.ts:67

---

RawArgsArray

Ƭ RawArgsArray: (MultiType | MultiType[] | RawArgs)[]

Defined in

src/types/lib/index.ts:71

---

MultiType

Ƭ MultiType: BigNumberish | Uint256 | object | boolean | CairoEnum

Defined in

src/types/lib/index.ts:73

---

UniversalDeployerContractPayload

Ƭ UniversalDeployerContractPayload: Object

Type declaration

Name	Type
classHash	BigNumberish
salt?	string
unique?	boolean
constructorCalldata?	RawArgs

Defined in

src/types/lib/index.ts:75

---

DeployAccountContractPayload

Ƭ DeployAccountContractPayload: Object

Type declaration

Name	Type
classHash	string
constructorCalldata?	RawArgs
addressSalt?	BigNumberish
contractAddress?	string

Defined in

src/types/lib/index.ts:82

---

DeployAccountContractTransaction

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

Defined in

src/types/lib/index.ts:89

---

DeclareContractPayload

Ƭ DeclareContractPayload: Object

Type declaration

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

Defined in

src/types/lib/index.ts:96

---

ContractClassIdentifier

Ƭ ContractClassIdentifier: DeclareContractPayload | { classHash: string }

DeclareContractPayload with classHash or contract defined

Defined in

src/types/lib/index.ts:106

---

CompleteDeclareContractPayload

Ƭ CompleteDeclareContractPayload: Object

Type declaration

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

Defined in

src/types/lib/index.ts:108

---

DeclareAndDeployContractPayload

Ƭ DeclareAndDeployContractPayload: Omit<UniversalDeployerContractPayload, "classHash"> & DeclareContractPayload

Defined in

src/types/lib/index.ts:115

---

DeclareContractTransaction

Ƭ DeclareContractTransaction: Object

Type declaration

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

Defined in

src/types/lib/index.ts:118

---

CallDetails

Ƭ CallDetails: Object

Type declaration

Name	Type
contractAddress	string
calldata?	RawArgs | Calldata
entrypoint?	string

Defined in

src/types/lib/index.ts:125

---

Invocation

Ƭ Invocation: CallDetails & { signature?: Signature }

Defined in

src/types/lib/index.ts:131

---

Call

Ƭ Call: CallDetails & { entrypoint: string }

Defined in

src/types/lib/index.ts:133

---

CairoVersion

Ƭ CairoVersion: "0" | "1" | undefined

Defined in

src/types/lib/index.ts:135

---

CompilerVersion

Ƭ CompilerVersion: "0" | "1" | "2" | undefined

Defined in

src/types/lib/index.ts:136

---

InvocationsDetails

Ƭ InvocationsDetails: { nonce?: BigNumberish ; maxFee?: BigNumberish ; version?: BigNumberish } & Partial<V3TransactionDetails>

Defined in

src/types/lib/index.ts:138

---

V3TransactionDetails

Ƭ V3TransactionDetails: Object

Type declaration

Name	Type
nonce	BigNumberish
version	BigNumberish
resourceBounds	ResourceBounds
tip	BigNumberish
paymasterData	BigNumberish[]
accountDeploymentData	BigNumberish[]
nonceDataAvailabilityMode	EDataAvailabilityMode
feeDataAvailabilityMode	EDataAvailabilityMode

Defined in

src/types/lib/index.ts:144

---

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:158

---

InvocationsDetailsWithNonce

Ƭ InvocationsDetailsWithNonce: InvocationsDetails & { nonce: BigNumberish } | V3TransactionDetails

Defined in

src/types/lib/index.ts:165

---

TransactionType

Ƭ TransactionType: ValuesType<typeof TransactionType>

Defined in

src/types/lib/index.ts:169

src/types/lib/index.ts:176

---

TransactionStatus

Ƭ TransactionStatus: ValuesType<typeof TransactionStatus>

Defined in

src/types/lib/index.ts:182

src/types/lib/index.ts:191

---

TransactionFinalityStatus

Ƭ TransactionFinalityStatus: ValuesType<typeof TransactionFinalityStatus>

Defined in

src/types/lib/index.ts:193

src/types/lib/index.ts:200

---

TransactionExecutionStatus

Ƭ TransactionExecutionStatus: ValuesType<typeof TransactionExecutionStatus>

Defined in

src/types/lib/index.ts:202

src/types/lib/index.ts:208

---

BlockStatus

Ƭ BlockStatus: ValuesType<typeof BlockStatus>

Defined in

src/types/lib/index.ts:210

src/types/lib/index.ts:217

---

BlockTag

Ƭ BlockTag: ValuesType<typeof BlockTag>

Defined in

src/types/lib/index.ts:219

src/types/lib/index.ts:224

---

BlockNumber

Ƭ BlockNumber: BlockTag | null | number

Defined in

src/types/lib/index.ts:226

---

BlockIdentifier

Ƭ BlockIdentifier: BlockNumber | BigNumberish

hex string and BigInt are detected as block hashes

decimal string and number are detected as block numbers

text string are detected as block tag

null return 'pending' block tag

Defined in

src/types/lib/index.ts:237

---

AccountInvocationItem

Ƭ AccountInvocationItem: { type: typeof DECLARE } & DeclareContractTransaction | { type: typeof DEPLOY_ACCOUNT } & DeployAccountContractTransaction | { type: typeof INVOKE } & Invocation & InvocationsDetailsWithNonce

items used by AccountInvocations

Defined in

src/types/lib/index.ts:242

---

AccountInvocations

Ƭ AccountInvocations: AccountInvocationItem[]

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

Defined in

src/types/lib/index.ts:252

---

Invocations

Ƭ Invocations: ({ type: typeof DECLARE } & OptionalPayload<DeclareContractPayload> | { type: typeof DEPLOY } & OptionalPayload<AllowArray<UniversalDeployerContractPayload>> | { type: typeof DEPLOY_ACCOUNT } & OptionalPayload<DeployAccountContractPayload> | { type: typeof INVOKE } & OptionalPayload<AllowArray<Call>>)[]

Invocations array user provide to bulk method (simulate)

Defined in

src/types/lib/index.ts:257

---

Tupled

Ƭ Tupled: Object

Type declaration

Name	Type
element	any
type	string

Defined in

src/types/lib/index.ts:268

---

Args

Ƭ Args: Object

Index signature

▪ [inputName: string]: BigNumberish | BigNumberish[] | ParsedStruct | ParsedStruct[]

Defined in

src/types/lib/index.ts:270

---

ParsedStruct

Ƭ ParsedStruct: Object

Index signature

▪ [key: string]: BigNumberish | BigNumberish[] | ParsedStruct | Uint256

Defined in

src/types/lib/index.ts:273

---

waitForTransactionOptions

Ƭ waitForTransactionOptions: Object

Type declaration

Name	Type
retryInterval?	number
successStates?	(TransactionFinalityStatus | TransactionExecutionStatus)[]
errorStates?	(TransactionFinalityStatus | TransactionExecutionStatus)[]

Defined in

src/types/lib/index.ts:277

---

getSimulateTransactionOptions

Ƭ getSimulateTransactionOptions: Object

Type declaration

Name	Type
blockIdentifier?	BlockIdentifier
skipValidate?	boolean
skipExecute?	boolean
skipFeeCharge?	boolean

Defined in

src/types/lib/index.ts:283

---

getContractVersionOptions

Ƭ getContractVersionOptions: Object

Type declaration

Name	Type
blockIdentifier?	BlockIdentifier
compiler?	boolean

Defined in

src/types/lib/index.ts:290

---

getEstimateFeeBulkOptions

Ƭ getEstimateFeeBulkOptions: Object

Type declaration

Name	Type
blockIdentifier?	BlockIdentifier
skipValidate?	boolean

Defined in

src/types/lib/index.ts:295

---

ContractVersion

Ƭ ContractVersion: Object

Represent Contract version

Type declaration

Name	Type	Description
cairo	CairoVersion	version of the cairo language
compiler	CompilerVersion	version of the cairo compiler used to compile the contract

Defined in

src/types/lib/index.ts:309

---

ContractClass

Ƭ ContractClass: LegacyContractClass | SierraContractClass

format produced after compressing compiled contract

CompressedCompiledContract

Defined in

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

---

CompiledContract

Ƭ CompiledContract: LegacyCompiledContract | CompiledSierra

format produced after compile .cairo to .json

Defined in

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

---

CairoContract

Ƭ CairoContract: ContractClass | CompiledContract

Compressed or decompressed Cairo0 or Cairo1 Contract

Defined in

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

---

EntryPointType

Ƭ EntryPointType: ValuesType<typeof EntryPointType>

Defined in

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

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

---

Abi

Ƭ Abi: ReadonlyArray<FunctionAbi | AbiEvent | AbiStruct | InterfaceAbi | any>

ABI

Defined in

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

---

AbiEntry

Ƭ AbiEntry: Object

Type declaration

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

Defined in

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

---

EventEntry

Ƭ EventEntry: Object

Type declaration

Name	Type
name	string
type	"felt" | "felt*" | string
kind	"key" | "data"

Defined in

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

---

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]: AbiStruct

Defined in

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

---

AbiStruct

Ƭ AbiStruct: Object

Type declaration

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

Defined in

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

---

AbiInterfaces

Ƭ AbiInterfaces: Object

Index signature

▪ [name: string]: InterfaceAbi

Defined in

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

---

InterfaceAbi

Ƭ InterfaceAbi: Object

Type declaration

Name	Type
items	FunctionAbi[]
name	string
type	"interface"

Defined in

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

---

AbiEnums

Ƭ AbiEnums: Object

Index signature

▪ [name: string]: AbiEnum

Defined in

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

---

AbiEnum

Ƭ AbiEnum: Object

Type declaration

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

Defined in

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

---

AbiEvents

Ƭ AbiEvents: Object

Index signature

▪ [hash: string]: AbiEvent

Defined in

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

---

AbiEvent

Ƭ AbiEvent: CairoEvent | LegacyEvent

Defined in

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

---

CairoEvent

Ƭ CairoEvent: CairoEventDefinition | AbiEvents

Defined in

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

---

CairoEventDefinition

Ƭ CairoEventDefinition: STRUCT_EVENT & { name: string ; type: "event" }

Defined in

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

---

CairoEventVariant

Ƭ CairoEventVariant: ENUM_EVENT & { name: string ; type: string }

Defined in

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

---

LegacyEvent

Ƭ LegacyEvent: Object

Type declaration

Name	Type
name	string
type	"event"
data	EVENT_FIELD[]
keys	EVENT_FIELD[]

Defined in

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

---

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 compiling .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 | number
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
bytecode_segment_lengths?	number[]
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:21

---

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:34

---

CompiledSierraCasm

Ƭ CompiledSierraCasm: CairoAssembly

Defined in

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

---

ByteCode

Ƭ ByteCode: string[]

SUBTYPES

Defined in

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

---

PythonicHints

Ƭ PythonicHints: [number, string[]][]

Defined in

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

---

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:44

---

SierraEntryPointsByType

Ƭ SierraEntryPointsByType: Object

Type declaration

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

Defined in

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

---

SierraContractEntryPointFields

Ƭ SierraContractEntryPointFields: Object

Type declaration

Name	Type
selector	string
function_idx	number

Defined in

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

---

RpcProviderOptions

Ƭ RpcProviderOptions: Object

Type declaration

Name	Type
nodeUrl?	string | NetworkName
retries?	number
transactionRetryIntervalFallback?	number
headers?	object
blockIdentifier?	BlockIdentifier
chainId?	StarknetChainId
specVersion?	string
default?	boolean
waitMode?	boolean
feeMarginPercentage?	{ l1BoundMaxAmount: number ; l1BoundMaxPricePerUnit: number ; maxFee: number }
feeMarginPercentage.l1BoundMaxAmount	number
feeMarginPercentage.l1BoundMaxPricePerUnit	number
feeMarginPercentage.maxFee	number
batch?	false | number

Defined in

src/types/provider/configuration.ts:6

---

BlockWithTxHashes

Ƭ BlockWithTxHashes: Merge<BlockWithTxHashes, BlockWithTxHashes>

Defined in

src/types/provider/spec.ts:101

---

ContractClassPayload

Ƭ ContractClassPayload: Merge<ContractClass, ContractClass>

Defined in

src/types/provider/spec.ts:102

---

FeeEstimate

Ƭ FeeEstimate: Merge<FEE_ESTIMATE, FEE_ESTIMATE>

Defined in

src/types/provider/spec.ts:104

---

TransactionReceipt

Ƭ TransactionReceipt: Merge<TransactionReceipt, TransactionReceipt>

Defined in

src/types/provider/spec.ts:110

---

GetBlockResponse

Ƭ GetBlockResponse: PendingBlock | Block

Defined in

src/types/provider/response.ts:42

---

PendingBlock

Ƭ PendingBlock: Object

Type declaration

Name	Type
status	"PENDING"
parent_hash	BLOCK_HASH
timestamp	number
sequencer_address	FELT
l1_gas_price	RESOURCE_PRICE
starknet_version	string
transactions	TXN_HASH[]

Defined in

src/types/provider/response.ts:44

---

Block

Ƭ Block: Object

Type declaration

Name	Type
status	"ACCEPTED_ON_L2" | "ACCEPTED_ON_L1" | "REJECTED"
block_hash	BLOCK_HASH
parent_hash	BLOCK_HASH
block_number	BLOCK_NUMBER
new_root	FELT
timestamp	number
sequencer_address	FELT
l1_gas_price	RESOURCE_PRICE
starknet_version	string
transactions	TXN_HASH[]

Defined in

src/types/provider/response.ts:54

---

RevertedTransactionReceiptResponse

Ƭ RevertedTransactionReceiptResponse: Object

Type declaration

Name	Type
type?	TransactionType | any
execution_status	typeof REVERTED | any
finality_status	TransactionFinalityStatus | any
status?	TransactionStatus
actual_fee	string
block_hash?	string
block_number?	BlockNumber
transaction_hash	string
transaction_index?	number
messages_sent	MessageToL1[]
events	any[]
revert_reason?	string

Defined in

src/types/provider/response.ts:72

---

RejectedTransactionReceiptResponse

Ƭ RejectedTransactionReceiptResponse: Object

Type declaration

Name	Type
status	typeof REJECTED
transaction_failure_reason	{ code: string ; error_message: string }
transaction_failure_reason.code	string
transaction_failure_reason.error_message	string

Defined in

src/types/provider/response.ts:87

---

GetTxReceiptResponseWithoutHelper

Ƭ GetTxReceiptResponseWithoutHelper: SuccessfulTransactionReceiptResponse | RevertedTransactionReceiptResponse | RejectedTransactionReceiptResponse

Defined in

src/types/provider/response.ts:95

---

SuccessfulTransactionReceiptResponse

Ƭ SuccessfulTransactionReceiptResponse: InvokeTransactionReceiptResponse | DeployTransactionReceiptResponse | DeclareTransactionReceiptResponse

Defined in

src/types/provider/response.ts:100

---

GetTransactionResponse

Ƭ GetTransactionResponse: TransactionWithHash

Defined in

src/types/provider/response.ts:105

---

InvokeTransactionReceiptResponse

Ƭ InvokeTransactionReceiptResponse: INVOKE_TXN_RECEIPT | PENDING_INVOKE_TXN_RECEIPT

Defined in

src/types/provider/response.ts:107

---

DeclareTransactionReceiptResponse

Ƭ DeclareTransactionReceiptResponse: DECLARE_TXN_RECEIPT | PENDING_DECLARE_TXN_RECEIPT

Defined in

src/types/provider/response.ts:108

---

DeployTransactionReceiptResponse

Ƭ DeployTransactionReceiptResponse: InvokeTransactionReceiptResponse

Defined in

src/types/provider/response.ts:109

---

DeployAccountTransactionReceiptResponse

Ƭ DeployAccountTransactionReceiptResponse: DEPLOY_ACCOUNT_TXN_RECEIPT | PENDING_DEPLOY_ACCOUNT_TXN_RECEIPT

Defined in

src/types/provider/response.ts:110

---

L1HandlerTransactionReceiptResponse

Ƭ L1HandlerTransactionReceiptResponse: L1_HANDLER_TXN_RECEIPT | PENDING_L1_HANDLER_TXN_RECEIPT

Defined in

src/types/provider/response.ts:113

---

EstimateFeeResponseBulk

Ƭ EstimateFeeResponseBulk: EstimateFeeResponse[]

Defined in

src/types/provider/response.ts:128

---

InvokeFunctionResponse

Ƭ InvokeFunctionResponse: InvokedTransaction

Defined in

src/types/provider/response.ts:130

---

DeclareContractResponse

Ƭ DeclareContractResponse: DeclaredTransaction

Defined in

src/types/provider/response.ts:132

---

CallContractResponse

Ƭ CallContractResponse: string[]

Defined in

src/types/provider/response.ts:134

---

Storage

Ƭ Storage: FELT

Defined in

src/types/provider/response.ts:136

---

Nonce

Ƭ Nonce: string

Defined in

src/types/provider/response.ts:138

---

SIMULATION_FLAG

Ƭ SIMULATION_FLAG: Merge<SIMULATION_FLAG, SIMULATION_FLAG>

Defined in

src/types/provider/spec.ts:60

---

SimulationFlags

Ƭ SimulationFlags: SIMULATION_FLAG[]

Defined in

src/types/provider/response.ts:141

---

SimulatedTransaction

Ƭ SimulatedTransaction: SimulateTransaction & { suggestedMaxFee: bigint ; resourceBounds: ResourceBounds }

Defined in

src/types/provider/response.ts:143

---

SimulateTransactionResponse

Ƭ SimulateTransactionResponse: SimulatedTransaction[]

Defined in

src/types/provider/response.ts:148

---

StateUpdateResponse

Ƭ StateUpdateResponse: StateUpdate | PendingStateUpdate

Defined in

src/types/provider/response.ts:150

---

StateUpdate

Ƭ StateUpdate: STATE_UPDATE

Defined in

src/types/provider/response.ts:151

---

PendingStateUpdate

Ƭ PendingStateUpdate: PENDING_STATE_UPDATE

Defined in

src/types/provider/response.ts:152

---

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:163

---

UniversalSuggestedFee

Ƭ UniversalSuggestedFee: Object

Type declaration

Name	Type
maxFee	BigNumberish
resourceBounds	ResourceBounds

Defined in

src/types/account.ts:17

---

EstimateFeeBulk

Ƭ EstimateFeeBulk: EstimateFee[]

Defined in

src/types/account.ts:22

---

AccountInvocationsFactoryDetails

Ƭ AccountInvocationsFactoryDetails: { versions: `${ETransactionVersion}`[] ; nonce?: BigNumberish ; blockIdentifier?: BlockIdentifier ; skipValidate?: boolean } & Partial<V3TransactionDetails>

Defined in

src/types/account.ts:25

---

MultiDeployContractResponse

Ƭ MultiDeployContractResponse: Object

Type declaration

Name	Type
contract_address	string[]
transaction_hash	string

Defined in

src/types/account.ts:53

---

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:58

---

DeclareDeployUDCResponse

Ƭ DeclareDeployUDCResponse: Object

Type declaration

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

Defined in

src/types/account.ts:70

---

SimulateTransactionDetails

Ƭ SimulateTransactionDetails: { nonce?: BigNumberish ; blockIdentifier?: BlockIdentifier ; skipValidate?: boolean ; skipExecute?: boolean } & Partial<V3TransactionDetails>

Defined in

src/types/account.ts:77

---

EstimateFeeAction

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

Defined in

src/types/account.ts:84

---

StarkProfile

Ƭ StarkProfile: Object

Type declaration

Name	Type
name?	string
profilePicture?	string
discord?	string
twitter?	string
github?	string
proofOfPersonhood?	boolean

Defined in

src/types/account.ts:102

---

CairoEnum

Ƭ CairoEnum: CairoCustomEnum | CairoOption<any> | CairoResult<any, any>

Defined in

src/types/cairoEnum.ts:3

---

ValidateType

Ƭ ValidateType: ValuesType<typeof ValidateType>

Defined in

src/types/calldata.ts:3

src/types/calldata.ts:9

---

Uint

Ƭ Uint: ValuesType<typeof Uint>

Defined in

src/types/calldata.ts:11

src/types/calldata.ts:21

---

Literal

Ƭ Literal: ValuesType<typeof Literal>

Defined in

src/types/calldata.ts:23

src/types/calldata.ts:30

---

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:11

---

ContractFunction

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

Type declaration

▸ (...args): any

Parameters

Name	Type
...args	ArgsOrCalldataWithOptions

Returns

any

Defined in

src/types/contract.ts:12

---

Result

Ƭ Result: { [key: string]: any; } | Result[] | bigint | string | boolean | CairoEnum

Defined in

src/types/contract.ts:14

---

ArgsOrCalldata

Ƭ ArgsOrCalldata: RawArgsArray | [Calldata] | Calldata

Defined in

src/types/contract.ts:24

---

ArgsOrCalldataWithOptions

Ƭ ArgsOrCalldataWithOptions: ArgsOrCalldata & ContractOptions

Defined in

src/types/contract.ts:25

---

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:26

---

CallOptions

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

Defined in

src/types/contract.ts:37

---

InvokeOptions

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

Defined in

src/types/contract.ts:42

---

ParsedEvent

Ƭ ParsedEvent: Object

Index signature

▪ [name: string]: ParsedStruct

Defined in

src/types/contract.ts:47

---

ParsedEvents

Ƭ ParsedEvents: ParsedEvent[]

Defined in

src/types/contract.ts:49

---

RPC_ERROR_SET

Ƭ RPC_ERROR_SET: Object

Type declaration

Name	Type
FAILED_TO_RECEIVE_TXN	FAILED_TO_RECEIVE_TXN
NO_TRACE_AVAILABLE	NO_TRACE_AVAILABLE
CONTRACT_NOT_FOUND	CONTRACT_NOT_FOUND
BLOCK_NOT_FOUND	BLOCK_NOT_FOUND
INVALID_TXN_INDEX	INVALID_TXN_INDEX
CLASS_HASH_NOT_FOUND	CLASS_HASH_NOT_FOUND
TXN_HASH_NOT_FOUND	TXN_HASH_NOT_FOUND
PAGE_SIZE_TOO_BIG	PAGE_SIZE_TOO_BIG
NO_BLOCKS	NO_BLOCKS
INVALID_CONTINUATION_TOKEN	INVALID_CONTINUATION_TOKEN
TOO_MANY_KEYS_IN_FILTER	TOO_MANY_KEYS_IN_FILTER
CONTRACT_ERROR	CONTRACT_ERROR
TRANSACTION_EXECUTION_ERROR	TRANSACTION_EXECUTION_ERROR
CLASS_ALREADY_DECLARED	CLASS_ALREADY_DECLARED
INVALID_TRANSACTION_NONCE	INVALID_TRANSACTION_NONCE
INSUFFICIENT_MAX_FEE	INSUFFICIENT_MAX_FEE
INSUFFICIENT_ACCOUNT_BALANCE	INSUFFICIENT_ACCOUNT_BALANCE
VALIDATION_FAILURE	VALIDATION_FAILURE
COMPILATION_FAILED	COMPILATION_FAILED
CONTRACT_CLASS_SIZE_IS_TOO_LARGE	CONTRACT_CLASS_SIZE_IS_TOO_LARGE
NON_ACCOUNT	NON_ACCOUNT
DUPLICATE_TX	DUPLICATE_TX
COMPILED_CLASS_HASH_MISMATCH	COMPILED_CLASS_HASH_MISMATCH
UNSUPPORTED_TX_VERSION	UNSUPPORTED_TX_VERSION
UNSUPPORTED_CONTRACT_CLASS_VERSION	UNSUPPORTED_CONTRACT_CLASS_VERSION
UNEXPECTED_ERROR	UNEXPECTED_ERROR

Defined in

src/types/errors.ts:4

---

RPC_ERROR

Ƭ RPC_ERROR: RPC_ERROR_SET[keyof RPC_ERROR_SET]

Defined in

src/types/errors.ts:33

---

InvocationsSignerDetails

Ƭ InvocationsSignerDetails: V2InvocationsSignerDetails | V3InvocationsSignerDetails & { version: `${ETransactionVersion}` ; skipValidate?: boolean }

Defined in

src/types/signer.ts:11

---

V2InvocationsSignerDetails

Ƭ V2InvocationsSignerDetails: Object

Type declaration

Name	Type
walletAddress	string
cairoVersion	CairoVersion
chainId	StarknetChainId
nonce	BigNumberish
maxFee	BigNumberish
version	`${ETransactionVersion2}`

Defined in

src/types/signer.ts:16

---

V3InvocationsSignerDetails

Ƭ V3InvocationsSignerDetails: V3TransactionDetails & { walletAddress: string ; cairoVersion: CairoVersion ; chainId: StarknetChainId ; version: `${ETransactionVersion3}` }

Defined in

src/types/signer.ts:25

---

DeclareSignerDetails

Ƭ DeclareSignerDetails: V3DeclareSignerDetails | V2DeclareSignerDetails & { version: `${ETransactionVersion}` }

Defined in

src/types/signer.ts:32

---

V2DeclareSignerDetails

Ƭ V2DeclareSignerDetails: Required<InvocationsDetails> & { classHash: string ; compiledClassHash?: string ; senderAddress: string ; chainId: StarknetChainId ; version: `${ETransactionVersion2}` }

Defined in

src/types/signer.ts:36

---

V3DeclareSignerDetails

Ƭ V3DeclareSignerDetails: V3TransactionDetails & { classHash: string ; compiledClassHash: string ; senderAddress: string ; chainId: StarknetChainId ; version: `${ETransactionVersion3}` }

Defined in

src/types/signer.ts:44

---

DeployAccountSignerDetails

Ƭ DeployAccountSignerDetails: V2DeployAccountSignerDetails | V3DeployAccountSignerDetails

Defined in

src/types/signer.ts:52

---

V2DeployAccountSignerDetails

Ƭ V2DeployAccountSignerDetails: Required<DeployAccountContractPayload> & Required<InvocationsDetails> & { contractAddress: BigNumberish ; chainId: StarknetChainId ; version: `${ETransactionVersion2}` }

Defined in

src/types/signer.ts:56

---

V3DeployAccountSignerDetails

Ƭ V3DeployAccountSignerDetails: Required<DeployAccountContractPayload> & V3TransactionDetails & { contractAddress: BigNumberish ; chainId: StarknetChainId ; version: `${ETransactionVersion3}` }

Defined in

src/types/signer.ts:63

---

LedgerPathCalculation

Ƭ LedgerPathCalculation: (accountId: number, applicationName: string) => Uint8Array

Type declaration

▸ (accountId, applicationName): Uint8Array

Parameters

Name	Type
accountId	number
applicationName	string

Returns

Uint8Array

Defined in

src/types/signer.ts:70

---

TransactionStatusReceiptSets

Ƭ TransactionStatusReceiptSets: Object

Type declaration

Name	Type
success	SuccessfulTransactionReceiptResponse
reverted	RevertedTransactionReceiptResponse
rejected	RejectedTransactionReceiptResponse
error	Error

Defined in

src/types/transactionReceipt.ts:7

---

TransactionReceiptStatus

Ƭ TransactionReceiptStatus: keyof TransactionStatusReceiptSets

Defined in

src/types/transactionReceipt.ts:13

---

TransactionReceiptValue

Ƭ TransactionReceiptValue: TransactionStatusReceiptSets[TransactionReceiptStatus]

Defined in

src/types/transactionReceipt.ts:14

---

TransactionReceiptCallbacksDefined

Ƭ TransactionReceiptCallbacksDefined: { [key in TransactionReceiptStatus]: Function }

Defined in

src/types/transactionReceipt.ts:16

---

TransactionReceiptCallbacksDefault

Ƭ TransactionReceiptCallbacksDefault: Partial<TransactionReceiptCallbacksDefined> & { _: () => void }

Defined in

src/types/transactionReceipt.ts:19

---

TransactionReceiptCallbacks

Ƭ TransactionReceiptCallbacks: TransactionReceiptCallbacksDefined | TransactionReceiptCallbacksDefault

Defined in

src/types/transactionReceipt.ts:22

---

TransactionReceiptUtilityInterface

Ƭ TransactionReceiptUtilityInterface: { statusReceipt: TransactionReceiptStatus ; value: TransactionReceiptValue ; match: (callbacks: TransactionReceiptCallbacks) => void } & { [key in `is${Capitalize<TransactionReceiptStatus>}`]: Function }

Defined in

src/types/transactionReceipt.ts:26

Variables

TransactionType

• Const TransactionType: Object

Type declaration

Name	Type
DECLARE	"DECLARE"
DEPLOY	"DEPLOY"
DEPLOY_ACCOUNT	"DEPLOY_ACCOUNT"
INVOKE	"INVOKE_FUNCTION"

Defined in

src/types/lib/index.ts:169

src/types/lib/index.ts:176

---

TransactionStatus

• Const TransactionStatus: Object

new statuses are defined by props: finality_status and execution_status to be #deprecated

Type declaration

Name	Type
NOT_RECEIVED	"NOT_RECEIVED"
RECEIVED	"RECEIVED"
ACCEPTED_ON_L2	"ACCEPTED_ON_L2"
ACCEPTED_ON_L1	"ACCEPTED_ON_L1"
REJECTED	"REJECTED"
REVERTED	"REVERTED"

Defined in

src/types/lib/index.ts:182

src/types/lib/index.ts:191

---

TransactionFinalityStatus

• Const TransactionFinalityStatus: Object

Type declaration

Name	Type
NOT_RECEIVED	"NOT_RECEIVED"
RECEIVED	"RECEIVED"
ACCEPTED_ON_L2	"ACCEPTED_ON_L2"
ACCEPTED_ON_L1	"ACCEPTED_ON_L1"

Defined in

src/types/lib/index.ts:193

src/types/lib/index.ts:200

---

TransactionExecutionStatus

• Const TransactionExecutionStatus: Object

Type declaration

Name	Type
REJECTED	"REJECTED"
REVERTED	"REVERTED"
SUCCEEDED	"SUCCEEDED"

Defined in

src/types/lib/index.ts:202

src/types/lib/index.ts:208

---

BlockStatus

• Const BlockStatus: Object

Type declaration

Name	Type
PENDING	"PENDING"
ACCEPTED_ON_L1	"ACCEPTED_ON_L1"
ACCEPTED_ON_L2	"ACCEPTED_ON_L2"
REJECTED	"REJECTED"

Defined in

src/types/lib/index.ts:210

src/types/lib/index.ts:217

---

BlockTag

• Const BlockTag: Object

Type declaration

Name	Type
PENDING	"pending"
LATEST	"latest"

Defined in

src/types/lib/index.ts:219

src/types/lib/index.ts:224

---

EntryPointType

• Const EntryPointType: Object

Type declaration

Name	Type
EXTERNAL	"EXTERNAL"
L1_HANDLER	"L1_HANDLER"
CONSTRUCTOR	"CONSTRUCTOR"

Defined in

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

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

---

ValidateType

• Const ValidateType: Object

Type declaration

Name	Type
DEPLOY	"DEPLOY"
CALL	"CALL"
INVOKE	"INVOKE"

Defined in

src/types/calldata.ts:3

src/types/calldata.ts:9

---

Uint

• Const Uint: Object

Type declaration

Name	Type
u8	"core::integer::u8"
u16	"core::integer::u16"
u32	"core::integer::u32"
u64	"core::integer::u64"
u128	"core::integer::u128"
u256	"core::integer::u256"
u512	"core::integer::u512"

Defined in

src/types/calldata.ts:11

src/types/calldata.ts:21

---

Literal

• Const Literal: Object

Type declaration

Name	Type
ClassHash	"core::starknet::class_hash::ClassHash"
ContractAddress	"core::starknet::contract_address::ContractAddress"
Secp256k1Point	"core::starknet::secp256k1::Secp256k1Point"
U96	"core::internal::bounded_int::BoundedInt::<0, 79228162514264337593543950335>"

Defined in

src/types/calldata.ts:23

src/types/calldata.ts:30

---

ETH_ADDRESS

• Const ETH_ADDRESS: "core::starknet::eth_address::EthAddress"

Defined in

src/types/calldata.ts:32

---

NON_ZERO_PREFIX

• Const NON_ZERO_PREFIX: "core::zeroable::NonZero::"

Defined in

src/types/calldata.ts:33

---

OutsideExecutionTypesV1

• Const OutsideExecutionTypesV1: Object

Type declaration

Name	Type
StarkNetDomain	{ name: string = 'name'; type: string = 'felt' }[]
OutsideExecution	{ name: string = 'caller'; type: string = 'felt' }[]
OutsideCall	{ name: string = 'to'; type: string = 'felt' }[]

Defined in

src/types/outsideExecution.ts:33

---

OutsideExecutionTypesV2

• Const OutsideExecutionTypesV2: Object

Type declaration

Name	Type
StarknetDomain	{ name: string = 'name'; type: string = 'shortstring' }[]
OutsideExecution	{ name: string = 'Caller'; type: string = 'ContractAddress' }[]
Call	{ name: string = 'To'; type: string = 'ContractAddress' }[]

Defined in

src/types/outsideExecution.ts:55