Version: Next

Class: Provider

Hierarchy

RpcProvider<this> & StarknetId<this>
↳ Provider
↳↳ Account

Constructors

constructor

• new Provider(optionsOrProvider?): Provider

Parameters

Name	Type
`optionsOrProvider?`	`RpcProviderOptions` \| `ProviderInterface` \| `RpcProvider`

Returns

Provider

Inherited from

Mixin(BaseRpcProvider, StarknetId).constructor

Defined in

src/provider/rpc.ts:63

• new Provider(): Provider

Returns

Provider

Inherited from

Mixin(BaseRpcProvider, StarknetId).constructor

Properties

responseParser

• responseParser: RPCResponseParser

Inherited from

Mixin(BaseRpcProvider, StarknetId).responseParser

Defined in

src/provider/rpc.ts:59

channel

• channel: RpcChannel | RpcChannel

Inherited from

Mixin(BaseRpcProvider, StarknetId).channel

Defined in

src/provider/rpc.ts:61

getStateUpdate

• getStateUpdate: () => Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>(blockIdentifier: "pre_confirmed") => Promise<PRE_CONFIRMED_STATE_UPDATE>(blockIdentifier: "latest") => Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>(blockIdentifier?: BlockIdentifier) => Promise<StateUpdateResponse>

Type declaration

▸ (): Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Returns

Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

▸ (blockIdentifier): Promise<PRE_CONFIRMED_STATE_UPDATE>

Parameters

Name	Type
`blockIdentifier`	`"pre_confirmed"`

Returns

Promise<PRE_CONFIRMED_STATE_UPDATE>

▸ (blockIdentifier): Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

▸ (blockIdentifier?): Promise<StateUpdateResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StateUpdateResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStateUpdate

Defined in

src/provider/rpc.ts:235

Methods

create

▸ create<T>(this, optionsOrProvider?): Promise<T>

auto configure channel based on provided node leave space for other async before constructor

Type parameters

Name	Type
`T`	extends `RpcProvider`<`T`>

Parameters

Name	Type
`this`	(...`args`: [optionsOrProvider?: RpcProviderOptions \| ProviderInterface \| RpcProvider]) => `T`
`optionsOrProvider?`	`RpcProviderOptions`

Returns

Promise<T>

Inherited from

Mixin(BaseRpcProvider, StarknetId).create

Defined in

src/provider/rpc.ts:95

getStarkName

