Namespace: types
Namespacesβ
Enumerationsβ
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β
AccountInvocationsFactoryDetailsβ
Ζ¬ AccountInvocationsFactoryDetails: Object
Type declarationβ
Name | Type |
---|---|
versions | bigint [] |
nonce? | BigNumberish |
blockIdentifier? | BlockIdentifier |
Defined inβ
MultiDeployContractResponseβ
Ζ¬ MultiDeployContractResponse: Object
Type declarationβ
Name | Type |
---|---|
contract_address | string [] |
transaction_hash | string |
Defined inβ
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β
DeclareDeployUDCResponseβ
Ζ¬ DeclareDeployUDCResponse: Object
Type declarationβ
Name | Type |
---|---|
declare | { class_hash : BigNumberish } & Partial <DeclareTransactionReceiptResponse > |
deploy | DeployContractUDCResponse |
Defined inβ
SimulateTransactionDetailsβ
Ζ¬ SimulateTransactionDetails: Object
Type declarationβ
Name | Type |
---|---|
nonce? | BigNumberish |
blockIdentifier? | BlockIdentifier |
skipValidate? | boolean |
skipExecute? | boolean |
Defined inβ
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β
ContractFunctionβ
Ζ¬ ContractFunction: (...args
: ArgsOrCalldataWithOptions
) => any
Type declarationβ
βΈ (...args
): any
Parametersβ
Name | Type |
---|---|
...args | ArgsOrCalldataWithOptions |
Returnsβ
any
Defined inβ
Resultβ
Ζ¬ Result: { [key: string]
: any
; } | Result
[] | bigint
| string
| boolean
Defined inβ
Calldataβ
Ζ¬ Calldata: string
[] & { __compiled__?
: boolean
}
Compiled calldata ready to be sent decimal-string array
Defined inβ
ArgsOrCalldataβ
Ζ¬ ArgsOrCalldata: RawArgsArray
| [Calldata
] | Calldata
Defined inβ
ArgsOrCalldataWithOptionsβ
Ζ¬ ArgsOrCalldataWithOptions: ArgsOrCalldata
& ContractOptions
Defined inβ
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β
CallOptionsβ
Ζ¬ CallOptions: Pick
<ContractOptions
, "blockIdentifier"
| "parseRequest"
| "parseResponse"
| "formatResponse"
>
Defined inβ
InvokeOptionsβ
Ζ¬ InvokeOptions: Pick
<ContractOptions
, "maxFee"
| "nonce"
| "signature"
| "parseRequest"
>
Defined inβ
WeierstrassSignatureTypeβ
Ζ¬ WeierstrassSignatureType: SignatureType
Defined inβ
ArraySignatureTypeβ
Ζ¬ ArraySignatureType: string
[]
Defined inβ
Signatureβ
Ζ¬ Signature: ArraySignatureType
| WeierstrassSignatureType
Defined inβ
BigNumberishβ
Ζ¬ BigNumberish: string
| number
| bigint
Defined inβ
RawCalldataβ
Ζ¬ RawCalldata: BigNumberish
[]
BigNumberish array use CallData.compile() to convert to Calldata
Defined inβ
HexCalldataβ
Ζ¬ HexCalldata: string
[]
Hexadecimal-string array
Defined inβ
AllowArrayβ
Ζ¬ AllowArray<T
>: T
| T
[]
Type parametersβ
Name |
---|
T |
Defined inβ
OptionalPayloadβ
Ζ¬ OptionalPayload<T
>: { payload
: T
} | T
Type parametersβ
Name |
---|
T |
Defined inβ
RawArgsβ
Ζ¬ RawArgs: RawArgsObject
| RawArgsArray
Defined inβ
RawArgsObjectβ
Ζ¬ RawArgsObject: Object
Index signatureβ
βͺ [inputName: string
]: MultiType
| MultiType
[] | RawArgs
Defined inβ
RawArgsArrayβ
Ζ¬ RawArgsArray: (MultiType
| MultiType
[] | RawArgs
)[]
Defined inβ
MultiTypeβ
Ζ¬ MultiType: BigNumberish
| Uint256
| object
| boolean
Defined inβ
UniversalDeployerContractPayloadβ
Ζ¬ UniversalDeployerContractPayload: Object
Type declarationβ
Name | Type |
---|---|
classHash | BigNumberish |
salt? | string |
unique? | boolean |
constructorCalldata? | RawArgs |
Defined inβ
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β
DeployAccountContractPayloadβ
Ζ¬ DeployAccountContractPayload: Object
Type declarationβ
Name | Type |
---|---|
classHash | string |
constructorCalldata? | RawArgs |
addressSalt? | BigNumberish |
contractAddress? | string |
Defined inβ
DeployAccountContractTransactionβ
Ζ¬ DeployAccountContractTransaction: Omit
<DeployAccountContractPayload
, "contractAddress"
> & { signature?
: Signature
}
Defined inβ
DeclareContractPayloadβ
Ζ¬ DeclareContractPayload: Object
Type declarationβ
Name | Type |
---|---|
contract | CompiledContract | string |
classHash? | string |
casm? | CompiledSierraCasm |
compiledClassHash? | string |
Defined inβ
CompleteDeclareContractPayloadβ
Ζ¬ CompleteDeclareContractPayload: Object
Type declarationβ
Name | Type |
---|---|
contract | CompiledContract | string |
classHash | string |
casm? | CompiledSierraCasm |
compiledClassHash? | string |
Defined inβ
DeclareAndDeployContractPayloadβ
Ζ¬ DeclareAndDeployContractPayload: Omit
<UniversalDeployerContractPayload
, "classHash"
> & DeclareContractPayload
Defined inβ
DeclareContractTransactionβ
Ζ¬ DeclareContractTransaction: Object
Type declarationβ
Name | Type |
---|---|
contract | ContractClass |
senderAddress | string |
signature? | Signature |
compiledClassHash? | string |
Defined inβ
CallDetailsβ
Ζ¬ CallDetails: Object
Type declarationβ
Name | Type |
---|---|
contractAddress | string |
calldata? | RawArgs |
entrypoint? | string |
Defined inβ
Invocationβ
Ζ¬ Invocation: CallDetails
& { signature?
: Signature
}
Defined inβ
Callβ
Ζ¬ Call: CallDetails
& { entrypoint
: string
}
Defined inβ
CairoVersionβ
Ζ¬ CairoVersion: "0"
| "1"
Defined inβ
InvocationsDetailsβ
Ζ¬ InvocationsDetails: Object
Type declarationβ
Name | Type |
---|---|
nonce? | BigNumberish |
maxFee? | BigNumberish |
version? | BigNumberish |
Defined inβ
Detailsβ
Ζ¬ Details: Object
Contain all additional details params
Type declarationβ
Name | Type |
---|---|
nonce | BigNumberish |
maxFee | BigNumberish |
version | BigNumberish |
chainId | StarknetChainId |
Defined inβ
InvocationsDetailsWithNonceβ
Ζ¬ InvocationsDetailsWithNonce: InvocationsDetails
& { nonce
: BigNumberish
}
Defined inβ
AccountInvocationItemβ
Ζ¬ AccountInvocationItem: { type
: "DECLARE"
} & DeclareContractTransaction
| { type
: "DEPLOY_ACCOUNT"
} & DeployAccountContractTransaction
| { type
: "INVOKE_FUNCTION"
} & Invocation
& InvocationsDetailsWithNonce
items used by AccountInvocations
Defined inβ
AccountInvocationsβ
Ζ¬ AccountInvocations: AccountInvocationItem
[]
Complete invocations array with account details (internal type from account -> provider)
Defined inβ
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β
Statusβ
Ζ¬ Status: "NOT_RECEIVED"
| "RECEIVED"
| "PENDING"
| "ACCEPTED_ON_L2"
| "ACCEPTED_ON_L1"
| "REJECTED"
Defined inβ
Tupledβ
Ζ¬ Tupled: Object
Type declarationβ
Name | Type |
---|---|
element | any |
type | string |
Defined inβ
BlockTagβ
Ζ¬ BlockTag: "pending"
| "latest"
Defined inβ
BlockNumberβ
Ζ¬ BlockNumber: BlockTag
| null
| number
Defined inβ
BlockIdentifierβ
Ζ¬ BlockIdentifier: BlockNumber
| BigNumberish
Defined inβ
Structβ
Ζ¬ Struct: Object
Index signatureβ
βͺ [k: string
]: BigNumberish
Type declarationβ
Name | Type |
---|---|
type | "struct" |
Defined inβ
Argsβ
Ζ¬ Args: Object
Index signatureβ
βͺ [inputName: string
]: BigNumberish
| BigNumberish
[] | ParsedStruct
| ParsedStruct
[]
Defined inβ
ParsedStructβ
Ζ¬ ParsedStruct: Object
Index signatureβ
βͺ [key: string
]: BigNumberish
| ParsedStruct
Defined inβ
waitForTransactionOptionsβ
Ζ¬ waitForTransactionOptions: Object
Type declarationβ
Name | Type |
---|---|
retryInterval? | number |
successStates? | TransactionStatus [] |
Defined inβ
getSimulateTransactionOptionsβ
Ζ¬ getSimulateTransactionOptions: Object
Type declarationβ
Name | Type |
---|---|
blockIdentifier? | BlockIdentifier |
skipValidate? | boolean |
skipExecute? | boolean |
Defined inβ
getEstimateFeeBulkOptionsβ
Ζ¬ getEstimateFeeBulkOptions: Object
Type declarationβ
Name | Type |
---|---|
blockIdentifier? | BlockIdentifier |
skipValidate? | boolean |
Defined inβ
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β
StarkNetMerkleTypeβ
Ζ¬ StarkNetMerkleType: Object
Type declarationβ
Name | Type |
---|---|
name | string |
type | "merkletree" |
contains | string |
Defined inβ
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β
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β
GetContractAddressesResponseβ
Ζ¬ GetContractAddressesResponse: Object
Type declarationβ
Name | Type |
---|---|
Starknet | string |
GpsStatementVerifier | string |
Defined inβ
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β
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β
CallL1Handlerβ
Ζ¬ CallL1Handler: Object
Type declarationβ
Name | Type |
---|---|
from_address | string |
to_address | string |
entry_point_selector | string |
payload | string [] |
Defined inβ
DeployedContractItemβ
Ζ¬ DeployedContractItem: Object
Type declarationβ
Name | Type |
---|---|
address | string |
class_hash | string |
Defined inβ
SequencerIdentifierβ
Ζ¬ SequencerIdentifier: { blockHash
: string
} | { blockNumber
: BlockNumber
}