▸ getStarkName(provider, address, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`provider`	`ProviderInterface`
`address`	`BigNumberish`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStarkName

Defined in

src/provider/extensions/starknetId.ts:62

getAddressFromStarkName

▸ getAddressFromStarkName(provider, name, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`provider`	`ProviderInterface`
`name`	`string`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getAddressFromStarkName

Defined in

src/provider/extensions/starknetId.ts:96

getStarkProfile

▸ getStarkProfile(provider, address, StarknetIdContract?, StarknetIdIdentityContract?, StarknetIdVerifierContract?, StarknetIdPfpContract?, StarknetIdPopContract?, StarknetIdMulticallContract?): Promise<StarkProfile>

Parameters

Name	Type
`provider`	`ProviderInterface`
`address`	`BigNumberish`
`StarknetIdContract?`	`string`
`StarknetIdIdentityContract?`	`string`
`StarknetIdVerifierContract?`	`string`
`StarknetIdPfpContract?`	`string`
`StarknetIdPopContract?`	`string`
`StarknetIdMulticallContract?`	`string`

Returns

Promise<StarkProfile>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStarkProfile

Defined in

src/provider/extensions/starknetId.ts:128

fetch

▸ fetch(method, params?, id?): Promise<Response>

Parameters

Name	Type	Default value
`method`	`string`	`undefined`
`params?`	`object`	`undefined`
`id`	`string` \| `number`	`0`

Returns

Promise<Response>

Inherited from

Mixin(BaseRpcProvider, StarknetId).fetch

Defined in

src/provider/rpc.ts:125

getChainId

▸ getChainId(): Promise<"0x534e5f4d41494e" | "0x534e5f5345504f4c4941">

Returns

Promise<"0x534e5f4d41494e" | "0x534e5f5345504f4c4941">

Inherited from

Mixin(BaseRpcProvider, StarknetId).getChainId

Defined in

src/provider/rpc.ts:129

readSpecVersion

▸ readSpecVersion(): undefined | "0.8.1" | "0.9.0"

Returns

undefined | "0.8.1" | "0.9.0"

Inherited from

Mixin(BaseRpcProvider, StarknetId).readSpecVersion

Defined in

src/provider/rpc.ts:133

getSpecVersion

▸ getSpecVersion(): Promise<string>

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getSpecVersion

Defined in

src/provider/rpc.ts:137

setUpSpecVersion

▸ setUpSpecVersion(): Promise<"0.8.1" | "0.9.0">

Returns

Promise<"0.8.1" | "0.9.0">

Inherited from

Mixin(BaseRpcProvider, StarknetId).setUpSpecVersion

Defined in

src/provider/rpc.ts:141

getNonceForAddress

▸ getNonceForAddress(contractAddress, blockIdentifier?): Promise<string>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getNonceForAddress

Defined in

src/provider/rpc.ts:145

getBlock

▸ getBlock(): Promise<{ transactions: string[] ; parent_hash: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string }>

Returns

Promise<{ transactions: string[] ; parent_hash: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlock

Defined in

src/provider/rpc.ts:152

▸ getBlock(blockIdentifier): Promise<{ transactions: string[] ; parent_hash: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string }>

Parameters

Name	Type
`blockIdentifier`	`"pre_confirmed"`

Returns

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlock

Defined in

src/provider/rpc.ts:153

▸ getBlock(blockIdentifier): Promise<{ status: EBlockStatus ; block_hash: string ; parent_hash: string ; block_number: number ; new_root: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string ; transactions: string[] }>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Promise<{ status: EBlockStatus ; block_hash: string ; parent_hash: string ; block_number: number ; new_root: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string ; transactions: string[] }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlock

Defined in

src/provider/rpc.ts:154

▸ getBlock(blockIdentifier): Promise<GetBlockResponse>

Parameters

Name	Type
`blockIdentifier`	`BlockIdentifier`

Returns

Promise<GetBlockResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlock

Defined in

src/provider/rpc.ts:155

getBlockLatestAccepted

▸ getBlockLatestAccepted(): Promise<BlockHashAndNumber>

Returns

Promise<BlockHashAndNumber>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockLatestAccepted

Defined in

src/provider/rpc.ts:162

getBlockNumber

▸ getBlockNumber(): Promise<number>

Returns

Promise<number>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockNumber

Defined in

src/provider/rpc.ts:166

getBlockWithTxHashes

▸ getBlockWithTxHashes(blockIdentifier?): Promise<OnlyFirst<BLOCK_WITH_TX_HASHES, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_TX_HASHES, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES & PENDING_BLOCK_HEADER> | OnlyFirst<BLOCK_WITH_TX_HASHES, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES & PRE_CONFIRMED_BLOCK_HEADER> | OnlyFirst<PRE_CONFIRMED_BLOCK_WITH_TX_HASHES, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES & PRE_CONFIRMED_BLOCK_HEADER>>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<OnlyFirst<BLOCK_WITH_TX_HASHES, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_TX_HASHES, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES & PENDING_BLOCK_HEADER> | OnlyFirst<BLOCK_WITH_TX_HASHES, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES & PRE_CONFIRMED_BLOCK_HEADER> | OnlyFirst<PRE_CONFIRMED_BLOCK_WITH_TX_HASHES, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_TX_HASHES & PRE_CONFIRMED_BLOCK_HEADER>>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockWithTxHashes

Defined in

src/provider/rpc.ts:170

getBlockWithTxs

▸ getBlockWithTxs(blockIdentifier?): Promise<OnlyFirst<BLOCK_WITH_TXS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_TXS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS & PENDING_BLOCK_HEADER> | OnlyFirst<BLOCK_WITH_TXS, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS & PRE_CONFIRMED_BLOCK_HEADER> | OnlyFirst<PRE_CONFIRMED_BLOCK_WITH_TXS, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS & PRE_CONFIRMED_BLOCK_HEADER>>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<OnlyFirst<BLOCK_WITH_TXS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_TXS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS & PENDING_BLOCK_HEADER> | OnlyFirst<BLOCK_WITH_TXS, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS & PRE_CONFIRMED_BLOCK_HEADER> | OnlyFirst<PRE_CONFIRMED_BLOCK_WITH_TXS, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_TXS & PRE_CONFIRMED_BLOCK_HEADER>>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockWithTxs

Defined in

src/provider/rpc.ts:174

waitForBlock

▸ waitForBlock(blockIdentifier?, retryInterval?): Promise<void>

Parameters

Name	Type	Default value
`blockIdentifier`	`BlockIdentifier`	`BlockTag.LATEST`
`retryInterval`	`number`	`5000`

Returns

Promise<void>

Inherited from

Mixin(BaseRpcProvider, StarknetId).waitForBlock

Defined in

src/provider/rpc.ts:178

getL1GasPrice

▸ getL1GasPrice(blockIdentifier?): Promise<string>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getL1GasPrice

Defined in

src/provider/rpc.ts:209

getL1MessageHash

▸ getL1MessageHash(l2TxHash): Promise<string>

Parameters

Name	Type
`l2TxHash`	`BigNumberish`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getL1MessageHash

Defined in

src/provider/rpc.ts:215

getBlockWithReceipts

▸ getBlockWithReceipts(blockIdentifier?): Promise<OnlyFirst<BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | OnlyFirst<BLOCK_WITH_RECEIPTS, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PRE_CONFIRMED_BLOCK_HEADER> | OnlyFirst<PRE_CONFIRMED_BLOCK_WITH_RECEIPTS, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PRE_CONFIRMED_BLOCK_HEADER>>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<OnlyFirst<BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | OnlyFirst<BLOCK_WITH_RECEIPTS, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PRE_CONFIRMED_BLOCK_HEADER> | OnlyFirst<PRE_CONFIRMED_BLOCK_WITH_RECEIPTS, { status: EBlockStatus } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PRE_CONFIRMED_BLOCK_HEADER>>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockWithReceipts

Defined in

src/provider/rpc.ts:231

getBlockStateUpdate

▸ getBlockStateUpdate(): Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Returns

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockStateUpdate

Defined in

src/provider/rpc.ts:237

▸ getBlockStateUpdate(blockIdentifier): Promise<PRE_CONFIRMED_STATE_UPDATE>

Parameters

Name	Type
`blockIdentifier`	`"pre_confirmed"`

Returns

Promise<PRE_CONFIRMED_STATE_UPDATE>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockStateUpdate

Defined in

src/provider/rpc.ts:238

▸ getBlockStateUpdate(blockIdentifier): Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockStateUpdate

Defined in

src/provider/rpc.ts:241

▸ getBlockStateUpdate(blockIdentifier?): Promise<StateUpdateResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StateUpdateResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockStateUpdate

Defined in

src/provider/rpc.ts:242

getBlockTransactionsTraces

▸ getBlockTransactionsTraces(blockIdentifier?): Promise<BlockTransactionsTraces | BlockTransactionsTraces>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockTransactionsTraces | BlockTransactionsTraces>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockTransactionsTraces

Defined in

src/provider/rpc.ts:247

getBlockTransactionCount

▸ getBlockTransactionCount(blockIdentifier?): Promise<number>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<number>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getBlockTransactionCount

Defined in

src/provider/rpc.ts:251

getTransaction

▸ getTransaction(txHash): Promise<TXN_WITH_HASH>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TXN_WITH_HASH>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransaction

Defined in

src/provider/rpc.ts:255

getTransactionByHash

▸ getTransactionByHash(txHash): Promise<TXN_WITH_HASH>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TXN_WITH_HASH>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionByHash

Defined in

src/provider/rpc.ts:259

getTransactionByBlockIdAndIndex

▸ getTransactionByBlockIdAndIndex(blockIdentifier, index): Promise<TXN_WITH_HASH>

Parameters

Name	Type
`blockIdentifier`	`BlockIdentifier`
`index`	`number`

Returns

Promise<TXN_WITH_HASH>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionByBlockIdAndIndex

Defined in

src/provider/rpc.ts:263

getTransactionReceipt

▸ getTransactionReceipt(txHash): Promise<GetTransactionReceiptResponse>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<GetTransactionReceiptResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionReceipt

Defined in

src/provider/rpc.ts:267

getTransactionTrace

▸ getTransactionTrace(txHash): Promise<TRANSACTION_TRACE | TRANSACTION_TRACE>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TRANSACTION_TRACE | TRANSACTION_TRACE>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionTrace

Defined in

src/provider/rpc.ts:274

getTransactionStatus

▸ getTransactionStatus(transactionHash): Promise<TXN_STATUS_RESULT | TXN_STATUS_RESULT>

Parameters

Name	Type
`transactionHash`	`BigNumberish`

Returns

Promise<TXN_STATUS_RESULT | TXN_STATUS_RESULT>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getTransactionStatus

Defined in

src/provider/rpc.ts:280

getSimulateTransaction

▸ getSimulateTransaction(invocations, options?): Promise<SimulateTransactionOverheadResponse>

Parameters

Name	Type
`invocations`	`AccountInvocations`
`options?`	`getSimulateTransactionOptions`

Returns

Promise<SimulateTransactionOverheadResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getSimulateTransaction

Defined in

src/provider/rpc.ts:284

waitForTransaction

▸ waitForTransaction(txHash, options?): Promise<GetTransactionReceiptResponse>

Parameters

Name	Type
`txHash`	`BigNumberish`
`options?`	`waitForTransactionOptions`

Returns

Promise<GetTransactionReceiptResponse>

Inherited from

Mixin(BaseRpcProvider, StarknetId).waitForTransaction

Defined in

src/provider/rpc.ts:294

getStorageAt

▸ getStorageAt(contractAddress, key, blockIdentifier?): Promise<string>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`key`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStorageAt

Defined in

src/provider/rpc.ts:306

getClassHashAt

▸ getClassHashAt(contractAddress, blockIdentifier?): Promise<string>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getClassHashAt

Defined in

src/provider/rpc.ts:314

getClassByHash

▸ getClassByHash(classHash): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Parameters

Name	Type
`classHash`	`BigNumberish`

Returns

Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getClassByHash

Defined in

src/provider/rpc.ts:318

getClass

▸ getClass(classHash, blockIdentifier?): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Parameters

Name	Type
`classHash`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getClass

Defined in

src/provider/rpc.ts:322

getClassAt

▸ getClassAt(contractAddress, blockIdentifier?): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getClassAt

Defined in

src/provider/rpc.ts:328

getContractVersion

▸ getContractVersion(contractAddress, classHash?, options?): Promise<ContractVersion>

Parameters

Name	Type
`contractAddress`	`BigNumberish`
`classHash?`	`undefined`
`options?`	`getContractVersionOptions`

Returns

Promise<ContractVersion>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getContractVersion

Defined in

src/provider/rpc.ts:334

▸ getContractVersion(contractAddress, classHash, options?): Promise<ContractVersion>

Parameters

Name	Type
`contractAddress`	`undefined`
`classHash`	`BigNumberish`
`options?`	`getContractVersionOptions`

Returns

Promise<ContractVersion>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getContractVersion

Defined in

src/provider/rpc.ts:339

getInvokeEstimateFee

▸ getInvokeEstimateFee(invocation, details, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponseOverhead>

Parameters

Name	Type
`invocation`	`Invocation`
`details`	`InvocationsDetailsWithNonce`
`blockIdentifier?`	`BlockIdentifier`
`skipValidate?`	`boolean`

Returns

Promise<EstimateFeeResponseOverhead>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getInvokeEstimateFee

Defined in

src/provider/rpc.ts:372

getDeclareEstimateFee

▸ getDeclareEstimateFee(invocation, details, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponseOverhead>

Parameters

Name	Type
`invocation`	`DeclareContractTransaction`
`details`	`InvocationsDetailsWithNonce`
`blockIdentifier?`	`BlockIdentifier`
`skipValidate?`	`boolean`

Returns

Promise<EstimateFeeResponseOverhead>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getDeclareEstimateFee

Defined in

src/provider/rpc.ts:391

getDeployAccountEstimateFee

▸ getDeployAccountEstimateFee(invocation, details, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponseOverhead>

Parameters

Name	Type
`invocation`	`DeployAccountContractTransaction`
`details`	`InvocationsDetailsWithNonce`
`blockIdentifier?`	`BlockIdentifier`
`skipValidate?`	`boolean`

Returns

Promise<EstimateFeeResponseOverhead>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getDeployAccountEstimateFee

Defined in

src/provider/rpc.ts:410

getEstimateFeeBulk

▸ getEstimateFeeBulk(invocations, options): Promise<EstimateFeeResponseBulkOverhead>

Parameters

Name	Type
`invocations`	`AccountInvocations`
`options`	`getEstimateFeeBulkOptions`

Returns

Promise<EstimateFeeResponseBulkOverhead>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getEstimateFeeBulk

Defined in

src/provider/rpc.ts:429

invokeFunction

▸ invokeFunction(functionInvocation, details): Promise<{ transaction_hash: string }>

Parameters

Name	Type
`functionInvocation`	`Invocation`
`details`	`InvocationsDetailsWithNonce`

Returns

Promise<{ transaction_hash: string }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).invokeFunction

Defined in

src/provider/rpc.ts:438

declareContract

▸ declareContract(transaction, details): Promise<{ class_hash: string ; transaction_hash: string }>

Parameters

Name	Type
`transaction`	`DeclareContractTransaction`
`details`	`InvocationsDetailsWithNonce`

Returns

Promise<{ class_hash: string ; transaction_hash: string }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).declareContract

Defined in

src/provider/rpc.ts:445

deployAccountContract

▸ deployAccountContract(transaction, details): Promise<{ contract_address: string ; transaction_hash: string }>

Parameters

Name	Type
`transaction`	`DeployAccountContractTransaction`
`details`	`InvocationsDetailsWithNonce`

Returns

Promise<{ contract_address: string ; transaction_hash: string }>

Inherited from

Mixin(BaseRpcProvider, StarknetId).deployAccountContract

Defined in

src/provider/rpc.ts:452

callContract

▸ callContract(call, blockIdentifier?): Promise<string[]>

Parameters

Name	Type
`call`	`Call`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<string[]>

Inherited from

Mixin(BaseRpcProvider, StarknetId).callContract

Defined in

src/provider/rpc.ts:459

estimateMessageFee

▸ estimateMessageFee(message, blockIdentifier?): Promise<FEE_ESTIMATE | MESSAGE_FEE_ESTIMATE>

Parameters

Name	Type
`message`	`MSG_FROM_L1`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<FEE_ESTIMATE | MESSAGE_FEE_ESTIMATE>

Inherited from

Mixin(BaseRpcProvider, StarknetId).estimateMessageFee

Defined in

src/provider/rpc.ts:463

getSyncingStats

▸ getSyncingStats(): Promise<Syncing>

Returns

Promise<Syncing>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getSyncingStats

Defined in

src/provider/rpc.ts:470

getEvents

▸ getEvents(eventFilter): Promise<EVENTS_CHUNK | EVENTS_CHUNK>

Parameters

Name	Type
`eventFilter`	`EventFilter` \| `EventFilter`

Returns

Promise<EVENTS_CHUNK | EVENTS_CHUNK>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getEvents

Defined in

src/provider/rpc.ts:474

verifyMessageInStarknet

▸ verifyMessageInStarknet(message, signature, accountAddress, signatureVerificationFunctionName?, signatureVerificationResponse?): Promise<boolean>

Parameters

Name	Type
`message`	`TypedData` \| `BigNumberish`
`signature`	`Signature`
`accountAddress`	`BigNumberish`
`signatureVerificationFunctionName?`	`string`
`signatureVerificationResponse?`	`Object`
`signatureVerificationResponse.okResponse`	`string`[]
`signatureVerificationResponse.nokResponse`	`string`[]
`signatureVerificationResponse.error`	`string`[]

Returns

Promise<boolean>

Inherited from

Mixin(BaseRpcProvider, StarknetId).verifyMessageInStarknet

Defined in

src/provider/rpc.ts:486

isClassDeclared

▸ isClassDeclared(contractClassIdentifier, blockIdentifier?): Promise<boolean>

Parameters

Name	Type
`contractClassIdentifier`	`ContractClassIdentifier`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<boolean>

Inherited from

Mixin(BaseRpcProvider, StarknetId).isClassDeclared

Defined in

src/provider/rpc.ts:503

prepareInvocations

▸ prepareInvocations(invocations): Promise<Invocations>

Parameters

Name	Type
`invocations`	`Invocations`

Returns

Promise<Invocations>

Inherited from

Mixin(BaseRpcProvider, StarknetId).prepareInvocations

Defined in

src/provider/rpc.ts:528

getL1MessagesStatus

▸ getL1MessagesStatus(transactionHash): Promise<L1L2MessagesStatus | L1L2MessagesStatus>

Parameters

Name	Type
`transactionHash`	`BigNumberish`

Returns

Promise<L1L2MessagesStatus | L1L2MessagesStatus>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getL1MessagesStatus

Defined in

src/provider/rpc.ts:549

getStorageProof

▸ getStorageProof(classHashes, contractAddresses, contractsStorageKeys, blockIdentifier?): Promise<StorageProof>

Parameters

Name	Type
`classHashes`	`BigNumberish`[]
`contractAddresses`	`BigNumberish`[]
`contractsStorageKeys`	`CONTRACT_STORAGE_KEYS`[]
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StorageProof>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStorageProof

Defined in

src/provider/rpc.ts:555

getCompiledCasm

▸ getCompiledCasm(classHash): Promise<CASM_COMPILED_CONTRACT_CLASS>

Parameters

Name	Type
`classHash`	`BigNumberish`

Returns

Promise<CASM_COMPILED_CONTRACT_CLASS>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getCompiledCasm

Defined in

src/provider/rpc.ts:569

getEstimateTip

▸ getEstimateTip(blockIdentifier?, options?): Promise<TipEstimate>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`
`options`	`TipAnalysisOptions`

Returns

Promise<TipEstimate>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getEstimateTip

Defined in

src/provider/rpc.ts:573

getStarkName

▸ getStarkName(address, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`address`	`BigNumberish`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStarkName

Defined in

src/provider/extensions/starknetId.ts:22

getAddressFromStarkName

▸ getAddressFromStarkName(name, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`name`	`string`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getAddressFromStarkName

Defined in

src/provider/extensions/starknetId.ts:31

getStarkProfile

▸ getStarkProfile(address, StarknetIdContract?, StarknetIdIdentityContract?, StarknetIdVerifierContract?, StarknetIdPfpContract?, StarknetIdPopContract?, StarknetIdMulticallContract?): Promise<StarkProfile>

Parameters

Name	Type
`address`	`BigNumberish`
`StarknetIdContract?`	`string`
`StarknetIdIdentityContract?`	`string`
`StarknetIdVerifierContract?`	`string`
`StarknetIdPfpContract?`	`string`
`StarknetIdPopContract?`	`string`
`StarknetIdMulticallContract?`	`string`

Returns

Promise<StarkProfile>

Inherited from

Mixin(BaseRpcProvider, StarknetId).getStarkProfile

Defined in

src/provider/extensions/starknetId.ts:40

Hierarchy​

Constructors​

constructor​

Parameters​

Returns​

Inherited from​

Defined in​

Returns​

Inherited from​

Properties​

responseParser​

Inherited from​

Defined in​

channel​

Inherited from​

Defined in​

getStateUpdate​

Type declaration​

Returns​

Parameters​

Returns​

Parameters​

Returns​

Parameters​

Returns​

Inherited from​

Defined in​

Methods​

create​

Type parameters​

Parameters​

Returns​

Inherited from​

Defined in​

getStarkName​

Parameters​

Returns​

Inherited from​

Defined in​

getAddressFromStarkName​

Parameters​

Returns​

Inherited from​

Defined in​

getStarkProfile​

Parameters​

Returns​

Inherited from​

Defined in​

fetch​

Parameters​

Returns​

Inherited from​

Defined in​

getChainId​

Returns​

Inherited from​

Defined in​

readSpecVersion​

Returns​

Inherited from​

Defined in​

getSpecVersion​

Returns​

Inherited from​

Defined in​

setUpSpecVersion​

Returns​

Inherited from​

Defined in​

getNonceForAddress​

Parameters​

Returns​

Inherited from​

Defined in​

getBlock​

Returns​

Inherited from​

Defined in​

Parameters​

Hierarchy

Constructors

constructor

Parameters

Returns

Inherited from

Defined in

Returns

Inherited from

Properties

responseParser

Inherited from

Defined in

channel

Inherited from

Defined in

getStateUpdate

Type declaration

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Inherited from

Defined in

Methods

create

Type parameters

Parameters

Returns

Inherited from

Defined in

getStarkName

Parameters

Returns

Inherited from

Defined in

getAddressFromStarkName

Parameters

Returns

Inherited from

Defined in

getStarkProfile

Parameters

Returns

Inherited from

Defined in

fetch

Parameters

Returns

Inherited from

Defined in

getChainId

Returns

Inherited from

Defined in

readSpecVersion

Returns

Inherited from

Defined in

getSpecVersion

Returns

Inherited from

Defined in

setUpSpecVersion

Returns

Inherited from

Defined in

getNonceForAddress

Parameters

Returns

Inherited from

Defined in

getBlock

Returns

Inherited from

Defined in

Parameters