From 679f225899317069e998b20fc5cb5b7318334121 Mon Sep 17 00:00:00 2001 From: Petar Penovic Date: Fri, 6 Oct 2023 15:33:31 +0200 Subject: [PATCH] docs: streamline automatically generated documentation --- .github/workflows/manual-docs-version-pr.yml | 1 + .github/workflows/push-docs-build-commit.yml | 55 - tsconfig.json | 4 +- www/.gitignore | 2 + www/docs/API/.gitkeep | 0 www/docs/API/_category_.yml | 1 - www/docs/API/classes/Account.md | 1707 ---------------- www/docs/API/classes/AccountInterface.md | 1246 ----------- www/docs/API/classes/CairoCustomEnum.md | 87 - www/docs/API/classes/CairoOption.md | 121 -- www/docs/API/classes/CairoResult.md | 122 -- www/docs/API/classes/CallData.md | 294 --- www/docs/API/classes/Contract.md | 497 ----- www/docs/API/classes/ContractFactory.md | 161 -- www/docs/API/classes/ContractInterface.md | 375 ---- www/docs/API/classes/CustomError.md | 153 -- www/docs/API/classes/GatewayError.md | 162 -- www/docs/API/classes/HttpError.md | 162 -- www/docs/API/classes/LibraryError.md | 155 -- www/docs/API/classes/Provider.md | 779 ------- www/docs/API/classes/ProviderInterface.md | 624 ------ www/docs/API/classes/RpcProvider.md | 1177 ----------- www/docs/API/classes/SequencerProvider.md | 1158 ----------- www/docs/API/classes/Signer.md | 179 -- www/docs/API/classes/SignerInterface.md | 139 -- www/docs/API/classes/_category_.yml | 2 - www/docs/API/classes/merkle.MerkleTree.md | 129 -- www/docs/API/enums/CairoOptionVariant.md | 27 - www/docs/API/enums/CairoResultVariant.md | 27 - www/docs/API/enums/EntryPointType.md | 37 - www/docs/API/enums/RPC.TransactionType.md | 58 - www/docs/API/enums/TransactionStatus.md | 67 - www/docs/API/enums/TransactionType.md | 47 - www/docs/API/enums/_category_.yml | 2 - www/docs/API/enums/cairo.Uint.md | 68 - www/docs/API/enums/constants.BaseUrl.md | 28 - www/docs/API/enums/constants.NetworkName.md | 28 - .../API/enums/constants.StarknetChainId.md | 28 - .../enums/constants.TransactionHashPrefix.md | 58 - .../enums/starknetId.StarknetIdContract.md | 28 - www/docs/API/enums/types.BlockStatus.md | 48 - www/docs/API/enums/types.BlockTag.md | 28 - www/docs/API/enums/types.EntryPointType.md | 38 - www/docs/API/enums/types.Litteral.md | 28 - .../API/enums/types.RPC.TransactionType.md | 58 - www/docs/API/enums/types.SIMULATION_FLAG.md | 28 - .../enums/types.TransactionExecutionStatus.md | 38 - .../enums/types.TransactionFinalityStatus.md | 48 - www/docs/API/enums/types.TransactionStatus.md | 71 - www/docs/API/enums/types.TransactionType.md | 48 - www/docs/API/enums/types.Uint.md | 68 - www/docs/API/enums/types.ValidateType.md | 38 - www/docs/API/index.md | 59 - www/docs/API/interfaces/CallStruct.md | 37 - .../CommonTransactionReceiptResponse.md | 53 - .../interfaces/CommonTransactionResponse.md | 65 - www/docs/API/interfaces/ContractEntryPoint.md | 27 - .../API/interfaces/DeclareContractResponse.md | 27 - .../API/interfaces/DeclareSignerDetails.md | 77 - .../interfaces/DeclareTransactionResponse.md | 103 - .../API/interfaces/DeployContractResponse.md | 27 - www/docs/API/interfaces/EstimateFee.md | 69 - www/docs/API/interfaces/EstimateFeeDetails.md | 37 - .../API/interfaces/EstimateFeeResponse.md | 53 - www/docs/API/interfaces/Event.md | 37 - www/docs/API/interfaces/GetBlockResponse.md | 117 -- www/docs/API/interfaces/GetCodeResponse.md | 17 - .../interfaces/InvocationsSignerDetails.md | 85 - .../API/interfaces/InvokeFunctionResponse.md | 17 - .../InvokeTransactionReceiptResponse.md | 103 - .../interfaces/InvokeTransactionResponse.md | 123 -- www/docs/API/interfaces/MessageToL1.md | 27 - www/docs/API/interfaces/MessageToL2.md | 27 - www/docs/API/interfaces/Program.md | 33 - www/docs/API/interfaces/ProviderOptions.md | 27 - ...encer.InvokeFunctionTransactionResponse.md | 146 -- .../API/interfaces/StateUpdateResponse.md | 59 - .../API/interfaces/TransactionSimulation.md | 41 - .../TransactionSimulationResponse.md | 33 - www/docs/API/interfaces/_category_.yml | 2 - .../ec.weierstrass.ProjConstructor.md | 150 -- .../ec.weierstrass.ProjPointType.md | 406 ---- .../ec.weierstrass.SignatureType.md | 188 -- .../interfaces/typedData.StarkNetDomain.md | 46 - .../API/interfaces/typedData.TypedData.md | 50 - www/docs/API/interfaces/types.CallStruct.md | 38 - .../types.CommonTransactionReceiptResponse.md | 54 - .../types.CommonTransactionResponse.md | 66 - .../interfaces/types.ContractEntryPoint.md | 28 - .../types.DeclareContractResponse.md | 28 - .../interfaces/types.DeclareSignerDetails.md | 78 - .../types.DeclareTransactionResponse.md | 104 - .../types.DeployContractResponse.md | 28 - www/docs/API/interfaces/types.EstimateFee.md | 70 - .../interfaces/types.EstimateFeeDetails.md | 38 - .../interfaces/types.EstimateFeeResponse.md | 54 - www/docs/API/interfaces/types.Event.md | 38 - .../API/interfaces/types.GetBlockResponse.md | 118 -- .../API/interfaces/types.GetCodeResponse.md | 18 - .../types.InvocationsSignerDetails.md | 86 - .../types.InvokeFunctionResponse.md | 18 - .../types.InvokeTransactionReceiptResponse.md | 128 -- .../types.InvokeTransactionResponse.md | 124 -- www/docs/API/interfaces/types.MessageToL1.md | 28 - www/docs/API/interfaces/types.MessageToL2.md | 28 - www/docs/API/interfaces/types.Program.md | 34 - .../API/interfaces/types.ProviderOptions.md | 28 - ...encer.InvokeFunctionTransactionResponse.md | 146 -- .../API/interfaces/types.StarkNetDomain.md | 46 - .../interfaces/types.StateUpdateResponse.md | 60 - .../interfaces/types.TransactionSimulation.md | 42 - .../types.TransactionSimulationResponse.md | 34 - www/docs/API/interfaces/types.TypedData.md | 50 - www/docs/API/interfaces/types.Uint256.md | 30 - www/docs/API/interfaces/uint256.Uint256.md | 28 - www/docs/API/modules.md | 1372 ------------- www/docs/API/namespaces/RPC.md | 382 ---- www/docs/API/namespaces/Sequencer.md | 713 ------- www/docs/API/namespaces/_category_.yml | 2 - www/docs/API/namespaces/cairo.md | 484 ----- www/docs/API/namespaces/constants.md | 155 -- www/docs/API/namespaces/ec.md | 12 - www/docs/API/namespaces/ec.starkCurve.md | 533 ----- www/docs/API/namespaces/ec.weierstrass.md | 384 ---- www/docs/API/namespaces/encode.md | 326 --- www/docs/API/namespaces/events.md | 54 - www/docs/API/namespaces/hash.md | 532 ----- www/docs/API/namespaces/hash.poseidon.md | 108 - www/docs/API/namespaces/json.md | 111 - www/docs/API/namespaces/merkle.md | 35 - www/docs/API/namespaces/num.md | 421 ---- www/docs/API/namespaces/provider-1.md | 77 - www/docs/API/namespaces/selector.md | 31 - www/docs/API/namespaces/shortString.md | 223 -- www/docs/API/namespaces/stark.md | 188 -- www/docs/API/namespaces/starknetId.md | 71 - www/docs/API/namespaces/transaction.md | 153 -- www/docs/API/namespaces/typedData.md | 253 --- www/docs/API/namespaces/types.RPC.md | 459 ----- www/docs/API/namespaces/types.Sequencer.md | 824 -------- www/docs/API/namespaces/types.md | 1818 ----------------- www/docs/API/namespaces/uint256.md | 99 - www/tsconfig.json | 1 + .../API/enums/EntryPointType.md | 37 - .../API/enums/RPC.TransactionType.md | 58 - .../API/enums/TransactionStatus.md | 67 - .../API/enums/TransactionType.md | 47 - .../API/interfaces/CallStruct.md | 37 - .../CommonTransactionReceiptResponse.md | 53 - .../interfaces/CommonTransactionResponse.md | 65 - .../API/interfaces/ContractEntryPoint.md | 27 - .../API/interfaces/DeclareContractResponse.md | 27 - .../API/interfaces/DeclareSignerDetails.md | 77 - .../interfaces/DeclareTransactionResponse.md | 103 - .../API/interfaces/DeployContractResponse.md | 27 - .../API/interfaces/EstimateFee.md | 69 - .../API/interfaces/EstimateFeeDetails.md | 37 - .../API/interfaces/EstimateFeeResponse.md | 53 - .../version-5.14.1/API/interfaces/Event.md | 37 - .../API/interfaces/GetBlockResponse.md | 117 -- .../API/interfaces/GetCodeResponse.md | 17 - .../interfaces/InvocationsSignerDetails.md | 85 - .../API/interfaces/InvokeFunctionResponse.md | 17 - .../InvokeTransactionReceiptResponse.md | 103 - .../interfaces/InvokeTransactionResponse.md | 123 -- .../API/interfaces/MessageToL1.md | 27 - .../API/interfaces/MessageToL2.md | 27 - .../version-5.14.1/API/interfaces/Program.md | 33 - .../API/interfaces/ProviderOptions.md | 27 - ...encer.InvokeFunctionTransactionResponse.md | 146 -- .../API/interfaces/StateUpdateResponse.md | 59 - .../API/interfaces/TransactionSimulation.md | 41 - .../TransactionSimulationResponse.md | 33 - .../interfaces/typedData.StarkNetDomain.md | 46 - .../API/interfaces/typedData.TypedData.md | 50 - .../interfaces/types.TransactionSimulation.md | 42 - .../types.TransactionSimulationResponse.md | 34 - .../API/interfaces/uint256.Uint256.md | 28 - .../version-5.14.1/API/namespaces/RPC.md | 382 ---- .../API/namespaces/Sequencer.md | 713 ------- .../API/enums/EntryPointType.md | 37 - .../API/enums/RPC.TransactionType.md | 58 - .../API/enums/TransactionStatus.md | 67 - .../API/enums/TransactionType.md | 47 - .../version-5.19.5/API/enums/cairo.Uint.md | 68 - .../API/enums/types.RPC.TransactionType.md | 58 - .../API/interfaces/CallStruct.md | 37 - .../CommonTransactionReceiptResponse.md | 53 - .../interfaces/CommonTransactionResponse.md | 65 - .../API/interfaces/ContractEntryPoint.md | 27 - .../API/interfaces/DeclareContractResponse.md | 27 - .../API/interfaces/DeclareSignerDetails.md | 77 - .../interfaces/DeclareTransactionResponse.md | 103 - .../API/interfaces/DeployContractResponse.md | 27 - .../API/interfaces/EstimateFee.md | 69 - .../API/interfaces/EstimateFeeDetails.md | 37 - .../API/interfaces/EstimateFeeResponse.md | 53 - .../version-5.19.5/API/interfaces/Event.md | 37 - .../API/interfaces/GetBlockResponse.md | 117 -- .../API/interfaces/GetCodeResponse.md | 17 - .../interfaces/InvocationsSignerDetails.md | 85 - .../API/interfaces/InvokeFunctionResponse.md | 17 - .../InvokeTransactionReceiptResponse.md | 103 - .../interfaces/InvokeTransactionResponse.md | 123 -- .../API/interfaces/MessageToL1.md | 27 - .../API/interfaces/MessageToL2.md | 27 - .../version-5.19.5/API/interfaces/Program.md | 33 - .../API/interfaces/ProviderOptions.md | 27 - ...encer.InvokeFunctionTransactionResponse.md | 146 -- .../API/interfaces/StateUpdateResponse.md | 59 - .../API/interfaces/TransactionSimulation.md | 41 - .../TransactionSimulationResponse.md | 33 - .../interfaces/typedData.StarkNetDomain.md | 46 - .../API/interfaces/typedData.TypedData.md | 50 - .../types.CommonTransactionReceiptResponse.md | 54 - .../interfaces/types.TransactionSimulation.md | 42 - .../types.TransactionSimulationResponse.md | 34 - .../API/interfaces/uint256.Uint256.md | 28 - .../version-5.19.5/API/namespaces/RPC.md | 382 ---- .../API/namespaces/Sequencer.md | 713 ------- 220 files changed, 6 insertions(+), 30509 deletions(-) delete mode 100644 .github/workflows/push-docs-build-commit.yml create mode 100644 www/docs/API/.gitkeep delete mode 100644 www/docs/API/_category_.yml delete mode 100644 www/docs/API/classes/Account.md delete mode 100644 www/docs/API/classes/AccountInterface.md delete mode 100644 www/docs/API/classes/CairoCustomEnum.md delete mode 100644 www/docs/API/classes/CairoOption.md delete mode 100644 www/docs/API/classes/CairoResult.md delete mode 100644 www/docs/API/classes/CallData.md delete mode 100644 www/docs/API/classes/Contract.md delete mode 100644 www/docs/API/classes/ContractFactory.md delete mode 100644 www/docs/API/classes/ContractInterface.md delete mode 100644 www/docs/API/classes/CustomError.md delete mode 100644 www/docs/API/classes/GatewayError.md delete mode 100644 www/docs/API/classes/HttpError.md delete mode 100644 www/docs/API/classes/LibraryError.md delete mode 100644 www/docs/API/classes/Provider.md delete mode 100644 www/docs/API/classes/ProviderInterface.md delete mode 100644 www/docs/API/classes/RpcProvider.md delete mode 100644 www/docs/API/classes/SequencerProvider.md delete mode 100644 www/docs/API/classes/Signer.md delete mode 100644 www/docs/API/classes/SignerInterface.md delete mode 100644 www/docs/API/classes/_category_.yml delete mode 100644 www/docs/API/classes/merkle.MerkleTree.md delete mode 100644 www/docs/API/enums/CairoOptionVariant.md delete mode 100644 www/docs/API/enums/CairoResultVariant.md delete mode 100644 www/docs/API/enums/EntryPointType.md delete mode 100644 www/docs/API/enums/RPC.TransactionType.md delete mode 100644 www/docs/API/enums/TransactionStatus.md delete mode 100644 www/docs/API/enums/TransactionType.md delete mode 100644 www/docs/API/enums/_category_.yml delete mode 100644 www/docs/API/enums/cairo.Uint.md delete mode 100644 www/docs/API/enums/constants.BaseUrl.md delete mode 100644 www/docs/API/enums/constants.NetworkName.md delete mode 100644 www/docs/API/enums/constants.StarknetChainId.md delete mode 100644 www/docs/API/enums/constants.TransactionHashPrefix.md delete mode 100644 www/docs/API/enums/starknetId.StarknetIdContract.md delete mode 100644 www/docs/API/enums/types.BlockStatus.md delete mode 100644 www/docs/API/enums/types.BlockTag.md delete mode 100644 www/docs/API/enums/types.EntryPointType.md delete mode 100644 www/docs/API/enums/types.Litteral.md delete mode 100644 www/docs/API/enums/types.RPC.TransactionType.md delete mode 100644 www/docs/API/enums/types.SIMULATION_FLAG.md delete mode 100644 www/docs/API/enums/types.TransactionExecutionStatus.md delete mode 100644 www/docs/API/enums/types.TransactionFinalityStatus.md delete mode 100644 www/docs/API/enums/types.TransactionStatus.md delete mode 100644 www/docs/API/enums/types.TransactionType.md delete mode 100644 www/docs/API/enums/types.Uint.md delete mode 100644 www/docs/API/enums/types.ValidateType.md delete mode 100644 www/docs/API/index.md delete mode 100644 www/docs/API/interfaces/CallStruct.md delete mode 100644 www/docs/API/interfaces/CommonTransactionReceiptResponse.md delete mode 100644 www/docs/API/interfaces/CommonTransactionResponse.md delete mode 100644 www/docs/API/interfaces/ContractEntryPoint.md delete mode 100644 www/docs/API/interfaces/DeclareContractResponse.md delete mode 100644 www/docs/API/interfaces/DeclareSignerDetails.md delete mode 100644 www/docs/API/interfaces/DeclareTransactionResponse.md delete mode 100644 www/docs/API/interfaces/DeployContractResponse.md delete mode 100644 www/docs/API/interfaces/EstimateFee.md delete mode 100644 www/docs/API/interfaces/EstimateFeeDetails.md delete mode 100644 www/docs/API/interfaces/EstimateFeeResponse.md delete mode 100644 www/docs/API/interfaces/Event.md delete mode 100644 www/docs/API/interfaces/GetBlockResponse.md delete mode 100644 www/docs/API/interfaces/GetCodeResponse.md delete mode 100644 www/docs/API/interfaces/InvocationsSignerDetails.md delete mode 100644 www/docs/API/interfaces/InvokeFunctionResponse.md delete mode 100644 www/docs/API/interfaces/InvokeTransactionReceiptResponse.md delete mode 100644 www/docs/API/interfaces/InvokeTransactionResponse.md delete mode 100644 www/docs/API/interfaces/MessageToL1.md delete mode 100644 www/docs/API/interfaces/MessageToL2.md delete mode 100644 www/docs/API/interfaces/Program.md delete mode 100644 www/docs/API/interfaces/ProviderOptions.md delete mode 100644 www/docs/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md delete mode 100644 www/docs/API/interfaces/StateUpdateResponse.md delete mode 100644 www/docs/API/interfaces/TransactionSimulation.md delete mode 100644 www/docs/API/interfaces/TransactionSimulationResponse.md delete mode 100644 www/docs/API/interfaces/_category_.yml delete mode 100644 www/docs/API/interfaces/ec.weierstrass.ProjConstructor.md delete mode 100644 www/docs/API/interfaces/ec.weierstrass.ProjPointType.md delete mode 100644 www/docs/API/interfaces/ec.weierstrass.SignatureType.md delete mode 100644 www/docs/API/interfaces/typedData.StarkNetDomain.md delete mode 100644 www/docs/API/interfaces/typedData.TypedData.md delete mode 100644 www/docs/API/interfaces/types.CallStruct.md delete mode 100644 www/docs/API/interfaces/types.CommonTransactionReceiptResponse.md delete mode 100644 www/docs/API/interfaces/types.CommonTransactionResponse.md delete mode 100644 www/docs/API/interfaces/types.ContractEntryPoint.md delete mode 100644 www/docs/API/interfaces/types.DeclareContractResponse.md delete mode 100644 www/docs/API/interfaces/types.DeclareSignerDetails.md delete mode 100644 www/docs/API/interfaces/types.DeclareTransactionResponse.md delete mode 100644 www/docs/API/interfaces/types.DeployContractResponse.md delete mode 100644 www/docs/API/interfaces/types.EstimateFee.md delete mode 100644 www/docs/API/interfaces/types.EstimateFeeDetails.md delete mode 100644 www/docs/API/interfaces/types.EstimateFeeResponse.md delete mode 100644 www/docs/API/interfaces/types.Event.md delete mode 100644 www/docs/API/interfaces/types.GetBlockResponse.md delete mode 100644 www/docs/API/interfaces/types.GetCodeResponse.md delete mode 100644 www/docs/API/interfaces/types.InvocationsSignerDetails.md delete mode 100644 www/docs/API/interfaces/types.InvokeFunctionResponse.md delete mode 100644 www/docs/API/interfaces/types.InvokeTransactionReceiptResponse.md delete mode 100644 www/docs/API/interfaces/types.InvokeTransactionResponse.md delete mode 100644 www/docs/API/interfaces/types.MessageToL1.md delete mode 100644 www/docs/API/interfaces/types.MessageToL2.md delete mode 100644 www/docs/API/interfaces/types.Program.md delete mode 100644 www/docs/API/interfaces/types.ProviderOptions.md delete mode 100644 www/docs/API/interfaces/types.Sequencer.InvokeFunctionTransactionResponse.md delete mode 100644 www/docs/API/interfaces/types.StarkNetDomain.md delete mode 100644 www/docs/API/interfaces/types.StateUpdateResponse.md delete mode 100644 www/docs/API/interfaces/types.TransactionSimulation.md delete mode 100644 www/docs/API/interfaces/types.TransactionSimulationResponse.md delete mode 100644 www/docs/API/interfaces/types.TypedData.md delete mode 100644 www/docs/API/interfaces/types.Uint256.md delete mode 100644 www/docs/API/interfaces/uint256.Uint256.md delete mode 100644 www/docs/API/modules.md delete mode 100644 www/docs/API/namespaces/RPC.md delete mode 100644 www/docs/API/namespaces/Sequencer.md delete mode 100644 www/docs/API/namespaces/_category_.yml delete mode 100644 www/docs/API/namespaces/cairo.md delete mode 100644 www/docs/API/namespaces/constants.md delete mode 100644 www/docs/API/namespaces/ec.md delete mode 100644 www/docs/API/namespaces/ec.starkCurve.md delete mode 100644 www/docs/API/namespaces/ec.weierstrass.md delete mode 100644 www/docs/API/namespaces/encode.md delete mode 100644 www/docs/API/namespaces/events.md delete mode 100644 www/docs/API/namespaces/hash.md delete mode 100644 www/docs/API/namespaces/hash.poseidon.md delete mode 100644 www/docs/API/namespaces/json.md delete mode 100644 www/docs/API/namespaces/merkle.md delete mode 100644 www/docs/API/namespaces/num.md delete mode 100644 www/docs/API/namespaces/provider-1.md delete mode 100644 www/docs/API/namespaces/selector.md delete mode 100644 www/docs/API/namespaces/shortString.md delete mode 100644 www/docs/API/namespaces/stark.md delete mode 100644 www/docs/API/namespaces/starknetId.md delete mode 100644 www/docs/API/namespaces/transaction.md delete mode 100644 www/docs/API/namespaces/typedData.md delete mode 100644 www/docs/API/namespaces/types.RPC.md delete mode 100644 www/docs/API/namespaces/types.Sequencer.md delete mode 100644 www/docs/API/namespaces/types.md delete mode 100644 www/docs/API/namespaces/uint256.md delete mode 100644 www/versioned_docs/version-5.14.1/API/enums/EntryPointType.md delete mode 100644 www/versioned_docs/version-5.14.1/API/enums/RPC.TransactionType.md delete mode 100644 www/versioned_docs/version-5.14.1/API/enums/TransactionStatus.md delete mode 100644 www/versioned_docs/version-5.14.1/API/enums/TransactionType.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/CallStruct.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/CommonTransactionReceiptResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/CommonTransactionResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/ContractEntryPoint.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/DeclareContractResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/DeclareSignerDetails.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/DeclareTransactionResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/DeployContractResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/EstimateFee.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/EstimateFeeDetails.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/EstimateFeeResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/Event.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/GetBlockResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/GetCodeResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/InvocationsSignerDetails.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/InvokeFunctionResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/InvokeTransactionReceiptResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/InvokeTransactionResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/MessageToL1.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/MessageToL2.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/Program.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/ProviderOptions.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/StateUpdateResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/TransactionSimulation.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/TransactionSimulationResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/typedData.StarkNetDomain.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/typedData.TypedData.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/types.TransactionSimulation.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/types.TransactionSimulationResponse.md delete mode 100644 www/versioned_docs/version-5.14.1/API/interfaces/uint256.Uint256.md delete mode 100644 www/versioned_docs/version-5.14.1/API/namespaces/RPC.md delete mode 100644 www/versioned_docs/version-5.14.1/API/namespaces/Sequencer.md delete mode 100644 www/versioned_docs/version-5.19.5/API/enums/EntryPointType.md delete mode 100644 www/versioned_docs/version-5.19.5/API/enums/RPC.TransactionType.md delete mode 100644 www/versioned_docs/version-5.19.5/API/enums/TransactionStatus.md delete mode 100644 www/versioned_docs/version-5.19.5/API/enums/TransactionType.md delete mode 100644 www/versioned_docs/version-5.19.5/API/enums/cairo.Uint.md delete mode 100644 www/versioned_docs/version-5.19.5/API/enums/types.RPC.TransactionType.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/CallStruct.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/CommonTransactionReceiptResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/CommonTransactionResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/ContractEntryPoint.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/DeclareContractResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/DeclareSignerDetails.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/DeclareTransactionResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/DeployContractResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/EstimateFee.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/EstimateFeeDetails.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/EstimateFeeResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/Event.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/GetBlockResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/GetCodeResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/InvocationsSignerDetails.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/InvokeFunctionResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/InvokeTransactionReceiptResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/InvokeTransactionResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/MessageToL1.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/MessageToL2.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/Program.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/ProviderOptions.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/StateUpdateResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/TransactionSimulation.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/TransactionSimulationResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/typedData.StarkNetDomain.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/typedData.TypedData.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/types.CommonTransactionReceiptResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/types.TransactionSimulation.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/types.TransactionSimulationResponse.md delete mode 100644 www/versioned_docs/version-5.19.5/API/interfaces/uint256.Uint256.md delete mode 100644 www/versioned_docs/version-5.19.5/API/namespaces/RPC.md delete mode 100644 www/versioned_docs/version-5.19.5/API/namespaces/Sequencer.md diff --git a/.github/workflows/manual-docs-version-pr.yml b/.github/workflows/manual-docs-version-pr.yml index d2bfecab1..83b9f0cf3 100644 --- a/.github/workflows/manual-docs-version-pr.yml +++ b/.github/workflows/manual-docs-version-pr.yml @@ -26,6 +26,7 @@ jobs: args=() [[ "${{ inputs.version-override }}" != "" ]] && args+=( '--version-override=${{ inputs.version-override }}' ) [[ "${{ inputs.version-override }}" != "" ]] && args+=( '--git-revision-override=v${{ inputs.version-override }}' ) + rm -rf www/docs/API/ npm run docs:build:version "${args[@]}" npm run docs:version "${args[@]}" npm run format diff --git a/.github/workflows/push-docs-build-commit.yml b/.github/workflows/push-docs-build-commit.yml deleted file mode 100644 index 32538546f..000000000 --- a/.github/workflows/push-docs-build-commit.yml +++ /dev/null @@ -1,55 +0,0 @@ -name: '[Push] Documentation Build Commit' -on: - push: - branches: - - develop - paths: - - 'src/**' - - 'www/**' - -jobs: - skip_check: - name: Skip check - runs-on: ubuntu-latest - outputs: - should_skip: ${{ steps.skip_duplicate.outputs.should_skip }} - steps: - - id: skip_duplicate - uses: fkirc/skip-duplicate-actions@v5 - with: - cancel_others: 'true' - - build_docs: - name: Documentation build - needs: [skip_check] - if: needs.skip_check.outputs.should_skip != 'true' - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - ref: ${{ github.ref }} - - uses: actions/setup-node@v3 - with: - node-version: lts/* - cache: 'npm' - - name: Setup - run: | - npm ci --ignore-scripts - cd www/ - npm ci --ignore-scripts - - name: Build - run: | - npm run docs:build - npm run format - - name: Check changes - run: | - git add www - git diff-index --cached --quiet HEAD || echo "has_changes=true" >> "$GITHUB_ENV" - echo ${{ env.has_changes }} - - name: Create commit - if: env.has_changes == 'true' - run: | - git config --global user.name 'CI' - git config --global user.email 'noreply@github.com' - git commit -m "docs: generate documentation" - git push diff --git a/tsconfig.json b/tsconfig.json index 7051f253c..dd414c37f 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -27,9 +27,9 @@ // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ /* Modules */ - "module": "commonjs" /* Specify what module code is generated. */, + "module": "Node16" /* Specify what module code is generated. */, // "rootDir": "./", /* Specify the root folder within your source files. */ - "moduleResolution": "node16" /* Specify how TypeScript looks up a file from a given module specifier. */, + // "moduleResolution": "Node16" /* Specify how TypeScript looks up a file from a given module specifier. */, // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ diff --git a/www/.gitignore b/www/.gitignore index b2d6de306..d73bc5a17 100644 --- a/www/.gitignore +++ b/www/.gitignore @@ -7,6 +7,8 @@ # Generated files .docusaurus .cache-loader +/docs/API/* +!/docs/API/.gitkeep # Misc .DS_Store diff --git a/www/docs/API/.gitkeep b/www/docs/API/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/www/docs/API/_category_.yml b/www/docs/API/_category_.yml deleted file mode 100644 index 3c0dfeba4..000000000 --- a/www/docs/API/_category_.yml +++ /dev/null @@ -1 +0,0 @@ -label: 'API' diff --git a/www/docs/API/classes/Account.md b/www/docs/API/classes/Account.md deleted file mode 100644 index 75d4aee33..000000000 --- a/www/docs/API/classes/Account.md +++ /dev/null @@ -1,1707 +0,0 @@ ---- -id: 'Account' -title: 'Class: Account' -sidebar_label: 'Account' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`Provider`](Provider.md) - - ↳ **`Account`** - -## Implements - -- [`AccountInterface`](AccountInterface.md) - -## Constructors - -### constructor - -• **new Account**(`providerOrOptions`, `address`, `pkOrSigner`, `cairoVersion?`) - -#### Parameters - -| Name | Type | -| :------------------ | :--------------------------------------------------------------------------------------------------------- | -| `providerOrOptions` | [`ProviderOptions`](../interfaces/types.ProviderOptions.md) \| [`ProviderInterface`](ProviderInterface.md) | -| `address` | `string` | -| `pkOrSigner` | `string` \| `Uint8Array` \| [`SignerInterface`](SignerInterface.md) | -| `cairoVersion?` | [`CairoVersion`](../namespaces/types.md#cairoversion) | - -#### Overrides - -[Provider](Provider.md).[constructor](Provider.md#constructor) - -#### Defined in - -[src/account/default.ts:70](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L70) - -## Properties - -### signer - -• **signer**: [`SignerInterface`](SignerInterface.md) - -#### Implementation of - -[AccountInterface](AccountInterface.md).[signer](AccountInterface.md#signer) - -#### Defined in - -[src/account/default.ts:64](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L64) - ---- - -### address - -• **address**: `string` - -#### Implementation of - -[AccountInterface](AccountInterface.md).[address](AccountInterface.md#address) - -#### Defined in - -[src/account/default.ts:66](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L66) - ---- - -### cairoVersion - -• **cairoVersion**: [`CairoVersion`](../namespaces/types.md#cairoversion) - -#### Implementation of - -[AccountInterface](AccountInterface.md).[cairoVersion](AccountInterface.md#cairoversion) - -#### Defined in - -[src/account/default.ts:68](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L68) - ---- - -### deploySelf - -• **deploySelf**: (`__namedParameters`: [`DeployAccountContractPayload`](../namespaces/types.md#deployaccountcontractpayload), `transactionsDetail`: [`InvocationsDetails`](../namespaces/types.md#invocationsdetails)) => `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -#### Type declaration - -▸ (`«destructured»`, `transactionsDetail?`): `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -##### Parameters - -| Name | Type | -| :------------------- | :------------------------------------------------------------------------------------ | -| `«destructured»` | [`DeployAccountContractPayload`](../namespaces/types.md#deployaccountcontractpayload) | -| `transactionsDetail` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | - -##### Returns - -`Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -#### Defined in - -[src/account/default.ts:437](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L437) - -## Methods - -### getNonce - -▸ **getNonce**(`blockIdentifier?`): `Promise`<`string`\> - -Gets the nonce of the account with respect to a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :---------------------------------------------- | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | optional blockIdentifier. Defaults to 'pending' | - -#### Returns - -`Promise`<`string`\> - -nonce of the account - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getNonce](AccountInterface.md#getnonce) - -#### Defined in - -[src/account/default.ts:88](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L88) - ---- - -### getNonceSafe - -▸ `Private` **getNonceSafe**(`nonce?`): `Promise`<`bigint`\> - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------- | -| `nonce?` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<`bigint`\> - -#### Defined in - -[src/account/default.ts:92](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L92) - ---- - -### getCairoVersion - -▸ **getCairoVersion**(`classHash?`): `Promise`<[`CairoVersion`](../namespaces/types.md#cairoversion)\> - -Retrieves the Cairo version from the network and sets `cairoVersion` if not already set in the constructor - -#### Parameters - -| Name | Type | Description | -| :----------- | :------- | :----------------------------------------------------------------------------------- | -| `classHash?` | `string` | if provided detects Cairo version from classHash, otherwise from the account address | - -#### Returns - -`Promise`<[`CairoVersion`](../namespaces/types.md#cairoversion)\> - -#### Defined in - -[src/account/default.ts:105](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L105) - ---- - -### estimateFee - -▸ **estimateFee**(`calls`, `estimateFeeDetails?`): `Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -#### Parameters - -| Name | Type | -| :-------------------- | :---------------------------------------------------------------------------------------- | -| `calls` | [`AllowArray`](../namespaces/types.md#allowarray)<[`Call`](../namespaces/types.md#call)\> | -| `estimateFeeDetails?` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | - -#### Returns - -`Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -#### Defined in - -[src/account/default.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L115) - ---- - -### estimateInvokeFee - -▸ **estimateInvokeFee**(`calls`, `«destructured»?`): `Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -Estimate Fee for executing an INVOKE transaction on starknet - -#### Parameters - -| Name | Type | Description | -| :--------------- | :---------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `calls` | [`AllowArray`](../namespaces/types.md#allowarray)<[`Call`](../namespaces/types.md#call)\> | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata | -| `«destructured»` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | - | - -#### Returns - -`Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -response from estimate_fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[estimateInvokeFee](AccountInterface.md#estimateinvokefee) - -#### Defined in - -[src/account/default.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L122) - ---- - -### estimateDeclareFee - -▸ **estimateDeclareFee**(`«destructured»`, `«destructured»?`): `Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -Estimate Fee for executing a DECLARE transaction on starknet - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `«destructured»` | [`DeclareContractPayload`](../namespaces/types.md#declarecontractpayload) | the payload object containing: - contract - the compiled contract to be declared - classHash - the class hash of the compiled contract. This can be obtained by using starknet-cli. | -| `«destructured»` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | - | - -#### Returns - -`Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -response from estimate_fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[estimateDeclareFee](AccountInterface.md#estimatedeclarefee) - -#### Defined in - -[src/account/default.ts:156](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L156) - ---- - -### estimateAccountDeployFee - -▸ **estimateAccountDeployFee**(`«destructured»`, `«destructured»?`): `Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -Estimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------- | -| `«destructured»` | [`DeployAccountContractPayload`](../namespaces/types.md#deployaccountcontractpayload) | contract - the compiled contract to be deployed - classHash - the class hash of the compiled contract. This can be obtained by using starknet-cli. | -| `«destructured»` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | optional blockIdentifier - constant nonce = 0 | - -#### Returns - -`Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -response from estimate_fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[estimateAccountDeployFee](AccountInterface.md#estimateaccountdeployfee) - -#### Defined in - -[src/account/default.ts:190](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L190) - ---- - -### estimateDeployFee - -▸ **estimateDeployFee**(`payload`, `transactionsDetail?`): `Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -Estimate Fee for executing a UDC DEPLOY transaction on starknet -This is different from the normal DEPLOY transaction as it goes through the Universal Deployer Contract (UDC) - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `payload` | [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload) \| [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload)[] | containing - classHash: computed class hash of compiled contract - salt: address salt - unique: bool if true ensure unique salt - calldata: constructor calldata | -| `transactionsDetail?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | Invocation Details containing: - optional nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`EstimateFee`](../interfaces/types.EstimateFee.md)\> - -#### Implementation of - -[AccountInterface](AccountInterface.md).[estimateDeployFee](AccountInterface.md#estimatedeployfee) - -#### Defined in - -[src/account/default.ts:229](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L229) - ---- - -### estimateFeeBulk - -▸ **estimateFeeBulk**(`invocations`, `«destructured»?`): `Promise`<[`EstimateFeeBulk`](../namespaces/types.md#estimatefeebulk)\> - -Estimate Fee for executing a list of transactions on starknet -Contract must be deployed for fee estimation to be possible - -#### Parameters - -| Name | Type | -| :--------------- | :---------------------------------------------------------------- | -| `invocations` | [`Invocations`](../namespaces/types.md#invocations) | -| `«destructured»` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | - -#### Returns - -`Promise`<[`EstimateFeeBulk`](../namespaces/types.md#estimatefeebulk)\> - -response from estimate_fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[estimateFeeBulk](AccountInterface.md#estimatefeebulk) - -#### Defined in - -[src/account/default.ts:237](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L237) - ---- - -### buildInvocation - -▸ **buildInvocation**(`call`, `signerDetails`): `Promise`<[`Invocation`](../namespaces/types.md#invocation)\> - -#### Parameters - -| Name | Type | -| :-------------- | :---------------------------------------------------------------------------- | -| `call` | [`Call`](../namespaces/types.md#call)[] | -| `signerDetails` | [`InvocationsSignerDetails`](../interfaces/types.InvocationsSignerDetails.md) | - -#### Returns - -`Promise`<[`Invocation`](../namespaces/types.md#invocation)\> - -#### Defined in - -[src/account/default.ts:261](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L261) - ---- - -### execute - -▸ **execute**(`calls`, `abis?`, `transactionsDetail?`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invoke execute function in account contract - -#### Parameters - -| Name | Type | Default value | Description | -| :------------------- | :---------------------------------------------------------------------------------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `calls` | [`AllowArray`](../namespaces/types.md#allowarray)<[`Call`](../namespaces/types.md#call)\> | `undefined` | the invocation object or an array of them, containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `abis` | `undefined` \| [`Abi`](../namespaces/types.md#abi)[] | `undefined` | - | -| `transactionsDetail` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | `{}` | - | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -response from addTransaction - -#### Implementation of - -[AccountInterface](AccountInterface.md).[execute](AccountInterface.md#execute) - -#### Defined in - -[src/account/default.ts:275](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L275) - ---- - -### declareIfNot - -▸ **declareIfNot**(`payload`, `transactionsDetail?`): `Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -First check if contract is already declared, if not declare it -If contract already declared returned transaction_hash is ''. -Method will pass even if contract is already declared - -#### Parameters - -| Name | Type | Description | -| :------------------- | :------------------------------------------------------------------------ | :---------- | -| `payload` | [`DeclareContractPayload`](../namespaces/types.md#declarecontractpayload) | - | -| `transactionsDetail` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | (optional) | - -#### Returns - -`Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -#### Defined in - -[src/account/default.ts:320](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L320) - ---- - -### declare - -▸ **declare**(`payload`, `transactionsDetail?`): `Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -Declares a given compiled contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :------------------- | :------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `payload` | [`DeclareContractPayload`](../namespaces/types.md#declarecontractpayload) | transaction payload to be deployed containing: - contract: compiled contract code - (optional) classHash: computed class hash of compiled contract. Pre-compute it for faster execution. - (required for Cairo1 without compiledClassHash) casm: CompiledContract \| string; - (optional for Cairo1 with casm) compiledClassHash: compiled class hash from casm. Pre-compute it for faster execution. | -| `transactionsDetail` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | Invocation Details containing: - optional nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[AccountInterface](AccountInterface.md).[declare](AccountInterface.md#declare) - -#### Defined in - -[src/account/default.ts:336](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L336) - ---- - -### deploy - -▸ **deploy**(`payload`, `details?`): `Promise`<[`MultiDeployContractResponse`](../namespaces/types.md#multideploycontractresponse)\> - -Deploys a declared contract to starknet - using Universal Deployer Contract (UDC) -support multicall - -#### Parameters - -| Name | Type | Description | -| :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `payload` | [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload) \| [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload)[] | classHash: computed class hash of compiled contract - [constructorCalldata] contract constructor calldata - [salt=pseudorandom] deploy address salt - [unique=true] ensure unique salt | -| `details?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | [nonce=getNonce] - [version=transactionVersion] - [maxFee=getSuggestedMaxFee] | - -#### Returns - -`Promise`<[`MultiDeployContractResponse`](../namespaces/types.md#multideploycontractresponse)\> - -- contract_address[] -- transaction_hash - -#### Implementation of - -[AccountInterface](AccountInterface.md).[deploy](AccountInterface.md#deploy) - -#### Defined in - -[src/account/default.ts:365](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L365) - ---- - -### deployContract - -▸ **deployContract**(`payload`, `details?`): `Promise`<[`DeployContractUDCResponse`](../namespaces/types.md#deploycontractudcresponse)\> - -Simplify deploy simulating old DeployContract with same response + UDC specific response -Internal wait for L2 transaction, support multicall - -#### Parameters - -| Name | Type | Description | -| :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `payload` | [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload) \| [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload)[] | classHash: computed class hash of compiled contract - [constructorCalldata] contract constructor calldata - [salt=pseudorandom] deploy address salt - [unique=true] ensure unique salt | -| `details?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | [nonce=getNonce] - [version=transactionVersion] - [maxFee=getSuggestedMaxFee] | - -#### Returns - -`Promise`<[`DeployContractUDCResponse`](../namespaces/types.md#deploycontractudcresponse)\> - -- contract_address -- transaction_hash -- address -- deployer -- unique -- classHash -- calldata_len -- calldata -- salt - -#### Implementation of - -[AccountInterface](AccountInterface.md).[deployContract](AccountInterface.md#deploycontract) - -#### Defined in - -[src/account/default.ts:411](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L411) - ---- - -### declareAndDeploy - -▸ **declareAndDeploy**(`payload`, `details?`): `Promise`<[`DeclareDeployUDCResponse`](../namespaces/types.md#declaredeployudcresponse)\> - -Declares and Deploy a given compiled contract (json) to starknet using UDC -Internal wait for L2 transaction, do not support multicall -Method will pass even if contract is already declared (internal using DeclareIfNot) - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `payload` | [`DeclareAndDeployContractPayload`](../namespaces/types.md#declareanddeploycontractpayload) | contract: compiled contract code - [casm=cairo1]: CairoAssembly \| undefined; - [compiledClassHash]: string \| undefined; - [classHash]: computed class hash of compiled contract - [constructorCalldata] contract constructor calldata - [salt=pseudorandom] deploy address salt - [unique=true] ensure unique salt | -| `details?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | [nonce=getNonce] - [version=transactionVersion] - [maxFee=getSuggestedMaxFee] | - -#### Returns - -`Promise`<[`DeclareDeployUDCResponse`](../namespaces/types.md#declaredeployudcresponse)\> - -- declare - - transaction_hash -- deploy - - contract_address - - transaction_hash - - address - - deployer - - unique - - classHash - - calldata_len - - calldata - - salt - -#### Implementation of - -[AccountInterface](AccountInterface.md).[declareAndDeploy](AccountInterface.md#declareanddeploy) - -#### Defined in - -[src/account/default.ts:420](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L420) - ---- - -### deployAccount - -▸ **deployAccount**(`«destructured»`, `transactionsDetail?`): `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -Deploy the account on Starknet - -#### Parameters - -| Name | Type | Description | -| :------------------- | :------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `«destructured»` | [`DeployAccountContractPayload`](../namespaces/types.md#deployaccountcontractpayload) | transaction payload to be deployed containing: - classHash: computed class hash of compiled contract - optional constructor calldata - optional address salt - optional contractAddress | -| `transactionsDetail` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | Invocation Details containing: - constant nonce = 0 - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[AccountInterface](AccountInterface.md).[deployAccount](AccountInterface.md#deployaccount) - -#### Defined in - -[src/account/default.ts:439](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L439) - ---- - -### signMessage - -▸ **signMessage**(`typedData`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Sign an JSON object for off-chain usage with the starknet private key and return the signature -This adds a message prefix so it cant be interchanged with transactions - -**`Throws`** - -if the JSON object is not a valid JSON - -#### Parameters - -| Name | Type | -| :---------- | :---------------------------------------------- | -| `typedData` | [`TypedData`](../interfaces/types.TypedData.md) | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -the signature of the JSON object - -#### Implementation of - -[AccountInterface](AccountInterface.md).[signMessage](AccountInterface.md#signmessage) - -#### Defined in - -[src/account/default.ts:493](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L493) - ---- - -### hashMessage - -▸ **hashMessage**(`typedData`): `Promise`<`string`\> - -Hash a JSON object with pederson hash and return the hash -This adds a message prefix so it cant be interchanged with transactions - -**`Throws`** - -if the JSON object is not a valid JSON - -#### Parameters - -| Name | Type | -| :---------- | :---------------------------------------------- | -| `typedData` | [`TypedData`](../interfaces/types.TypedData.md) | - -#### Returns - -`Promise`<`string`\> - -the hash of the JSON object - -#### Implementation of - -[AccountInterface](AccountInterface.md).[hashMessage](AccountInterface.md#hashmessage) - -#### Defined in - -[src/account/default.ts:497](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L497) - ---- - -### verifyMessageHash - -▸ **verifyMessageHash**(`hash`, `signature`): `Promise`<`boolean`\> - -Verify a signature of a given hash - -**`Warning`** - -This method is not recommended, use verifyMessage instead - -**`Throws`** - -if the signature is not a valid signature - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------------------------------------------------- | :-------------------- | -| `hash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | hash to be verified | -| `signature` | [`Signature`](../namespaces/types.md#signature) | signature of the hash | - -#### Returns - -`Promise`<`boolean`\> - -true if the signature is valid, false otherwise - -#### Implementation of - -[AccountInterface](AccountInterface.md).[verifyMessageHash](AccountInterface.md#verifymessagehash) - -#### Defined in - -[src/account/default.ts:501](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L501) - ---- - -### verifyMessage - -▸ **verifyMessage**(`typedData`, `signature`): `Promise`<`boolean`\> - -Verify a signature of a JSON object - -**`Throws`** - -if the JSON object is not a valid JSON or the signature is not a valid signature - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :--------------------------- | -| `typedData` | [`TypedData`](../interfaces/types.TypedData.md) | JSON object to be verified | -| `signature` | [`Signature`](../namespaces/types.md#signature) | signature of the JSON object | - -#### Returns - -`Promise`<`boolean`\> - -true if the signature is valid, false otherwise - -#### Implementation of - -[AccountInterface](AccountInterface.md).[verifyMessage](AccountInterface.md#verifymessage) - -#### Defined in - -[src/account/default.ts:517](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L517) - ---- - -### getSuggestedMaxFee - -▸ **getSuggestedMaxFee**(`«destructured»`, `details`): `Promise`<`bigint`\> - -Gets Suggested Max Fee based on the transaction type - -#### Parameters - -| Name | Type | -| :--------------- | :---------------------------------------------------------------- | -| `«destructured»` | [`EstimateFeeAction`](../namespaces/types.md#estimatefeeaction) | -| `details` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | - -#### Returns - -`Promise`<`bigint`\> - -suggestedMaxFee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getSuggestedMaxFee](AccountInterface.md#getsuggestedmaxfee) - -#### Defined in - -[src/account/default.ts:522](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L522) - ---- - -### buildDeclarePayload - -▸ **buildDeclarePayload**(`payload`, `«destructured»`): `Promise`<[`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction)\> - -will be renamed to buildDeclareContractTransaction - -#### Parameters - -| Name | Type | -| :--------------- | :---------------------------------------------------------------------------- | -| `payload` | [`DeclareContractPayload`](../namespaces/types.md#declarecontractpayload) | -| `«destructured»` | [`InvocationsSignerDetails`](../interfaces/types.InvocationsSignerDetails.md) | - -#### Returns - -`Promise`<[`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction)\> - -#### Defined in - -[src/account/default.ts:556](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L556) - ---- - -### buildAccountDeployPayload - -▸ **buildAccountDeployPayload**(`«destructured»`, `«destructured»`): `Promise`<[`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction)\> - -#### Parameters - -| Name | Type | -| :--------------- | :------------------------------------------------------------------------------------ | -| `«destructured»` | [`DeployAccountContractPayload`](../namespaces/types.md#deployaccountcontractpayload) | -| `«destructured»` | [`InvocationsSignerDetails`](../interfaces/types.InvocationsSignerDetails.md) | - -#### Returns - -`Promise`<[`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction)\> - -#### Defined in - -[src/account/default.ts:580](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L580) - ---- - -### buildUDCContractPayload - -▸ **buildUDCContractPayload**(`payload`): [`Call`](../namespaces/types.md#call)[] - -#### Parameters - -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `payload` | [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload) \| [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload)[] | - -#### Returns - -[`Call`](../namespaces/types.md#call)[] - -#### Defined in - -[src/account/default.ts:613](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L613) - ---- - -### simulateTransaction - -▸ **simulateTransaction**(`invocations`, `«destructured»?`): `Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -Simulates an array of transaction and returns an array of transaction trace and estimated fee. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :-------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------- | -| `invocations` | [`Invocations`](../namespaces/types.md#invocations) | Invocations containing: - type - transaction type: DECLARE, (multi)DEPLOY, DEPLOY_ACCOUNT, (multi)INVOKE_FUNCTION | -| `«destructured»` | [`SimulateTransactionDetails`](../namespaces/types.md#simulatetransactiondetails) | SimulateTransactionDetails | - -#### Returns - -`Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -response from simulate_transaction - -#### Implementation of - -[AccountInterface](AccountInterface.md).[simulateTransaction](AccountInterface.md#simulatetransaction) - -#### Defined in - -[src/account/default.ts:640](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L640) - ---- - -### accountInvocationsFactory - -▸ **accountInvocationsFactory**(`invocations`, `«destructured»`): `Promise`<[`AccountInvocations`](../namespaces/types.md#accountinvocations)\> - -#### Parameters - -| Name | Type | -| :--------------- | :-------------------------------------------------------------------------------------------- | -| `invocations` | [`Invocations`](../namespaces/types.md#invocations) | -| `«destructured»` | [`AccountInvocationsFactoryDetails`](../namespaces/types.md#accountinvocationsfactorydetails) | - -#### Returns - -`Promise`<[`AccountInvocations`](../namespaces/types.md#accountinvocations)\> - -#### Defined in - -[src/account/default.ts:657](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L657) - ---- - -### getStarkName - -▸ **getStarkName**(`address?`, `StarknetIdContract?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------------- | :---------------------------------------------------- | -| `address` | [`BigNumberish`](../namespaces/types.md#bignumberish) | -| `StarknetIdContract?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Overrides - -[Provider](Provider.md).[getStarkName](Provider.md#getstarkname) - -#### Defined in - -[src/account/default.ts:732](https://github.com/0xs34n/starknet.js/blob/develop/src/account/default.ts#L732) - ---- - -### getChainId - -▸ **getChainId**(): `Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -Gets the Starknet chain Id - -#### Returns - -`Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -the chain Id - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getChainId](AccountInterface.md#getchainid) - -#### Inherited from - -[Provider](Provider.md).[getChainId](Provider.md#getchainid) - -#### Defined in - -[src/provider/default.ts:65](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L65) - ---- - -### getBlock - -▸ **getBlock**(`blockIdentifier`): `Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -Gets the block information - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -the block object - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getBlock](AccountInterface.md#getblock) - -#### Inherited from - -[Provider](Provider.md).[getBlock](Provider.md#getblock) - -#### Defined in - -[src/provider/default.ts:69](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L69) - ---- - -### getClassAt - -▸ **getClassAt**(`contractAddress`, `blockIdentifier?`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Gets the contract class of the deployed contract. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getClassAt](AccountInterface.md#getclassat) - -#### Inherited from - -[Provider](Provider.md).[getClassAt](Provider.md#getclassat) - -#### Defined in - -[src/provider/default.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L73) - ---- - -### getClassHashAt - -▸ **getClassHashAt**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Returns the class hash deployed under the given address. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -Class hash - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getClassHashAt](AccountInterface.md#getclasshashat) - -#### Inherited from - -[Provider](Provider.md).[getClassHashAt](Provider.md#getclasshashat) - -#### Defined in - -[src/provider/default.ts:80](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L80) - ---- - -### getClassByHash - -▸ **getClassByHash**(`classHash`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Returns the contract class deployed under the given class hash. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------- | :---------- | -| `classHash` | `string` | class hash | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getClassByHash](AccountInterface.md#getclassbyhash) - -#### Inherited from - -[Provider](Provider.md).[getClassByHash](Provider.md#getclassbyhash) - -#### Defined in - -[src/provider/default.ts:87](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L87) - ---- - -### getEstimateFee - -▸ **getEstimateFee**(`invocationWithTxType`, `invocationDetails`, `blockIdentifier`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -**`Deprecated`** - -Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :--------------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocationWithTxType` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `invocationDetails` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getEstimateFee](AccountInterface.md#getestimatefee) - -#### Inherited from - -[Provider](Provider.md).[getEstimateFee](Provider.md#getestimatefee) - -#### Defined in - -[src/provider/default.ts:91](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L91) - ---- - -### getInvokeEstimateFee - -▸ **getInvokeEstimateFee**(`invocationWithTxType`, `invocationDetails`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :--------------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocationWithTxType` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `invocationDetails` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getInvokeEstimateFee](AccountInterface.md#getinvokeestimatefee) - -#### Inherited from - -[Provider](Provider.md).[getInvokeEstimateFee](Provider.md#getinvokeestimatefee) - -#### Defined in - -[src/provider/default.ts:99](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L99) - ---- - -### getEstimateFeeBulk - -▸ **getEstimateFeeBulk**(`invocations`, `options`): `Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -Estimates the fee for a list of INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------- | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `options` | [`getEstimateFeeBulkOptions`](../namespaces/types.md#getestimatefeebulkoptions) | getEstimateFeeBulkOptions - (optional) blockIdentifier - BlockIdentifier - (optional) skipValidate - boolean (default false) | - -#### Returns - -`Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -the estimated fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getEstimateFeeBulk](AccountInterface.md#getestimatefeebulk) - -#### Inherited from - -[Provider](Provider.md).[getEstimateFeeBulk](Provider.md#getestimatefeebulk) - -#### Defined in - -[src/provider/default.ts:113](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L113) - ---- - -### getNonceForAddress - -▸ **getNonceForAddress**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the nonce of a contract with respect to a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - | - -#### Returns - -`Promise`<`string`\> - -the hex nonce - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getNonceForAddress](AccountInterface.md#getnonceforaddress) - -#### Inherited from - -[Provider](Provider.md).[getNonceForAddress](Provider.md#getnonceforaddress) - -#### Defined in - -[src/provider/default.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L120) - ---- - -### getStorageAt - -▸ **getStorageAt**(`contractAddress`, `key`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the contract's storage variable at a specific key. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------------------------------------------------- | -| `contractAddress` | `string` | | -| `key` | [`BigNumberish`](../namespaces/types.md#bignumberish) | from getStorageVarAddress('') (WIP) | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -the value of the storage variable - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getStorageAt](AccountInterface.md#getstorageat) - -#### Inherited from - -[Provider](Provider.md).[getStorageAt](Provider.md#getstorageat) - -#### Defined in - -[src/provider/default.ts:127](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L127) - ---- - -### getTransaction - -▸ **getTransaction**(`txHash`): `Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -Gets the transaction information from a tx id. - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? } - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getTransaction](AccountInterface.md#gettransaction) - -#### Inherited from - -[Provider](Provider.md).[getTransaction](Provider.md#gettransaction) - -#### Defined in - -[src/provider/default.ts:135](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L135) - ---- - -### getTransactionReceipt - -▸ **getTransactionReceipt**(`txHash`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Gets the transaction receipt from a tx hash. - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -the transaction receipt object - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getTransactionReceipt](AccountInterface.md#gettransactionreceipt) - -#### Inherited from - -[Provider](Provider.md).[getTransactionReceipt](Provider.md#gettransactionreceipt) - -#### Defined in - -[src/provider/default.ts:139](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L139) - ---- - -### callContract - -▸ **callContract**(`request`, `blockIdentifier?`): `Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -Calls a function on the Starknet contract. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :----------------------- | -| `request` | [`Call`](../namespaces/types.md#call) | transaction to be called | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -the result of the function on the smart contract. - -#### Implementation of - -[AccountInterface](AccountInterface.md).[callContract](AccountInterface.md#callcontract) - -#### Inherited from - -[Provider](Provider.md).[callContract](Provider.md#callcontract) - -#### Defined in - -[src/provider/default.ts:143](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L143) - ---- - -### invokeFunction - -▸ **invokeFunction**(`functionInvocation`, `details`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invokes a function on starknet - -**`Deprecated`** - -This method wont be supported as soon as fees are mandatory. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :------------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `functionInvocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version - maxFee - optional maxFee | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -response from addTransaction - -#### Implementation of - -[AccountInterface](AccountInterface.md).[invokeFunction](AccountInterface.md#invokefunction) - -#### Inherited from - -[Provider](Provider.md).[invokeFunction](Provider.md#invokefunction) - -#### Defined in - -[src/provider/default.ts:150](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L150) - ---- - -### deployAccountContract - -▸ **deployAccountContract**(`payload`, `details`): `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -Deploys a given compiled Account contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :-------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ | -| `payload` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | payload to be deployed containing: - compiled contract code - constructor calldata - address salt | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | - | - -#### Returns - -`Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[AccountInterface](AccountInterface.md).[deployAccountContract](AccountInterface.md#deployaccountcontract) - -#### Inherited from - -[Provider](Provider.md).[deployAccountContract](Provider.md#deployaccountcontract) - -#### Defined in - -[src/provider/default.ts:157](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L157) - ---- - -### declareContract - -▸ **declareContract**(`transaction`, `details`): `Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -Declares a given compiled contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | -| `transaction` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be deployed containing: - compiled contract code - sender address - signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | Invocation Details containing: - nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[AccountInterface](AccountInterface.md).[declareContract](AccountInterface.md#declarecontract) - -#### Inherited from - -[Provider](Provider.md).[declareContract](Provider.md#declarecontract) - -#### Defined in - -[src/provider/default.ts:164](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L164) - ---- - -### getDeclareEstimateFee - -▸ **getDeclareEstimateFee**(`transaction`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DECLARE transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------ | -| `transaction` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be declared containing: - compiled contract code - sender address - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getDeclareEstimateFee](AccountInterface.md#getdeclareestimatefee) - -#### Inherited from - -[Provider](Provider.md).[getDeclareEstimateFee](Provider.md#getdeclareestimatefee) - -#### Defined in - -[src/provider/default.ts:171](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L171) - ---- - -### getDeployAccountEstimateFee - -▸ **getDeployAccountEstimateFee**(`transaction`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DEPLOY_ACCOUNT transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | -| `transaction` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | transaction payload to be deployed containing: - classHash - constructorCalldata - addressSalt - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getDeployAccountEstimateFee](AccountInterface.md#getdeployaccountestimatefee) - -#### Inherited from - -[Provider](Provider.md).[getDeployAccountEstimateFee](Provider.md#getdeployaccountestimatefee) - -#### Defined in - -[src/provider/default.ts:180](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L180) - ---- - -### getCode - -▸ **getCode**(`contractAddress`, `blockIdentifier?`): `Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -**`Deprecated`** - -The method should not be used - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------- | -| `contractAddress` | `string` | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getCode](AccountInterface.md#getcode) - -#### Inherited from - -[Provider](Provider.md).[getCode](Provider.md#getcode) - -#### Defined in - -[src/provider/default.ts:194](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L194) - ---- - -### waitForTransaction - -▸ **waitForTransaction**(`txHash`, `options?`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Wait for the transaction to be accepted - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | transaction hash | -| `options?` | [`waitForTransactionOptions`](../namespaces/types.md#waitfortransactionoptions) | waitForTransactionOptions - (optional) retryInterval: number \| undefined; - (optional) successStates: TransactionStatus[] \| undefined; | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -GetTransactionReceiptResponse - -#### Implementation of - -[AccountInterface](AccountInterface.md).[waitForTransaction](AccountInterface.md#waitfortransaction) - -#### Inherited from - -[Provider](Provider.md).[waitForTransaction](Provider.md#waitfortransaction) - -#### Defined in - -[src/provider/default.ts:201](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L201) - ---- - -### getSimulateTransaction - -▸ **getSimulateTransaction**(`invocations`, `options?`): `Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -Simulates the transaction and returns the transaction trace and estimated fee. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `options?` | [`getSimulateTransactionOptions`](../namespaces/types.md#getsimulatetransactionoptions) | getSimulateTransactionOptions - (optional) blockIdentifier - block identifier - (optional) skipValidate - skip cairo **validate** method - (optional) skipExecute - skip cairo **execute** method | - -#### Returns - -`Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -an array of transaction trace and estimated fee - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getSimulateTransaction](AccountInterface.md#getsimulatetransaction) - -#### Inherited from - -[Provider](Provider.md).[getSimulateTransaction](Provider.md#getsimulatetransaction) - -#### Defined in - -[src/provider/default.ts:208](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L208) - ---- - -### getStateUpdate - -▸ **getStateUpdate**(`blockIdentifier?`): `Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -Gets the state changes in a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -StateUpdateResponse - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getStateUpdate](AccountInterface.md#getstateupdate) - -#### Inherited from - -[Provider](Provider.md).[getStateUpdate](Provider.md#getstateupdate) - -#### Defined in - -[src/provider/default.ts:215](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L215) - ---- - -### getAddressFromStarkName - -▸ **getAddressFromStarkName**(`name`, `StarknetIdContract?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------------- | :------- | -| `name` | `string` | -| `StarknetIdContract?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Inherited from - -[Provider](Provider.md).[getAddressFromStarkName](Provider.md#getaddressfromstarkname) - -#### Defined in - -[src/provider/default.ts:223](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L223) - ---- - -### getContractVersion - -▸ **getContractVersion**(`contractAddress`, `classHash?`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `string` | string | -| `classHash?` | `undefined` | undefined | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getContractVersion](AccountInterface.md#getcontractversion) - -#### Inherited from - -[Provider](Provider.md).[getContractVersion](Provider.md#getcontractversion) - -#### Defined in - -[src/provider/default.ts:227](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L227) - -▸ **getContractVersion**(`contractAddress`, `classHash`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `undefined` | undefined | -| `classHash` | `string` | | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Implementation of - -[AccountInterface](AccountInterface.md).[getContractVersion](AccountInterface.md#getcontractversion) - -#### Inherited from - -[Provider](Provider.md).[getContractVersion](Provider.md#getcontractversion) - -#### Defined in - -[src/provider/default.ts:232](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L232) diff --git a/www/docs/API/classes/AccountInterface.md b/www/docs/API/classes/AccountInterface.md deleted file mode 100644 index 370683938..000000000 --- a/www/docs/API/classes/AccountInterface.md +++ /dev/null @@ -1,1246 +0,0 @@ ---- -id: 'AccountInterface' -title: 'Class: AccountInterface' -sidebar_label: 'AccountInterface' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`ProviderInterface`](ProviderInterface.md) - - ↳ **`AccountInterface`** - -## Implemented by - -- [`Account`](Account.md) - -## Constructors - -### constructor - -• **new AccountInterface**() - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[constructor](ProviderInterface.md#constructor) - -## Properties - -### address - -• `Abstract` **address**: `string` - -#### Defined in - -[src/account/interface.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L34) - ---- - -### signer - -• `Abstract` **signer**: [`SignerInterface`](SignerInterface.md) - -#### Defined in - -[src/account/interface.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L36) - ---- - -### cairoVersion - -• `Abstract` **cairoVersion**: [`CairoVersion`](../namespaces/types.md#cairoversion) - -#### Defined in - -[src/account/interface.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L38) - -## Methods - -### estimateInvokeFee - -▸ `Abstract` **estimateInvokeFee**(`calls`, `estimateFeeDetails?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimate Fee for executing an INVOKE transaction on starknet - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `calls` | [`AllowArray`](../namespaces/types.md#allowarray)<[`Call`](../namespaces/types.md#call)\> | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata | -| `estimateFeeDetails?` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | - | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -response from estimate_fee - -#### Defined in - -[src/account/interface.ts:50](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L50) - ---- - -### estimateDeclareFee - -▸ `Abstract` **estimateDeclareFee**(`contractPayload`, `estimateFeeDetails?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimate Fee for executing a DECLARE transaction on starknet - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractPayload` | [`DeclareContractPayload`](../namespaces/types.md#declarecontractpayload) | the payload object containing: - contract - the compiled contract to be declared - classHash - the class hash of the compiled contract. This can be obtained by using starknet-cli. | -| `estimateFeeDetails?` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | - | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -response from estimate_fee - -#### Defined in - -[src/account/interface.ts:64](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L64) - ---- - -### estimateAccountDeployFee - -▸ `Abstract` **estimateAccountDeployFee**(`contractPayload`, `estimateFeeDetails?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractPayload` | [`DeployAccountContractPayload`](../namespaces/types.md#deployaccountcontractpayload) | contract - the compiled contract to be deployed - classHash - the class hash of the compiled contract. This can be obtained by using starknet-cli. | -| `estimateFeeDetails?` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | optional blockIdentifier - constant nonce = 0 | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -response from estimate_fee - -#### Defined in - -[src/account/interface.ts:80](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L80) - ---- - -### estimateDeployFee - -▸ `Abstract` **estimateDeployFee**(`deployContractPayload`, `transactionsDetail?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimate Fee for executing a UDC DEPLOY transaction on starknet -This is different from the normal DEPLOY transaction as it goes through the Universal Deployer Contract (UDC) - -#### Parameters - -| Name | Type | Description | -| :---------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `deployContractPayload` | [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload) \| [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload)[] | containing - classHash: computed class hash of compiled contract - salt: address salt - unique: bool if true ensure unique salt - calldata: constructor calldata | -| `transactionsDetail?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | Invocation Details containing: - optional nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -#### Defined in - -[src/account/interface.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L100) - ---- - -### estimateFeeBulk - -▸ `Abstract` **estimateFeeBulk**(`invocations`, `details?`): `Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -Estimate Fee for executing a list of transactions on starknet -Contract must be deployed for fee estimation to be possible - -#### Parameters - -| Name | Type | -| :------------ | :---------------------------------------------------------------- | -| `invocations` | [`Invocations`](../namespaces/types.md#invocations) | -| `details?` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | - -#### Returns - -`Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -response from estimate_fee - -#### Defined in - -[src/account/interface.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L115) - ---- - -### execute - -▸ `Abstract` **execute**(`transactions`, `abis?`, `transactionsDetail?`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invoke execute function in account contract - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :---------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `transactions` | [`AllowArray`](../namespaces/types.md#allowarray)<[`Call`](../namespaces/types.md#call)\> | the invocation object or an array of them, containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `abis?` | [`Abi`](../namespaces/types.md#abi)[] | - | -| `transactionsDetail?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | - | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -response from addTransaction - -#### Defined in - -[src/account/interface.ts:132](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L132) - ---- - -### declare - -▸ `Abstract` **declare**(`contractPayload`, `transactionsDetail?`): `Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -Declares a given compiled contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractPayload` | [`DeclareContractPayload`](../namespaces/types.md#declarecontractpayload) | transaction payload to be deployed containing: - contract: compiled contract code - (optional) classHash: computed class hash of compiled contract. Pre-compute it for faster execution. - (required for Cairo1 without compiledClassHash) casm: CompiledContract \| string; - (optional for Cairo1 with casm) compiledClassHash: compiled class hash from casm. Pre-compute it for faster execution. | -| `transactionsDetail?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | Invocation Details containing: - optional nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Defined in - -[src/account/interface.ts:152](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L152) - ---- - -### deploy - -▸ `Abstract` **deploy**(`payload`, `details?`): `Promise`<[`MultiDeployContractResponse`](../namespaces/types.md#multideploycontractresponse)\> - -Deploys a declared contract to starknet - using Universal Deployer Contract (UDC) -support multicall - -#### Parameters - -| Name | Type | Description | -| :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `payload` | [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload) \| [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload)[] | classHash: computed class hash of compiled contract - [constructorCalldata] contract constructor calldata - [salt=pseudorandom] deploy address salt - [unique=true] ensure unique salt | -| `details?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | [nonce=getNonce] - [version=transactionVersion] - [maxFee=getSuggestedMaxFee] | - -#### Returns - -`Promise`<[`MultiDeployContractResponse`](../namespaces/types.md#multideploycontractresponse)\> - -- contract_address[] -- transaction_hash - -#### Defined in - -[src/account/interface.ts:174](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L174) - ---- - -### deployContract - -▸ `Abstract` **deployContract**(`payload`, `details?`): `Promise`<[`DeployContractUDCResponse`](../namespaces/types.md#deploycontractudcresponse)\> - -Simplify deploy simulating old DeployContract with same response + UDC specific response -Internal wait for L2 transaction, support multicall - -#### Parameters - -| Name | Type | Description | -| :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `payload` | [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload) \| [`UniversalDeployerContractPayload`](../namespaces/types.md#universaldeployercontractpayload)[] | classHash: computed class hash of compiled contract - [constructorCalldata] contract constructor calldata - [salt=pseudorandom] deploy address salt - [unique=true] ensure unique salt | -| `details?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | [nonce=getNonce] - [version=transactionVersion] - [maxFee=getSuggestedMaxFee] | - -#### Returns - -`Promise`<[`DeployContractUDCResponse`](../namespaces/types.md#deploycontractudcresponse)\> - -- contract_address -- transaction_hash -- address -- deployer -- unique -- classHash -- calldata_len -- calldata -- salt - -#### Defined in - -[src/account/interface.ts:203](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L203) - ---- - -### declareAndDeploy - -▸ `Abstract` **declareAndDeploy**(`payload`, `details?`): `Promise`<[`DeclareDeployUDCResponse`](../namespaces/types.md#declaredeployudcresponse)\> - -Declares and Deploy a given compiled contract (json) to starknet using UDC -Internal wait for L2 transaction, do not support multicall -Method will pass even if contract is already declared (internal using DeclareIfNot) - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `payload` | [`DeclareAndDeployContractPayload`](../namespaces/types.md#declareanddeploycontractpayload) | contract: compiled contract code - [casm=cairo1]: CairoAssembly \| undefined; - [compiledClassHash]: string \| undefined; - [classHash]: computed class hash of compiled contract - [constructorCalldata] contract constructor calldata - [salt=pseudorandom] deploy address salt - [unique=true] ensure unique salt | -| `details?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | [nonce=getNonce] - [version=transactionVersion] - [maxFee=getSuggestedMaxFee] | - -#### Returns - -`Promise`<[`DeclareDeployUDCResponse`](../namespaces/types.md#declaredeployudcresponse)\> - -- declare - - transaction_hash -- deploy - - contract_address - - transaction_hash - - address - - deployer - - unique - - classHash - - calldata_len - - calldata - - salt - -#### Defined in - -[src/account/interface.ts:239](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L239) - ---- - -### deployAccount - -▸ `Abstract` **deployAccount**(`contractPayload`, `transactionsDetail?`): `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -Deploy the account on Starknet - -#### Parameters - -| Name | Type | Description | -| :-------------------- | :------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractPayload` | [`DeployAccountContractPayload`](../namespaces/types.md#deployaccountcontractpayload) | transaction payload to be deployed containing: - classHash: computed class hash of compiled contract - optional constructor calldata - optional address salt - optional contractAddress | -| `transactionsDetail?` | [`InvocationsDetails`](../namespaces/types.md#invocationsdetails) | Invocation Details containing: - constant nonce = 0 - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Defined in - -[src/account/interface.ts:258](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L258) - ---- - -### signMessage - -▸ `Abstract` **signMessage**(`typedData`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Sign an JSON object for off-chain usage with the starknet private key and return the signature -This adds a message prefix so it cant be interchanged with transactions - -**`Throws`** - -if the JSON object is not a valid JSON - -#### Parameters - -| Name | Type | -| :---------- | :---------------------------------------------- | -| `typedData` | [`TypedData`](../interfaces/types.TypedData.md) | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -the signature of the JSON object - -#### Defined in - -[src/account/interface.ts:271](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L271) - ---- - -### hashMessage - -▸ `Abstract` **hashMessage**(`typedData`): `Promise`<`string`\> - -Hash a JSON object with pederson hash and return the hash -This adds a message prefix so it cant be interchanged with transactions - -**`Throws`** - -if the JSON object is not a valid JSON - -#### Parameters - -| Name | Type | -| :---------- | :---------------------------------------------- | -| `typedData` | [`TypedData`](../interfaces/types.TypedData.md) | - -#### Returns - -`Promise`<`string`\> - -the hash of the JSON object - -#### Defined in - -[src/account/interface.ts:281](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L281) - ---- - -### verifyMessage - -▸ `Abstract` **verifyMessage**(`typedData`, `signature`): `Promise`<`boolean`\> - -Verify a signature of a JSON object - -**`Throws`** - -if the JSON object is not a valid JSON or the signature is not a valid signature - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------------------------------------------- | :--------------------------- | -| `typedData` | [`TypedData`](../interfaces/types.TypedData.md) | JSON object to be verified | -| `signature` | [`Signature`](../namespaces/types.md#signature) | signature of the JSON object | - -#### Returns - -`Promise`<`boolean`\> - -true if the signature is valid, false otherwise - -#### Defined in - -[src/account/interface.ts:291](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L291) - ---- - -### verifyMessageHash - -▸ `Abstract` **verifyMessageHash**(`hash`, `signature`): `Promise`<`boolean`\> - -Verify a signature of a given hash - -**`Warning`** - -This method is not recommended, use verifyMessage instead - -**`Throws`** - -if the signature is not a valid signature - -#### Parameters - -| Name | Type | Description | -| :---------- | :---------------------------------------------------- | :-------------------- | -| `hash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | hash to be verified | -| `signature` | [`Signature`](../namespaces/types.md#signature) | signature of the hash | - -#### Returns - -`Promise`<`boolean`\> - -true if the signature is valid, false otherwise - -#### Defined in - -[src/account/interface.ts:302](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L302) - ---- - -### getNonce - -▸ `Abstract` **getNonce**(`blockIdentifier?`): `Promise`<`string`\> - -Gets the nonce of the account with respect to a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :---------------------------------------------- | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | optional blockIdentifier. Defaults to 'pending' | - -#### Returns - -`Promise`<`string`\> - -nonce of the account - -#### Defined in - -[src/account/interface.ts:310](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L310) - ---- - -### getSuggestedMaxFee - -▸ `Abstract` **getSuggestedMaxFee**(`estimateFeeAction`, `details`): `Promise`<`bigint`\> - -Gets Suggested Max Fee based on the transaction type - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------------------------------------------- | -| `estimateFeeAction` | [`EstimateFeeAction`](../namespaces/types.md#estimatefeeaction) | -| `details` | [`EstimateFeeDetails`](../interfaces/types.EstimateFeeDetails.md) | - -#### Returns - -`Promise`<`bigint`\> - -suggestedMaxFee - -#### Defined in - -[src/account/interface.ts:319](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L319) - ---- - -### simulateTransaction - -▸ `Abstract` **simulateTransaction**(`invocations`, `details?`): `Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -Simulates an array of transaction and returns an array of transaction trace and estimated fee. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------- | -| `invocations` | [`Invocations`](../namespaces/types.md#invocations) | Invocations containing: - type - transaction type: DECLARE, (multi)DEPLOY, DEPLOY_ACCOUNT, (multi)INVOKE_FUNCTION | -| `details?` | [`SimulateTransactionDetails`](../namespaces/types.md#simulatetransactiondetails) | SimulateTransactionDetails | - -#### Returns - -`Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -response from simulate_transaction - -#### Defined in - -[src/account/interface.ts:333](https://github.com/0xs34n/starknet.js/blob/develop/src/account/interface.ts#L333) - ---- - -### getChainId - -▸ `Abstract` **getChainId**(): `Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -Gets the Starknet chain Id - -#### Returns - -`Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -the chain Id - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getChainId](ProviderInterface.md#getchainid) - -#### Defined in - -[src/provider/interface.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L40) - ---- - -### callContract - -▸ `Abstract` **callContract**(`call`, `blockIdentifier?`): `Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -Calls a function on the Starknet contract. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :----------------------- | -| `call` | [`Call`](../namespaces/types.md#call) | transaction to be called | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -the result of the function on the smart contract. - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[callContract](ProviderInterface.md#callcontract) - -#### Defined in - -[src/provider/interface.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L49) - ---- - -### getBlock - -▸ `Abstract` **getBlock**(`blockIdentifier`): `Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -Gets the block information - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -the block object - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getBlock](ProviderInterface.md#getblock) - -#### Defined in - -[src/provider/interface.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L60) - ---- - -### getCode - -▸ `Abstract` **getCode**(`contractAddress`, `blockIdentifier?`): `Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -**`Deprecated`** - -The method should not be used - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------- | -| `contractAddress` | `string` | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getCode](ProviderInterface.md#getcode) - -#### Defined in - -[src/provider/interface.ts:65](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L65) - ---- - -### getClassAt - -▸ `Abstract` **getClassAt**(`contractAddress`, `blockIdentifier?`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Gets the contract class of the deployed contract. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getClassAt](ProviderInterface.md#getclassat) - -#### Defined in - -[src/provider/interface.ts:77](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L77) - ---- - -### getClassHashAt - -▸ `Abstract` **getClassHashAt**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Returns the class hash deployed under the given address. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -Class hash - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getClassHashAt](ProviderInterface.md#getclasshashat) - -#### Defined in - -[src/provider/interface.ts:89](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L89) - ---- - -### getClassByHash - -▸ `Abstract` **getClassByHash**(`classHash`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Returns the contract class deployed under the given class hash. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------- | :---------- | -| `classHash` | `string` | class hash | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getClassByHash](ProviderInterface.md#getclassbyhash) - -#### Defined in - -[src/provider/interface.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L100) - ---- - -### getNonceForAddress - -▸ `Abstract` **getNonceForAddress**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the nonce of a contract with respect to a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - | - -#### Returns - -`Promise`<`string`\> - -the hex nonce - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getNonceForAddress](ProviderInterface.md#getnonceforaddress) - -#### Defined in - -[src/provider/interface.ts:108](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L108) - ---- - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`contractAddress`, `key`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the contract's storage variable at a specific key. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------------------------------------------------- | -| `contractAddress` | `string` | | -| `key` | [`BigNumberish`](../namespaces/types.md#bignumberish) | from getStorageVarAddress('') (WIP) | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -the value of the storage variable - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getStorageAt](ProviderInterface.md#getstorageat) - -#### Defined in - -[src/provider/interface.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L121) - ---- - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -Gets the transaction information from a tx id. - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------- | -| `transactionHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? } - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getTransaction](ProviderInterface.md#gettransaction) - -#### Defined in - -[src/provider/interface.ts:133](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L133) - ---- - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Gets the transaction receipt from a tx hash. - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------- | -| `transactionHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -the transaction receipt object - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getTransactionReceipt](ProviderInterface.md#gettransactionreceipt) - -#### Defined in - -[src/provider/interface.ts:141](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L141) - ---- - -### deployAccountContract - -▸ `Abstract` **deployAccountContract**(`payload`, `details`): `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -Deploys a given compiled Account contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :-------- | :------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------ | -| `payload` | [`DeployAccountContractPayload`](../namespaces/types.md#deployaccountcontractpayload) | payload to be deployed containing: - compiled contract code - constructor calldata - address salt | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | - | - -#### Returns - -`Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[deployAccountContract](ProviderInterface.md#deployaccountcontract) - -#### Defined in - -[src/provider/interface.ts:154](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L154) - ---- - -### invokeFunction - -▸ `Abstract` **invokeFunction**(`invocation`, `details`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invokes a function on starknet - -**`Deprecated`** - -This method wont be supported as soon as fees are mandatory. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :----------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version - maxFee - optional maxFee | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -response from addTransaction - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[invokeFunction](ProviderInterface.md#invokefunction) - -#### Defined in - -[src/provider/interface.ts:174](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L174) - ---- - -### declareContract - -▸ `Abstract` **declareContract**(`transaction`, `details`): `Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -Declares a given compiled contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | -| `transaction` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be deployed containing: - compiled contract code - sender address - signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | Invocation Details containing: - nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[declareContract](ProviderInterface.md#declarecontract) - -#### Defined in - -[src/provider/interface.ts:191](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L191) - ---- - -### getEstimateFee - -▸ `Abstract` **getEstimateFee**(`invocation`, `details`, `blockIdentifier`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -**`Deprecated`** - -Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getEstimateFee](ProviderInterface.md#getestimatefee) - -#### Defined in - -[src/provider/interface.ts:212](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L212) - ---- - -### getInvokeEstimateFee - -▸ `Abstract` **getInvokeEstimateFee**(`invocation`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getInvokeEstimateFee](ProviderInterface.md#getinvokeestimatefee) - -#### Defined in - -[src/provider/interface.ts:234](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L234) - ---- - -### getDeclareEstimateFee - -▸ `Abstract` **getDeclareEstimateFee**(`transaction`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DECLARE transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------ | -| `transaction` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be declared containing: - compiled contract code - sender address - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getDeclareEstimateFee](ProviderInterface.md#getdeclareestimatefee) - -#### Defined in - -[src/provider/interface.ts:256](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L256) - ---- - -### getDeployAccountEstimateFee - -▸ `Abstract` **getDeployAccountEstimateFee**(`transaction`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DEPLOY_ACCOUNT transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | -| `transaction` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | transaction payload to be deployed containing: - classHash - constructorCalldata - addressSalt - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getDeployAccountEstimateFee](ProviderInterface.md#getdeployaccountestimatefee) - -#### Defined in - -[src/provider/interface.ts:279](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L279) - ---- - -### getEstimateFeeBulk - -▸ `Abstract` **getEstimateFeeBulk**(`invocations`, `options?`): `Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -Estimates the fee for a list of INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------- | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `options?` | [`getEstimateFeeBulkOptions`](../namespaces/types.md#getestimatefeebulkoptions) | getEstimateFeeBulkOptions - (optional) blockIdentifier - BlockIdentifier - (optional) skipValidate - boolean (default false) | - -#### Returns - -`Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -the estimated fee - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getEstimateFeeBulk](ProviderInterface.md#getestimatefeebulk) - -#### Defined in - -[src/provider/interface.ts:295](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L295) - ---- - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`txHash`, `options?`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Wait for the transaction to be accepted - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | transaction hash | -| `options?` | [`waitForTransactionOptions`](../namespaces/types.md#waitfortransactionoptions) | waitForTransactionOptions - (optional) retryInterval: number \| undefined; - (optional) successStates: TransactionStatus[] \| undefined; | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -GetTransactionReceiptResponse - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[waitForTransaction](ProviderInterface.md#waitfortransaction) - -#### Defined in - -[src/provider/interface.ts:308](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L308) - ---- - -### getSimulateTransaction - -▸ `Abstract` **getSimulateTransaction**(`invocations`, `options?`): `Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -Simulates the transaction and returns the transaction trace and estimated fee. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `options?` | [`getSimulateTransactionOptions`](../namespaces/types.md#getsimulatetransactionoptions) | getSimulateTransactionOptions - (optional) blockIdentifier - block identifier - (optional) skipValidate - skip cairo **validate** method - (optional) skipExecute - skip cairo **execute** method | - -#### Returns - -`Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -an array of transaction trace and estimated fee - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getSimulateTransaction](ProviderInterface.md#getsimulatetransaction) - -#### Defined in - -[src/provider/interface.ts:323](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L323) - ---- - -### getStateUpdate - -▸ `Abstract` **getStateUpdate**(`blockIdentifier?`): `Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -Gets the state changes in a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -StateUpdateResponse - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getStateUpdate](ProviderInterface.md#getstateupdate) - -#### Defined in - -[src/provider/interface.ts:334](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L334) - ---- - -### getContractVersion - -▸ `Abstract` **getContractVersion**(`contractAddress`, `classHash?`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `string` | string | -| `classHash?` | `undefined` | undefined | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getContractVersion](ProviderInterface.md#getcontractversion) - -#### Defined in - -[src/provider/interface.ts:344](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L344) - -▸ `Abstract` **getContractVersion**(`contractAddress`, `classHash`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `undefined` | undefined | -| `classHash` | `string` | | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Inherited from - -[ProviderInterface](ProviderInterface.md).[getContractVersion](ProviderInterface.md#getcontractversion) - -#### Defined in - -[src/provider/interface.ts:358](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L358) diff --git a/www/docs/API/classes/CairoCustomEnum.md b/www/docs/API/classes/CairoCustomEnum.md deleted file mode 100644 index b3afe1fb5..000000000 --- a/www/docs/API/classes/CairoCustomEnum.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -id: 'CairoCustomEnum' -title: 'Class: CairoCustomEnum' -sidebar_label: 'CairoCustomEnum' -sidebar_position: 0 -custom_edit_url: null ---- - -Class to handle Cairo custom Enum - -**`Param`** - -object containing the variants and its content. Example : -{Success: 234, Warning: undefined, Error: undefined}. -Only one variant with a value, object, array. - -**`Example`** - -```typescript -const myCairoEnum = new CairoCustomEnum( {Success: undefined, Warning: "0x7f32ea", Error: undefined}) -``` - -## Constructors - -### constructor - -• **new CairoCustomEnum**(`enumContent`) - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------- | :----------------------------------------------------------------------------------------------- | -| `enumContent` | [`CairoEnumRaw`](../modules.md#cairoenumraw) | an object with the variants as keys and the content as value. Only one content shall be defined. | - -#### Defined in - -[src/utils/calldata/enum/CairoCustomEnum.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoCustomEnum.ts#L27) - -## Properties - -### variant - -• `Readonly` **variant**: [`CairoEnumRaw`](../modules.md#cairoenumraw) - -direct readonly access to variants of the Cairo Custom Enum. - -**`Example`** - -```typescript -const successValue = myCairoEnum.variant.Success; - -#### Defined in - -[src/utils/calldata/enum/CairoCustomEnum.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoCustomEnum.ts#L22) - -## Methods - -### unwrap - -▸ **unwrap**(): `any` - -#### Returns - -`any` - -the content of the valid variant of a Cairo custom Enum. - -#### Defined in - -[src/utils/calldata/enum/CairoCustomEnum.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoCustomEnum.ts#L45) - -___ - -### activeVariant - -▸ **activeVariant**(): `string` - -#### Returns - -`string` - -the name of the valid variant of a Cairo custom Enum. - -#### Defined in - -[src/utils/calldata/enum/CairoCustomEnum.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoCustomEnum.ts#L58) -``` diff --git a/www/docs/API/classes/CairoOption.md b/www/docs/API/classes/CairoOption.md deleted file mode 100644 index f1f74ee6a..000000000 --- a/www/docs/API/classes/CairoOption.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -id: 'CairoOption' -title: 'Class: CairoOption' -sidebar_label: 'CairoOption' -sidebar_position: 0 -custom_edit_url: null ---- - -Class to handle Cairo Option - -**`Param`** - -CairoOptionVariant.Some or CairoOptionVariant.None - -**`Param`** - -value of type T. - -**`Example`** - -```typescript -const myOption = new CairoOption(CairoOptionVariant.Some, "0x54dda8"); -``` - -## Type parameters - -| Name | -| :--- | -| `T` | - -## Constructors - -### constructor - -• **new CairoOption**<`T`\>(`variant`, `someContent?`) - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Parameters - -| Name | Type | -| :------------- | :----------------------------------------------------- | -| `variant` | [`CairoOptionVariant`](../enums/CairoOptionVariant.md) | -| `someContent?` | `T` | - -#### Defined in - -[src/utils/calldata/enum/CairoOption.ts:20](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoOption.ts#L20) - -## Properties - -### Some - -• `Optional` `Readonly` **Some**: `T` - -#### Defined in - -[src/utils/calldata/enum/CairoOption.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoOption.ts#L16) - ---- - -### None - -• `Optional` `Readonly` **None**: `boolean` - -#### Defined in - -[src/utils/calldata/enum/CairoOption.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoOption.ts#L18) - -## Methods - -### unwrap - -▸ **unwrap**(): `undefined` \| `T` - -#### Returns - -`undefined` \| `T` - -the content of the valid variant of a Cairo custom Enum. -If None, returns 'undefined'. - -#### Defined in - -[src/utils/calldata/enum/CairoOption.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoOption.ts#L43) - ---- - -### isSome - -▸ **isSome**(): `boolean` - -#### Returns - -`boolean` - -true if the valid variant is 'isSome'. - -#### Defined in - -[src/utils/calldata/enum/CairoOption.ts:54](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoOption.ts#L54) - ---- - -### isNone - -▸ **isNone**(): `boolean` - -#### Returns - -`boolean` - -true if the valid variant is 'isNone'. - -#### Defined in - -[src/utils/calldata/enum/CairoOption.ts:62](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoOption.ts#L62) diff --git a/www/docs/API/classes/CairoResult.md b/www/docs/API/classes/CairoResult.md deleted file mode 100644 index 85db0db9d..000000000 --- a/www/docs/API/classes/CairoResult.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -id: 'CairoResult' -title: 'Class: CairoResult' -sidebar_label: 'CairoResult' -sidebar_position: 0 -custom_edit_url: null ---- - -Class to handle Cairo Result - -**`Param`** - -CairoResultVariant.Ok or CairoResultVariant.Err - -**`Param`** - -value of type T or U. - -**`Example`** - -```typescript -const myOption = new CairoResult(CairoResultVariant.Ok, "0x54dda8"); -``` - -## Type parameters - -| Name | -| :--- | -| `T` | -| `U` | - -## Constructors - -### constructor - -• **new CairoResult**<`T`, `U`\>(`variant`, `resultContent`) - -#### Type parameters - -| Name | -| :--- | -| `T` | -| `U` | - -#### Parameters - -| Name | Type | -| :-------------- | :----------------------------------------------------- | -| `variant` | [`CairoResultVariant`](../enums/CairoResultVariant.md) | -| `resultContent` | `T` \| `U` | - -#### Defined in - -[src/utils/calldata/enum/CairoResult.ts:20](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoResult.ts#L20) - -## Properties - -### Ok - -• `Optional` `Readonly` **Ok**: `T` - -#### Defined in - -[src/utils/calldata/enum/CairoResult.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoResult.ts#L16) - ---- - -### Err - -• `Optional` `Readonly` **Err**: `U` - -#### Defined in - -[src/utils/calldata/enum/CairoResult.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoResult.ts#L18) - -## Methods - -### unwrap - -▸ **unwrap**(): `T` \| `U` - -#### Returns - -`T` \| `U` - -the content of the valid variant of a Cairo Result. - -#### Defined in - -[src/utils/calldata/enum/CairoResult.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoResult.ts#L37) - ---- - -### isOk - -▸ **isOk**(): `boolean` - -#### Returns - -`boolean` - -true if the valid variant is 'Ok'. - -#### Defined in - -[src/utils/calldata/enum/CairoResult.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoResult.ts#L51) - ---- - -### isErr - -▸ **isErr**(): `boolean` - -#### Returns - -`boolean` - -true if the valid variant is 'isErr'. - -#### Defined in - -[src/utils/calldata/enum/CairoResult.ts:59](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoResult.ts#L59) diff --git a/www/docs/API/classes/CallData.md b/www/docs/API/classes/CallData.md deleted file mode 100644 index 55c395956..000000000 --- a/www/docs/API/classes/CallData.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -id: 'CallData' -title: 'Class: CallData' -sidebar_label: 'CallData' -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new CallData**(`abi`) - -#### Parameters - -| Name | Type | -| :---- | :---------------------------------- | -| `abi` | [`Abi`](../namespaces/types.md#abi) | - -#### Defined in - -[src/utils/calldata/index.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L47) - -## Properties - -### abi - -• **abi**: [`Abi`](../namespaces/types.md#abi) - -#### Defined in - -[src/utils/calldata/index.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L39) - ---- - -### parser - -• **parser**: `AbiParserInterface` - -#### Defined in - -[src/utils/calldata/index.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L41) - ---- - -### structs - -• `Protected` `Readonly` **structs**: [`AbiStructs`](../namespaces/types.md#abistructs) - -#### Defined in - -[src/utils/calldata/index.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L43) - ---- - -### enums - -• `Protected` `Readonly` **enums**: [`AbiEnums`](../namespaces/types.md#abienums) - -#### Defined in - -[src/utils/calldata/index.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L45) - -## Methods - -### compile - -▸ `Static` **compile**(`rawArgs`): [`Calldata`](../namespaces/types.md#calldata) - -Compile contract callData without abi - -#### Parameters - -| Name | Type | Description | -| :-------- | :------------------------------------------ | :--------------------------------------------------------------------------- | -| `rawArgs` | [`RawArgs`](../namespaces/types.md#rawargs) | RawArgs representing cairo method arguments or string array of compiled data | - -#### Returns - -[`Calldata`](../namespaces/types.md#calldata) - -Calldata - -#### Defined in - -[src/utils/calldata/index.ts:161](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L161) - ---- - -### getAbiStruct - -▸ `Static` **getAbiStruct**(`abi`): [`AbiStructs`](../namespaces/types.md#abistructs) - -Helper to extract structs from abi - -#### Parameters - -| Name | Type | Description | -| :---- | :---------------------------------- | :---------- | -| `abi` | [`Abi`](../namespaces/types.md#abi) | Abi | - -#### Returns - -[`AbiStructs`](../namespaces/types.md#abistructs) - -AbiStructs - structs from abi - -#### Defined in - -[src/utils/calldata/index.ts:279](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L279) - ---- - -### getAbiEnum - -▸ `Static` **getAbiEnum**(`abi`): [`AbiEnums`](../namespaces/types.md#abienums) - -Helper to extract enums from abi - -#### Parameters - -| Name | Type | Description | -| :---- | :---------------------------------- | :---------- | -| `abi` | [`Abi`](../namespaces/types.md#abi) | Abi | - -#### Returns - -[`AbiEnums`](../namespaces/types.md#abienums) - -AbiEnums - enums from abi - -#### Defined in - -[src/utils/calldata/index.ts:296](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L296) - ---- - -### toCalldata - -▸ `Static` **toCalldata**(`rawCalldata?`): [`Calldata`](../namespaces/types.md#calldata) - -Helper: Compile HexCalldata | RawCalldata | RawArgs - -#### Parameters - -| Name | Type | Default value | Description | -| :------------ | :------------------------------------------ | :------------ | :------------------------------------ | -| `rawCalldata` | [`RawArgs`](../namespaces/types.md#rawargs) | `[]` | HexCalldata \| RawCalldata \| RawArgs | - -#### Returns - -[`Calldata`](../namespaces/types.md#calldata) - -Calldata - -#### Defined in - -[src/utils/calldata/index.ts:315](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L315) - ---- - -### toHex - -▸ `Static` **toHex**(`raw?`): [`HexCalldata`](../namespaces/types.md#hexcalldata) - -Helper: Convert raw to HexCalldata - -#### Parameters - -| Name | Type | Default value | Description | -| :---- | :------------------------------------------ | :------------ | :------------------------------------ | -| `raw` | [`RawArgs`](../namespaces/types.md#rawargs) | `[]` | HexCalldata \| RawCalldata \| RawArgs | - -#### Returns - -[`HexCalldata`](../namespaces/types.md#hexcalldata) - -HexCalldata - -#### Defined in - -[src/utils/calldata/index.ts:324](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L324) - ---- - -### validate - -▸ **validate**(`type`, `method`, `args?`): `void` - -Validate arguments passed to the method as corresponding to the ones in the abi - -#### Parameters - -| Name | Type | Default value | Description | -| :------- | :-------------------------------------------------------- | :------------ | :------------------------------------------------------- | -| `type` | [`ValidateType`](../enums/types.ValidateType.md) | `undefined` | ValidateType - type of the method | -| `method` | `string` | `undefined` | string - name of the method | -| `args` | [`ArgsOrCalldata`](../namespaces/types.md#argsorcalldata) | `[]` | ArgsOrCalldata - arguments that are passed to the method | - -#### Returns - -`void` - -#### Defined in - -[src/utils/calldata/index.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L60) - ---- - -### compile - -▸ **compile**(`method`, `argsCalldata`): [`Calldata`](../namespaces/types.md#calldata) - -Compile contract callData with abi -Parse the calldata by using input fields from the abi for that method - -**`Example`** - -```typescript -const calldata = myCallData.compile("constructor",["0x34a",[1,3n]]); -``` - -```typescript -const calldata2 = myCallData.compile("constructor",{list:[1,3n],balance:"0x34"}); // wrong order is valid -``` - -#### Parameters - -| Name | Type | Description | -| :------------- | :------------------------------------------ | :------------------- | -| `method` | `string` | string - method name | -| `argsCalldata` | [`RawArgs`](../namespaces/types.md#rawargs) | - | - -#### Returns - -[`Calldata`](../namespaces/types.md#calldata) - -Calldata - parsed arguments in format that contract is expecting - -#### Defined in - -[src/utils/calldata/index.ts:113](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L113) - ---- - -### parse - -▸ **parse**(`method`, `response`): [`Result`](../namespaces/types.md#result) - -Parse elements of the response array and structuring them into response object - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------- | :---------------------------------- | -| `method` | `string` | string - method name | -| `response` | `string`[] | string[] - response from the method | - -#### Returns - -[`Result`](../namespaces/types.md#result) - -Result - parsed response corresponding to the abi - -#### Defined in - -[src/utils/calldata/index.ts:245](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L245) - ---- - -### format - -▸ **format**(`method`, `response`, `format`): [`Result`](../namespaces/types.md#result) - -Format cairo method response data to native js values based on provided format schema - -#### Parameters - -| Name | Type | Description | -| :--------- | :--------- | :------------------------------- | -| `method` | `string` | string - cairo method name | -| `response` | `string`[] | string[] - cairo method response | -| `format` | `object` | object - formatter object schema | - -#### Returns - -[`Result`](../namespaces/types.md#result) - -Result - parsed and formatted response object - -#### Defined in - -[src/utils/calldata/index.ts:269](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/index.ts#L269) diff --git a/www/docs/API/classes/Contract.md b/www/docs/API/classes/Contract.md deleted file mode 100644 index 6e40e0c98..000000000 --- a/www/docs/API/classes/Contract.md +++ /dev/null @@ -1,497 +0,0 @@ ---- -id: 'Contract' -title: 'Class: Contract' -sidebar_label: 'Contract' -sidebar_position: 0 -custom_edit_url: null ---- - -## Implements - -- [`ContractInterface`](ContractInterface.md) - -## Indexable - -▪ [key: `string`]: [`AsyncContractFunction`](../namespaces/types.md#asynccontractfunction) \| `any` - -## Constructors - -### constructor - -• **new Contract**(`abi`, `address`, `providerOrAccount?`) - -Contract class to handle contract methods - -#### Parameters - -| Name | Type | Default value | Description | -| :------------------ | :--------------------------------------------------------------------------------------- | :---------------- | :-------------------------------------------- | -| `abi` | [`Abi`](../namespaces/types.md#abi) | `undefined` | Abi of the contract object | -| `address` | `string` | `undefined` | (optional) - address to connect to | -| `providerOrAccount` | [`ProviderInterface`](ProviderInterface.md) \| [`AccountInterface`](AccountInterface.md) | `defaultProvider` | (optional) - Provider or Account to attach to | - -#### Defined in - -[src/contract/default.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L148) - -## Properties - -### abi - -• **abi**: [`Abi`](../namespaces/types.md#abi) - -#### Implementation of - -[ContractInterface](ContractInterface.md).[abi](ContractInterface.md#abi) - -#### Defined in - -[src/contract/default.ts:117](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L117) - ---- - -### address - -• **address**: `string` - -#### Implementation of - -[ContractInterface](ContractInterface.md).[address](ContractInterface.md#address) - -#### Defined in - -[src/contract/default.ts:119](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L119) - ---- - -### providerOrAccount - -• **providerOrAccount**: [`ProviderInterface`](ProviderInterface.md) \| [`AccountInterface`](AccountInterface.md) - -#### Implementation of - -[ContractInterface](ContractInterface.md).[providerOrAccount](ContractInterface.md#provideroraccount) - -#### Defined in - -[src/contract/default.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L121) - ---- - -### deployTransactionHash - -• `Optional` **deployTransactionHash**: `string` - -#### Implementation of - -[ContractInterface](ContractInterface.md).[deployTransactionHash](ContractInterface.md#deploytransactionhash) - -#### Defined in - -[src/contract/default.ts:123](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L123) - ---- - -### structs - -• `Protected` `Readonly` **structs**: `Object` - -#### Index signature - -▪ [name: `string`]: [`StructAbi`](../namespaces/types.md#structabi) - -#### Defined in - -[src/contract/default.ts:125](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L125) - ---- - -### events - -• `Protected` `Readonly` **events**: [`AbiEvents`](../namespaces/types.md#abievents) - -#### Defined in - -[src/contract/default.ts:127](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L127) - ---- - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`AsyncContractFunction`](../namespaces/types.md#asynccontractfunction) - -#### Implementation of - -[ContractInterface](ContractInterface.md).[functions](ContractInterface.md#functions) - -#### Defined in - -[src/contract/default.ts:129](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L129) - ---- - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`AsyncContractFunction`](../namespaces/types.md#asynccontractfunction) - -#### Implementation of - -[ContractInterface](ContractInterface.md).[callStatic](ContractInterface.md#callstatic) - -#### Defined in - -[src/contract/default.ts:131](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L131) - ---- - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../namespaces/types.md#contractfunction) - -#### Implementation of - -[ContractInterface](ContractInterface.md).[populateTransaction](ContractInterface.md#populatetransaction) - -#### Defined in - -[src/contract/default.ts:133](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L133) - ---- - -### estimateFee - -• `Readonly` **estimateFee**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../namespaces/types.md#contractfunction) - -#### Implementation of - -[ContractInterface](ContractInterface.md).[estimateFee](ContractInterface.md#estimatefee) - -#### Defined in - -[src/contract/default.ts:135](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L135) - ---- - -### callData - -• `Private` **callData**: [`CallData`](CallData.md) - -#### Defined in - -[src/contract/default.ts:139](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L139) - -## Methods - -### attach - -▸ **attach**(`address`): `void` - -Saves the address of the contract deployed on network that will be used for interaction - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :---------------------- | -| `address` | `string` | address of the contract | - -#### Returns - -`void` - -#### Implementation of - -[ContractInterface](ContractInterface.md).[attach](ContractInterface.md#attach) - -#### Defined in - -[src/contract/default.ts:204](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L204) - ---- - -### connect - -▸ **connect**(`providerOrAccount`): `void` - -Attaches to new Provider or Account - -#### Parameters - -| Name | Type | Description | -| :------------------ | :--------------------------------------------------------------------------------------- | :----------------------------------- | -| `providerOrAccount` | [`ProviderInterface`](ProviderInterface.md) \| [`AccountInterface`](AccountInterface.md) | new Provider or Account to attach to | - -#### Returns - -`void` - -#### Implementation of - -[ContractInterface](ContractInterface.md).[connect](ContractInterface.md#connect) - -#### Defined in - -[src/contract/default.ts:208](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L208) - ---- - -### deployed - -▸ **deployed**(): `Promise`<[`Contract`](Contract.md)\> - -Resolves when contract is deployed on the network or when no deployment transaction is found - -**`Throws`** - -When deployment fails - -#### Returns - -`Promise`<[`Contract`](Contract.md)\> - -Promise that resolves when contract is deployed on the network or when no deployment transaction is found - -#### Implementation of - -[ContractInterface](ContractInterface.md).[deployed](ContractInterface.md#deployed) - -#### Defined in - -[src/contract/default.ts:212](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L212) - ---- - -### call - -▸ **call**(`method`, `args?`, `«destructured»?`): `Promise`<[`Result`](../namespaces/types.md#result)\> - -Calls a method on a contract - -#### Parameters - -| Name | Type | Default value | Description | -| :--------------- | :-------------------------------------------------------- | :------------ | :---------------------------------- | -| `method` | `string` | `undefined` | name of the method | -| `args` | [`ArgsOrCalldata`](../namespaces/types.md#argsorcalldata) | `[]` | Array of the arguments for the call | -| `«destructured»` | [`CallOptions`](../namespaces/types.md#calloptions) | `{}` | optional blockIdentifier | - -#### Returns - -`Promise`<[`Result`](../namespaces/types.md#result)\> - -Result of the call as an array with key value pars - -#### Implementation of - -[ContractInterface](ContractInterface.md).[call](ContractInterface.md#call) - -#### Defined in - -[src/contract/default.ts:220](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L220) - ---- - -### invoke - -▸ **invoke**(`method`, `args?`, `«destructured»?`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invokes a method on a contract - -#### Parameters - -| Name | Type | Default value | Description | -| :--------------- | :-------------------------------------------------------- | :------------ | :------------------------------------------------ | -| `method` | `string` | `undefined` | name of the method | -| `args` | [`ArgsOrCalldata`](../namespaces/types.md#argsorcalldata) | `[]` | Array of the arguments for the invoke or Calldata | -| `«destructured»` | [`InvokeOptions`](../namespaces/types.md#invokeoptions) | `{}` | | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Add Transaction Response - -#### Implementation of - -[ContractInterface](ContractInterface.md).[invoke](ContractInterface.md#invoke) - -#### Defined in - -[src/contract/default.ts:262](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L262) - ---- - -### estimate - -▸ **estimate**(`method`, `args?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates a method on a contract - -#### Parameters - -| Name | Type | Default value | Description | -| :------- | :-------------------------------------------------------- | :------------ | :---------------------------------------------- | -| `method` | `string` | `undefined` | name of the method | -| `args` | [`ArgsOrCalldata`](../namespaces/types.md#argsorcalldata) | `[]` | Array of the arguments for the call or Calldata | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -#### Implementation of - -[ContractInterface](ContractInterface.md).[estimate](ContractInterface.md#estimate) - -#### Defined in - -[src/contract/default.ts:306](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L306) - ---- - -### populate - -▸ **populate**(`method`, `args?`): [`Call`](../namespaces/types.md#call) - -Calls a method on a contract - -#### Parameters - -| Name | Type | Default value | Description | -| :------- | :------------------------------------------ | :------------ | :---------------------------------------------- | -| `method` | `string` | `undefined` | name of the method | -| `args` | [`RawArgs`](../namespaces/types.md#rawargs) | `[]` | Array of the arguments for the call or Calldata | - -#### Returns - -[`Call`](../namespaces/types.md#call) - -Invocation object - -#### Implementation of - -[ContractInterface](ContractInterface.md).[populate](ContractInterface.md#populate) - -#### Defined in - -[src/contract/default.ts:320](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L320) - ---- - -### parseEvents - -▸ **parseEvents**(`receipt`): [`ParsedEvents`](../namespaces/types.md#parsedevents) - -Parse contract events of a GetTransactionReceiptResponse received from waitForTransaction. Based on contract's abi - -#### Parameters - -| Name | Type | Description | -| :-------- | :-------------------------------------------------------------------------------------- | :------------------ | -| `receipt` | [`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse) | transaction receipt | - -#### Returns - -[`ParsedEvents`](../namespaces/types.md#parsedevents) - -Events parsed - -#### Implementation of - -[ContractInterface](ContractInterface.md).[parseEvents](ContractInterface.md#parseevents) - -#### Defined in - -[src/contract/default.ts:329](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L329) - ---- - -### isCairo1 - -▸ **isCairo1**(): `boolean` - -tells if the contract comes from a Cairo 1 contract - -**`Example`** - -```typescript -const isCairo1: boolean = myContract.isCairo1(); -``` - -#### Returns - -`boolean` - -TRUE if the contract comes from a Cairo1 contract - -#### Implementation of - -[ContractInterface](ContractInterface.md).[isCairo1](ContractInterface.md#iscairo1) - -#### Defined in - -[src/contract/default.ts:341](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L341) - ---- - -### getVersion - -▸ **getVersion**(): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Retrieves the version of the contract (cairo version & compiler version) - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Implementation of - -[ContractInterface](ContractInterface.md).[getVersion](ContractInterface.md#getversion) - -#### Defined in - -[src/contract/default.ts:345](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L345) - ---- - -### typed - -▸ **typed**<`TAbi`\>(`tAbi`): [`TypedContract`](../modules.md#typedcontract)<`TAbi`\> - -#### Type parameters - -| Name | Type | -| :----- | :--------------------------------------------------------------------------- | -| `TAbi` | extends readonly (`AbiFunction` \| `AbiEvent` \| `AbiStruct` \| `AbiEnum`)[] | - -#### Parameters - -| Name | Type | -| :----- | :----- | -| `tAbi` | `TAbi` | - -#### Returns - -[`TypedContract`](../modules.md#typedcontract)<`TAbi`\> - -#### Implementation of - -[ContractInterface](ContractInterface.md).[typed](ContractInterface.md#typed) - -#### Defined in - -[src/contract/default.ts:349](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L349) diff --git a/www/docs/API/classes/ContractFactory.md b/www/docs/API/classes/ContractFactory.md deleted file mode 100644 index 5157bd9ac..000000000 --- a/www/docs/API/classes/ContractFactory.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -id: 'ContractFactory' -title: 'Class: ContractFactory' -sidebar_label: 'ContractFactory' -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new ContractFactory**(`params`) - -#### Parameters - -| Name | Type | Description | -| :------- | :------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `params` | [`ContractFactoryParams`](../modules.md#contractfactoryparams) | CFParams - compiledContract: CompiledContract; - account: AccountInterface; - casm?: CairoAssembly; - classHash?: string; - compiledClassHash?: string; - abi?: Abi; | - -#### Defined in - -[src/contract/contractFactory.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L46) - -## Properties - -### compiledContract - -• **compiledContract**: [`CompiledContract`](../namespaces/types.md#compiledcontract) - -#### Defined in - -[src/contract/contractFactory.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L23) - ---- - -### account - -• **account**: [`AccountInterface`](AccountInterface.md) - -#### Defined in - -[src/contract/contractFactory.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L25) - ---- - -### abi - -• **abi**: [`Abi`](../namespaces/types.md#abi) - -#### Defined in - -[src/contract/contractFactory.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L27) - ---- - -### classHash - -• `Optional` **classHash**: `string` - -#### Defined in - -[src/contract/contractFactory.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L29) - ---- - -### casm - -• `Optional` **casm**: [`CairoAssembly`](../namespaces/types.md#cairoassembly) - -#### Defined in - -[src/contract/contractFactory.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L31) - ---- - -### compiledClassHash - -• `Optional` **compiledClassHash**: `string` - -#### Defined in - -[src/contract/contractFactory.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L33) - ---- - -### CallData - -• `Private` **CallData**: [`CallData`](CallData.md) - -#### Defined in - -[src/contract/contractFactory.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L35) - -## Methods - -### deploy - -▸ **deploy**(`...args`): `Promise`<[`Contract`](Contract.md)\> - -Deploys contract and returns new instance of the Contract - -If contract is not declared it will first declare it, and then deploy - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------------------ | -| `...args` | [`ArgsOrCalldataWithOptions`](../namespaces/types.md#argsorcalldatawithoptions) | - -#### Returns - -`Promise`<[`Contract`](Contract.md)\> - -#### Defined in - -[src/contract/contractFactory.ts:61](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L61) - ---- - -### connect - -▸ **connect**(`account`): [`ContractFactory`](ContractFactory.md) - -Attaches to new Account - -#### Parameters - -| Name | Type | Description | -| :-------- | :---------------------------------------- | :----------------------- | -| `account` | [`AccountInterface`](AccountInterface.md) | new Account to attach to | - -#### Returns - -[`ContractFactory`](ContractFactory.md) - -#### Defined in - -[src/contract/contractFactory.ts:101](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L101) - ---- - -### attach - -▸ **attach**(`address`): [`Contract`](Contract.md) - -Attaches current abi and account to the new address - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `address` | `string` | - -#### Returns - -[`Contract`](Contract.md) - -#### Defined in - -[src/contract/contractFactory.ts:109](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L109) diff --git a/www/docs/API/classes/ContractInterface.md b/www/docs/API/classes/ContractInterface.md deleted file mode 100644 index 257e4d5bb..000000000 --- a/www/docs/API/classes/ContractInterface.md +++ /dev/null @@ -1,375 +0,0 @@ ---- -id: 'ContractInterface' -title: 'Class: ContractInterface' -sidebar_label: 'ContractInterface' -sidebar_position: 0 -custom_edit_url: null ---- - -## Implemented by - -- [`Contract`](Contract.md) - -## Indexable - -▪ [key: `string`]: [`AsyncContractFunction`](../namespaces/types.md#asynccontractfunction) \| `any` - -## Constructors - -### constructor - -• **new ContractInterface**() - -## Properties - -### abi - -• `Abstract` **abi**: [`Abi`](../namespaces/types.md#abi) - -#### Defined in - -[src/contract/interface.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L25) - ---- - -### address - -• `Abstract` **address**: `string` - -#### Defined in - -[src/contract/interface.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L27) - ---- - -### providerOrAccount - -• `Abstract` **providerOrAccount**: [`ProviderInterface`](ProviderInterface.md) \| [`AccountInterface`](AccountInterface.md) - -#### Defined in - -[src/contract/interface.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L29) - ---- - -### deployTransactionHash - -• `Optional` `Abstract` **deployTransactionHash**: `string` - -#### Defined in - -[src/contract/interface.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L31) - ---- - -### functions - -• `Readonly` **functions**: `Object` - -#### Index signature - -▪ [name: `string`]: [`AsyncContractFunction`](../namespaces/types.md#asynccontractfunction) - -#### Defined in - -[src/contract/interface.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L33) - ---- - -### callStatic - -• `Readonly` **callStatic**: `Object` - -#### Index signature - -▪ [name: `string`]: [`AsyncContractFunction`](../namespaces/types.md#asynccontractfunction) - -#### Defined in - -[src/contract/interface.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L35) - ---- - -### populateTransaction - -• `Readonly` **populateTransaction**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../namespaces/types.md#contractfunction) - -#### Defined in - -[src/contract/interface.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L37) - ---- - -### estimateFee - -• `Readonly` **estimateFee**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ContractFunction`](../namespaces/types.md#contractfunction) - -#### Defined in - -[src/contract/interface.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L39) - -## Methods - -### attach - -▸ `Abstract` **attach**(`address`): `void` - -Saves the address of the contract deployed on network that will be used for interaction - -#### Parameters - -| Name | Type | Description | -| :-------- | :------- | :---------------------- | -| `address` | `string` | address of the contract | - -#### Returns - -`void` - -#### Defined in - -[src/contract/interface.ts:48](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L48) - ---- - -### connect - -▸ `Abstract` **connect**(`providerOrAccount`): `void` - -Attaches to new Provider or Account - -#### Parameters - -| Name | Type | Description | -| :------------------ | :--------------------------------------------------------------------------------------- | :----------------------------------- | -| `providerOrAccount` | [`ProviderInterface`](ProviderInterface.md) \| [`AccountInterface`](AccountInterface.md) | new Provider or Account to attach to | - -#### Returns - -`void` - -#### Defined in - -[src/contract/interface.ts:55](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L55) - ---- - -### deployed - -▸ `Abstract` **deployed**(): `Promise`<[`ContractInterface`](ContractInterface.md)\> - -Resolves when contract is deployed on the network or when no deployment transaction is found - -**`Throws`** - -When deployment fails - -#### Returns - -`Promise`<[`ContractInterface`](ContractInterface.md)\> - -Promise that resolves when contract is deployed on the network or when no deployment transaction is found - -#### Defined in - -[src/contract/interface.ts:63](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L63) - ---- - -### call - -▸ `Abstract` **call**(`method`, `args?`, `options?`): `Promise`<[`Result`](../namespaces/types.md#result)\> - -Calls a method on a contract - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------------- | :---------------------------------- | -| `method` | `string` | name of the method | -| `args?` | [`ArgsOrCalldata`](../namespaces/types.md#argsorcalldata) | Array of the arguments for the call | -| `options?` | [`CallOptions`](../namespaces/types.md#calloptions) | optional blockIdentifier | - -#### Returns - -`Promise`<[`Result`](../namespaces/types.md#result)\> - -Result of the call as an array with key value pars - -#### Defined in - -[src/contract/interface.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L73) - ---- - -### invoke - -▸ `Abstract` **invoke**(`method`, `args?`, `options?`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invokes a method on a contract - -#### Parameters - -| Name | Type | Description | -| :--------- | :-------------------------------------------------------- | :------------------------------------------------ | -| `method` | `string` | name of the method | -| `args?` | [`ArgsOrCalldata`](../namespaces/types.md#argsorcalldata) | Array of the arguments for the invoke or Calldata | -| `options?` | [`InvokeOptions`](../namespaces/types.md#invokeoptions) | | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Add Transaction Response - -#### Defined in - -[src/contract/interface.ts:87](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L87) - ---- - -### estimate - -▸ `Abstract` **estimate**(`method`, `args?`, `options?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates a method on a contract - -#### Parameters - -| Name | Type | Description | -| :------------------------- | :---------------------------------------------------------- | :---------------------------------------------- | -| `method` | `string` | name of the method | -| `args?` | [`ArgsOrCalldata`](../namespaces/types.md#argsorcalldata) | Array of the arguments for the call or Calldata | -| `options?` | `Object` | optional blockIdentifier | -| `options.blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -#### Defined in - -[src/contract/interface.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L100) - ---- - -### populate - -▸ `Abstract` **populate**(`method`, `args?`): [`Invocation`](../namespaces/types.md#invocation) - -Calls a method on a contract - -#### Parameters - -| Name | Type | Description | -| :------- | :-------------------------------------------------------- | :---------------------------------------------- | -| `method` | `string` | name of the method | -| `args?` | [`ArgsOrCalldata`](../namespaces/types.md#argsorcalldata) | Array of the arguments for the call or Calldata | - -#### Returns - -[`Invocation`](../namespaces/types.md#invocation) - -Invocation object - -#### Defined in - -[src/contract/interface.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L115) - ---- - -### parseEvents - -▸ `Abstract` **parseEvents**(`receipt`): [`ParsedEvents`](../namespaces/types.md#parsedevents) - -Parse contract events of a GetTransactionReceiptResponse received from waitForTransaction. Based on contract's abi - -#### Parameters - -| Name | Type | Description | -| :-------- | :-------------------------------------------------------------------------------------- | :------------------ | -| `receipt` | [`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse) | transaction receipt | - -#### Returns - -[`ParsedEvents`](../namespaces/types.md#parsedevents) - -Events parsed - -#### Defined in - -[src/contract/interface.ts:123](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L123) - ---- - -### isCairo1 - -▸ `Abstract` **isCairo1**(): `boolean` - -tells if the contract comes from a Cairo 1 contract - -**`Example`** - -```typescript -const isCairo1: boolean = myContract.isCairo1(); -``` - -#### Returns - -`boolean` - -TRUE if the contract comes from a Cairo1 contract - -#### Defined in - -[src/contract/interface.ts:134](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L134) - ---- - -### getVersion - -▸ `Abstract` **getVersion**(): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Retrieves the version of the contract (cairo version & compiler version) - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Defined in - -[src/contract/interface.ts:139](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L139) - ---- - -### typed - -▸ `Abstract` **typed**<`TAbi`\>(`tAbi`): [`TypedContract`](../modules.md#typedcontract)<`TAbi`\> - -#### Type parameters - -| Name | Type | -| :----- | :--------------------------------------------------------------------------- | -| `TAbi` | extends readonly (`AbiFunction` \| `AbiEvent` \| `AbiStruct` \| `AbiEnum`)[] | - -#### Parameters - -| Name | Type | -| :----- | :----- | -| `tAbi` | `TAbi` | - -#### Returns - -[`TypedContract`](../modules.md#typedcontract)<`TAbi`\> - -#### Defined in - -[src/contract/interface.ts:141](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L141) diff --git a/www/docs/API/classes/CustomError.md b/www/docs/API/classes/CustomError.md deleted file mode 100644 index ebfb6ff91..000000000 --- a/www/docs/API/classes/CustomError.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -id: 'CustomError' -title: 'Class: CustomError' -sidebar_label: 'CustomError' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- `Error` - - ↳ **`CustomError`** - - ↳↳ [`LibraryError`](LibraryError.md) - -## Constructors - -### constructor - -• **new CustomError**(`message?`) - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `message?` | `string` | - -#### Overrides - -Error.constructor - -#### Defined in - -[src/provider/errors.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L18) - -## Properties - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - ---- - -### name - -• **name**: `string` - -#### Overrides - -Error.name - -#### Defined in - -[src/provider/errors.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L16) - ---- - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -www/node_modules/typescript/lib/lib.es5.d.ts:1055 - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -Error.stack - -#### Defined in - -www/node_modules/typescript/lib/lib.es5.d.ts:1056 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/www/docs/API/classes/GatewayError.md b/www/docs/API/classes/GatewayError.md deleted file mode 100644 index f456f97f8..000000000 --- a/www/docs/API/classes/GatewayError.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -id: 'GatewayError' -title: 'Class: GatewayError' -sidebar_label: 'GatewayError' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`LibraryError`](LibraryError.md) - - ↳ **`GatewayError`** - -## Constructors - -### constructor - -• **new GatewayError**(`message`, `errorCode`) - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `message` | `string` | -| `errorCode` | `string` | - -#### Overrides - -[LibraryError](LibraryError.md).[constructor](LibraryError.md#constructor) - -#### Defined in - -[src/provider/errors.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L40) - -## Properties - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -#### Inherited from - -[LibraryError](LibraryError.md).[prepareStackTrace](LibraryError.md#preparestacktrace) - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -[LibraryError](LibraryError.md).[stackTraceLimit](LibraryError.md#stacktracelimit) - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - ---- - -### errorCode - -• **errorCode**: `string` - -#### Defined in - -[src/provider/errors.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L40) - ---- - -### name - -• **name**: `string` - -#### Inherited from - -[LibraryError](LibraryError.md).[name](LibraryError.md#name) - -#### Defined in - -[src/provider/errors.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L16) - ---- - -### message - -• **message**: `string` - -#### Inherited from - -[LibraryError](LibraryError.md).[message](LibraryError.md#message) - -#### Defined in - -www/node_modules/typescript/lib/lib.es5.d.ts:1055 - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -[LibraryError](LibraryError.md).[stack](LibraryError.md#stack) - -#### Defined in - -www/node_modules/typescript/lib/lib.es5.d.ts:1056 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[LibraryError](LibraryError.md).[captureStackTrace](LibraryError.md#capturestacktrace) - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/www/docs/API/classes/HttpError.md b/www/docs/API/classes/HttpError.md deleted file mode 100644 index 0c12617b7..000000000 --- a/www/docs/API/classes/HttpError.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -id: 'HttpError' -title: 'Class: HttpError' -sidebar_label: 'HttpError' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`LibraryError`](LibraryError.md) - - ↳ **`HttpError`** - -## Constructors - -### constructor - -• **new HttpError**(`message`, `errorCode`) - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `message` | `string` | -| `errorCode` | `number` | - -#### Overrides - -[LibraryError](LibraryError.md).[constructor](LibraryError.md#constructor) - -#### Defined in - -[src/provider/errors.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L46) - -## Properties - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -#### Inherited from - -[LibraryError](LibraryError.md).[prepareStackTrace](LibraryError.md#preparestacktrace) - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -[LibraryError](LibraryError.md).[stackTraceLimit](LibraryError.md#stacktracelimit) - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - ---- - -### errorCode - -• **errorCode**: `number` - -#### Defined in - -[src/provider/errors.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L46) - ---- - -### name - -• **name**: `string` - -#### Inherited from - -[LibraryError](LibraryError.md).[name](LibraryError.md#name) - -#### Defined in - -[src/provider/errors.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L16) - ---- - -### message - -• **message**: `string` - -#### Inherited from - -[LibraryError](LibraryError.md).[message](LibraryError.md#message) - -#### Defined in - -www/node_modules/typescript/lib/lib.es5.d.ts:1055 - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -[LibraryError](LibraryError.md).[stack](LibraryError.md#stack) - -#### Defined in - -www/node_modules/typescript/lib/lib.es5.d.ts:1056 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[LibraryError](LibraryError.md).[captureStackTrace](LibraryError.md#capturestacktrace) - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/www/docs/API/classes/LibraryError.md b/www/docs/API/classes/LibraryError.md deleted file mode 100644 index 20b0695d7..000000000 --- a/www/docs/API/classes/LibraryError.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -id: 'LibraryError' -title: 'Class: LibraryError' -sidebar_label: 'LibraryError' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CustomError`](CustomError.md) - - ↳ **`LibraryError`** - - ↳↳ [`GatewayError`](GatewayError.md) - - ↳↳ [`HttpError`](HttpError.md) - -## Constructors - -### constructor - -• **new LibraryError**(`message?`) - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `message?` | `string` | - -#### Inherited from - -[CustomError](CustomError.md).[constructor](CustomError.md#constructor) - -#### Defined in - -[src/provider/errors.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L18) - -## Properties - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -Optional override for formatting stack traces - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -##### Parameters - -| Name | Type | -| :------------ | :----------- | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -#### Inherited from - -[CustomError](CustomError.md).[prepareStackTrace](CustomError.md#preparestacktrace) - -#### Defined in - -node_modules/@types/node/globals.d.ts:11 - ---- - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -[CustomError](CustomError.md).[stackTraceLimit](CustomError.md#stacktracelimit) - -#### Defined in - -node_modules/@types/node/globals.d.ts:13 - ---- - -### name - -• **name**: `string` - -#### Inherited from - -[CustomError](CustomError.md).[name](CustomError.md#name) - -#### Defined in - -[src/provider/errors.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L16) - ---- - -### message - -• **message**: `string` - -#### Inherited from - -[CustomError](CustomError.md).[message](CustomError.md#message) - -#### Defined in - -www/node_modules/typescript/lib/lib.es5.d.ts:1055 - ---- - -### stack - -• `Optional` **stack**: `string` - -#### Inherited from - -[CustomError](CustomError.md).[stack](CustomError.md#stack) - -#### Defined in - -www/node_modules/typescript/lib/lib.es5.d.ts:1056 - -## Methods - -### captureStackTrace - -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :---------------- | :--------- | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -[CustomError](CustomError.md).[captureStackTrace](CustomError.md#capturestacktrace) - -#### Defined in - -node_modules/@types/node/globals.d.ts:4 diff --git a/www/docs/API/classes/Provider.md b/www/docs/API/classes/Provider.md deleted file mode 100644 index d86311fb7..000000000 --- a/www/docs/API/classes/Provider.md +++ /dev/null @@ -1,779 +0,0 @@ ---- -id: 'Provider' -title: 'Class: Provider' -sidebar_label: 'Provider' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`Provider`** - - ↳ [`Account`](Account.md) - -## Implements - -- [`ProviderInterface`](ProviderInterface.md) - -## Constructors - -### constructor - -• **new Provider**(`providerOrOptions?`) - -#### Parameters - -| Name | Type | -| :------------------- | :--------------------------------------------------------------------------------------------------------- | -| `providerOrOptions?` | [`ProviderOptions`](../interfaces/types.ProviderOptions.md) \| [`ProviderInterface`](ProviderInterface.md) | - -#### Defined in - -[src/provider/default.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L43) - -## Properties - -### provider - -• `Private` **provider**: [`ProviderInterface`](ProviderInterface.md) - -#### Defined in - -[src/provider/default.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L41) - -## Methods - -### getChainId - -▸ **getChainId**(): `Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -Gets the Starknet chain Id - -#### Returns - -`Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -the chain Id - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getChainId](ProviderInterface.md#getchainid) - -#### Defined in - -[src/provider/default.ts:65](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L65) - ---- - -### getBlock - -▸ **getBlock**(`blockIdentifier`): `Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -Gets the block information - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -the block object - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getBlock](ProviderInterface.md#getblock) - -#### Defined in - -[src/provider/default.ts:69](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L69) - ---- - -### getClassAt - -▸ **getClassAt**(`contractAddress`, `blockIdentifier?`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Gets the contract class of the deployed contract. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getClassAt](ProviderInterface.md#getclassat) - -#### Defined in - -[src/provider/default.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L73) - ---- - -### getClassHashAt - -▸ **getClassHashAt**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Returns the class hash deployed under the given address. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -Class hash - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getClassHashAt](ProviderInterface.md#getclasshashat) - -#### Defined in - -[src/provider/default.ts:80](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L80) - ---- - -### getClassByHash - -▸ **getClassByHash**(`classHash`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Returns the contract class deployed under the given class hash. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------- | :---------- | -| `classHash` | `string` | class hash | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getClassByHash](ProviderInterface.md#getclassbyhash) - -#### Defined in - -[src/provider/default.ts:87](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L87) - ---- - -### getEstimateFee - -▸ **getEstimateFee**(`invocationWithTxType`, `invocationDetails`, `blockIdentifier`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -**`Deprecated`** - -Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :--------------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocationWithTxType` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `invocationDetails` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getEstimateFee](ProviderInterface.md#getestimatefee) - -#### Defined in - -[src/provider/default.ts:91](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L91) - ---- - -### getInvokeEstimateFee - -▸ **getInvokeEstimateFee**(`invocationWithTxType`, `invocationDetails`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :--------------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocationWithTxType` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `invocationDetails` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getInvokeEstimateFee](ProviderInterface.md#getinvokeestimatefee) - -#### Defined in - -[src/provider/default.ts:99](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L99) - ---- - -### getEstimateFeeBulk - -▸ **getEstimateFeeBulk**(`invocations`, `options`): `Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -Estimates the fee for a list of INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------- | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `options` | [`getEstimateFeeBulkOptions`](../namespaces/types.md#getestimatefeebulkoptions) | getEstimateFeeBulkOptions - (optional) blockIdentifier - BlockIdentifier - (optional) skipValidate - boolean (default false) | - -#### Returns - -`Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getEstimateFeeBulk](ProviderInterface.md#getestimatefeebulk) - -#### Defined in - -[src/provider/default.ts:113](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L113) - ---- - -### getNonceForAddress - -▸ **getNonceForAddress**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the nonce of a contract with respect to a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - | - -#### Returns - -`Promise`<`string`\> - -the hex nonce - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getNonceForAddress](ProviderInterface.md#getnonceforaddress) - -#### Defined in - -[src/provider/default.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L120) - ---- - -### getStorageAt - -▸ **getStorageAt**(`contractAddress`, `key`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the contract's storage variable at a specific key. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------------------------------------------------- | -| `contractAddress` | `string` | | -| `key` | [`BigNumberish`](../namespaces/types.md#bignumberish) | from getStorageVarAddress('') (WIP) | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -the value of the storage variable - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getStorageAt](ProviderInterface.md#getstorageat) - -#### Defined in - -[src/provider/default.ts:127](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L127) - ---- - -### getTransaction - -▸ **getTransaction**(`txHash`): `Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -Gets the transaction information from a tx id. - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? } - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getTransaction](ProviderInterface.md#gettransaction) - -#### Defined in - -[src/provider/default.ts:135](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L135) - ---- - -### getTransactionReceipt - -▸ **getTransactionReceipt**(`txHash`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Gets the transaction receipt from a tx hash. - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -the transaction receipt object - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getTransactionReceipt](ProviderInterface.md#gettransactionreceipt) - -#### Defined in - -[src/provider/default.ts:139](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L139) - ---- - -### callContract - -▸ **callContract**(`request`, `blockIdentifier?`): `Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -Calls a function on the Starknet contract. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :----------------------- | -| `request` | [`Call`](../namespaces/types.md#call) | transaction to be called | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -the result of the function on the smart contract. - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[callContract](ProviderInterface.md#callcontract) - -#### Defined in - -[src/provider/default.ts:143](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L143) - ---- - -### invokeFunction - -▸ **invokeFunction**(`functionInvocation`, `details`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invokes a function on starknet - -**`Deprecated`** - -This method wont be supported as soon as fees are mandatory. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :------------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `functionInvocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version - maxFee - optional maxFee | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -response from addTransaction - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[invokeFunction](ProviderInterface.md#invokefunction) - -#### Defined in - -[src/provider/default.ts:150](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L150) - ---- - -### deployAccountContract - -▸ **deployAccountContract**(`payload`, `details`): `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -Deploys a given compiled Account contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :-------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ | -| `payload` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | payload to be deployed containing: - compiled contract code - constructor calldata - address salt | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | - | - -#### Returns - -`Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[deployAccountContract](ProviderInterface.md#deployaccountcontract) - -#### Defined in - -[src/provider/default.ts:157](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L157) - ---- - -### declareContract - -▸ **declareContract**(`transaction`, `details`): `Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -Declares a given compiled contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | -| `transaction` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be deployed containing: - compiled contract code - sender address - signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | Invocation Details containing: - nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[declareContract](ProviderInterface.md#declarecontract) - -#### Defined in - -[src/provider/default.ts:164](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L164) - ---- - -### getDeclareEstimateFee - -▸ **getDeclareEstimateFee**(`transaction`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DECLARE transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------ | -| `transaction` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be declared containing: - compiled contract code - sender address - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getDeclareEstimateFee](ProviderInterface.md#getdeclareestimatefee) - -#### Defined in - -[src/provider/default.ts:171](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L171) - ---- - -### getDeployAccountEstimateFee - -▸ **getDeployAccountEstimateFee**(`transaction`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DEPLOY_ACCOUNT transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | -| `transaction` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | transaction payload to be deployed containing: - classHash - constructorCalldata - addressSalt - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getDeployAccountEstimateFee](ProviderInterface.md#getdeployaccountestimatefee) - -#### Defined in - -[src/provider/default.ts:180](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L180) - ---- - -### getCode - -▸ **getCode**(`contractAddress`, `blockIdentifier?`): `Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -**`Deprecated`** - -The method should not be used - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------- | -| `contractAddress` | `string` | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getCode](ProviderInterface.md#getcode) - -#### Defined in - -[src/provider/default.ts:194](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L194) - ---- - -### waitForTransaction - -▸ **waitForTransaction**(`txHash`, `options?`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Wait for the transaction to be accepted - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | transaction hash | -| `options?` | [`waitForTransactionOptions`](../namespaces/types.md#waitfortransactionoptions) | waitForTransactionOptions - (optional) retryInterval: number \| undefined; - (optional) successStates: TransactionStatus[] \| undefined; | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -GetTransactionReceiptResponse - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[waitForTransaction](ProviderInterface.md#waitfortransaction) - -#### Defined in - -[src/provider/default.ts:201](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L201) - ---- - -### getSimulateTransaction - -▸ **getSimulateTransaction**(`invocations`, `options?`): `Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -Simulates the transaction and returns the transaction trace and estimated fee. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `options?` | [`getSimulateTransactionOptions`](../namespaces/types.md#getsimulatetransactionoptions) | getSimulateTransactionOptions - (optional) blockIdentifier - block identifier - (optional) skipValidate - skip cairo **validate** method - (optional) skipExecute - skip cairo **execute** method | - -#### Returns - -`Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -an array of transaction trace and estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getSimulateTransaction](ProviderInterface.md#getsimulatetransaction) - -#### Defined in - -[src/provider/default.ts:208](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L208) - ---- - -### getStateUpdate - -▸ **getStateUpdate**(`blockIdentifier?`): `Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -Gets the state changes in a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -StateUpdateResponse - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getStateUpdate](ProviderInterface.md#getstateupdate) - -#### Defined in - -[src/provider/default.ts:215](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L215) - ---- - -### getStarkName - -▸ **getStarkName**(`address`, `StarknetIdContract?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------------- | :---------------------------------------------------- | -| `address` | [`BigNumberish`](../namespaces/types.md#bignumberish) | -| `StarknetIdContract?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/provider/default.ts:219](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L219) - ---- - -### getAddressFromStarkName - -▸ **getAddressFromStarkName**(`name`, `StarknetIdContract?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------------- | :------- | -| `name` | `string` | -| `StarknetIdContract?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/provider/default.ts:223](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L223) - ---- - -### getContractVersion - -▸ **getContractVersion**(`contractAddress`, `classHash?`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `string` | string | -| `classHash?` | `undefined` | undefined | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getContractVersion](ProviderInterface.md#getcontractversion) - -#### Defined in - -[src/provider/default.ts:227](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L227) - -▸ **getContractVersion**(`contractAddress`, `classHash`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `undefined` | undefined | -| `classHash` | `string` | | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getContractVersion](ProviderInterface.md#getcontractversion) - -#### Defined in - -[src/provider/default.ts:232](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L232) diff --git a/www/docs/API/classes/ProviderInterface.md b/www/docs/API/classes/ProviderInterface.md deleted file mode 100644 index 0c4bfa091..000000000 --- a/www/docs/API/classes/ProviderInterface.md +++ /dev/null @@ -1,624 +0,0 @@ ---- -id: 'ProviderInterface' -title: 'Class: ProviderInterface' -sidebar_label: 'ProviderInterface' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`ProviderInterface`** - - ↳ [`AccountInterface`](AccountInterface.md) - -## Implemented by - -- [`Provider`](Provider.md) -- [`RpcProvider`](RpcProvider.md) -- [`SequencerProvider`](SequencerProvider.md) - -## Constructors - -### constructor - -• **new ProviderInterface**() - -## Methods - -### getChainId - -▸ `Abstract` **getChainId**(): `Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -Gets the Starknet chain Id - -#### Returns - -`Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -the chain Id - -#### Defined in - -[src/provider/interface.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L40) - ---- - -### callContract - -▸ `Abstract` **callContract**(`call`, `blockIdentifier?`): `Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -Calls a function on the Starknet contract. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :----------------------- | -| `call` | [`Call`](../namespaces/types.md#call) | transaction to be called | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -the result of the function on the smart contract. - -#### Defined in - -[src/provider/interface.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L49) - ---- - -### getBlock - -▸ `Abstract` **getBlock**(`blockIdentifier`): `Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -Gets the block information - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -the block object - -#### Defined in - -[src/provider/interface.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L60) - ---- - -### getCode - -▸ `Abstract` **getCode**(`contractAddress`, `blockIdentifier?`): `Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -**`Deprecated`** - -The method should not be used - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------- | -| `contractAddress` | `string` | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -#### Defined in - -[src/provider/interface.ts:65](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L65) - ---- - -### getClassAt - -▸ `Abstract` **getClassAt**(`contractAddress`, `blockIdentifier?`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Gets the contract class of the deployed contract. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Defined in - -[src/provider/interface.ts:77](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L77) - ---- - -### getClassHashAt - -▸ `Abstract` **getClassHashAt**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Returns the class hash deployed under the given address. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -Class hash - -#### Defined in - -[src/provider/interface.ts:89](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L89) - ---- - -### getClassByHash - -▸ `Abstract` **getClassByHash**(`classHash`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Returns the contract class deployed under the given class hash. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------- | :---------- | -| `classHash` | `string` | class hash | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Defined in - -[src/provider/interface.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L100) - ---- - -### getNonceForAddress - -▸ `Abstract` **getNonceForAddress**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the nonce of a contract with respect to a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - | - -#### Returns - -`Promise`<`string`\> - -the hex nonce - -#### Defined in - -[src/provider/interface.ts:108](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L108) - ---- - -### getStorageAt - -▸ `Abstract` **getStorageAt**(`contractAddress`, `key`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the contract's storage variable at a specific key. - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------------------------------------------------- | -| `contractAddress` | `string` | | -| `key` | [`BigNumberish`](../namespaces/types.md#bignumberish) | from getStorageVarAddress('') (WIP) | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -the value of the storage variable - -#### Defined in - -[src/provider/interface.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L121) - ---- - -### getTransaction - -▸ `Abstract` **getTransaction**(`transactionHash`): `Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -Gets the transaction information from a tx id. - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------- | -| `transactionHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? } - -#### Defined in - -[src/provider/interface.ts:133](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L133) - ---- - -### getTransactionReceipt - -▸ `Abstract` **getTransactionReceipt**(`transactionHash`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Gets the transaction receipt from a tx hash. - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------- | -| `transactionHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -the transaction receipt object - -#### Defined in - -[src/provider/interface.ts:141](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L141) - ---- - -### deployAccountContract - -▸ `Abstract` **deployAccountContract**(`payload`, `details`): `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -Deploys a given compiled Account contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :-------- | :------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------ | -| `payload` | [`DeployAccountContractPayload`](../namespaces/types.md#deployaccountcontractpayload) | payload to be deployed containing: - compiled contract code - constructor calldata - address salt | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | - | - -#### Returns - -`Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Defined in - -[src/provider/interface.ts:154](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L154) - ---- - -### invokeFunction - -▸ `Abstract` **invokeFunction**(`invocation`, `details`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invokes a function on starknet - -**`Deprecated`** - -This method wont be supported as soon as fees are mandatory. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :----------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version - maxFee - optional maxFee | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -response from addTransaction - -#### Defined in - -[src/provider/interface.ts:174](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L174) - ---- - -### declareContract - -▸ `Abstract` **declareContract**(`transaction`, `details`): `Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -Declares a given compiled contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :------------ | :---------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | -| `transaction` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be deployed containing: - compiled contract code - sender address - signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | Invocation Details containing: - nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Defined in - -[src/provider/interface.ts:191](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L191) - ---- - -### getEstimateFee - -▸ `Abstract` **getEstimateFee**(`invocation`, `details`, `blockIdentifier`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -**`Deprecated`** - -Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Defined in - -[src/provider/interface.ts:212](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L212) - ---- - -### getInvokeEstimateFee - -▸ `Abstract` **getInvokeEstimateFee**(`invocation`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Defined in - -[src/provider/interface.ts:234](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L234) - ---- - -### getDeclareEstimateFee - -▸ `Abstract` **getDeclareEstimateFee**(`transaction`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DECLARE transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------ | -| `transaction` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be declared containing: - compiled contract code - sender address - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Defined in - -[src/provider/interface.ts:256](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L256) - ---- - -### getDeployAccountEstimateFee - -▸ `Abstract` **getDeployAccountEstimateFee**(`transaction`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DEPLOY_ACCOUNT transaction - -#### Parameters - -| Name | Type | Description | -| :----------------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | -| `transaction` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | transaction payload to be deployed containing: - classHash - constructorCalldata - addressSalt - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | -| `skipValidate?` | `boolean` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Defined in - -[src/provider/interface.ts:279](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L279) - ---- - -### getEstimateFeeBulk - -▸ `Abstract` **getEstimateFeeBulk**(`invocations`, `options?`): `Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -Estimates the fee for a list of INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------- | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `options?` | [`getEstimateFeeBulkOptions`](../namespaces/types.md#getestimatefeebulkoptions) | getEstimateFeeBulkOptions - (optional) blockIdentifier - BlockIdentifier - (optional) skipValidate - boolean (default false) | - -#### Returns - -`Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -the estimated fee - -#### Defined in - -[src/provider/interface.ts:295](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L295) - ---- - -### waitForTransaction - -▸ `Abstract` **waitForTransaction**(`txHash`, `options?`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Wait for the transaction to be accepted - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | transaction hash | -| `options?` | [`waitForTransactionOptions`](../namespaces/types.md#waitfortransactionoptions) | waitForTransactionOptions - (optional) retryInterval: number \| undefined; - (optional) successStates: TransactionStatus[] \| undefined; | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -GetTransactionReceiptResponse - -#### Defined in - -[src/provider/interface.ts:308](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L308) - ---- - -### getSimulateTransaction - -▸ `Abstract` **getSimulateTransaction**(`invocations`, `options?`): `Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -Simulates the transaction and returns the transaction trace and estimated fee. - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `options?` | [`getSimulateTransactionOptions`](../namespaces/types.md#getsimulatetransactionoptions) | getSimulateTransactionOptions - (optional) blockIdentifier - block identifier - (optional) skipValidate - skip cairo **validate** method - (optional) skipExecute - skip cairo **execute** method | - -#### Returns - -`Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -an array of transaction trace and estimated fee - -#### Defined in - -[src/provider/interface.ts:323](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L323) - ---- - -### getStateUpdate - -▸ `Abstract` **getStateUpdate**(`blockIdentifier?`): `Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -Gets the state changes in a specific block - -#### Parameters - -| Name | Type | Description | -| :----------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -StateUpdateResponse - -#### Defined in - -[src/provider/interface.ts:334](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L334) - ---- - -### getContractVersion - -▸ `Abstract` **getContractVersion**(`contractAddress`, `classHash?`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `string` | string | -| `classHash?` | `undefined` | undefined | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Defined in - -[src/provider/interface.ts:344](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L344) - -▸ `Abstract` **getContractVersion**(`contractAddress`, `classHash`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `undefined` | undefined | -| `classHash` | `string` | | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Defined in - -[src/provider/interface.ts:358](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/interface.ts#L358) diff --git a/www/docs/API/classes/RpcProvider.md b/www/docs/API/classes/RpcProvider.md deleted file mode 100644 index a12d193e0..000000000 --- a/www/docs/API/classes/RpcProvider.md +++ /dev/null @@ -1,1177 +0,0 @@ ---- -id: 'RpcProvider' -title: 'Class: RpcProvider' -sidebar_label: 'RpcProvider' -sidebar_position: 0 -custom_edit_url: null ---- - -## Implements - -- [`ProviderInterface`](ProviderInterface.md) - -## Constructors - -### constructor - -• **new RpcProvider**(`optionsOrProvider`) - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------------------------------------------- | -| `optionsOrProvider` | [`RpcProviderOptions`](../namespaces/types.md#rpcprovideroptions) | - -#### Defined in - -[src/provider/rpc.ts:79](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L79) - -## Properties - -### nodeUrl - -• **nodeUrl**: `string` - -#### Defined in - -[src/provider/rpc.ts:67](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L67) - ---- - -### headers - -• **headers**: `object` - -#### Defined in - -[src/provider/rpc.ts:69](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L69) - ---- - -### responseParser - -• `Private` **responseParser**: `RPCResponseParser` - -#### Defined in - -[src/provider/rpc.ts:71](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L71) - ---- - -### retries - -• `Private` **retries**: `number` - -#### Defined in - -[src/provider/rpc.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L73) - ---- - -### blockIdentifier - -• `Private` **blockIdentifier**: [`BlockIdentifier`](../namespaces/types.md#blockidentifier) - -#### Defined in - -[src/provider/rpc.ts:75](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L75) - ---- - -### chainId - -• `Private` `Optional` **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/provider/rpc.ts:77](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L77) - -## Methods - -### fetch - -▸ **fetch**(`method`, `params`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :------- | :---- | -| `method` | `any` | -| `params` | `any` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[src/provider/rpc.ts:89](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L89) - ---- - -### errorHandler - -▸ `Protected` **errorHandler**(`error`): `void` - -#### Parameters - -| Name | Type | -| :------ | :---- | -| `error` | `any` | - -#### Returns - -`void` - -#### Defined in - -[src/provider/rpc.ts:98](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L98) - ---- - -### fetchEndpoint - -▸ `Protected` **fetchEndpoint**<`T`\>(`method`, `params?`): `Promise`<`Methods`[`T`][``"result"``]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------- | -| `T` | extends keyof `Methods` | - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------- | -| `method` | `T` | -| `params?` | `Methods`[`T`][``"params"``] | - -#### Returns - -`Promise`<`Methods`[`T`][``"result"``]\> - -#### Defined in - -[src/provider/rpc.ts:105](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L105) - ---- - -### getChainId - -▸ **getChainId**(): `Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -Gets the Starknet chain Id - -#### Returns - -`Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -the chain Id - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getChainId](ProviderInterface.md#getchainid) - -#### Defined in - -[src/provider/rpc.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L121) - ---- - -### getBlock - -▸ **getBlock**(`blockIdentifier?`): `Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -Gets the block information - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -the block object - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getBlock](ProviderInterface.md#getblock) - -#### Defined in - -[src/provider/rpc.ts:126](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L126) - ---- - -### getBlockHashAndNumber - -▸ **getBlockHashAndNumber**(): `Promise`<`BlockHashAndNumber`\> - -#### Returns - -`Promise`<`BlockHashAndNumber`\> - -#### Defined in - -[src/provider/rpc.ts:134](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L134) - ---- - -### getBlockWithTxHashes - -▸ **getBlockWithTxHashes**(`blockIdentifier?`): `Promise`<`BlockWithTxHashes`\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<`BlockWithTxHashes`\> - -#### Defined in - -[src/provider/rpc.ts:138](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L138) - ---- - -### getBlockWithTxs - -▸ **getBlockWithTxs**(`blockIdentifier?`): `Promise`<`BlockWithTxs`\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<`BlockWithTxs`\> - -#### Defined in - -[src/provider/rpc.ts:145](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L145) - ---- - -### getClassHashAt - -▸ **getClassHashAt**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Returns the class hash deployed under the given address. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -Class hash - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getClassHashAt](ProviderInterface.md#getclasshashat) - -#### Defined in - -[src/provider/rpc.ts:152](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L152) - ---- - -### getNonceForAddress - -▸ **getNonceForAddress**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the nonce of a contract with respect to a specific block - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - | - -#### Returns - -`Promise`<`string`\> - -the hex nonce - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getNonceForAddress](ProviderInterface.md#getnonceforaddress) - -#### Defined in - -[src/provider/rpc.ts:163](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L163) - ---- - -### getPendingTransactions - -▸ **getPendingTransactions**(): `Promise`<`PendingTransactions`\> - -#### Returns - -`Promise`<`PendingTransactions`\> - -#### Defined in - -[src/provider/rpc.ts:174](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L174) - ---- - -### getProtocolVersion - -▸ **getProtocolVersion**(): `Promise`<`Error`\> - -#### Returns - -`Promise`<`Error`\> - -#### Defined in - -[src/provider/rpc.ts:178](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L178) - ---- - -### getStateUpdate - -▸ **getStateUpdate**(`blockIdentifier?`): `Promise`<`StateUpdate`\> - -Gets the state changes in a specific block - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`StateUpdate`\> - -StateUpdateResponse - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getStateUpdate](ProviderInterface.md#getstateupdate) - -#### Defined in - -[src/provider/rpc.ts:182](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L182) - ---- - -### getStorageAt - -▸ **getStorageAt**(`contractAddress`, `key`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the contract's storage variable at a specific key. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------------------------------------------------- | -| `contractAddress` | `string` | | -| `key` | [`BigNumberish`](../namespaces/types.md#bignumberish) | from getStorageVarAddress('') (WIP) | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -the value of the storage variable - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getStorageAt](ProviderInterface.md#getstorageat) - -#### Defined in - -[src/provider/rpc.ts:189](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L189) - ---- - -### getTransaction - -▸ **getTransaction**(`txHash`): `Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -Gets the transaction information from a tx id. - -#### Parameters - -| Name | Type | -| :------- | :------- | -| `txHash` | `string` | - -#### Returns - -`Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? } - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getTransaction](ProviderInterface.md#gettransaction) - -#### Defined in - -[src/provider/rpc.ts:204](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L204) - ---- - -### getTransactionByHash - -▸ **getTransactionByHash**(`txHash`): `Promise`<`TXN`\> - -#### Parameters - -| Name | Type | -| :------- | :------- | -| `txHash` | `string` | - -#### Returns - -`Promise`<`TXN`\> - -#### Defined in - -[src/provider/rpc.ts:208](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L208) - ---- - -### getTransactionByBlockIdAndIndex - -▸ **getTransactionByBlockIdAndIndex**(`blockIdentifier`, `index`): `Promise`<`TXN`\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | -| `index` | `number` | - -#### Returns - -`Promise`<`TXN`\> - -#### Defined in - -[src/provider/rpc.ts:212](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L212) - ---- - -### getTransactionReceipt - -▸ **getTransactionReceipt**(`txHash`): `Promise`<`TXN_RECEIPT`\> - -Gets the transaction receipt from a tx hash. - -#### Parameters - -| Name | Type | -| :------- | :------- | -| `txHash` | `string` | - -#### Returns - -`Promise`<`TXN_RECEIPT`\> - -the transaction receipt object - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getTransactionReceipt](ProviderInterface.md#gettransactionreceipt) - -#### Defined in - -[src/provider/rpc.ts:220](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L220) - ---- - -### getClassByHash - -▸ **getClassByHash**(`classHash`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Returns the contract class deployed under the given class hash. - -#### Parameters - -| Name | Type | Description | -| :---------- | :------- | :---------- | -| `classHash` | `string` | class hash | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getClassByHash](ProviderInterface.md#getclassbyhash) - -#### Defined in - -[src/provider/rpc.ts:224](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L224) - ---- - -### getClass - -▸ **getClass**(`classHash`, `blockIdentifier?`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------------- | -| `classHash` | `string` | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -#### Defined in - -[src/provider/rpc.ts:228](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L228) - ---- - -### getClassAt - -▸ **getClassAt**(`contractAddress`, `blockIdentifier?`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Gets the contract class of the deployed contract. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getClassAt](ProviderInterface.md#getclassat) - -#### Defined in - -[src/provider/rpc.ts:239](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L239) - ---- - -### getCode - -▸ **getCode**(`_contractAddress`, `_blockIdentifier?`): `Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -**`Deprecated`** - -The method should not be used - -#### Parameters - -| Name | Type | -| :------------------ | :---------------------------------------------------------- | -| `_contractAddress` | `string` | -| `_blockIdentifier?` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`GetCodeResponse`](../interfaces/types.GetCodeResponse.md)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getCode](ProviderInterface.md#getcode) - -#### Defined in - -[src/provider/rpc.ts:250](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L250) - ---- - -### getContractVersion - -▸ **getContractVersion**(`contractAddress`, `classHash?`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `string` | string | -| `classHash?` | `undefined` | undefined | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getContractVersion](ProviderInterface.md#getcontractversion) - -#### Defined in - -[src/provider/rpc.ts:257](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L257) - -▸ **getContractVersion**(`contractAddress`, `classHash`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `undefined` | undefined | -| `classHash` | `string` | | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getContractVersion](ProviderInterface.md#getcontractversion) - -#### Defined in - -[src/provider/rpc.ts:262](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L262) - ---- - -### getEstimateFee - -▸ **getEstimateFee**(`invocation`, `invocationDetails`, `blockIdentifier?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -**`Deprecated`** - -Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :------------------ | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `invocationDetails` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getEstimateFee](ProviderInterface.md#getestimatefee) - -#### Defined in - -[src/provider/rpc.ts:292](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L292) - ---- - -### getInvokeEstimateFee - -▸ **getInvokeEstimateFee**(`invocation`, `invocationDetails`, `blockIdentifier?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :------------------ | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `invocationDetails` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getInvokeEstimateFee](ProviderInterface.md#getinvokeestimatefee) - -#### Defined in - -[src/provider/rpc.ts:300](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L300) - ---- - -### getDeclareEstimateFee - -▸ **getDeclareEstimateFee**(`invocation`, `details`, `blockIdentifier?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DECLARE transaction - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------ | -| `invocation` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be declared containing: - compiled contract code - sender address - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getDeclareEstimateFee](ProviderInterface.md#getdeclareestimatefee) - -#### Defined in - -[src/provider/rpc.ts:320](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L320) - ---- - -### getDeployAccountEstimateFee - -▸ **getDeployAccountEstimateFee**(`invocation`, `details`, `blockIdentifier?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DEPLOY_ACCOUNT transaction - -#### Parameters - -| Name | Type | Description | -| :---------------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ | -| `invocation` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | transaction payload to be deployed containing: - classHash - constructorCalldata - addressSalt - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | (optional) block identifier | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getDeployAccountEstimateFee](ProviderInterface.md#getdeployaccountestimatefee) - -#### Defined in - -[src/provider/rpc.ts:340](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L340) - ---- - -### getEstimateFeeBulk - -▸ **getEstimateFeeBulk**(`invocations`, `«destructured»`): `Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -Estimates the fee for a list of INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------- | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `«destructured»` | [`getEstimateFeeBulkOptions`](../namespaces/types.md#getestimatefeebulkoptions) | getEstimateFeeBulkOptions - (optional) blockIdentifier - BlockIdentifier - (optional) skipValidate - boolean (default false) | - -#### Returns - -`Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getEstimateFeeBulk](ProviderInterface.md#getestimatefeebulk) - -#### Defined in - -[src/provider/rpc.ts:360](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L360) - ---- - -### declareContract - -▸ **declareContract**(`«destructured»`, `details`): `Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -Declares a given compiled contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :--------------- | :---------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | -| `«destructured»` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be deployed containing: - compiled contract code - sender address - signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | Invocation Details containing: - nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[declareContract](ProviderInterface.md#declarecontract) - -#### Defined in - -[src/provider/rpc.ts:375](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L375) - ---- - -### deployAccountContract - -▸ **deployAccountContract**(`«destructured»`, `details`): `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -Deploys a given compiled Account contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :--------------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ | -| `«destructured»` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | payload to be deployed containing: - compiled contract code - constructor calldata - address salt | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | - | - -#### Returns - -`Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[deployAccountContract](ProviderInterface.md#deployaccountcontract) - -#### Defined in - -[src/provider/rpc.ts:415](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L415) - ---- - -### invokeFunction - -▸ **invokeFunction**(`functionInvocation`, `details`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invokes a function on starknet - -**`Deprecated`** - -This method wont be supported as soon as fees are mandatory. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :------------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `functionInvocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version - maxFee - optional maxFee | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -response from addTransaction - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[invokeFunction](ProviderInterface.md#invokefunction) - -#### Defined in - -[src/provider/rpc.ts:433](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L433) - ---- - -### callContract - -▸ **callContract**(`call`, `blockIdentifier?`): `Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -Calls a function on the Starknet contract. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :----------------------- | -| `call` | [`Call`](../namespaces/types.md#call) | transaction to be called | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -the result of the function on the smart contract. - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[callContract](ProviderInterface.md#callcontract) - -#### Defined in - -[src/provider/rpc.ts:451](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L451) - ---- - -### traceTransaction - -▸ **traceTransaction**(`transactionHash`): `Promise`<`TRANSACTION_TRACE`\> - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `transactionHash` | `string` | - -#### Returns - -`Promise`<`TRANSACTION_TRACE`\> - -#### Defined in - -[src/provider/rpc.ts:468](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L468) - ---- - -### traceBlockTransactions - -▸ **traceBlockTransactions**(`blockHash`): `Promise`<`Traces`\> - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `blockHash` | `string` | - -#### Returns - -`Promise`<`Traces`\> - -#### Defined in - -[src/provider/rpc.ts:472](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L472) - ---- - -### waitForTransaction - -▸ **waitForTransaction**(`txHash`, `options?`): `Promise`<`any`\> - -Wait for the transaction to be accepted - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- | -| `txHash` | `string` | transaction hash | -| `options?` | [`waitForTransactionOptions`](../namespaces/types.md#waitfortransactionoptions) | waitForTransactionOptions - (optional) retryInterval: number \| undefined; - (optional) successStates: TransactionStatus[] \| undefined; | - -#### Returns - -`Promise`<`any`\> - -GetTransactionReceiptResponse - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[waitForTransaction](ProviderInterface.md#waitfortransaction) - -#### Defined in - -[src/provider/rpc.ts:476](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L476) - ---- - -### getTransactionCount - -▸ **getTransactionCount**(`blockIdentifier?`): `Promise`<`number`\> - -Gets the transaction count from a block. - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<`number`\> - -Number of transactions - -#### Defined in - -[src/provider/rpc.ts:541](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L541) - ---- - -### getBlockNumber - -▸ **getBlockNumber**(): `Promise`<`number`\> - -Gets the latest block number - -#### Returns - -`Promise`<`number`\> - -Number of the latest block - -#### Defined in - -[src/provider/rpc.ts:554](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L554) - ---- - -### getSyncingStats - -▸ **getSyncingStats**(): `Promise`<`SyncingStatus`\> - -Gets syncing status of the node - -#### Returns - -`Promise`<`SyncingStatus`\> - -Object with the stats data - -#### Defined in - -[src/provider/rpc.ts:564](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L564) - ---- - -### getEvents - -▸ **getEvents**(`eventFilter`): `Promise`<`EVENTS_CHUNK`\> - -Gets all the events filtered - -#### Parameters - -| Name | Type | -| :------------ | :------------ | -| `eventFilter` | `EventFilter` | - -#### Returns - -`Promise`<`EVENTS_CHUNK`\> - -events and the pagination of the events - -#### Defined in - -[src/provider/rpc.ts:574](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L574) - ---- - -### getSimulateTransaction - -▸ **getSimulateTransaction**(`invocations`, `«destructured»`): `Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -Simulates the transaction and returns the transaction trace and estimated fee. - -#### Parameters - -| Name | Type | Description | -| :--------------- | :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `«destructured»` | [`getSimulateTransactionOptions`](../namespaces/types.md#getsimulatetransactionoptions) | getSimulateTransactionOptions - (optional) blockIdentifier - block identifier - (optional) skipValidate - skip cairo **validate** method - (optional) skipExecute - skip cairo **execute** method | - -#### Returns - -`Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -an array of transaction trace and estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getSimulateTransaction](ProviderInterface.md#getsimulatetransaction) - -#### Defined in - -[src/provider/rpc.ts:578](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L578) - ---- - -### getStarkName - -▸ **getStarkName**(`address`, `StarknetIdContract?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------------- | :---------------------------------------------------- | -| `address` | [`BigNumberish`](../namespaces/types.md#bignumberish) | -| `StarknetIdContract?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/provider/rpc.ts:600](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L600) - ---- - -### getAddressFromStarkName - -▸ **getAddressFromStarkName**(`name`, `StarknetIdContract?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------------- | :------- | -| `name` | `string` | -| `StarknetIdContract?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/provider/rpc.ts:604](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L604) - ---- - -### buildTransaction - -▸ **buildTransaction**(`invocation`, `versionType?`): [`BaseTransaction`](../namespaces/types.RPC.md#basetransaction) - -#### Parameters - -| Name | Type | -| :------------- | :---------------------------------------------------------------------- | -| `invocation` | [`AccountInvocationItem`](../namespaces/types.md#accountinvocationitem) | -| `versionType?` | `"fee"` \| `"transaction"` | - -#### Returns - -[`BaseTransaction`](../namespaces/types.RPC.md#basetransaction) - -#### Defined in - -[src/provider/rpc.ts:608](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/rpc.ts#L608) diff --git a/www/docs/API/classes/SequencerProvider.md b/www/docs/API/classes/SequencerProvider.md deleted file mode 100644 index 3355fe6f4..000000000 --- a/www/docs/API/classes/SequencerProvider.md +++ /dev/null @@ -1,1158 +0,0 @@ ---- -id: 'SequencerProvider' -title: 'Class: SequencerProvider' -sidebar_label: 'SequencerProvider' -sidebar_position: 0 -custom_edit_url: null ---- - -## Implements - -- [`ProviderInterface`](ProviderInterface.md) - -## Constructors - -### constructor - -• **new SequencerProvider**(`optionsOrProvider?`) - -#### Parameters - -| Name | Type | Default value | -| :------------------ | :---------------------------------------------------------------------------- | :--------------- | -| `optionsOrProvider` | [`SequencerProviderOptions`](../namespaces/types.md#sequencerprovideroptions) | `defaultOptions` | - -#### Defined in - -[src/provider/sequencer.ts:94](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L94) - -## Properties - -### baseUrl - -• **baseUrl**: `string` - -#### Defined in - -[src/provider/sequencer.ts:80](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L80) - ---- - -### feederGatewayUrl - -• **feederGatewayUrl**: `string` - -#### Defined in - -[src/provider/sequencer.ts:82](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L82) - ---- - -### gatewayUrl - -• **gatewayUrl**: `string` - -#### Defined in - -[src/provider/sequencer.ts:84](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L84) - ---- - -### headers - -• `Optional` **headers**: `Record`<`string`, `string`\> - -#### Defined in - -[src/provider/sequencer.ts:86](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L86) - ---- - -### blockIdentifier - -• `Private` **blockIdentifier**: [`BlockIdentifier`](../namespaces/types.md#blockidentifier) - -#### Defined in - -[src/provider/sequencer.ts:88](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L88) - ---- - -### chainId - -• `Private` **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/provider/sequencer.ts:90](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L90) - ---- - -### responseParser - -• `Private` **responseParser**: `SequencerAPIResponseParser` - -#### Defined in - -[src/provider/sequencer.ts:92](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L92) - -## Methods - -### getNetworkFromName - -▸ `Static` `Protected` **getNetworkFromName**(`name`): `BaseUrl` - -#### Parameters - -| Name | Type | -| :----- | :--------------------------------------------------------------------------------------------------------------- | -| `name` | [`StarknetChainId`](../enums/constants.StarknetChainId.md) \| [`NetworkName`](../enums/constants.NetworkName.md) | - -#### Returns - -`BaseUrl` - -#### Defined in - -[src/provider/sequencer.ts:114](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L114) - ---- - -### getChainIdFromBaseUrl - -▸ `Static` `Protected` **getChainIdFromBaseUrl**(`baseUrl`): [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `baseUrl` | `string` | - -#### Returns - -[`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/provider/sequencer.ts:127](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L127) - ---- - -### getFetchUrl - -▸ `Private` **getFetchUrl**(`endpoint`): `string` - -#### Parameters - -| Name | Type | -| :--------- | :-------------------------------------------------------------- | -| `endpoint` | keyof [`Endpoints`](../namespaces/types.Sequencer.md#endpoints) | - -#### Returns - -`string` - -#### Defined in - -[src/provider/sequencer.ts:141](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L141) - ---- - -### getFetchMethod - -▸ `Private` **getFetchMethod**(`endpoint`): `"POST"` \| `"GET"` - -#### Parameters - -| Name | Type | -| :--------- | :-------------------------------------------------------------- | -| `endpoint` | keyof [`Endpoints`](../namespaces/types.Sequencer.md#endpoints) | - -#### Returns - -`"POST"` \| `"GET"` - -#### Defined in - -[src/provider/sequencer.ts:146](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L146) - ---- - -### getQueryString - -▸ `Private` **getQueryString**(`query?`): `string` - -#### Parameters - -| Name | Type | -| :------- | :------------------------- | -| `query?` | `Record`<`string`, `any`\> | - -#### Returns - -`string` - -#### Defined in - -[src/provider/sequencer.ts:159](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L159) - ---- - -### getHeaders - -▸ `Private` **getHeaders**(`method`): `undefined` \| `Record`<`string`, `string`\> - -#### Parameters - -| Name | Type | -| :------- | :------------------------------------------------------------------ | -| `method` | [`SequencerHttpMethod`](../namespaces/types.md#sequencerhttpmethod) | - -#### Returns - -`undefined` \| `Record`<`string`, `string`\> - -#### Defined in - -[src/provider/sequencer.ts:176](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L176) - ---- - -### fetchEndpoint - -▸ `Protected` **fetchEndpoint**<`T`\>(`endpoint`, `...«destructured»`): `Promise`<[`Endpoints`](../namespaces/types.Sequencer.md#endpoints)[`T`][``"RESPONSE"``]\> - -#### Type parameters - -| Name | Type | -| :--- | :---------------------------------------------------------------------- | -| `T` | extends keyof [`Endpoints`](../namespaces/types.Sequencer.md#endpoints) | - -#### Parameters - -| Name | Type | -| :------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `endpoint` | `T` | -| `...«destructured»` | [`Endpoints`](../namespaces/types.Sequencer.md#endpoints)[`T`][``"QUERY"``] extends `never` ? [`Endpoints`](../namespaces/types.Sequencer.md#endpoints)[`T`][``"REQUEST"``] extends `never` ? [] : [`undefined`, [`Endpoints`](../namespaces/types.Sequencer.md#endpoints)[`T`][``"REQUEST"``]] : [`Endpoints`](../namespaces/types.Sequencer.md#endpoints)[`T`][``"REQUEST"``] extends `never` ? [[`Endpoints`](../namespaces/types.Sequencer.md#endpoints)[`T`][``"QUERY"``]] : [[`Endpoints`](../namespaces/types.Sequencer.md#endpoints)[`T`][``"QUERY"``], [`Endpoints`](../namespaces/types.Sequencer.md#endpoints)[`T`][``"REQUEST"``]] | - -#### Returns - -`Promise`<[`Endpoints`](../namespaces/types.Sequencer.md#endpoints)[`T`][``"RESPONSE"``]\> - -#### Defined in - -[src/provider/sequencer.ts:187](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L187) - ---- - -### fetch - -▸ **fetch**(`endpoint`, `options?`): `Promise`<`any`\> - -#### Parameters - -| Name | Type | -| :----------------------------- | :------------------------------------------------------------------ | -| `endpoint` | `string` | -| `options?` | `Object` | -| `options.method?` | [`SequencerHttpMethod`](../namespaces/types.md#sequencerhttpmethod) | -| `options.body?` | `any` | -| `options.parseAlwaysAsBigInt?` | `boolean` | - -#### Returns - -`Promise`<`any`\> - -#### Defined in - -[src/provider/sequencer.ts:209](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L209) - ---- - -### getChainId - -▸ **getChainId**(): `Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -Gets the Starknet chain Id - -#### Returns - -`Promise`<[`StarknetChainId`](../enums/constants.StarknetChainId.md)\> - -the chain Id - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getChainId](ProviderInterface.md#getchainid) - -#### Defined in - -[src/provider/sequencer.ts:250](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L250) - ---- - -### callContract - -▸ **callContract**(`«destructured»`, `blockIdentifier?`): `Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -Calls a function on the Starknet contract. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :----------------------- | -| `«destructured»` | [`Call`](../namespaces/types.md#call) | transaction to be called | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`CallContractResponse`](../namespaces/types.md#callcontractresponse)\> - -the result of the function on the smart contract. - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[callContract](ProviderInterface.md#callcontract) - -#### Defined in - -[src/provider/sequencer.ts:254](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L254) - ---- - -### getBlock - -▸ **getBlock**(`blockIdentifier?`): `Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -Gets the block information - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`GetBlockResponse`](../interfaces/types.GetBlockResponse.md)\> - -the block object - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getBlock](ProviderInterface.md#getblock) - -#### Defined in - -[src/provider/sequencer.ts:272](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L272) - ---- - -### getNonceForAddress - -▸ **getNonceForAddress**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the nonce of a contract with respect to a specific block - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - | - -#### Returns - -`Promise`<`string`\> - -the hex nonce - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getNonceForAddress](ProviderInterface.md#getnonceforaddress) - -#### Defined in - -[src/provider/sequencer.ts:280](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L280) - ---- - -### getStorageAt - -▸ **getStorageAt**(`contractAddress`, `key`, `blockIdentifier?`): `Promise`<`string`\> - -Gets the contract's storage variable at a specific key. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------------------------------------------------- | -| `contractAddress` | `string` | | -| `key` | [`BigNumberish`](../namespaces/types.md#bignumberish) | from getStorageVarAddress('') (WIP) | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -the value of the storage variable - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getStorageAt](ProviderInterface.md#getstorageat) - -#### Defined in - -[src/provider/sequencer.ts:287](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L287) - ---- - -### getTransaction - -▸ **getTransaction**(`txHash`): `Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -Gets the transaction information from a tx id. - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionResponse`](../namespaces/types.md#gettransactionresponse)\> - -the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? } - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getTransaction](ProviderInterface.md#gettransaction) - -#### Defined in - -[src/provider/sequencer.ts:300](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L300) - ---- - -### getTransactionReceipt - -▸ **getTransactionReceipt**(`txHash`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Gets the transaction receipt from a tx hash. - -#### Parameters - -| Name | Type | -| :------- | :---------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -the transaction receipt object - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getTransactionReceipt](ProviderInterface.md#gettransactionreceipt) - -#### Defined in - -[src/provider/sequencer.ts:309](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L309) - ---- - -### getClassAt - -▸ **getClassAt**(`contractAddress`, `blockIdentifier?`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Gets the contract class of the deployed contract. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getClassAt](ProviderInterface.md#getclassat) - -#### Defined in - -[src/provider/sequencer.ts:316](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L316) - ---- - -### getClassHashAt - -▸ **getClassHashAt**(`contractAddress`, `blockIdentifier?`): `Promise`<`string`\> - -Returns the class hash deployed under the given address. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `contractAddress` | `string` | contract address | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<`string`\> - -Class hash - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getClassHashAt](ProviderInterface.md#getclasshashat) - -#### Defined in - -[src/provider/sequencer.ts:325](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L325) - ---- - -### getClassByHash - -▸ **getClassByHash**(`classHash`, `blockIdentifier?`): `Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Returns the contract class deployed under the given class hash. - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :---------- | -| `classHash` | `string` | class hash | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - | - -#### Returns - -`Promise`<[`ContractClassResponse`](../namespaces/types.md#contractclassresponse)\> - -Contract class of compiled contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getClassByHash](ProviderInterface.md#getclassbyhash) - -#### Defined in - -[src/provider/sequencer.ts:332](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L332) - ---- - -### getCompiledClassByClassHash - -▸ **getCompiledClassByClassHash**(`classHash`, `blockIdentifier?`): `Promise`<[`CairoAssembly`](../namespaces/types.md#cairoassembly)\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------------- | -| `classHash` | `string` | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`CairoAssembly`](../namespaces/types.md#cairoassembly)\> - -#### Defined in - -[src/provider/sequencer.ts:341](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L341) - ---- - -### getContractVersion - -▸ **getContractVersion**(`contractAddress`, `classHash?`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `string` | string | -| `classHash?` | `undefined` | undefined | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getContractVersion](ProviderInterface.md#getcontractversion) - -#### Defined in - -[src/provider/sequencer.ts:348](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L348) - -▸ **getContractVersion**(`contractAddress`, `classHash`, `options?`): `Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -Gets the contract version from the provided address - -#### Parameters - -| Name | Type | Description | -| :---------------- | :------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contractAddress` | `undefined` | undefined | -| `classHash` | `string` | | -| `options?` | [`getContractVersionOptions`](../namespaces/types.md#getcontractversionoptions) | getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier | - -#### Returns - -`Promise`<[`ContractVersion`](../namespaces/types.md#contractversion)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getContractVersion](ProviderInterface.md#getcontractversion) - -#### Defined in - -[src/provider/sequencer.ts:353](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L353) - ---- - -### invokeFunction - -▸ **invokeFunction**(`functionInvocation`, `details`): `Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -Invokes a function on starknet - -**`Deprecated`** - -This method wont be supported as soon as fees are mandatory. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Description | -| :------------------- | :---------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `functionInvocation` | [`Invocation`](../namespaces/types.md#invocation) | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | optional details containing: - nonce - optional nonce - version - optional version - maxFee - optional maxFee | - -#### Returns - -`Promise`<[`InvokeFunctionResponse`](../interfaces/types.InvokeFunctionResponse.md)\> - -response from addTransaction - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[invokeFunction](ProviderInterface.md#invokefunction) - -#### Defined in - -[src/provider/sequencer.ts:383](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L383) - ---- - -### deployAccountContract - -▸ **deployAccountContract**(`«destructured»`, `details`): `Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -Deploys a given compiled Account contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :--------------- | :-------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------ | -| `«destructured»` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | payload to be deployed containing: - compiled contract code - constructor calldata - address salt | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | - | - -#### Returns - -`Promise`<[`DeployContractResponse`](../interfaces/types.DeployContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[deployAccountContract](ProviderInterface.md#deployaccountcontract) - -#### Defined in - -[src/provider/sequencer.ts:398](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L398) - ---- - -### declareContract - -▸ **declareContract**(`«destructured»`, `details`): `Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -Declares a given compiled contract (json) to starknet - -#### Parameters - -| Name | Type | Description | -| :--------------- | :---------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | -| `«destructured»` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | transaction payload to be deployed containing: - compiled contract code - sender address - signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | Invocation Details containing: - nonce - optional version - optional maxFee | - -#### Returns - -`Promise`<[`DeclareContractResponse`](../interfaces/types.DeclareContractResponse.md)\> - -a confirmation of sending a transaction on the starknet contract - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[declareContract](ProviderInterface.md#declarecontract) - -#### Defined in - -[src/provider/sequencer.ts:414](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L414) - ---- - -### getEstimateFee - -▸ **getEstimateFee**(`invocation`, `invocationDetails`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -**`Deprecated`** - -Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class - -#### Parameters - -| Name | Type | Default value | Description | -| :------------------ | :---------------------------------------------------------------------------------- | :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | `undefined` | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `invocationDetails` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | `undefined` | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | `undefined` | (optional) block identifier | -| `skipValidate` | `boolean` | `false` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getEstimateFee](ProviderInterface.md#getestimatefee) - -#### Defined in - -[src/provider/sequencer.ts:442](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L442) - ---- - -### getInvokeEstimateFee - -▸ **getInvokeEstimateFee**(`invocation`, `invocationDetails`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given INVOKE transaction - -#### Parameters - -| Name | Type | Default value | Description | -| :------------------ | :---------------------------------------------------------------------------------- | :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `invocation` | [`Invocation`](../namespaces/types.md#invocation) | `undefined` | the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature | -| `invocationDetails` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | `undefined` | optional details containing: - nonce - optional nonce - version - optional version | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | `undefined` | (optional) block identifier | -| `skipValidate` | `boolean` | `false` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getInvokeEstimateFee](ProviderInterface.md#getinvokeestimatefee) - -#### Defined in - -[src/provider/sequencer.ts:451](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L451) - ---- - -### getDeclareEstimateFee - -▸ **getDeclareEstimateFee**(`invocation`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DECLARE transaction - -#### Parameters - -| Name | Type | Default value | Description | -| :---------------- | :---------------------------------------------------------------------------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------ | -| `invocation` | [`DeclareContractTransaction`](../namespaces/types.md#declarecontracttransaction) | `undefined` | transaction payload to be declared containing: - compiled contract code - sender address - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | `undefined` | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | `undefined` | (optional) block identifier | -| `skipValidate` | `boolean` | `false` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getDeclareEstimateFee](ProviderInterface.md#getdeclareestimatefee) - -#### Defined in - -[src/provider/sequencer.ts:470](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L470) - ---- - -### getDeployAccountEstimateFee - -▸ **getDeployAccountEstimateFee**(`invocation`, `details`, `blockIdentifier?`, `skipValidate?`): `Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -Estimates the fee for a given DEPLOY_ACCOUNT transaction - -#### Parameters - -| Name | Type | Default value | Description | -| :---------------- | :-------------------------------------------------------------------------------------------- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------ | -| `invocation` | [`DeployAccountContractTransaction`](../namespaces/types.md#deployaccountcontracttransaction) | `undefined` | transaction payload to be deployed containing: - classHash - constructorCalldata - addressSalt - signature - (defaults to []) the signature | -| `details` | [`InvocationsDetailsWithNonce`](../namespaces/types.md#invocationsdetailswithnonce) | `undefined` | optional details containing: - nonce - version - optional version - optional maxFee | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | `undefined` | (optional) block identifier | -| `skipValidate` | `boolean` | `false` | (optional) skip cairo **validate** method | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getDeployAccountEstimateFee](ProviderInterface.md#getdeployaccountestimatefee) - -#### Defined in - -[src/provider/sequencer.ts:489](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L489) - ---- - -### getEstimateFeeBulk - -▸ **getEstimateFeeBulk**(`invocations`, `«destructured»`): `Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -Estimates the fee for a list of INVOKE transaction - -#### Parameters - -| Name | Type | Description | -| :--------------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------- | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | AccountInvocations - Complete invocations array with account details | -| `«destructured»` | [`getEstimateFeeBulkOptions`](../namespaces/types.md#getestimatefeebulkoptions) | getEstimateFeeBulkOptions - (optional) blockIdentifier - BlockIdentifier - (optional) skipValidate - boolean (default false) | - -#### Returns - -`Promise`<[`EstimateFeeResponseBulk`](../namespaces/types.md#estimatefeeresponsebulk)\> - -the estimated fee - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getEstimateFeeBulk](ProviderInterface.md#getestimatefeebulk) - -#### Defined in - -[src/provider/sequencer.ts:508](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L508) - ---- - -### getCode - -▸ **getCode**(`contractAddress`, `blockIdentifier?`): `Promise`<[`GetCodeResponse`](../namespaces/types.Sequencer.md#getcoderesponse)\> - -**`Deprecated`** - -The method should not be used - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------------- | -| `contractAddress` | `string` | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`GetCodeResponse`](../namespaces/types.Sequencer.md#getcoderesponse)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getCode](ProviderInterface.md#getcode) - -#### Defined in - -[src/provider/sequencer.ts:520](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L520) - ---- - -### waitForTransaction - -▸ **waitForTransaction**(`txHash`, `options?`): `Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -Wait for the transaction to be accepted - -#### Parameters - -| Name | Type | Description | -| :--------- | :------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | transaction hash | -| `options?` | [`waitForTransactionOptions`](../namespaces/types.md#waitfortransactionoptions) | waitForTransactionOptions - (optional) retryInterval: number \| undefined; - (optional) successStates: TransactionStatus[] \| undefined; | - -#### Returns - -`Promise`<[`GetTransactionReceiptResponse`](../namespaces/types.md#gettransactionreceiptresponse)\> - -GetTransactionReceiptResponse - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[waitForTransaction](ProviderInterface.md#waitfortransaction) - -#### Defined in - -[src/provider/sequencer.ts:527](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L527) - ---- - -### getTransactionStatus - -▸ **getTransactionStatus**(`txHash`): `Promise`<[`GetTransactionStatusResponse`](../namespaces/types.md#gettransactionstatusresponse)\> - -Gets the status of a transaction. - -#### Parameters - -| Name | Type | Description | -| :------- | :---------------------------------------------------- | :----------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | BigNumberish | - -#### Returns - -`Promise`<[`GetTransactionStatusResponse`](../namespaces/types.md#gettransactionstatusresponse)\> - -GetTransactionStatusResponse - the transaction status object - -#### Defined in - -[src/provider/sequencer.ts:582](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L582) - ---- - -### getContractAddresses - -▸ **getContractAddresses**(): `Promise`<[`GetContractAddressesResponse`](../namespaces/types.md#getcontractaddressesresponse)\> - -Gets the smart contract address on the goerli testnet. - -#### Returns - -`Promise`<[`GetContractAddressesResponse`](../namespaces/types.md#getcontractaddressesresponse)\> - -GetContractAddressesResponse - starknet smart contract addresses - -#### Defined in - -[src/provider/sequencer.ts:591](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L591) - ---- - -### getTransactionTrace - -▸ **getTransactionTrace**(`txHash`): `Promise`<[`TransactionTraceResponse`](../namespaces/types.Sequencer.md#transactiontraceresponse)\> - -Gets the transaction trace from a tx id. - -#### Parameters - -| Name | Type | Description | -| :------- | :---------------------------------------------------- | :----------- | -| `txHash` | [`BigNumberish`](../namespaces/types.md#bignumberish) | BigNumberish | - -#### Returns - -`Promise`<[`TransactionTraceResponse`](../namespaces/types.Sequencer.md#transactiontraceresponse)\> - -TransactionTraceResponse - the transaction trace - -#### Defined in - -[src/provider/sequencer.ts:600](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L600) - ---- - -### estimateMessageFee - -▸ **estimateMessageFee**(`«destructured»`, `blockIdentifier?`): `Promise`<[`EstimateFeeResponse`](../namespaces/types.Sequencer.md#estimatefeeresponse)\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------------- | -| `«destructured»` | [`CallL1Handler`](../namespaces/types.md#calll1handler) | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`EstimateFeeResponse`](../namespaces/types.Sequencer.md#estimatefeeresponse)\> - -#### Defined in - -[src/provider/sequencer.ts:607](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L607) - ---- - -### getSimulateTransaction - -▸ **getSimulateTransaction**(`invocations`, `«destructured»`): `Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -Simulate transaction using Sequencer provider -WARNING!: Sequencer will process only first element from invocations array - -#### Parameters - -| Name | Type | Description | -| :--------------- | :-------------------------------------------------------------------------------------- | :---------------------------------------------------------------- | -| `invocations` | [`AccountInvocations`](../namespaces/types.md#accountinvocations) | Array of invocations, but only first invocation will be processed | -| `«destructured»` | [`getSimulateTransactionOptions`](../namespaces/types.md#getsimulatetransactionoptions) | - | - -#### Returns - -`Promise`<[`SimulateTransactionResponse`](../namespaces/types.md#simulatetransactionresponse)\> - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getSimulateTransaction](ProviderInterface.md#getsimulatetransaction) - -#### Defined in - -[src/provider/sequencer.ts:630](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L630) - ---- - -### getStateUpdate - -▸ **getStateUpdate**(`blockIdentifier?`): `Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -Gets the state changes in a specific block - -#### Parameters - -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------- | :--------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | block identifier | - -#### Returns - -`Promise`<[`StateUpdateResponse`](../interfaces/types.StateUpdateResponse.md)\> - -StateUpdateResponse - -#### Implementation of - -[ProviderInterface](ProviderInterface.md).[getStateUpdate](ProviderInterface.md#getstateupdate) - -#### Defined in - -[src/provider/sequencer.ts:657](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L657) - ---- - -### getBlockTraces - -▸ **getBlockTraces**(`blockIdentifier?`): `Promise`<[`BlockTransactionTracesResponse`](../namespaces/types.Sequencer.md#blocktransactiontracesresponse)\> - -#### Parameters - -| Name | Type | -| :---------------- | :---------------------------------------------------------- | -| `blockIdentifier` | [`BlockIdentifier`](../namespaces/types.md#blockidentifier) | - -#### Returns - -`Promise`<[`BlockTransactionTracesResponse`](../namespaces/types.Sequencer.md#blocktransactiontracesresponse)\> - -#### Defined in - -[src/provider/sequencer.ts:667](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L667) - ---- - -### getStarkName - -▸ **getStarkName**(`address`, `StarknetIdContract?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------------- | :---------------------------------------------------- | -| `address` | [`BigNumberish`](../namespaces/types.md#bignumberish) | -| `StarknetIdContract?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/provider/sequencer.ts:674](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L674) - ---- - -### getAddressFromStarkName - -▸ **getAddressFromStarkName**(`name`, `StarknetIdContract?`): `Promise`<`string`\> - -#### Parameters - -| Name | Type | -| :-------------------- | :------- | -| `name` | `string` | -| `StarknetIdContract?` | `string` | - -#### Returns - -`Promise`<`string`\> - -#### Defined in - -[src/provider/sequencer.ts:678](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L678) - ---- - -### buildTransaction - -▸ **buildTransaction**(`invocation`, `versionType?`): [`AccountTransactionItem`](../namespaces/types.Sequencer.md#accounttransactionitem) - -Build Single AccountTransaction from Single AccountInvocation - -#### Parameters - -| Name | Type | Description | -| :------------- | :---------------------------------------------------------------------- | :---------------------------------------------------------- | -| `invocation` | [`AccountInvocationItem`](../namespaces/types.md#accountinvocationitem) | AccountInvocationItem | -| `versionType?` | `"fee"` \| `"transaction"` | 'fee' \| 'transaction' - used to determine default versions | - -#### Returns - -[`AccountTransactionItem`](../namespaces/types.Sequencer.md#accounttransactionitem) - -AccountTransactionItem - -#### Defined in - -[src/provider/sequencer.ts:688](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/sequencer.ts#L688) diff --git a/www/docs/API/classes/Signer.md b/www/docs/API/classes/Signer.md deleted file mode 100644 index a21a7ac59..000000000 --- a/www/docs/API/classes/Signer.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -id: 'Signer' -title: 'Class: Signer' -sidebar_label: 'Signer' -sidebar_position: 0 -custom_edit_url: null ---- - -## Implements - -- [`SignerInterface`](SignerInterface.md) - -## Constructors - -### constructor - -• **new Signer**(`pk?`) - -#### Parameters - -| Name | Type | -| :--- | :----------------------- | -| `pk` | `string` \| `Uint8Array` | - -#### Defined in - -[src/signer/default.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/default.ts#L26) - -## Properties - -### pk - -• `Protected` **pk**: `string` \| `Uint8Array` - -#### Defined in - -[src/signer/default.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/default.ts#L24) - -## Methods - -### getPubKey - -▸ **getPubKey**(): `Promise`<`string`\> - -Method to get the public key of the signer - -#### Returns - -`Promise`<`string`\> - -public key of signer as hex string with 0x prefix - -#### Implementation of - -[SignerInterface](SignerInterface.md).[getPubKey](SignerInterface.md#getpubkey) - -#### Defined in - -[src/signer/default.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/default.ts#L30) - ---- - -### signMessage - -▸ **signMessage**(`typedData`, `accountAddress`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Sign an JSON object for off-chain usage with the starknet private key and return the signature -This adds a message prefix so it cant be interchanged with transactions - -**`Throws`** - -if the JSON object is not a valid JSON - -#### Parameters - -| Name | Type | Description | -| :--------------- | :---------------------------------------------- | :----------------------- | -| `typedData` | [`TypedData`](../interfaces/types.TypedData.md) | JSON object to be signed | -| `accountAddress` | `string` | account | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -the signature of the JSON object - -#### Implementation of - -[SignerInterface](SignerInterface.md).[signMessage](SignerInterface.md#signmessage) - -#### Defined in - -[src/signer/default.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/default.ts#L34) - ---- - -### signTransaction - -▸ **signTransaction**(`transactions`, `transactionsDetail`, `abis?`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Signs a transaction with the starknet private key and returns the signature - -#### Parameters - -| Name | Type | -| :------------------- | :---------------------------------------------------------------------------- | -| `transactions` | [`Call`](../namespaces/types.md#call)[] | -| `transactionsDetail` | [`InvocationsSignerDetails`](../interfaces/types.InvocationsSignerDetails.md) | -| `abis?` | [`Abi`](../namespaces/types.md#abi)[] | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -signature - -#### Implementation of - -[SignerInterface](SignerInterface.md).[signTransaction](SignerInterface.md#signtransaction) - -#### Defined in - -[src/signer/default.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/default.ts#L39) - ---- - -### signDeployAccountTransaction - -▸ **signDeployAccountTransaction**(`«destructured»`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Signs a DEPLOY_ACCOUNT transaction with the starknet private key and returns the signature - -#### Parameters - -| Name | Type | Description | -| :--------------- | :-------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `«destructured»` | [`DeployAccountSignerDetails`](../namespaces/types.md#deployaccountsignerdetails) | contractAddress - the computed address of the contract - constructorCalldata - calldata to be passed in deploy constructor - addressSalt - contract address salt - chainId - the chainId to declare contract on - maxFee - maxFee for the declare transaction - version - transaction version - nonce - Nonce of the declare transaction | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -signature - -#### Implementation of - -[SignerInterface](SignerInterface.md).[signDeployAccountTransaction](SignerInterface.md#signdeployaccounttransaction) - -#### Defined in - -[src/signer/default.ts:63](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/default.ts#L63) - ---- - -### signDeclareTransaction - -▸ **signDeclareTransaction**(`«destructured»`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Signs a DECLARE transaction with the starknet private key and returns the signature - -#### Parameters - -| Name | Type | Description | -| :--------------- | :-------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `«destructured»` | [`DeclareSignerDetails`](../interfaces/types.DeclareSignerDetails.md) | classHash - computed class hash. Will be replaced by ContractClass in future once class hash is present in CompiledContract - senderAddress - the address of the sender - chainId - the chainId to declare contract on - maxFee - maxFee for the declare transaction - version - transaction version - nonce - Nonce of the declare transaction | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -signature - -#### Implementation of - -[SignerInterface](SignerInterface.md).[signDeclareTransaction](SignerInterface.md#signdeclaretransaction) - -#### Defined in - -[src/signer/default.ts:87](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/default.ts#L87) diff --git a/www/docs/API/classes/SignerInterface.md b/www/docs/API/classes/SignerInterface.md deleted file mode 100644 index 93fc6584a..000000000 --- a/www/docs/API/classes/SignerInterface.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -id: 'SignerInterface' -title: 'Class: SignerInterface' -sidebar_label: 'SignerInterface' -sidebar_position: 0 -custom_edit_url: null ---- - -## Implemented by - -- [`Signer`](Signer.md) - -## Constructors - -### constructor - -• **new SignerInterface**() - -## Methods - -### getPubKey - -▸ `Abstract` **getPubKey**(): `Promise`<`string`\> - -Method to get the public key of the signer - -#### Returns - -`Promise`<`string`\> - -public key of signer as hex string with 0x prefix - -#### Defined in - -[src/signer/interface.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/interface.ts#L17) - ---- - -### signMessage - -▸ `Abstract` **signMessage**(`typedData`, `accountAddress`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Sign an JSON object for off-chain usage with the starknet private key and return the signature -This adds a message prefix so it cant be interchanged with transactions - -**`Throws`** - -if the JSON object is not a valid JSON - -#### Parameters - -| Name | Type | Description | -| :--------------- | :---------------------------------------------- | :----------------------- | -| `typedData` | [`TypedData`](../interfaces/types.TypedData.md) | JSON object to be signed | -| `accountAddress` | `string` | account | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -the signature of the JSON object - -#### Defined in - -[src/signer/interface.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/interface.ts#L28) - ---- - -### signTransaction - -▸ `Abstract` **signTransaction**(`transactions`, `transactionsDetail`, `abis?`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Signs a transaction with the starknet private key and returns the signature - -#### Parameters - -| Name | Type | -| :------------------- | :---------------------------------------------------------------------------- | -| `transactions` | [`Call`](../namespaces/types.md#call)[] | -| `transactionsDetail` | [`InvocationsSignerDetails`](../interfaces/types.InvocationsSignerDetails.md) | -| `abis?` | [`Abi`](../namespaces/types.md#abi)[] | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -signature - -#### Defined in - -[src/signer/interface.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/interface.ts#L41) - ---- - -### signDeployAccountTransaction - -▸ `Abstract` **signDeployAccountTransaction**(`transaction`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Signs a DEPLOY_ACCOUNT transaction with the starknet private key and returns the signature - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `transaction` | [`DeployAccountSignerDetails`](../namespaces/types.md#deployaccountsignerdetails) | contractAddress - the computed address of the contract - constructorCalldata - calldata to be passed in deploy constructor - addressSalt - contract address salt - chainId - the chainId to declare contract on - maxFee - maxFee for the declare transaction - version - transaction version - nonce - Nonce of the declare transaction | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -signature - -#### Defined in - -[src/signer/interface.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/interface.ts#L60) - ---- - -### signDeclareTransaction - -▸ `Abstract` **signDeclareTransaction**(`transaction`): `Promise`<[`Signature`](../namespaces/types.md#signature)\> - -Signs a DECLARE transaction with the starknet private key and returns the signature - -#### Parameters - -| Name | Type | Description | -| :------------ | :-------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `transaction` | [`DeclareSignerDetails`](../interfaces/types.DeclareSignerDetails.md) | classHash - computed class hash. Will be replaced by ContractClass in future once class hash is present in CompiledContract - senderAddress - the address of the sender - chainId - the chainId to declare contract on - maxFee - maxFee for the declare transaction - version - transaction version - nonce - Nonce of the declare transaction | - -#### Returns - -`Promise`<[`Signature`](../namespaces/types.md#signature)\> - -signature - -#### Defined in - -[src/signer/interface.ts:76](https://github.com/0xs34n/starknet.js/blob/develop/src/signer/interface.ts#L76) diff --git a/www/docs/API/classes/_category_.yml b/www/docs/API/classes/_category_.yml deleted file mode 100644 index 4ddfa3005..000000000 --- a/www/docs/API/classes/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: 'Classes' -position: 3 diff --git a/www/docs/API/classes/merkle.MerkleTree.md b/www/docs/API/classes/merkle.MerkleTree.md deleted file mode 100644 index cafce1a6b..000000000 --- a/www/docs/API/classes/merkle.MerkleTree.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -id: 'merkle.MerkleTree' -title: 'Class: MerkleTree' -sidebar_label: 'MerkleTree' -custom_edit_url: null ---- - -[merkle](../namespaces/merkle.md).MerkleTree - -## Constructors - -### constructor - -• **new MerkleTree**(`leafHashes`) - -#### Parameters - -| Name | Type | -| :----------- | :--------- | -| `leafHashes` | `string`[] | - -#### Defined in - -[src/utils/merkle.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/merkle.ts#L11) - -## Properties - -### leaves - -• **leaves**: `string`[] - -#### Defined in - -[src/utils/merkle.ts:5](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/merkle.ts#L5) - ---- - -### branches - -• **branches**: `string`[][] = `[]` - -#### Defined in - -[src/utils/merkle.ts:7](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/merkle.ts#L7) - ---- - -### root - -• **root**: `string` - -#### Defined in - -[src/utils/merkle.ts:9](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/merkle.ts#L9) - -## Methods - -### hash - -▸ `Static` **hash**(`a`, `b`): `string` - -Create pedersen hash from a and b - -#### Parameters - -| Name | Type | -| :--- | :------- | -| `a` | `string` | -| `b` | `string` | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/merkle.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/merkle.ts#L43) - ---- - -### build - -▸ `Private` **build**(`leaves`): `string` - -Create Merkle tree - -#### Parameters - -| Name | Type | Description | -| :------- | :--------- | :--------------- | -| `leaves` | `string`[] | hex-string array | - -#### Returns - -`string` - -format: hex-string; Merkle tree root - -#### Defined in - -[src/utils/merkle.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/merkle.ts#L21) - ---- - -### getProof - -▸ **getProof**(`leaf`, `branch?`, `hashPath?`): `string`[] - -Return path to leaf - -#### Parameters - -| Name | Type | Default value | Description | -| :--------- | :--------- | :------------ | :--------------- | -| `leaf` | `string` | `undefined` | hex-string | -| `branch` | `string`[] | `undefined` | hex-string array | -| `hashPath` | `string`[] | `[]` | hex-string array | - -#### Returns - -`string`[] - -format: hex-string array - -#### Defined in - -[src/utils/merkle.ts:55](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/merkle.ts#L55) diff --git a/www/docs/API/enums/CairoOptionVariant.md b/www/docs/API/enums/CairoOptionVariant.md deleted file mode 100644 index ffb4e236f..000000000 --- a/www/docs/API/enums/CairoOptionVariant.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'CairoOptionVariant' -title: 'Enumeration: CairoOptionVariant' -sidebar_label: 'CairoOptionVariant' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### Some - -• **Some** = `0` - -#### Defined in - -[src/utils/calldata/enum/CairoOption.ts:2](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoOption.ts#L2) - ---- - -### None - -• **None** = `1` - -#### Defined in - -[src/utils/calldata/enum/CairoOption.ts:3](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoOption.ts#L3) diff --git a/www/docs/API/enums/CairoResultVariant.md b/www/docs/API/enums/CairoResultVariant.md deleted file mode 100644 index fa9ca5ee5..000000000 --- a/www/docs/API/enums/CairoResultVariant.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'CairoResultVariant' -title: 'Enumeration: CairoResultVariant' -sidebar_label: 'CairoResultVariant' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### Ok - -• **Ok** = `0` - -#### Defined in - -[src/utils/calldata/enum/CairoResult.ts:2](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoResult.ts#L2) - ---- - -### Err - -• **Err** = `1` - -#### Defined in - -[src/utils/calldata/enum/CairoResult.ts:3](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoResult.ts#L3) diff --git a/www/docs/API/enums/EntryPointType.md b/www/docs/API/enums/EntryPointType.md deleted file mode 100644 index d12d855dd..000000000 --- a/www/docs/API/enums/EntryPointType.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'EntryPointType' -title: 'Enumeration: EntryPointType' -sidebar_label: 'EntryPointType' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### EXTERNAL - -• **EXTERNAL** = `"EXTERNAL"` - -#### Defined in - -[src/types/lib/contract/index.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L11) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"L1_HANDLER"` - -#### Defined in - -[src/types/lib/contract/index.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L12) - ---- - -### CONSTRUCTOR - -• **CONSTRUCTOR** = `"CONSTRUCTOR"` - -#### Defined in - -[src/types/lib/contract/index.ts:13](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L13) diff --git a/www/docs/API/enums/RPC.TransactionType.md b/www/docs/API/enums/RPC.TransactionType.md deleted file mode 100644 index ac692bad3..000000000 --- a/www/docs/API/enums/RPC.TransactionType.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: 'RPC.TransactionType' -title: 'Enumeration: TransactionType' -sidebar_label: 'TransactionType' -custom_edit_url: null ---- - -[RPC](../namespaces/RPC.md).TransactionType - -## Enumeration Members - -### DECLARE - -• **DECLARE** = `"DECLARE"` - -#### Defined in - -[src/types/api/rpc.ts:48](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L48) - ---- - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/api/rpc.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L49) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"DEPLOY_ACCOUNT"` - -#### Defined in - -[src/types/api/rpc.ts:50](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L50) - ---- - -### INVOKE - -• **INVOKE** = `"INVOKE"` - -#### Defined in - -[src/types/api/rpc.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L51) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"L1_HANDLER"` - -#### Defined in - -[src/types/api/rpc.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L52) diff --git a/www/docs/API/enums/TransactionStatus.md b/www/docs/API/enums/TransactionStatus.md deleted file mode 100644 index bb7db2b2e..000000000 --- a/www/docs/API/enums/TransactionStatus.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: 'TransactionStatus' -title: 'Enumeration: TransactionStatus' -sidebar_label: 'TransactionStatus' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### NOT_RECEIVED - -• **NOT_RECEIVED** = `"NOT_RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L120) - ---- - -### RECEIVED - -• **RECEIVED** = `"RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L121) - ---- - -### PENDING - -• **PENDING** = `"PENDING"` - -#### Defined in - -[src/types/lib/index.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L122) - ---- - -### ACCEPTED_ON_L2 - -• **ACCEPTED_ON_L2** = `"ACCEPTED_ON_L2"` - -#### Defined in - -[src/types/lib/index.ts:123](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L123) - ---- - -### ACCEPTED_ON_L1 - -• **ACCEPTED_ON_L1** = `"ACCEPTED_ON_L1"` - -#### Defined in - -[src/types/lib/index.ts:124](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L124) - ---- - -### REJECTED - -• **REJECTED** = `"REJECTED"` - -#### Defined in - -[src/types/lib/index.ts:125](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L125) diff --git a/www/docs/API/enums/TransactionType.md b/www/docs/API/enums/TransactionType.md deleted file mode 100644 index 13cfbb5f8..000000000 --- a/www/docs/API/enums/TransactionType.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: 'TransactionType' -title: 'Enumeration: TransactionType' -sidebar_label: 'TransactionType' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### INVOKE - -• **INVOKE** = `"INVOKE_FUNCTION"` - -#### Defined in - -[src/types/lib/index.ts:154](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L154) - ---- - -### DECLARE - -• **DECLARE** = `"DECLARE"` - -#### Defined in - -[src/types/lib/index.ts:155](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L155) - ---- - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/lib/index.ts:156](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L156) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"DEPLOY_ACCOUNT"` - -#### Defined in - -[src/types/lib/index.ts:157](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L157) diff --git a/www/docs/API/enums/_category_.yml b/www/docs/API/enums/_category_.yml deleted file mode 100644 index 195776cfb..000000000 --- a/www/docs/API/enums/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: 'Enumerations' -position: 2 diff --git a/www/docs/API/enums/cairo.Uint.md b/www/docs/API/enums/cairo.Uint.md deleted file mode 100644 index f5e07a894..000000000 --- a/www/docs/API/enums/cairo.Uint.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: 'cairo.Uint' -title: 'Enumeration: Uint' -sidebar_label: 'Uint' -custom_edit_url: null ---- - -[cairo](../namespaces/cairo.md).Uint - -## Enumeration Members - -### u8 - -• **u8** = `"core::integer::u8"` - -#### Defined in - -[src/utils/calldata/cairo.ts:7](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L7) - ---- - -### u16 - -• **u16** = `"core::integer::u16"` - -#### Defined in - -[src/utils/calldata/cairo.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L8) - ---- - -### u32 - -• **u32** = `"core::integer::u32"` - -#### Defined in - -[src/utils/calldata/cairo.ts:9](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L9) - ---- - -### u64 - -• **u64** = `"core::integer::u64"` - -#### Defined in - -[src/utils/calldata/cairo.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L10) - ---- - -### u128 - -• **u128** = `"core::integer::u128"` - -#### Defined in - -[src/utils/calldata/cairo.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L11) - ---- - -### u256 - -• **u256** = `"core::integer::u256"` - -#### Defined in - -[src/utils/calldata/cairo.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L12) diff --git a/www/docs/API/enums/constants.BaseUrl.md b/www/docs/API/enums/constants.BaseUrl.md deleted file mode 100644 index d9220ca87..000000000 --- a/www/docs/API/enums/constants.BaseUrl.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'constants.BaseUrl' -title: 'Enumeration: BaseUrl' -sidebar_label: 'BaseUrl' -custom_edit_url: null ---- - -[constants](../namespaces/constants.md).BaseUrl - -## Enumeration Members - -### SN_MAIN - -• **SN_MAIN** = `"https://alpha-mainnet.starknet.io"` - -#### Defined in - -[src/constants.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L21) - ---- - -### SN_GOERLI - -• **SN_GOERLI** = `"https://alpha4.starknet.io"` - -#### Defined in - -[src/constants.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L22) diff --git a/www/docs/API/enums/constants.NetworkName.md b/www/docs/API/enums/constants.NetworkName.md deleted file mode 100644 index fe9ebc08d..000000000 --- a/www/docs/API/enums/constants.NetworkName.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'constants.NetworkName' -title: 'Enumeration: NetworkName' -sidebar_label: 'NetworkName' -custom_edit_url: null ---- - -[constants](../namespaces/constants.md).NetworkName - -## Enumeration Members - -### SN_MAIN - -• **SN_MAIN** = `"SN_MAIN"` - -#### Defined in - -[src/constants.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L26) - ---- - -### SN_GOERLI - -• **SN_GOERLI** = `"SN_GOERLI"` - -#### Defined in - -[src/constants.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L27) diff --git a/www/docs/API/enums/constants.StarknetChainId.md b/www/docs/API/enums/constants.StarknetChainId.md deleted file mode 100644 index 80bc8bb5b..000000000 --- a/www/docs/API/enums/constants.StarknetChainId.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'constants.StarknetChainId' -title: 'Enumeration: StarknetChainId' -sidebar_label: 'StarknetChainId' -custom_edit_url: null ---- - -[constants](../namespaces/constants.md).StarknetChainId - -## Enumeration Members - -### SN_MAIN - -• **SN_MAIN** = `"0x534e5f4d41494e"` - -#### Defined in - -[src/constants.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L31) - ---- - -### SN_GOERLI - -• **SN_GOERLI** = `"0x534e5f474f45524c49"` - -#### Defined in - -[src/constants.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L32) diff --git a/www/docs/API/enums/constants.TransactionHashPrefix.md b/www/docs/API/enums/constants.TransactionHashPrefix.md deleted file mode 100644 index 3276b8e54..000000000 --- a/www/docs/API/enums/constants.TransactionHashPrefix.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: 'constants.TransactionHashPrefix' -title: 'Enumeration: TransactionHashPrefix' -sidebar_label: 'TransactionHashPrefix' -custom_edit_url: null ---- - -[constants](../namespaces/constants.md).TransactionHashPrefix - -## Enumeration Members - -### DECLARE - -• **DECLARE** = `"0x6465636c617265"` - -#### Defined in - -[src/constants.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L36) - ---- - -### DEPLOY - -• **DEPLOY** = `"0x6465706c6f79"` - -#### Defined in - -[src/constants.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L37) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"0x6465706c6f795f6163636f756e74"` - -#### Defined in - -[src/constants.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L38) - ---- - -### INVOKE - -• **INVOKE** = `"0x696e766f6b65"` - -#### Defined in - -[src/constants.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L39) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"0x6c315f68616e646c6572"` - -#### Defined in - -[src/constants.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L40) diff --git a/www/docs/API/enums/starknetId.StarknetIdContract.md b/www/docs/API/enums/starknetId.StarknetIdContract.md deleted file mode 100644 index 75c427cf7..000000000 --- a/www/docs/API/enums/starknetId.StarknetIdContract.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'starknetId.StarknetIdContract' -title: 'Enumeration: StarknetIdContract' -sidebar_label: 'StarknetIdContract' -custom_edit_url: null ---- - -[starknetId](../namespaces/starknetId.md).StarknetIdContract - -## Enumeration Members - -### MAINNET - -• **MAINNET** = `"0x6ac597f8116f886fa1c97a23fa4e08299975ecaf6b598873ca6792b9bbfb678"` - -#### Defined in - -[src/utils/starknetId.ts:104](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/starknetId.ts#L104) - ---- - -### TESTNET - -• **TESTNET** = `"0x3bab268e932d2cecd1946f100ae67ce3dff9fd234119ea2f6da57d16d29fce"` - -#### Defined in - -[src/utils/starknetId.ts:105](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/starknetId.ts#L105) diff --git a/www/docs/API/enums/types.BlockStatus.md b/www/docs/API/enums/types.BlockStatus.md deleted file mode 100644 index 645637a2d..000000000 --- a/www/docs/API/enums/types.BlockStatus.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: 'types.BlockStatus' -title: 'Enumeration: BlockStatus' -sidebar_label: 'BlockStatus' -custom_edit_url: null ---- - -[types](../namespaces/types.md).BlockStatus - -## Enumeration Members - -### PENDING - -• **PENDING** = `"PENDING"` - -#### Defined in - -[src/types/lib/index.ts:165](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L165) - ---- - -### ACCEPTED_ON_L1 - -• **ACCEPTED_ON_L1** = `"ACCEPTED_ON_L1"` - -#### Defined in - -[src/types/lib/index.ts:166](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L166) - ---- - -### ACCEPTED_ON_L2 - -• **ACCEPTED_ON_L2** = `"ACCEPTED_ON_L2"` - -#### Defined in - -[src/types/lib/index.ts:167](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L167) - ---- - -### REJECTED - -• **REJECTED** = `"REJECTED"` - -#### Defined in - -[src/types/lib/index.ts:168](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L168) diff --git a/www/docs/API/enums/types.BlockTag.md b/www/docs/API/enums/types.BlockTag.md deleted file mode 100644 index 12ad279e5..000000000 --- a/www/docs/API/enums/types.BlockTag.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'types.BlockTag' -title: 'Enumeration: BlockTag' -sidebar_label: 'BlockTag' -custom_edit_url: null ---- - -[types](../namespaces/types.md).BlockTag - -## Enumeration Members - -### pending - -• **pending** = `"pending"` - -#### Defined in - -[src/types/lib/index.ts:172](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L172) - ---- - -### latest - -• **latest** = `"latest"` - -#### Defined in - -[src/types/lib/index.ts:173](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L173) diff --git a/www/docs/API/enums/types.EntryPointType.md b/www/docs/API/enums/types.EntryPointType.md deleted file mode 100644 index 04a8380bd..000000000 --- a/www/docs/API/enums/types.EntryPointType.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: 'types.EntryPointType' -title: 'Enumeration: EntryPointType' -sidebar_label: 'EntryPointType' -custom_edit_url: null ---- - -[types](../namespaces/types.md).EntryPointType - -## Enumeration Members - -### EXTERNAL - -• **EXTERNAL** = `"EXTERNAL"` - -#### Defined in - -[src/types/lib/contract/index.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L23) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"L1_HANDLER"` - -#### Defined in - -[src/types/lib/contract/index.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L24) - ---- - -### CONSTRUCTOR - -• **CONSTRUCTOR** = `"CONSTRUCTOR"` - -#### Defined in - -[src/types/lib/contract/index.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L25) diff --git a/www/docs/API/enums/types.Litteral.md b/www/docs/API/enums/types.Litteral.md deleted file mode 100644 index 9ef30f105..000000000 --- a/www/docs/API/enums/types.Litteral.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'types.Litteral' -title: 'Enumeration: Litteral' -sidebar_label: 'Litteral' -custom_edit_url: null ---- - -[types](../namespaces/types.md).Litteral - -## Enumeration Members - -### ClassHash - -• **ClassHash** = `"core::starknet::class_hash::ClassHash"` - -#### Defined in - -[src/types/calldata.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L17) - ---- - -### ContractAddress - -• **ContractAddress** = `"core::starknet::contract_address::ContractAddress"` - -#### Defined in - -[src/types/calldata.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L18) diff --git a/www/docs/API/enums/types.RPC.TransactionType.md b/www/docs/API/enums/types.RPC.TransactionType.md deleted file mode 100644 index 85bb03dae..000000000 --- a/www/docs/API/enums/types.RPC.TransactionType.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: 'types.RPC.TransactionType' -title: 'Enumeration: TransactionType' -sidebar_label: 'TransactionType' -custom_edit_url: null ---- - -[types](../namespaces/types.md).[RPC](../namespaces/types.RPC.md).TransactionType - -## Enumeration Members - -### DECLARE - -• **DECLARE** = `"DECLARE"` - -#### Defined in - -[src/types/api/rpc.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L51) - ---- - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/api/rpc.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L52) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"DEPLOY_ACCOUNT"` - -#### Defined in - -[src/types/api/rpc.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L53) - ---- - -### INVOKE - -• **INVOKE** = `"INVOKE"` - -#### Defined in - -[src/types/api/rpc.ts:54](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L54) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"L1_HANDLER"` - -#### Defined in - -[src/types/api/rpc.ts:55](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L55) diff --git a/www/docs/API/enums/types.SIMULATION_FLAG.md b/www/docs/API/enums/types.SIMULATION_FLAG.md deleted file mode 100644 index 59e61836b..000000000 --- a/www/docs/API/enums/types.SIMULATION_FLAG.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'types.SIMULATION_FLAG' -title: 'Enumeration: SIMULATION_FLAG' -sidebar_label: 'SIMULATION_FLAG' -custom_edit_url: null ---- - -[types](../namespaces/types.md).SIMULATION_FLAG - -## Enumeration Members - -### SKIP_VALIDATE - -• **SKIP_VALIDATE** = `"SKIP_VALIDATE"` - -#### Defined in - -[src/types/account.ts:59](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L59) - ---- - -### SKIP_EXECUTE - -• **SKIP_EXECUTE** = `"SKIP_EXECUTE"` - -#### Defined in - -[src/types/account.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L60) diff --git a/www/docs/API/enums/types.TransactionExecutionStatus.md b/www/docs/API/enums/types.TransactionExecutionStatus.md deleted file mode 100644 index 6d5ffda50..000000000 --- a/www/docs/API/enums/types.TransactionExecutionStatus.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: 'types.TransactionExecutionStatus' -title: 'Enumeration: TransactionExecutionStatus' -sidebar_label: 'TransactionExecutionStatus' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionExecutionStatus - -## Enumeration Members - -### REJECTED - -• **REJECTED** = `"REJECTED"` - -#### Defined in - -[src/types/lib/index.ts:159](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L159) - ---- - -### REVERTED - -• **REVERTED** = `"REVERTED"` - -#### Defined in - -[src/types/lib/index.ts:160](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L160) - ---- - -### SUCCEEDED - -• **SUCCEEDED** = `"SUCCEEDED"` - -#### Defined in - -[src/types/lib/index.ts:161](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L161) diff --git a/www/docs/API/enums/types.TransactionFinalityStatus.md b/www/docs/API/enums/types.TransactionFinalityStatus.md deleted file mode 100644 index aaecd2914..000000000 --- a/www/docs/API/enums/types.TransactionFinalityStatus.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: 'types.TransactionFinalityStatus' -title: 'Enumeration: TransactionFinalityStatus' -sidebar_label: 'TransactionFinalityStatus' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionFinalityStatus - -## Enumeration Members - -### NOT_RECEIVED - -• **NOT_RECEIVED** = `"NOT_RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:152](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L152) - ---- - -### RECEIVED - -• **RECEIVED** = `"RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:153](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L153) - ---- - -### ACCEPTED_ON_L2 - -• **ACCEPTED_ON_L2** = `"ACCEPTED_ON_L2"` - -#### Defined in - -[src/types/lib/index.ts:154](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L154) - ---- - -### ACCEPTED_ON_L1 - -• **ACCEPTED_ON_L1** = `"ACCEPTED_ON_L1"` - -#### Defined in - -[src/types/lib/index.ts:155](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L155) diff --git a/www/docs/API/enums/types.TransactionStatus.md b/www/docs/API/enums/types.TransactionStatus.md deleted file mode 100644 index d59f27662..000000000 --- a/www/docs/API/enums/types.TransactionStatus.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: 'types.TransactionStatus' -title: 'Enumeration: TransactionStatus' -sidebar_label: 'TransactionStatus' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionStatus - -new statuses are defined by props: finality_status and execution_status -to be #deprecated - -## Enumeration Members - -### NOT_RECEIVED - -• **NOT_RECEIVED** = `"NOT_RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:143](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L143) - ---- - -### RECEIVED - -• **RECEIVED** = `"RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:144](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L144) - ---- - -### ACCEPTED_ON_L2 - -• **ACCEPTED_ON_L2** = `"ACCEPTED_ON_L2"` - -#### Defined in - -[src/types/lib/index.ts:145](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L145) - ---- - -### ACCEPTED_ON_L1 - -• **ACCEPTED_ON_L1** = `"ACCEPTED_ON_L1"` - -#### Defined in - -[src/types/lib/index.ts:146](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L146) - ---- - -### REJECTED - -• **REJECTED** = `"REJECTED"` - -#### Defined in - -[src/types/lib/index.ts:147](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L147) - ---- - -### REVERTED - -• **REVERTED** = `"REVERTED"` - -#### Defined in - -[src/types/lib/index.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L148) diff --git a/www/docs/API/enums/types.TransactionType.md b/www/docs/API/enums/types.TransactionType.md deleted file mode 100644 index f6a5f2b85..000000000 --- a/www/docs/API/enums/types.TransactionType.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: 'types.TransactionType' -title: 'Enumeration: TransactionType' -sidebar_label: 'TransactionType' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionType - -## Enumeration Members - -### DECLARE - -• **DECLARE** = `"DECLARE"` - -#### Defined in - -[src/types/lib/index.ts:132](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L132) - ---- - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/lib/index.ts:133](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L133) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"DEPLOY_ACCOUNT"` - -#### Defined in - -[src/types/lib/index.ts:134](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L134) - ---- - -### INVOKE - -• **INVOKE** = `"INVOKE_FUNCTION"` - -#### Defined in - -[src/types/lib/index.ts:135](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L135) diff --git a/www/docs/API/enums/types.Uint.md b/www/docs/API/enums/types.Uint.md deleted file mode 100644 index 15f66537c..000000000 --- a/www/docs/API/enums/types.Uint.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: 'types.Uint' -title: 'Enumeration: Uint' -sidebar_label: 'Uint' -custom_edit_url: null ---- - -[types](../namespaces/types.md).Uint - -## Enumeration Members - -### u8 - -• **u8** = `"core::integer::u8"` - -#### Defined in - -[src/types/calldata.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L8) - ---- - -### u16 - -• **u16** = `"core::integer::u16"` - -#### Defined in - -[src/types/calldata.ts:9](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L9) - ---- - -### u32 - -• **u32** = `"core::integer::u32"` - -#### Defined in - -[src/types/calldata.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L10) - ---- - -### u64 - -• **u64** = `"core::integer::u64"` - -#### Defined in - -[src/types/calldata.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L11) - ---- - -### u128 - -• **u128** = `"core::integer::u128"` - -#### Defined in - -[src/types/calldata.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L12) - ---- - -### u256 - -• **u256** = `"core::integer::u256"` - -#### Defined in - -[src/types/calldata.ts:13](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L13) diff --git a/www/docs/API/enums/types.ValidateType.md b/www/docs/API/enums/types.ValidateType.md deleted file mode 100644 index 8a62c9aae..000000000 --- a/www/docs/API/enums/types.ValidateType.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: 'types.ValidateType' -title: 'Enumeration: ValidateType' -sidebar_label: 'ValidateType' -custom_edit_url: null ---- - -[types](../namespaces/types.md).ValidateType - -## Enumeration Members - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/calldata.ts:2](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L2) - ---- - -### CALL - -• **CALL** = `"CALL"` - -#### Defined in - -[src/types/calldata.ts:3](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L3) - ---- - -### INVOKE - -• **INVOKE** = `"INVOKE"` - -#### Defined in - -[src/types/calldata.ts:4](https://github.com/0xs34n/starknet.js/blob/develop/src/types/calldata.ts#L4) diff --git a/www/docs/API/index.md b/www/docs/API/index.md deleted file mode 100644 index 910f95b85..000000000 --- a/www/docs/API/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: 'index' -title: 'Starknet.js API' -sidebar_label: 'Readme' -sidebar_position: 0 -custom_edit_url: null ---- - -This API is based on the [Starknet.js V3](https://github.com/0xs34n/starknet.js/discussions/102) Interface write up by [Janek](https://twitter.com/0xjanek) of [Argent](https://www.argent.xyz/) - -## Provider - -The Provider [**API**](./classes/Provider.md) allows you to interact with the Starknet network, without signing transactions or messages. - -Typically, these are _read_ calls on the blockchain. - -Guide is [**here**](../guides/connect_network.md). - -## Account - -An Account extends [`Provider`](/docs/API/provider) and inherits all of its methods. - -It also introduces new methods that allow Accounts to create and verify signatures with a custom [`Signer`](/docs/API/signer), declare and deploy Contract and deploy new Account - -This [**API**](./classes/Account.md) is the primary way to interact with an account contract on Starknet. - -Guide is [**here**](../guides/create_account.md). - -## Contract - -Contracts [**API**](./classes/Contract.md) can do data transformations in JavaScript based on an ABI. They can also call and invoke to Starknet through a provided Signer. - -Contracts allow you to transform Cairo values, like `Uint256` to `BigNumber`. It could also allow users to pass their own transformers, similar to `JSON.parse`. - -Guide is [**here**](../guides/create_contract.md). - -## Signer - -The Signer [**API**](./classes/Signer.md) allows you to sign transactions and messages, and also allows you to get the public key. - -## Utils - -Util functions are provided so you can use various low level functions in your application : - -### [elliptic curve](./namespaces/ec.md) - -### [hash](./namespaces/hash.md) - -### [num](./namespaces/num.md) - -### [encode](./namespaces/encode.md) - -### [merkle](./namespaces/merkle.md) - -### [shortString](./namespaces/shortString.md) - -### [stark](./namespaces/stark.md) - -### [uint256](./namespaces/uint256.md) diff --git a/www/docs/API/interfaces/CallStruct.md b/www/docs/API/interfaces/CallStruct.md deleted file mode 100644 index daa7d572d..000000000 --- a/www/docs/API/interfaces/CallStruct.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'CallStruct' -title: 'Interface: CallStruct' -sidebar_label: 'CallStruct' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### to - -• **to**: `string` - -#### Defined in - -[src/types/lib/index.ts:181](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L181) - ---- - -### selector - -• **selector**: `string` - -#### Defined in - -[src/types/lib/index.ts:182](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L182) - ---- - -### calldata - -• **calldata**: `string`[] - -#### Defined in - -[src/types/lib/index.ts:183](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L183) diff --git a/www/docs/API/interfaces/CommonTransactionReceiptResponse.md b/www/docs/API/interfaces/CommonTransactionReceiptResponse.md deleted file mode 100644 index dccb43798..000000000 --- a/www/docs/API/interfaces/CommonTransactionReceiptResponse.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: 'CommonTransactionReceiptResponse' -title: 'Interface: CommonTransactionReceiptResponse' -sidebar_label: 'CommonTransactionReceiptResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`CommonTransactionReceiptResponse`** - - ↳ [`InvokeTransactionReceiptResponse`](InvokeTransactionReceiptResponse.md) - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:72](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L72) - ---- - -### status - -• `Optional` **status**: [`Status`](../modules.md#status) - -#### Defined in - -[src/types/provider.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L73) - ---- - -### actual_fee - -• `Optional` **actual_fee**: `string` - -#### Defined in - -[src/types/provider.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L74) - ---- - -### status_data - -• `Optional` **status_data**: `string` - -#### Defined in - -[src/types/provider.ts:75](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L75) diff --git a/www/docs/API/interfaces/CommonTransactionResponse.md b/www/docs/API/interfaces/CommonTransactionResponse.md deleted file mode 100644 index 12cff7e67..000000000 --- a/www/docs/API/interfaces/CommonTransactionResponse.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: 'CommonTransactionResponse' -title: 'Interface: CommonTransactionResponse' -sidebar_label: 'CommonTransactionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`CommonTransactionResponse`** - - ↳ [`InvokeTransactionResponse`](InvokeTransactionResponse.md) - - ↳ [`DeclareTransactionResponse`](DeclareTransactionResponse.md) - -## Properties - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L43) - ---- - -### version - -• `Optional` **version**: `string` - -#### Defined in - -[src/types/provider.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L44) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../modules.md#signature) - -#### Defined in - -[src/types/provider.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L45) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Defined in - -[src/types/provider.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L46) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Defined in - -[src/types/provider.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L47) diff --git a/www/docs/API/interfaces/ContractEntryPoint.md b/www/docs/API/interfaces/ContractEntryPoint.md deleted file mode 100644 index af76821bb..000000000 --- a/www/docs/API/interfaces/ContractEntryPoint.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'ContractEntryPoint' -title: 'Interface: ContractEntryPoint' -sidebar_label: 'ContractEntryPoint' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### offset - -• **offset**: `string` - -#### Defined in - -[src/types/provider.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L58) - ---- - -### selector - -• **selector**: `string` - -#### Defined in - -[src/types/provider.ts:59](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L59) diff --git a/www/docs/API/interfaces/DeclareContractResponse.md b/www/docs/API/interfaces/DeclareContractResponse.md deleted file mode 100644 index 6c128e5f2..000000000 --- a/www/docs/API/interfaces/DeclareContractResponse.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'DeclareContractResponse' -title: 'Interface: DeclareContractResponse' -sidebar_label: 'DeclareContractResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L115) - ---- - -### class_hash - -• **class_hash**: `string` - -#### Defined in - -[src/types/provider.ts:116](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L116) diff --git a/www/docs/API/interfaces/DeclareSignerDetails.md b/www/docs/API/interfaces/DeclareSignerDetails.md deleted file mode 100644 index b0902db42..000000000 --- a/www/docs/API/interfaces/DeclareSignerDetails.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: 'DeclareSignerDetails' -title: 'Interface: DeclareSignerDetails' -sidebar_label: 'DeclareSignerDetails' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### classHash - -• **classHash**: `string` - -#### Defined in - -[src/types/signer.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L12) - ---- - -### senderAddress - -• **senderAddress**: `string` - -#### Defined in - -[src/types/signer.ts:13](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L13) - ---- - -### chainId - -• **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/types/signer.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L14) - ---- - -### maxFee - -• **maxFee**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:15](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L15) - ---- - -### version - -• **version**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L16) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L17) - ---- - -### compiledClassHash - -• `Optional` **compiledClassHash**: `string` - -#### Defined in - -[src/types/signer.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L18) diff --git a/www/docs/API/interfaces/DeclareTransactionResponse.md b/www/docs/API/interfaces/DeclareTransactionResponse.md deleted file mode 100644 index 7debede4b..000000000 --- a/www/docs/API/interfaces/DeclareTransactionResponse.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -id: 'DeclareTransactionResponse' -title: 'Interface: DeclareTransactionResponse' -sidebar_label: 'DeclareTransactionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionResponse`](CommonTransactionResponse.md) - - ↳ **`DeclareTransactionResponse`** - -## Properties - -### contract_class - -• `Optional` **contract_class**: `any` - -#### Defined in - -[src/types/provider.ts:63](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L63) - ---- - -### sender_address - -• `Optional` **sender_address**: `string` - -#### Defined in - -[src/types/provider.ts:64](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L64) - ---- - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[transaction_hash](CommonTransactionResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L43) - ---- - -### version - -• `Optional` **version**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[version](CommonTransactionResponse.md#version) - -#### Defined in - -[src/types/provider.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L44) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../modules.md#signature) - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[signature](CommonTransactionResponse.md#signature) - -#### Defined in - -[src/types/provider.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L45) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[max_fee](CommonTransactionResponse.md#max_fee) - -#### Defined in - -[src/types/provider.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L46) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[nonce](CommonTransactionResponse.md#nonce) - -#### Defined in - -[src/types/provider.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L47) diff --git a/www/docs/API/interfaces/DeployContractResponse.md b/www/docs/API/interfaces/DeployContractResponse.md deleted file mode 100644 index 032441b15..000000000 --- a/www/docs/API/interfaces/DeployContractResponse.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'DeployContractResponse' -title: 'Interface: DeployContractResponse' -sidebar_label: 'DeployContractResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### contract_address - -• **contract_address**: `string` - -#### Defined in - -[src/types/account.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L22) - ---- - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/account.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L23) diff --git a/www/docs/API/interfaces/EstimateFee.md b/www/docs/API/interfaces/EstimateFee.md deleted file mode 100644 index c2c1767fa..000000000 --- a/www/docs/API/interfaces/EstimateFee.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: 'EstimateFee' -title: 'Interface: EstimateFee' -sidebar_label: 'EstimateFee' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`EstimateFeeResponse`](EstimateFeeResponse.md) - - ↳ **`EstimateFee`** - -## Properties - -### suggestedMaxFee - -• **suggestedMaxFee**: `bigint` - -#### Overrides - -[EstimateFeeResponse](EstimateFeeResponse.md).[suggestedMaxFee](EstimateFeeResponse.md#suggestedmaxfee) - -#### Defined in - -[src/types/account.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L10) - ---- - -### overall_fee - -• **overall_fee**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](EstimateFeeResponse.md).[overall_fee](EstimateFeeResponse.md#overall_fee) - -#### Defined in - -[src/types/provider.ts:104](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L104) - ---- - -### gas_consumed - -• `Optional` **gas_consumed**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](EstimateFeeResponse.md).[gas_consumed](EstimateFeeResponse.md#gas_consumed) - -#### Defined in - -[src/types/provider.ts:105](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L105) - ---- - -### gas_price - -• `Optional` **gas_price**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](EstimateFeeResponse.md).[gas_price](EstimateFeeResponse.md#gas_price) - -#### Defined in - -[src/types/provider.ts:106](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L106) diff --git a/www/docs/API/interfaces/EstimateFeeDetails.md b/www/docs/API/interfaces/EstimateFeeDetails.md deleted file mode 100644 index 32bb54e93..000000000 --- a/www/docs/API/interfaces/EstimateFeeDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'EstimateFeeDetails' -title: 'Interface: EstimateFeeDetails' -sidebar_label: 'EstimateFeeDetails' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### nonce - -• `Optional` **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/account.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L16) - ---- - -### blockIdentifier - -• `Optional` **blockIdentifier**: `BlockIdentifier` - -#### Defined in - -[src/types/account.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L17) - ---- - -### skipValidate - -• `Optional` **skipValidate**: `boolean` - -#### Defined in - -[src/types/account.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L18) diff --git a/www/docs/API/interfaces/EstimateFeeResponse.md b/www/docs/API/interfaces/EstimateFeeResponse.md deleted file mode 100644 index f83d5eb02..000000000 --- a/www/docs/API/interfaces/EstimateFeeResponse.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: 'EstimateFeeResponse' -title: 'Interface: EstimateFeeResponse' -sidebar_label: 'EstimateFeeResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`EstimateFeeResponse`** - - ↳ [`EstimateFee`](EstimateFee.md) - -## Properties - -### overall_fee - -• **overall_fee**: `bigint` - -#### Defined in - -[src/types/provider.ts:104](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L104) - ---- - -### gas_consumed - -• `Optional` **gas_consumed**: `bigint` - -#### Defined in - -[src/types/provider.ts:105](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L105) - ---- - -### gas_price - -• `Optional` **gas_price**: `bigint` - -#### Defined in - -[src/types/provider.ts:106](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L106) - ---- - -### suggestedMaxFee - -• `Optional` **suggestedMaxFee**: `bigint` - -#### Defined in - -[src/types/provider.ts:107](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L107) diff --git a/www/docs/API/interfaces/Event.md b/www/docs/API/interfaces/Event.md deleted file mode 100644 index 7ee3df029..000000000 --- a/www/docs/API/interfaces/Event.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'Event' -title: 'Interface: Event' -sidebar_label: 'Event' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### from_address - -• **from_address**: `string` - -#### Defined in - -[src/types/provider.ts:84](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L84) - ---- - -### keys - -• **keys**: `string`[] - -#### Defined in - -[src/types/provider.ts:85](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L85) - ---- - -### data - -• **data**: `string`[] - -#### Defined in - -[src/types/provider.ts:86](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L86) diff --git a/www/docs/API/interfaces/GetBlockResponse.md b/www/docs/API/interfaces/GetBlockResponse.md deleted file mode 100644 index 5927a2005..000000000 --- a/www/docs/API/interfaces/GetBlockResponse.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -id: 'GetBlockResponse' -title: 'Interface: GetBlockResponse' -sidebar_label: 'GetBlockResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -[src/types/provider.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L22) - ---- - -### block_hash - -• **block_hash**: `string` - -#### Defined in - -[src/types/provider.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L23) - ---- - -### block_number - -• **block_number**: `number` - -#### Defined in - -[src/types/provider.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L24) - ---- - -### new_root - -• **new_root**: `string` - -#### Defined in - -[src/types/provider.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L25) - ---- - -### parent_hash - -• **parent_hash**: `string` - -#### Defined in - -[src/types/provider.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L26) - ---- - -### status - -• **status**: [`Status`](../modules.md#status) - -#### Defined in - -[src/types/provider.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L27) - ---- - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -[src/types/provider.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L28) - ---- - -### gas_price - -• `Optional` **gas_price**: `string` - -#### Defined in - -[src/types/provider.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L29) - ---- - -### sequencer_address - -• `Optional` **sequencer_address**: `string` - -#### Defined in - -[src/types/provider.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L30) - ---- - -### starknet_version - -• `Optional` **starknet_version**: `string` - -#### Defined in - -[src/types/provider.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L31) - ---- - -### transaction_receipts - -• `Optional` **transaction_receipts**: `any` - -#### Defined in - -[src/types/provider.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L32) diff --git a/www/docs/API/interfaces/GetCodeResponse.md b/www/docs/API/interfaces/GetCodeResponse.md deleted file mode 100644 index 3418b8433..000000000 --- a/www/docs/API/interfaces/GetCodeResponse.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: 'GetCodeResponse' -title: 'Interface: GetCodeResponse' -sidebar_label: 'GetCodeResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### bytecode - -• **bytecode**: [`ByteCode`](../modules.md#bytecode) - -#### Defined in - -[src/types/provider.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L36) diff --git a/www/docs/API/interfaces/InvocationsSignerDetails.md b/www/docs/API/interfaces/InvocationsSignerDetails.md deleted file mode 100644 index 9bfe79bc6..000000000 --- a/www/docs/API/interfaces/InvocationsSignerDetails.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: 'InvocationsSignerDetails' -title: 'Interface: InvocationsSignerDetails' -sidebar_label: 'InvocationsSignerDetails' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- `Required`<[`InvocationsDetails`](../modules.md#invocationsdetails)\> - - ↳ **`InvocationsSignerDetails`** - -## Properties - -### walletAddress - -• **walletAddress**: `string` - -#### Defined in - -[src/types/signer.ts:6](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L6) - ---- - -### chainId - -• **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/types/signer.ts:7](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L7) - ---- - -### cairoVersion - -• **cairoVersion**: [`CairoVersion`](../modules.md#cairoversion) - -#### Defined in - -[src/types/signer.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L8) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -Required.nonce - -#### Defined in - -[src/types/lib/index.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L100) - ---- - -### maxFee - -• **maxFee**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -Required.maxFee - -#### Defined in - -[src/types/lib/index.ts:101](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L101) - ---- - -### version - -• **version**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -Required.version - -#### Defined in - -[src/types/lib/index.ts:102](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L102) diff --git a/www/docs/API/interfaces/InvokeFunctionResponse.md b/www/docs/API/interfaces/InvokeFunctionResponse.md deleted file mode 100644 index b1109c1ad..000000000 --- a/www/docs/API/interfaces/InvokeFunctionResponse.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: 'InvokeFunctionResponse' -title: 'Interface: InvokeFunctionResponse' -sidebar_label: 'InvokeFunctionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:111](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L111) diff --git a/www/docs/API/interfaces/InvokeTransactionReceiptResponse.md b/www/docs/API/interfaces/InvokeTransactionReceiptResponse.md deleted file mode 100644 index f180775c1..000000000 --- a/www/docs/API/interfaces/InvokeTransactionReceiptResponse.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -id: 'InvokeTransactionReceiptResponse' -title: 'Interface: InvokeTransactionReceiptResponse' -sidebar_label: 'InvokeTransactionReceiptResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionReceiptResponse`](CommonTransactionReceiptResponse.md) - - ↳ **`InvokeTransactionReceiptResponse`** - -## Properties - -### messages_sent - -• `Optional` **messages_sent**: [`MessageToL1`](MessageToL1.md)[] - -**`Deprecated`** - -Use l2_to_l1_messages - -#### Defined in - -[src/types/provider.ts:96](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L96) - ---- - -### events - -• `Optional` **events**: [`Event`](Event.md)[] - -#### Defined in - -[src/types/provider.ts:97](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L97) - ---- - -### l1_origin_message - -• `Optional` **l1_origin_message**: [`MessageToL2`](MessageToL2.md) - -#### Defined in - -[src/types/provider.ts:98](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L98) - ---- - -### transaction_hash - -• **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[transaction_hash](CommonTransactionReceiptResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider.ts:72](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L72) - ---- - -### status - -• `Optional` **status**: [`Status`](../modules.md#status) - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[status](CommonTransactionReceiptResponse.md#status) - -#### Defined in - -[src/types/provider.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L73) - ---- - -### actual_fee - -• `Optional` **actual_fee**: `string` - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[actual_fee](CommonTransactionReceiptResponse.md#actual_fee) - -#### Defined in - -[src/types/provider.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L74) - ---- - -### status_data - -• `Optional` **status_data**: `string` - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[status_data](CommonTransactionReceiptResponse.md#status_data) - -#### Defined in - -[src/types/provider.ts:75](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L75) diff --git a/www/docs/API/interfaces/InvokeTransactionResponse.md b/www/docs/API/interfaces/InvokeTransactionResponse.md deleted file mode 100644 index 7ba4e5238..000000000 --- a/www/docs/API/interfaces/InvokeTransactionResponse.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -id: 'InvokeTransactionResponse' -title: 'Interface: InvokeTransactionResponse' -sidebar_label: 'InvokeTransactionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionResponse`](CommonTransactionResponse.md) - - ↳ **`InvokeTransactionResponse`** - -## Properties - -### contract_address - -• `Optional` **contract_address**: `string` - -#### Defined in - -[src/types/provider.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L51) - ---- - -### sender_address - -• `Optional` **sender_address**: `string` - -#### Defined in - -[src/types/provider.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L52) - ---- - -### entry_point_selector - -• `Optional` **entry_point_selector**: `string` - -#### Defined in - -[src/types/provider.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L53) - ---- - -### calldata - -• **calldata**: [`RawCalldata`](../modules.md#rawcalldata) - -#### Defined in - -[src/types/provider.ts:54](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L54) - ---- - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[transaction_hash](CommonTransactionResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L43) - ---- - -### version - -• `Optional` **version**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[version](CommonTransactionResponse.md#version) - -#### Defined in - -[src/types/provider.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L44) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../modules.md#signature) - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[signature](CommonTransactionResponse.md#signature) - -#### Defined in - -[src/types/provider.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L45) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[max_fee](CommonTransactionResponse.md#max_fee) - -#### Defined in - -[src/types/provider.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L46) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[nonce](CommonTransactionResponse.md#nonce) - -#### Defined in - -[src/types/provider.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L47) diff --git a/www/docs/API/interfaces/MessageToL1.md b/www/docs/API/interfaces/MessageToL1.md deleted file mode 100644 index 254f3287f..000000000 --- a/www/docs/API/interfaces/MessageToL1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'MessageToL1' -title: 'Interface: MessageToL1' -sidebar_label: 'MessageToL1' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### to_address - -• **to_address**: `string` - -#### Defined in - -[src/types/provider.ts:79](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L79) - ---- - -### payload - -• **payload**: `string`[] - -#### Defined in - -[src/types/provider.ts:80](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L80) diff --git a/www/docs/API/interfaces/MessageToL2.md b/www/docs/API/interfaces/MessageToL2.md deleted file mode 100644 index 7204c7a63..000000000 --- a/www/docs/API/interfaces/MessageToL2.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'MessageToL2' -title: 'Interface: MessageToL2' -sidebar_label: 'MessageToL2' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### from_address - -• **from_address**: `string` - -#### Defined in - -[src/types/provider.ts:90](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L90) - ---- - -### payload - -• **payload**: `string`[] - -#### Defined in - -[src/types/provider.ts:91](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L91) diff --git a/www/docs/API/interfaces/Program.md b/www/docs/API/interfaces/Program.md deleted file mode 100644 index 42e8eef92..000000000 --- a/www/docs/API/interfaces/Program.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: 'Program' -title: 'Interface: Program' -sidebar_label: 'Program' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- `Record`<`string`, `any`\> - - ↳ **`Program`** - -## Properties - -### builtins - -• **builtins**: `string`[] - -#### Defined in - -[src/types/lib/contract/legacy.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L31) - ---- - -### data - -• **data**: `string`[] - -#### Defined in - -[src/types/lib/contract/legacy.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L32) diff --git a/www/docs/API/interfaces/ProviderOptions.md b/www/docs/API/interfaces/ProviderOptions.md deleted file mode 100644 index bc68fc6c2..000000000 --- a/www/docs/API/interfaces/ProviderOptions.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'ProviderOptions' -title: 'Interface: ProviderOptions' -sidebar_label: 'ProviderOptions' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### sequencer - -• `Optional` **sequencer**: [`SequencerProviderOptions`](../modules.md#sequencerprovideroptions) - -#### Defined in - -[src/provider/default.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L35) - ---- - -### rpc - -• `Optional` **rpc**: [`RpcProviderOptions`](../modules.md#rpcprovideroptions) - -#### Defined in - -[src/provider/default.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L36) diff --git a/www/docs/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md b/www/docs/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md deleted file mode 100644 index fe907635e..000000000 --- a/www/docs/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -id: 'Sequencer.InvokeFunctionTransactionResponse' -title: 'Interface: InvokeFunctionTransactionResponse' -sidebar_label: 'InvokeFunctionTransactionResponse' -custom_edit_url: null ---- - -[Sequencer](../namespaces/Sequencer.md).InvokeFunctionTransactionResponse - -## Hierarchy - -- [`InvokeFunctionTransaction`](../namespaces/Sequencer.md#invokefunctiontransaction) - - ↳ **`InvokeFunctionTransactionResponse`** - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:141](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L141) - ---- - -### entry_point_selector - -• **entry_point_selector**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:142](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L142) - ---- - -### type - -• **type**: `"INVOKE_FUNCTION"` - -#### Inherited from - -InvokeFunctionTransaction.type - -#### Defined in - -[src/types/api/sequencer.ts:112](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L112) - ---- - -### sender_address - -• **sender_address**: `string` - -#### Inherited from - -InvokeFunctionTransaction.sender_address - -#### Defined in - -[src/types/api/sequencer.ts:113](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L113) - ---- - -### signature - -• `Optional` **signature**: `string`[] - -#### Inherited from - -InvokeFunctionTransaction.signature - -#### Defined in - -[src/types/api/sequencer.ts:114](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L114) - ---- - -### entry_point_type - -• `Optional` **entry_point_type**: [`EXTERNAL`](../enums/EntryPointType.md#external) - -#### Inherited from - -InvokeFunctionTransaction.entry_point_type - -#### Defined in - -[src/types/api/sequencer.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L115) - ---- - -### calldata - -• `Optional` **calldata**: [`RawCalldata`](../modules.md#rawcalldata) - -#### Inherited from - -InvokeFunctionTransaction.calldata - -#### Defined in - -[src/types/api/sequencer.ts:116](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L116) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.nonce - -#### Defined in - -[src/types/api/sequencer.ts:117](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L117) - ---- - -### max_fee - -• `Optional` **max_fee**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.max_fee - -#### Defined in - -[src/types/api/sequencer.ts:118](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L118) - ---- - -### version - -• `Optional` **version**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.version - -#### Defined in - -[src/types/api/sequencer.ts:119](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L119) diff --git a/www/docs/API/interfaces/StateUpdateResponse.md b/www/docs/API/interfaces/StateUpdateResponse.md deleted file mode 100644 index 3ee6ec6bf..000000000 --- a/www/docs/API/interfaces/StateUpdateResponse.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: 'StateUpdateResponse' -title: 'Interface: StateUpdateResponse' -sidebar_label: 'StateUpdateResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### block_hash - -• **block_hash**: `string` - -#### Defined in - -[src/types/provider.ts:154](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L154) - ---- - -### new_root - -• **new_root**: `string` - -#### Defined in - -[src/types/provider.ts:155](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L155) - ---- - -### old_root - -• **old_root**: `string` - -#### Defined in - -[src/types/provider.ts:156](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L156) - ---- - -### state_diff - -• **state_diff**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------- | :------------------------------------------------------------------------ | -| `storage_diffs` | [`StorageDiffs`](../namespaces/RPC.md#storagediffs) | -| `declared_contract_hashes?` | [`DeclaredContractHashes`](../namespaces/RPC.md#declaredcontracthashes) | -| `deployed_contracts` | [`DeployedContracts`](../namespaces/Sequencer.md#deployedcontracts) | -| `nonces` | [`Nonces`](../namespaces/RPC.md#nonces) | -| `old_declared_contracts?` | [`OldDeclaredContracts`](../namespaces/Sequencer.md#olddeclaredcontracts) | -| `declared_classes?` | [`DeclaredClasses`](../namespaces/Sequencer.md#declaredclasses) | -| `replaced_classes?` | [`ReplacedClasses`](../namespaces/Sequencer.md#replacedclasses) | - -#### Defined in - -[src/types/provider.ts:157](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L157) diff --git a/www/docs/API/interfaces/TransactionSimulation.md b/www/docs/API/interfaces/TransactionSimulation.md deleted file mode 100644 index 073c9c5d8..000000000 --- a/www/docs/API/interfaces/TransactionSimulation.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: 'TransactionSimulation' -title: 'Interface: TransactionSimulation' -sidebar_label: 'TransactionSimulation' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`TransactionSimulationResponse`](TransactionSimulationResponse.md) - - ↳ **`TransactionSimulation`** - -## Properties - -### fee_estimation - -• **fee_estimation**: [`EstimateFee`](EstimateFee.md) - -#### Overrides - -[TransactionSimulationResponse](TransactionSimulationResponse.md).[fee_estimation](TransactionSimulationResponse.md#fee_estimation) - -#### Defined in - -[src/types/account.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L51) - ---- - -### trace - -• **trace**: [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) - -#### Inherited from - -[TransactionSimulationResponse](TransactionSimulationResponse.md).[trace](TransactionSimulationResponse.md#trace) - -#### Defined in - -[src/types/provider.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L148) diff --git a/www/docs/API/interfaces/TransactionSimulationResponse.md b/www/docs/API/interfaces/TransactionSimulationResponse.md deleted file mode 100644 index e9b0e9032..000000000 --- a/www/docs/API/interfaces/TransactionSimulationResponse.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: 'TransactionSimulationResponse' -title: 'Interface: TransactionSimulationResponse' -sidebar_label: 'TransactionSimulationResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`TransactionSimulationResponse`** - - ↳ [`TransactionSimulation`](TransactionSimulation.md) - -## Properties - -### trace - -• **trace**: [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) - -#### Defined in - -[src/types/provider.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L148) - ---- - -### fee_estimation - -• **fee_estimation**: [`EstimateFeeResponse`](EstimateFeeResponse.md) - -#### Defined in - -[src/types/provider.ts:149](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L149) diff --git a/www/docs/API/interfaces/_category_.yml b/www/docs/API/interfaces/_category_.yml deleted file mode 100644 index 8ad053b07..000000000 --- a/www/docs/API/interfaces/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: 'Interfaces' -position: 4 diff --git a/www/docs/API/interfaces/ec.weierstrass.ProjConstructor.md b/www/docs/API/interfaces/ec.weierstrass.ProjConstructor.md deleted file mode 100644 index 9079c3eb2..000000000 --- a/www/docs/API/interfaces/ec.weierstrass.ProjConstructor.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -id: 'ec.weierstrass.ProjConstructor' -title: 'Interface: ProjConstructor' -sidebar_label: 'ProjConstructor' -custom_edit_url: null ---- - -[ec](../namespaces/ec.md).[weierstrass](../namespaces/ec.weierstrass.md).ProjConstructor - -## Type parameters - -| Name | -| :--- | -| `T` | - -## Hierarchy - -- `GroupConstructor`<[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\>\> - - ↳ **`ProjConstructor`** - -## Constructors - -### constructor - -• **new ProjConstructor**(`x`, `y`, `z`) - -#### Parameters - -| Name | Type | -| :--- | :--- | -| `x` | `T` | -| `y` | `T` | -| `z` | `T` | - -#### Inherited from - -GroupConstructor\>.constructor - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:76 - -## Properties - -### BASE - -• **BASE**: [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Inherited from - -GroupConstructor.BASE - -#### Defined in - -node_modules/@noble/curves/abstract/curve.d.ts:19 - ---- - -### ZERO - -• **ZERO**: [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Inherited from - -GroupConstructor.ZERO - -#### Defined in - -node_modules/@noble/curves/abstract/curve.d.ts:20 - -## Methods - -### fromAffine - -▸ **fromAffine**(`p`): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Parameters - -| Name | Type | -| :--- | :----------------------------------------------------------------- | -| `p` | [`AffinePoint`](../namespaces/ec.weierstrass.md#affinepoint)<`T`\> | - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:77 - ---- - -### fromHex - -▸ **fromHex**(`hex`): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Parameters - -| Name | Type | -| :---- | :---- | -| `hex` | `Hex` | - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:78 - ---- - -### fromPrivateKey - -▸ **fromPrivateKey**(`privateKey`): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Parameters - -| Name | Type | -| :----------- | :-------- | -| `privateKey` | `PrivKey` | - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:79 - ---- - -### normalizeZ - -▸ **normalizeZ**(`points`): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\>[] - -#### Parameters - -| Name | Type | -| :------- | :--------------------------------------------------------- | -| `points` | [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\>[] | - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\>[] - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:80 diff --git a/www/docs/API/interfaces/ec.weierstrass.ProjPointType.md b/www/docs/API/interfaces/ec.weierstrass.ProjPointType.md deleted file mode 100644 index e13c3c1b5..000000000 --- a/www/docs/API/interfaces/ec.weierstrass.ProjPointType.md +++ /dev/null @@ -1,406 +0,0 @@ ---- -id: 'ec.weierstrass.ProjPointType' -title: 'Interface: ProjPointType' -sidebar_label: 'ProjPointType' -custom_edit_url: null ---- - -[ec](../namespaces/ec.md).[weierstrass](../namespaces/ec.weierstrass.md).ProjPointType - -### Design rationale for types - -- Interaction between classes from different curves should fail: - `k256.Point.BASE.add(p256.Point.BASE)` -- For this purpose we want to use `instanceof` operator, which is fast and works during runtime -- Different calls of `curve()` would return different classes - - `curve(params) !== curve(params)`: if somebody decided to monkey-patch their curve, - it won't affect others - -TypeScript can't infer types for classes created inside a function. Classes is one instance of nominative types in TypeScript and interfaces only check for shape, so it's hard to create unique type for every function call. - -We can use generic types via some param, like curve opts, but that would: 1. Enable interaction between `curve(params)` and `curve(params)` (curves of same params) -which is hard to debug. 2. Params can be generic and we can't enforce them to be constant value: -if somebody creates curve from non-constant params, -it would be allowed to interact with other curves with non-constant params - -TODO: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#unique-symbol - -## Type parameters - -| Name | -| :--- | -| `T` | - -## Hierarchy - -- `Group`<[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\>\> - - ↳ **`ProjPointType`** - -## Properties - -### px - -• `Readonly` **px**: `T` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:58 - ---- - -### py - -• `Readonly` **py**: `T` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:59 - ---- - -### pz - -• `Readonly` **pz**: `T` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:60 - -## Accessors - -### x - -• `get` **x**(): `T` - -#### Returns - -`T` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:61 - ---- - -### y - -• `get` **y**(): `T` - -#### Returns - -`T` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:62 - -## Methods - -### multiply - -▸ **multiply**(`scalar`): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Parameters - -| Name | Type | -| :------- | :------- | -| `scalar` | `bigint` | - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Overrides - -Group.multiply - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:63 - ---- - -### toAffine - -▸ **toAffine**(`iz?`): [`AffinePoint`](../namespaces/ec.weierstrass.md#affinepoint)<`T`\> - -#### Parameters - -| Name | Type | -| :---- | :--- | -| `iz?` | `T` | - -#### Returns - -[`AffinePoint`](../namespaces/ec.weierstrass.md#affinepoint)<`T`\> - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:64 - ---- - -### isTorsionFree - -▸ **isTorsionFree**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:65 - ---- - -### clearCofactor - -▸ **clearCofactor**(): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:66 - ---- - -### assertValidity - -▸ **assertValidity**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:67 - ---- - -### hasEvenY - -▸ **hasEvenY**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:68 - ---- - -### toRawBytes - -▸ **toRawBytes**(`isCompressed?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :-------------- | :-------- | -| `isCompressed?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:69 - ---- - -### toHex - -▸ **toHex**(`isCompressed?`): `string` - -#### Parameters - -| Name | Type | -| :-------------- | :-------- | -| `isCompressed?` | `boolean` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:70 - ---- - -### multiplyUnsafe - -▸ **multiplyUnsafe**(`scalar`): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Parameters - -| Name | Type | -| :------- | :------- | -| `scalar` | `bigint` | - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:71 - ---- - -### multiplyAndAddUnsafe - -▸ **multiplyAndAddUnsafe**(`Q`, `a`, `b`): `undefined` \| [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Parameters - -| Name | Type | -| :--- | :------------------------------------------------------- | -| `Q` | [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> | -| `a` | `bigint` | -| `b` | `bigint` | - -#### Returns - -`undefined` \| [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:72 - ---- - -### \_setWindowSize - -▸ **\_setWindowSize**(`windowSize`): `void` - -#### Parameters - -| Name | Type | -| :----------- | :------- | -| `windowSize` | `number` | - -#### Returns - -`void` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:73 - ---- - -### double - -▸ **double**(): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Inherited from - -Group.double - -#### Defined in - -node_modules/@noble/curves/abstract/curve.d.ts:11 - ---- - -### negate - -▸ **negate**(): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Inherited from - -Group.negate - -#### Defined in - -node_modules/@noble/curves/abstract/curve.d.ts:12 - ---- - -### add - -▸ **add**(`other`): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Parameters - -| Name | Type | -| :------ | :------------------------------------------------------- | -| `other` | [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> | - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Inherited from - -Group.add - -#### Defined in - -node_modules/@noble/curves/abstract/curve.d.ts:13 - ---- - -### subtract - -▸ **subtract**(`other`): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Parameters - -| Name | Type | -| :------ | :------------------------------------------------------- | -| `other` | [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> | - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> - -#### Inherited from - -Group.subtract - -#### Defined in - -node_modules/@noble/curves/abstract/curve.d.ts:14 - ---- - -### equals - -▸ **equals**(`other`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------------------------------------------------------- | -| `other` | [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`T`\> | - -#### Returns - -`boolean` - -#### Inherited from - -Group.equals - -#### Defined in - -node_modules/@noble/curves/abstract/curve.d.ts:15 diff --git a/www/docs/API/interfaces/ec.weierstrass.SignatureType.md b/www/docs/API/interfaces/ec.weierstrass.SignatureType.md deleted file mode 100644 index 92a4d82b7..000000000 --- a/www/docs/API/interfaces/ec.weierstrass.SignatureType.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -id: 'ec.weierstrass.SignatureType' -title: 'Interface: SignatureType' -sidebar_label: 'SignatureType' -custom_edit_url: null ---- - -[ec](../namespaces/ec.md).[weierstrass](../namespaces/ec.weierstrass.md).SignatureType - -## Properties - -### r - -• `Readonly` **r**: `bigint` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:141 - ---- - -### s - -• `Readonly` **s**: `bigint` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:142 - ---- - -### recovery - -• `Optional` `Readonly` **recovery**: `number` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:143 - -## Methods - -### assertValidity - -▸ **assertValidity**(): `void` - -#### Returns - -`void` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:144 - ---- - -### addRecoveryBit - -▸ **addRecoveryBit**(`recovery`): [`RecoveredSignatureType`](../namespaces/ec.weierstrass.md#recoveredsignaturetype) - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `recovery` | `number` | - -#### Returns - -[`RecoveredSignatureType`](../namespaces/ec.weierstrass.md#recoveredsignaturetype) - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:145 - ---- - -### hasHighS - -▸ **hasHighS**(): `boolean` - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:146 - ---- - -### normalizeS - -▸ **normalizeS**(): [`SignatureType`](ec.weierstrass.SignatureType.md) - -#### Returns - -[`SignatureType`](ec.weierstrass.SignatureType.md) - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:147 - ---- - -### recoverPublicKey - -▸ **recoverPublicKey**(`msgHash`): [`ProjPointType`](ec.weierstrass.ProjPointType.md)<`bigint`\> - -#### Parameters - -| Name | Type | -| :-------- | :---- | -| `msgHash` | `Hex` | - -#### Returns - -[`ProjPointType`](ec.weierstrass.ProjPointType.md)<`bigint`\> - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:148 - ---- - -### toCompactRawBytes - -▸ **toCompactRawBytes**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:149 - ---- - -### toCompactHex - -▸ **toCompactHex**(): `string` - -#### Returns - -`string` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:150 - ---- - -### toDERRawBytes - -▸ **toDERRawBytes**(`isCompressed?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :-------------- | :-------- | -| `isCompressed?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:151 - ---- - -### toDERHex - -▸ **toDERHex**(`isCompressed?`): `string` - -#### Parameters - -| Name | Type | -| :-------------- | :-------- | -| `isCompressed?` | `boolean` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:152 diff --git a/www/docs/API/interfaces/typedData.StarkNetDomain.md b/www/docs/API/interfaces/typedData.StarkNetDomain.md deleted file mode 100644 index ba7547aea..000000000 --- a/www/docs/API/interfaces/typedData.StarkNetDomain.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: 'typedData.StarkNetDomain' -title: 'Interface: StarkNetDomain' -sidebar_label: 'StarkNetDomain' -custom_edit_url: null ---- - -[typedData](../namespaces/typedData.md).StarkNetDomain - -The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field. - -## Hierarchy - -- `Record`<`string`, `unknown`\> - - ↳ **`StarkNetDomain`** - -## Properties - -### name - -• `Optional` **name**: `string` - -#### Defined in - -[src/utils/typedData/types.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L24) - ---- - -### version - -• `Optional` **version**: `string` - -#### Defined in - -[src/utils/typedData/types.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L25) - ---- - -### chainId - -• `Optional` **chainId**: `string` \| `number` - -#### Defined in - -[src/utils/typedData/types.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L26) diff --git a/www/docs/API/interfaces/typedData.TypedData.md b/www/docs/API/interfaces/typedData.TypedData.md deleted file mode 100644 index 9a829a04b..000000000 --- a/www/docs/API/interfaces/typedData.TypedData.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: 'typedData.TypedData' -title: 'Interface: TypedData' -sidebar_label: 'TypedData' -custom_edit_url: null ---- - -[typedData](../namespaces/typedData.md).TypedData - -The complete typed data, with all the structs, domain data, primary type of the message, and the message itself. - -## Properties - -### types - -• **types**: `Record`<`string`, [`StarkNetType`](../namespaces/typedData.md#starknettype)[]\> - -#### Defined in - -[src/utils/typedData/types.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L33) - ---- - -### primaryType - -• **primaryType**: `string` - -#### Defined in - -[src/utils/typedData/types.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L34) - ---- - -### domain - -• **domain**: [`StarkNetDomain`](typedData.StarkNetDomain.md) - -#### Defined in - -[src/utils/typedData/types.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L35) - ---- - -### message - -• **message**: `Record`<`string`, `unknown`\> - -#### Defined in - -[src/utils/typedData/types.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L36) diff --git a/www/docs/API/interfaces/types.CallStruct.md b/www/docs/API/interfaces/types.CallStruct.md deleted file mode 100644 index 29a355dd5..000000000 --- a/www/docs/API/interfaces/types.CallStruct.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: 'types.CallStruct' -title: 'Interface: CallStruct' -sidebar_label: 'CallStruct' -custom_edit_url: null ---- - -[types](../namespaces/types.md).CallStruct - -## Properties - -### to - -• **to**: `string` - -#### Defined in - -[src/types/lib/index.ts:245](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L245) - ---- - -### selector - -• **selector**: `string` - -#### Defined in - -[src/types/lib/index.ts:246](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L246) - ---- - -### calldata - -• **calldata**: `string`[] - -#### Defined in - -[src/types/lib/index.ts:247](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L247) diff --git a/www/docs/API/interfaces/types.CommonTransactionReceiptResponse.md b/www/docs/API/interfaces/types.CommonTransactionReceiptResponse.md deleted file mode 100644 index 534ffc6e1..000000000 --- a/www/docs/API/interfaces/types.CommonTransactionReceiptResponse.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: 'types.CommonTransactionReceiptResponse' -title: 'Interface: CommonTransactionReceiptResponse' -sidebar_label: 'CommonTransactionReceiptResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).CommonTransactionReceiptResponse - -## Hierarchy - -- **`CommonTransactionReceiptResponse`** - - ↳ [`InvokeTransactionReceiptResponse`](types.InvokeTransactionReceiptResponse.md) - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:75](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L75) - ---- - -### status - -• `Optional` **status**: `"NOT_RECEIVED"` \| `"RECEIVED"` \| `"ACCEPTED_ON_L2"` \| `"ACCEPTED_ON_L1"` \| `"REJECTED"` - -#### Defined in - -[src/types/provider/response.ts:76](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L76) - ---- - -### actual_fee - -• `Optional` **actual_fee**: `string` - -#### Defined in - -[src/types/provider/response.ts:77](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L77) - ---- - -### status_data - -• `Optional` **status_data**: `string` - -#### Defined in - -[src/types/provider/response.ts:78](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L78) diff --git a/www/docs/API/interfaces/types.CommonTransactionResponse.md b/www/docs/API/interfaces/types.CommonTransactionResponse.md deleted file mode 100644 index 74ddfaa06..000000000 --- a/www/docs/API/interfaces/types.CommonTransactionResponse.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: 'types.CommonTransactionResponse' -title: 'Interface: CommonTransactionResponse' -sidebar_label: 'CommonTransactionResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).CommonTransactionResponse - -## Hierarchy - -- **`CommonTransactionResponse`** - - ↳ [`InvokeTransactionResponse`](types.InvokeTransactionResponse.md) - - ↳ [`DeclareTransactionResponse`](types.DeclareTransactionResponse.md) - -## Properties - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L58) - ---- - -### version - -• `Optional` **version**: `string` - -#### Defined in - -[src/types/provider/response.ts:59](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L59) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../namespaces/types.md#signature) - -#### Defined in - -[src/types/provider/response.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L60) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Defined in - -[src/types/provider/response.ts:61](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L61) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Defined in - -[src/types/provider/response.ts:62](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L62) diff --git a/www/docs/API/interfaces/types.ContractEntryPoint.md b/www/docs/API/interfaces/types.ContractEntryPoint.md deleted file mode 100644 index a406359ec..000000000 --- a/www/docs/API/interfaces/types.ContractEntryPoint.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'types.ContractEntryPoint' -title: 'Interface: ContractEntryPoint' -sidebar_label: 'ContractEntryPoint' -custom_edit_url: null ---- - -[types](../namespaces/types.md).ContractEntryPoint - -## Properties - -### offset - -• **offset**: `string` - -#### Defined in - -[src/types/provider/response.ts:48](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L48) - ---- - -### selector - -• **selector**: `string` - -#### Defined in - -[src/types/provider/response.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L49) diff --git a/www/docs/API/interfaces/types.DeclareContractResponse.md b/www/docs/API/interfaces/types.DeclareContractResponse.md deleted file mode 100644 index b0f640a0a..000000000 --- a/www/docs/API/interfaces/types.DeclareContractResponse.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'types.DeclareContractResponse' -title: 'Interface: DeclareContractResponse' -sidebar_label: 'DeclareContractResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).DeclareContractResponse - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:183](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L183) - ---- - -### class_hash - -• **class_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:184](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L184) diff --git a/www/docs/API/interfaces/types.DeclareSignerDetails.md b/www/docs/API/interfaces/types.DeclareSignerDetails.md deleted file mode 100644 index eca95a59f..000000000 --- a/www/docs/API/interfaces/types.DeclareSignerDetails.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: 'types.DeclareSignerDetails' -title: 'Interface: DeclareSignerDetails' -sidebar_label: 'DeclareSignerDetails' -custom_edit_url: null ---- - -[types](../namespaces/types.md).DeclareSignerDetails - -## Properties - -### classHash - -• **classHash**: `string` - -#### Defined in - -[src/types/signer.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L16) - ---- - -### senderAddress - -• **senderAddress**: `string` - -#### Defined in - -[src/types/signer.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L17) - ---- - -### chainId - -• **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/types/signer.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L18) - ---- - -### maxFee - -• **maxFee**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:19](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L19) - ---- - -### version - -• **version**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:20](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L20) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L21) - ---- - -### compiledClassHash - -• `Optional` **compiledClassHash**: `string` - -#### Defined in - -[src/types/signer.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L22) diff --git a/www/docs/API/interfaces/types.DeclareTransactionResponse.md b/www/docs/API/interfaces/types.DeclareTransactionResponse.md deleted file mode 100644 index ab963992f..000000000 --- a/www/docs/API/interfaces/types.DeclareTransactionResponse.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -id: 'types.DeclareTransactionResponse' -title: 'Interface: DeclareTransactionResponse' -sidebar_label: 'DeclareTransactionResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).DeclareTransactionResponse - -## Hierarchy - -- [`CommonTransactionResponse`](types.CommonTransactionResponse.md) - - ↳ **`DeclareTransactionResponse`** - -## Properties - -### contract_class - -• `Optional` **contract_class**: `any` - -#### Defined in - -[src/types/provider/response.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L73) - ---- - -### sender_address - -• `Optional` **sender_address**: `string` - -#### Defined in - -[src/types/provider/response.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L74) - ---- - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[transaction_hash](types.CommonTransactionResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider/response.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L58) - ---- - -### version - -• `Optional` **version**: `string` - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[version](types.CommonTransactionResponse.md#version) - -#### Defined in - -[src/types/provider/response.ts:59](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L59) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../namespaces/types.md#signature) - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[signature](types.CommonTransactionResponse.md#signature) - -#### Defined in - -[src/types/provider/response.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L60) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[max_fee](types.CommonTransactionResponse.md#max_fee) - -#### Defined in - -[src/types/provider/response.ts:61](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L61) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[nonce](types.CommonTransactionResponse.md#nonce) - -#### Defined in - -[src/types/provider/response.ts:62](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L62) diff --git a/www/docs/API/interfaces/types.DeployContractResponse.md b/www/docs/API/interfaces/types.DeployContractResponse.md deleted file mode 100644 index 120097bd6..000000000 --- a/www/docs/API/interfaces/types.DeployContractResponse.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'types.DeployContractResponse' -title: 'Interface: DeployContractResponse' -sidebar_label: 'DeployContractResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).DeployContractResponse - -## Properties - -### contract_address - -• **contract_address**: `string` - -#### Defined in - -[src/types/account.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L23) - ---- - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/account.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L24) diff --git a/www/docs/API/interfaces/types.EstimateFee.md b/www/docs/API/interfaces/types.EstimateFee.md deleted file mode 100644 index ced001743..000000000 --- a/www/docs/API/interfaces/types.EstimateFee.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: 'types.EstimateFee' -title: 'Interface: EstimateFee' -sidebar_label: 'EstimateFee' -custom_edit_url: null ---- - -[types](../namespaces/types.md).EstimateFee - -## Hierarchy - -- [`EstimateFeeResponse`](types.EstimateFeeResponse.md) - - ↳ **`EstimateFee`** - -## Properties - -### suggestedMaxFee - -• **suggestedMaxFee**: `bigint` - -#### Overrides - -[EstimateFeeResponse](types.EstimateFeeResponse.md).[suggestedMaxFee](types.EstimateFeeResponse.md#suggestedmaxfee) - -#### Defined in - -[src/types/account.ts:5](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L5) - ---- - -### overall_fee - -• **overall_fee**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](types.EstimateFeeResponse.md).[overall_fee](types.EstimateFeeResponse.md#overall_fee) - -#### Defined in - -[src/types/provider/response.ts:172](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L172) - ---- - -### gas_consumed - -• `Optional` **gas_consumed**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](types.EstimateFeeResponse.md).[gas_consumed](types.EstimateFeeResponse.md#gas_consumed) - -#### Defined in - -[src/types/provider/response.ts:173](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L173) - ---- - -### gas_price - -• `Optional` **gas_price**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](types.EstimateFeeResponse.md).[gas_price](types.EstimateFeeResponse.md#gas_price) - -#### Defined in - -[src/types/provider/response.ts:174](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L174) diff --git a/www/docs/API/interfaces/types.EstimateFeeDetails.md b/www/docs/API/interfaces/types.EstimateFeeDetails.md deleted file mode 100644 index e7ff8dd3c..000000000 --- a/www/docs/API/interfaces/types.EstimateFeeDetails.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: 'types.EstimateFeeDetails' -title: 'Interface: EstimateFeeDetails' -sidebar_label: 'EstimateFeeDetails' -custom_edit_url: null ---- - -[types](../namespaces/types.md).EstimateFeeDetails - -## Properties - -### nonce - -• `Optional` **nonce**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Defined in - -[src/types/account.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L17) - ---- - -### blockIdentifier - -• `Optional` **blockIdentifier**: [`BlockIdentifier`](../namespaces/types.md#blockidentifier) - -#### Defined in - -[src/types/account.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L18) - ---- - -### skipValidate - -• `Optional` **skipValidate**: `boolean` - -#### Defined in - -[src/types/account.ts:19](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L19) diff --git a/www/docs/API/interfaces/types.EstimateFeeResponse.md b/www/docs/API/interfaces/types.EstimateFeeResponse.md deleted file mode 100644 index 960ff6666..000000000 --- a/www/docs/API/interfaces/types.EstimateFeeResponse.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: 'types.EstimateFeeResponse' -title: 'Interface: EstimateFeeResponse' -sidebar_label: 'EstimateFeeResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).EstimateFeeResponse - -## Hierarchy - -- **`EstimateFeeResponse`** - - ↳ [`EstimateFee`](types.EstimateFee.md) - -## Properties - -### overall_fee - -• **overall_fee**: `bigint` - -#### Defined in - -[src/types/provider/response.ts:172](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L172) - ---- - -### gas_consumed - -• `Optional` **gas_consumed**: `bigint` - -#### Defined in - -[src/types/provider/response.ts:173](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L173) - ---- - -### gas_price - -• `Optional` **gas_price**: `bigint` - -#### Defined in - -[src/types/provider/response.ts:174](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L174) - ---- - -### suggestedMaxFee - -• `Optional` **suggestedMaxFee**: `bigint` - -#### Defined in - -[src/types/provider/response.ts:175](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L175) diff --git a/www/docs/API/interfaces/types.Event.md b/www/docs/API/interfaces/types.Event.md deleted file mode 100644 index e4b315e43..000000000 --- a/www/docs/API/interfaces/types.Event.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: 'types.Event' -title: 'Interface: Event' -sidebar_label: 'Event' -custom_edit_url: null ---- - -[types](../namespaces/types.md).Event - -## Properties - -### from_address - -• **from_address**: `string` - -#### Defined in - -[src/types/provider/response.ts:83](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L83) - ---- - -### keys - -• **keys**: `string`[] - -#### Defined in - -[src/types/provider/response.ts:84](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L84) - ---- - -### data - -• **data**: `string`[] - -#### Defined in - -[src/types/provider/response.ts:85](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L85) diff --git a/www/docs/API/interfaces/types.GetBlockResponse.md b/www/docs/API/interfaces/types.GetBlockResponse.md deleted file mode 100644 index 9fdbfd1a2..000000000 --- a/www/docs/API/interfaces/types.GetBlockResponse.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: 'types.GetBlockResponse' -title: 'Interface: GetBlockResponse' -sidebar_label: 'GetBlockResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).GetBlockResponse - -## Properties - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -[src/types/provider/response.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L29) - ---- - -### block_hash - -• **block_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L30) - ---- - -### block_number - -• **block_number**: `number` - -#### Defined in - -[src/types/provider/response.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L31) - ---- - -### new_root - -• **new_root**: `string` - -#### Defined in - -[src/types/provider/response.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L32) - ---- - -### parent_hash - -• **parent_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L33) - ---- - -### status - -• **status**: [`BlockStatus`](../enums/types.BlockStatus.md) - -#### Defined in - -[src/types/provider/response.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L34) - ---- - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -[src/types/provider/response.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L35) - ---- - -### gas_price - -• `Optional` **gas_price**: `string` - -#### Defined in - -[src/types/provider/response.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L36) - ---- - -### sequencer_address - -• `Optional` **sequencer_address**: `string` - -#### Defined in - -[src/types/provider/response.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L37) - ---- - -### starknet_version - -• `Optional` **starknet_version**: `string` - -#### Defined in - -[src/types/provider/response.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L38) - ---- - -### transaction_receipts - -• `Optional` **transaction_receipts**: `any` - -#### Defined in - -[src/types/provider/response.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L39) diff --git a/www/docs/API/interfaces/types.GetCodeResponse.md b/www/docs/API/interfaces/types.GetCodeResponse.md deleted file mode 100644 index b5dd2c80c..000000000 --- a/www/docs/API/interfaces/types.GetCodeResponse.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: 'types.GetCodeResponse' -title: 'Interface: GetCodeResponse' -sidebar_label: 'GetCodeResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).GetCodeResponse - -## Properties - -### bytecode - -• **bytecode**: [`ByteCode`](../namespaces/types.md#bytecode) - -#### Defined in - -[src/types/provider/response.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L43) diff --git a/www/docs/API/interfaces/types.InvocationsSignerDetails.md b/www/docs/API/interfaces/types.InvocationsSignerDetails.md deleted file mode 100644 index b6cc03430..000000000 --- a/www/docs/API/interfaces/types.InvocationsSignerDetails.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: 'types.InvocationsSignerDetails' -title: 'Interface: InvocationsSignerDetails' -sidebar_label: 'InvocationsSignerDetails' -custom_edit_url: null ---- - -[types](../namespaces/types.md).InvocationsSignerDetails - -## Hierarchy - -- `Required`<[`InvocationsDetails`](../namespaces/types.md#invocationsdetails)\> - - ↳ **`InvocationsSignerDetails`** - -## Properties - -### walletAddress - -• **walletAddress**: `string` - -#### Defined in - -[src/types/signer.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L10) - ---- - -### chainId - -• **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/types/signer.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L11) - ---- - -### cairoVersion - -• **cairoVersion**: [`CairoVersion`](../namespaces/types.md#cairoversion) - -#### Defined in - -[src/types/signer.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L12) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Inherited from - -Required.nonce - -#### Defined in - -[src/types/lib/index.ts:112](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L112) - ---- - -### maxFee - -• **maxFee**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Inherited from - -Required.maxFee - -#### Defined in - -[src/types/lib/index.ts:113](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L113) - ---- - -### version - -• **version**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Inherited from - -Required.version - -#### Defined in - -[src/types/lib/index.ts:114](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L114) diff --git a/www/docs/API/interfaces/types.InvokeFunctionResponse.md b/www/docs/API/interfaces/types.InvokeFunctionResponse.md deleted file mode 100644 index bfe0e33ba..000000000 --- a/www/docs/API/interfaces/types.InvokeFunctionResponse.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: 'types.InvokeFunctionResponse' -title: 'Interface: InvokeFunctionResponse' -sidebar_label: 'InvokeFunctionResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).InvokeFunctionResponse - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:179](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L179) diff --git a/www/docs/API/interfaces/types.InvokeTransactionReceiptResponse.md b/www/docs/API/interfaces/types.InvokeTransactionReceiptResponse.md deleted file mode 100644 index 9acc8e7b3..000000000 --- a/www/docs/API/interfaces/types.InvokeTransactionReceiptResponse.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -id: 'types.InvokeTransactionReceiptResponse' -title: 'Interface: InvokeTransactionReceiptResponse' -sidebar_label: 'InvokeTransactionReceiptResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).InvokeTransactionReceiptResponse - -## Properties - -### type - -• `Optional` **type**: [`TransactionType`](../enums/types.TransactionType.md) - -#### Defined in - -[src/types/provider/response.ts:112](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L112) - ---- - -### execution_status - -• **execution_status**: [`TransactionExecutionStatus`](../enums/types.TransactionExecutionStatus.md) - -#### Defined in - -[src/types/provider/response.ts:113](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L113) - ---- - -### finality_status - -• **finality_status**: [`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) - -#### Defined in - -[src/types/provider/response.ts:114](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L114) - ---- - -### status - -• `Optional` **status**: `"NOT_RECEIVED"` \| `"RECEIVED"` \| `"ACCEPTED_ON_L2"` \| `"ACCEPTED_ON_L1"` \| `"REJECTED"` \| `"REVERTED"` - -#### Defined in - -[src/types/provider/response.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L115) - ---- - -### actual_fee - -• **actual_fee**: `string` - -#### Defined in - -[src/types/provider/response.ts:116](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L116) - ---- - -### block_hash - -• **block_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:117](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L117) - ---- - -### block_number - -• **block_number**: [`BlockNumber`](../namespaces/types.md#blocknumber) - -#### Defined in - -[src/types/provider/response.ts:118](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L118) - ---- - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:119](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L119) - ---- - -### transaction_index - -• `Optional` **transaction_index**: `number` - -#### Defined in - -[src/types/provider/response.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L120) - ---- - -### messages_sent - -• **messages_sent**: [`MessageToL1`](types.MessageToL1.md)[] - -#### Defined in - -[src/types/provider/response.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L121) - ---- - -### events - -• **events**: `any`[] - -#### Defined in - -[src/types/provider/response.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L122) - ---- - -### execution_resources - -• `Optional` **execution_resources**: `any` - -#### Defined in - -[src/types/provider/response.ts:123](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L123) diff --git a/www/docs/API/interfaces/types.InvokeTransactionResponse.md b/www/docs/API/interfaces/types.InvokeTransactionResponse.md deleted file mode 100644 index 44966a739..000000000 --- a/www/docs/API/interfaces/types.InvokeTransactionResponse.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -id: 'types.InvokeTransactionResponse' -title: 'Interface: InvokeTransactionResponse' -sidebar_label: 'InvokeTransactionResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).InvokeTransactionResponse - -## Hierarchy - -- [`CommonTransactionResponse`](types.CommonTransactionResponse.md) - - ↳ **`InvokeTransactionResponse`** - -## Properties - -### contract_address - -• `Optional` **contract_address**: `string` - -#### Defined in - -[src/types/provider/response.ts:66](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L66) - ---- - -### sender_address - -• `Optional` **sender_address**: `string` - -#### Defined in - -[src/types/provider/response.ts:67](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L67) - ---- - -### entry_point_selector - -• `Optional` **entry_point_selector**: `string` - -#### Defined in - -[src/types/provider/response.ts:68](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L68) - ---- - -### calldata - -• **calldata**: [`RawCalldata`](../namespaces/types.md#rawcalldata) - -#### Defined in - -[src/types/provider/response.ts:69](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L69) - ---- - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[transaction_hash](types.CommonTransactionResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider/response.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L58) - ---- - -### version - -• `Optional` **version**: `string` - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[version](types.CommonTransactionResponse.md#version) - -#### Defined in - -[src/types/provider/response.ts:59](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L59) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../namespaces/types.md#signature) - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[signature](types.CommonTransactionResponse.md#signature) - -#### Defined in - -[src/types/provider/response.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L60) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[max_fee](types.CommonTransactionResponse.md#max_fee) - -#### Defined in - -[src/types/provider/response.ts:61](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L61) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Inherited from - -[CommonTransactionResponse](types.CommonTransactionResponse.md).[nonce](types.CommonTransactionResponse.md#nonce) - -#### Defined in - -[src/types/provider/response.ts:62](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L62) diff --git a/www/docs/API/interfaces/types.MessageToL1.md b/www/docs/API/interfaces/types.MessageToL1.md deleted file mode 100644 index 89b51694e..000000000 --- a/www/docs/API/interfaces/types.MessageToL1.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'types.MessageToL1' -title: 'Interface: MessageToL1' -sidebar_label: 'MessageToL1' -custom_edit_url: null ---- - -[types](../namespaces/types.md).MessageToL1 - -## Properties - -### to_address - -• **to_address**: `string` - -#### Defined in - -[src/types/provider/response.ts:78](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L78) - ---- - -### payload - -• **payload**: `string`[] - -#### Defined in - -[src/types/provider/response.ts:79](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L79) diff --git a/www/docs/API/interfaces/types.MessageToL2.md b/www/docs/API/interfaces/types.MessageToL2.md deleted file mode 100644 index bd9b8daba..000000000 --- a/www/docs/API/interfaces/types.MessageToL2.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'types.MessageToL2' -title: 'Interface: MessageToL2' -sidebar_label: 'MessageToL2' -custom_edit_url: null ---- - -[types](../namespaces/types.md).MessageToL2 - -## Properties - -### from_address - -• **from_address**: `string` - -#### Defined in - -[src/types/provider/response.ts:89](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L89) - ---- - -### payload - -• **payload**: `string`[] - -#### Defined in - -[src/types/provider/response.ts:90](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L90) diff --git a/www/docs/API/interfaces/types.Program.md b/www/docs/API/interfaces/types.Program.md deleted file mode 100644 index ff09a9a63..000000000 --- a/www/docs/API/interfaces/types.Program.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: 'types.Program' -title: 'Interface: Program' -sidebar_label: 'Program' -custom_edit_url: null ---- - -[types](../namespaces/types.md).Program - -## Hierarchy - -- `Record`<`string`, `any`\> - - ↳ **`Program`** - -## Properties - -### builtins - -• **builtins**: `string`[] - -#### Defined in - -[src/types/lib/contract/legacy.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L37) - ---- - -### data - -• **data**: `string`[] - -#### Defined in - -[src/types/lib/contract/legacy.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L38) diff --git a/www/docs/API/interfaces/types.ProviderOptions.md b/www/docs/API/interfaces/types.ProviderOptions.md deleted file mode 100644 index 8e73cb763..000000000 --- a/www/docs/API/interfaces/types.ProviderOptions.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'types.ProviderOptions' -title: 'Interface: ProviderOptions' -sidebar_label: 'ProviderOptions' -custom_edit_url: null ---- - -[types](../namespaces/types.md).ProviderOptions - -## Properties - -### sequencer - -• `Optional` **sequencer**: [`SequencerProviderOptions`](../namespaces/types.md#sequencerprovideroptions) - -#### Defined in - -[src/types/provider/configuration.ts:5](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/configuration.ts#L5) - ---- - -### rpc - -• `Optional` **rpc**: [`RpcProviderOptions`](../namespaces/types.md#rpcprovideroptions) - -#### Defined in - -[src/types/provider/configuration.ts:6](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/configuration.ts#L6) diff --git a/www/docs/API/interfaces/types.Sequencer.InvokeFunctionTransactionResponse.md b/www/docs/API/interfaces/types.Sequencer.InvokeFunctionTransactionResponse.md deleted file mode 100644 index c20134d32..000000000 --- a/www/docs/API/interfaces/types.Sequencer.InvokeFunctionTransactionResponse.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -id: 'types.Sequencer.InvokeFunctionTransactionResponse' -title: 'Interface: InvokeFunctionTransactionResponse' -sidebar_label: 'InvokeFunctionTransactionResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).[Sequencer](../namespaces/types.Sequencer.md).InvokeFunctionTransactionResponse - -## Hierarchy - -- [`InvokeFunctionTransaction`](../namespaces/types.Sequencer.md#invokefunctiontransaction) - - ↳ **`InvokeFunctionTransactionResponse`** - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:149](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L149) - ---- - -### entry_point_selector - -• **entry_point_selector**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:150](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L150) - ---- - -### type - -• **type**: [`INVOKE`](../enums/types.TransactionType.md#invoke) - -#### Inherited from - -InvokeFunctionTransaction.type - -#### Defined in - -[src/types/api/sequencer.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L120) - ---- - -### sender_address - -• **sender_address**: `string` - -#### Inherited from - -InvokeFunctionTransaction.sender_address - -#### Defined in - -[src/types/api/sequencer.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L121) - ---- - -### signature - -• `Optional` **signature**: `string`[] - -#### Inherited from - -InvokeFunctionTransaction.signature - -#### Defined in - -[src/types/api/sequencer.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L122) - ---- - -### entry_point_type - -• `Optional` **entry_point_type**: [`EXTERNAL`](../enums/types.EntryPointType.md#external) - -#### Inherited from - -InvokeFunctionTransaction.entry_point_type - -#### Defined in - -[src/types/api/sequencer.ts:123](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L123) - ---- - -### calldata - -• `Optional` **calldata**: [`RawCalldata`](../namespaces/types.md#rawcalldata) - -#### Inherited from - -InvokeFunctionTransaction.calldata - -#### Defined in - -[src/types/api/sequencer.ts:124](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L124) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.nonce - -#### Defined in - -[src/types/api/sequencer.ts:125](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L125) - ---- - -### max_fee - -• `Optional` **max_fee**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.max_fee - -#### Defined in - -[src/types/api/sequencer.ts:126](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L126) - ---- - -### version - -• `Optional` **version**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.version - -#### Defined in - -[src/types/api/sequencer.ts:127](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L127) diff --git a/www/docs/API/interfaces/types.StarkNetDomain.md b/www/docs/API/interfaces/types.StarkNetDomain.md deleted file mode 100644 index c2f4943d9..000000000 --- a/www/docs/API/interfaces/types.StarkNetDomain.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: 'types.StarkNetDomain' -title: 'Interface: StarkNetDomain' -sidebar_label: 'StarkNetDomain' -custom_edit_url: null ---- - -[types](../namespaces/types.md).StarkNetDomain - -The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field. - -## Hierarchy - -- `Record`<`string`, `unknown`\> - - ↳ **`StarkNetDomain`** - -## Properties - -### name - -• `Optional` **name**: `string` - -#### Defined in - -[src/types/typedData.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/typedData.ts#L24) - ---- - -### version - -• `Optional` **version**: `string` - -#### Defined in - -[src/types/typedData.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/typedData.ts#L25) - ---- - -### chainId - -• `Optional` **chainId**: `string` \| `number` - -#### Defined in - -[src/types/typedData.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/types/typedData.ts#L26) diff --git a/www/docs/API/interfaces/types.StateUpdateResponse.md b/www/docs/API/interfaces/types.StateUpdateResponse.md deleted file mode 100644 index 090995086..000000000 --- a/www/docs/API/interfaces/types.StateUpdateResponse.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: 'types.StateUpdateResponse' -title: 'Interface: StateUpdateResponse' -sidebar_label: 'StateUpdateResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).StateUpdateResponse - -## Properties - -### block_hash - -• `Optional` **block_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:227](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L227) - ---- - -### new_root - -• `Optional` **new_root**: `string` - -#### Defined in - -[src/types/provider/response.ts:228](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L228) - ---- - -### old_root - -• **old_root**: `string` - -#### Defined in - -[src/types/provider/response.ts:229](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L229) - ---- - -### state_diff - -• **state_diff**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | -| `storage_diffs` | [`StorageDiffs`](../namespaces/types.RPC.md#storagediffs) | -| `deployed_contracts` | [`DeployedContracts`](../namespaces/types.Sequencer.md#deployedcontracts) | -| `nonces` | [`Nonces`](../namespaces/types.RPC.md#nonces) | -| `old_declared_contracts?` | [`OldDeclaredContracts`](../namespaces/types.Sequencer.md#olddeclaredcontracts) | -| `declared_classes?` | [`DeclaredClasses`](../namespaces/types.Sequencer.md#declaredclasses) | -| `replaced_classes?` | [`ReplacedClasses`](../namespaces/types.RPC.md#replacedclasses) \| [`ReplacedClasses`](../namespaces/types.Sequencer.md#replacedclasses) | -| `deprecated_declared_classes?` | [`DeprecatedDeclaredClasses`](../namespaces/types.RPC.md#deprecateddeclaredclasses) | - -#### Defined in - -[src/types/provider/response.ts:230](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L230) diff --git a/www/docs/API/interfaces/types.TransactionSimulation.md b/www/docs/API/interfaces/types.TransactionSimulation.md deleted file mode 100644 index d76c9f852..000000000 --- a/www/docs/API/interfaces/types.TransactionSimulation.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: 'types.TransactionSimulation' -title: 'Interface: TransactionSimulation' -sidebar_label: 'TransactionSimulation' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionSimulation - -## Hierarchy - -- [`TransactionSimulationResponse`](types.TransactionSimulationResponse.md) - - ↳ **`TransactionSimulation`** - -## Properties - -### fee_estimation - -• **fee_estimation**: [`EstimateFee`](types.EstimateFee.md) - -#### Overrides - -[TransactionSimulationResponse](types.TransactionSimulationResponse.md).[fee_estimation](types.TransactionSimulationResponse.md#fee_estimation) - -#### Defined in - -[src/types/account.ts:50](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L50) - ---- - -### trace - -• **trace**: [`TransactionTraceResponse`](../namespaces/types.md#transactiontraceresponse) - -#### Inherited from - -[TransactionSimulationResponse](types.TransactionSimulationResponse.md).[trace](types.TransactionSimulationResponse.md#trace) - -#### Defined in - -[src/types/provider/response.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L148) diff --git a/www/docs/API/interfaces/types.TransactionSimulationResponse.md b/www/docs/API/interfaces/types.TransactionSimulationResponse.md deleted file mode 100644 index 0495a39f3..000000000 --- a/www/docs/API/interfaces/types.TransactionSimulationResponse.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: 'types.TransactionSimulationResponse' -title: 'Interface: TransactionSimulationResponse' -sidebar_label: 'TransactionSimulationResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionSimulationResponse - -## Hierarchy - -- **`TransactionSimulationResponse`** - - ↳ [`TransactionSimulation`](types.TransactionSimulation.md) - -## Properties - -### trace - -• **trace**: [`TransactionTraceResponse`](../namespaces/types.md#transactiontraceresponse) - -#### Defined in - -[src/types/provider/response.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L148) - ---- - -### fee_estimation - -• **fee_estimation**: [`EstimateFeeResponse`](types.EstimateFeeResponse.md) - -#### Defined in - -[src/types/provider/response.ts:149](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L149) diff --git a/www/docs/API/interfaces/types.TypedData.md b/www/docs/API/interfaces/types.TypedData.md deleted file mode 100644 index c0001e2e2..000000000 --- a/www/docs/API/interfaces/types.TypedData.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: 'types.TypedData' -title: 'Interface: TypedData' -sidebar_label: 'TypedData' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TypedData - -The complete typed data, with all the structs, domain data, primary type of the message, and the message itself. - -## Properties - -### types - -• **types**: `Record`<`string`, [`StarkNetType`](../namespaces/types.md#starknettype)[]\> - -#### Defined in - -[src/types/typedData.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/types/typedData.ts#L33) - ---- - -### primaryType - -• **primaryType**: `string` - -#### Defined in - -[src/types/typedData.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/types/typedData.ts#L34) - ---- - -### domain - -• **domain**: [`StarkNetDomain`](types.StarkNetDomain.md) - -#### Defined in - -[src/types/typedData.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/types/typedData.ts#L35) - ---- - -### message - -• **message**: `Record`<`string`, `unknown`\> - -#### Defined in - -[src/types/typedData.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/types/typedData.ts#L36) diff --git a/www/docs/API/interfaces/types.Uint256.md b/www/docs/API/interfaces/types.Uint256.md deleted file mode 100644 index ebf4c2d08..000000000 --- a/www/docs/API/interfaces/types.Uint256.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: 'types.Uint256' -title: 'Interface: Uint256' -sidebar_label: 'Uint256' -custom_edit_url: null ---- - -[types](../namespaces/types.md).Uint256 - -Represents an integer in the range [0, 2^256) - -## Properties - -### low - -• **low**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Defined in - -[src/types/lib/index.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L23) - ---- - -### high - -• **high**: [`BigNumberish`](../namespaces/types.md#bignumberish) - -#### Defined in - -[src/types/lib/index.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L25) diff --git a/www/docs/API/interfaces/uint256.Uint256.md b/www/docs/API/interfaces/uint256.Uint256.md deleted file mode 100644 index a108bc422..000000000 --- a/www/docs/API/interfaces/uint256.Uint256.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'uint256.Uint256' -title: 'Interface: Uint256' -sidebar_label: 'Uint256' -custom_edit_url: null ---- - -[uint256](../namespaces/uint256.md).Uint256 - -## Properties - -### low - -• **low**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/utils/uint256.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L8) - ---- - -### high - -• **high**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/utils/uint256.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L10) diff --git a/www/docs/API/modules.md b/www/docs/API/modules.md deleted file mode 100644 index 158b2e4f8..000000000 --- a/www/docs/API/modules.md +++ /dev/null @@ -1,1372 +0,0 @@ ---- -id: 'modules' -title: 'Starknet.js API - v5.21.0' -sidebar_label: 'Exports' -sidebar_position: 0.5 -custom_edit_url: null ---- - -## Namespaces - -- [types](namespaces/types.md) -- [constants](namespaces/constants.md) -- [encode](namespaces/encode.md) -- [hash](namespaces/hash.md) -- [json](namespaces/json.md) -- [num](namespaces/num.md) -- [transaction](namespaces/transaction.md) -- [stark](namespaces/stark.md) -- [merkle](namespaces/merkle.md) -- [uint256](namespaces/uint256.md) -- [shortString](namespaces/shortString.md) -- [typedData](namespaces/typedData.md) -- [ec](namespaces/ec.md) -- [starknetId](namespaces/starknetId.md) -- [provider](namespaces/provider-1.md) -- [selector](namespaces/selector.md) -- [events](namespaces/events.md) -- [cairo](namespaces/cairo.md) - -## Enumerations - -- [CairoOptionVariant](enums/CairoOptionVariant.md) -- [CairoResultVariant](enums/CairoResultVariant.md) - -## Classes - -- [Account](classes/Account.md) -- [AccountInterface](classes/AccountInterface.md) -- [Contract](classes/Contract.md) -- [ContractInterface](classes/ContractInterface.md) -- [ContractFactory](classes/ContractFactory.md) -- [Provider](classes/Provider.md) -- [CustomError](classes/CustomError.md) -- [LibraryError](classes/LibraryError.md) -- [GatewayError](classes/GatewayError.md) -- [HttpError](classes/HttpError.md) -- [SequencerProvider](classes/SequencerProvider.md) -- [ProviderInterface](classes/ProviderInterface.md) -- [RpcProvider](classes/RpcProvider.md) -- [SignerInterface](classes/SignerInterface.md) -- [Signer](classes/Signer.md) -- [CallData](classes/CallData.md) -- [CairoCustomEnum](classes/CairoCustomEnum.md) -- [CairoOption](classes/CairoOption.md) -- [CairoResult](classes/CairoResult.md) - -## References - -### RPC - -Re-exports [RPC](namespaces/types.RPC.md) - ---- - -### CallL1Handler - -Re-exports [CallL1Handler](namespaces/types.md#calll1handler) - ---- - -### DeployedContractItem - -Re-exports [DeployedContractItem](namespaces/types.md#deployedcontractitem) - ---- - -### ExecutionResources - -Re-exports [ExecutionResources](namespaces/types.md#executionresources) - ---- - -### FunctionInvocation - -Re-exports [FunctionInvocation](namespaces/types.md#functioninvocation) - ---- - -### GetContractAddressesResponse - -Re-exports [GetContractAddressesResponse](namespaces/types.md#getcontractaddressesresponse) - ---- - -### GetTransactionStatusResponse - -Re-exports [GetTransactionStatusResponse](namespaces/types.md#gettransactionstatusresponse) - ---- - -### SequencerIdentifier - -Re-exports [SequencerIdentifier](namespaces/types.md#sequenceridentifier) - ---- - -### Sequencer - -Re-exports [Sequencer](namespaces/types.Sequencer.md) - ---- - -### EstimateFee - -Re-exports [EstimateFee](interfaces/types.EstimateFee.md) - ---- - -### EstimateFeeBulk - -Re-exports [EstimateFeeBulk](namespaces/types.md#estimatefeebulk) - ---- - -### AccountInvocationsFactoryDetails - -Re-exports [AccountInvocationsFactoryDetails](namespaces/types.md#accountinvocationsfactorydetails) - ---- - -### EstimateFeeDetails - -Re-exports [EstimateFeeDetails](interfaces/types.EstimateFeeDetails.md) - ---- - -### DeployContractResponse - -Re-exports [DeployContractResponse](interfaces/types.DeployContractResponse.md) - ---- - -### MultiDeployContractResponse - -Re-exports [MultiDeployContractResponse](namespaces/types.md#multideploycontractresponse) - ---- - -### DeployContractUDCResponse - -Re-exports [DeployContractUDCResponse](namespaces/types.md#deploycontractudcresponse) - ---- - -### DeclareDeployUDCResponse - -Re-exports [DeclareDeployUDCResponse](namespaces/types.md#declaredeployudcresponse) - ---- - -### SimulateTransactionDetails - -Re-exports [SimulateTransactionDetails](namespaces/types.md#simulatetransactiondetails) - ---- - -### SIMULATION_FLAG - -Re-exports [SIMULATION_FLAG](enums/types.SIMULATION_FLAG.md) - ---- - -### ValidateType - -Re-exports [ValidateType](enums/types.ValidateType.md) - ---- - -### Uint - -Re-exports [Uint](enums/types.Uint.md) - ---- - -### Litteral - -Re-exports [Litteral](enums/types.Litteral.md) - ---- - -### AsyncContractFunction - -Re-exports [AsyncContractFunction](namespaces/types.md#asynccontractfunction) - ---- - -### ContractFunction - -Re-exports [ContractFunction](namespaces/types.md#contractfunction) - ---- - -### Result - -Re-exports [Result](namespaces/types.md#result) - ---- - -### ArgsOrCalldata - -Re-exports [ArgsOrCalldata](namespaces/types.md#argsorcalldata) - ---- - -### ArgsOrCalldataWithOptions - -Re-exports [ArgsOrCalldataWithOptions](namespaces/types.md#argsorcalldatawithoptions) - ---- - -### ContractOptions - -Re-exports [ContractOptions](namespaces/types.md#contractoptions) - ---- - -### CallOptions - -Re-exports [CallOptions](namespaces/types.md#calloptions) - ---- - -### InvokeOptions - -Re-exports [InvokeOptions](namespaces/types.md#invokeoptions) - ---- - -### ParsedEvent - -Re-exports [ParsedEvent](namespaces/types.md#parsedevent) - ---- - -### ParsedEvents - -Re-exports [ParsedEvents](namespaces/types.md#parsedevents) - ---- - -### WeierstrassSignatureType - -Re-exports [WeierstrassSignatureType](namespaces/types.md#weierstrasssignaturetype) - ---- - -### ArraySignatureType - -Re-exports [ArraySignatureType](namespaces/types.md#arraysignaturetype) - ---- - -### Signature - -Re-exports [Signature](namespaces/types.md#signature) - ---- - -### BigNumberish - -Re-exports [BigNumberish](namespaces/types.md#bignumberish) - ---- - -### Calldata - -Re-exports [Calldata](namespaces/types.md#calldata) - ---- - -### Uint256 - -Re-exports [Uint256](interfaces/types.Uint256.md) - ---- - -### RawCalldata - -Re-exports [RawCalldata](namespaces/types.md#rawcalldata) - ---- - -### HexCalldata - -Re-exports [HexCalldata](namespaces/types.md#hexcalldata) - ---- - -### AllowArray - -Re-exports [AllowArray](namespaces/types.md#allowarray) - ---- - -### OptionalPayload - -Re-exports [OptionalPayload](namespaces/types.md#optionalpayload) - ---- - -### RawArgs - -Re-exports [RawArgs](namespaces/types.md#rawargs) - ---- - -### RawArgsObject - -Re-exports [RawArgsObject](namespaces/types.md#rawargsobject) - ---- - -### RawArgsArray - -Re-exports [RawArgsArray](namespaces/types.md#rawargsarray) - ---- - -### MultiType - -Re-exports [MultiType](namespaces/types.md#multitype) - ---- - -### UniversalDeployerContractPayload - -Re-exports [UniversalDeployerContractPayload](namespaces/types.md#universaldeployercontractpayload) - ---- - -### DeployAccountContractPayload - -Re-exports [DeployAccountContractPayload](namespaces/types.md#deployaccountcontractpayload) - ---- - -### DeployAccountContractTransaction - -Re-exports [DeployAccountContractTransaction](namespaces/types.md#deployaccountcontracttransaction) - ---- - -### DeclareContractPayload - -Re-exports [DeclareContractPayload](namespaces/types.md#declarecontractpayload) - ---- - -### CompleteDeclareContractPayload - -Re-exports [CompleteDeclareContractPayload](namespaces/types.md#completedeclarecontractpayload) - ---- - -### DeclareAndDeployContractPayload - -Re-exports [DeclareAndDeployContractPayload](namespaces/types.md#declareanddeploycontractpayload) - ---- - -### DeclareContractTransaction - -Re-exports [DeclareContractTransaction](namespaces/types.md#declarecontracttransaction) - ---- - -### CallDetails - -Re-exports [CallDetails](namespaces/types.md#calldetails) - ---- - -### Invocation - -Re-exports [Invocation](namespaces/types.md#invocation) - ---- - -### Call - -Re-exports [Call](namespaces/types.md#call) - ---- - -### CairoVersion - -Re-exports [CairoVersion](namespaces/types.md#cairoversion) - ---- - -### CompilerVersion - -Re-exports [CompilerVersion](namespaces/types.md#compilerversion) - ---- - -### InvocationsDetails - -Re-exports [InvocationsDetails](namespaces/types.md#invocationsdetails) - ---- - -### Details - -Re-exports [Details](namespaces/types.md#details) - ---- - -### InvocationsDetailsWithNonce - -Re-exports [InvocationsDetailsWithNonce](namespaces/types.md#invocationsdetailswithnonce) - ---- - -### TransactionType - -Re-exports [TransactionType](enums/types.TransactionType.md) - ---- - -### TransactionStatus - -Re-exports [TransactionStatus](enums/types.TransactionStatus.md) - ---- - -### TransactionFinalityStatus - -Re-exports [TransactionFinalityStatus](enums/types.TransactionFinalityStatus.md) - ---- - -### TransactionExecutionStatus - -Re-exports [TransactionExecutionStatus](enums/types.TransactionExecutionStatus.md) - ---- - -### BlockStatus - -Re-exports [BlockStatus](enums/types.BlockStatus.md) - ---- - -### BlockTag - -Re-exports [BlockTag](enums/types.BlockTag.md) - ---- - -### BlockNumber - -Re-exports [BlockNumber](namespaces/types.md#blocknumber) - ---- - -### BlockIdentifier - -Re-exports [BlockIdentifier](namespaces/types.md#blockidentifier) - ---- - -### AccountInvocationItem - -Re-exports [AccountInvocationItem](namespaces/types.md#accountinvocationitem) - ---- - -### AccountInvocations - -Re-exports [AccountInvocations](namespaces/types.md#accountinvocations) - ---- - -### Invocations - -Re-exports [Invocations](namespaces/types.md#invocations) - ---- - -### Tupled - -Re-exports [Tupled](namespaces/types.md#tupled) - ---- - -### Args - -Re-exports [Args](namespaces/types.md#args) - ---- - -### ParsedStruct - -Re-exports [ParsedStruct](namespaces/types.md#parsedstruct) - ---- - -### waitForTransactionOptions - -Re-exports [waitForTransactionOptions](namespaces/types.md#waitfortransactionoptions) - ---- - -### getSimulateTransactionOptions - -Re-exports [getSimulateTransactionOptions](namespaces/types.md#getsimulatetransactionoptions) - ---- - -### getContractVersionOptions - -Re-exports [getContractVersionOptions](namespaces/types.md#getcontractversionoptions) - ---- - -### getEstimateFeeBulkOptions - -Re-exports [getEstimateFeeBulkOptions](namespaces/types.md#getestimatefeebulkoptions) - ---- - -### CallStruct - -Re-exports [CallStruct](interfaces/types.CallStruct.md) - ---- - -### ContractVersion - -Re-exports [ContractVersion](namespaces/types.md#contractversion) - ---- - -### ContractClass - -Re-exports [ContractClass](namespaces/types.md#contractclass) - ---- - -### CompiledContract - -Re-exports [CompiledContract](namespaces/types.md#compiledcontract) - ---- - -### CairoContract - -Re-exports [CairoContract](namespaces/types.md#cairocontract) - ---- - -### EntryPointType - -Re-exports [EntryPointType](enums/types.EntryPointType.md) - ---- - -### Abi - -Re-exports [Abi](namespaces/types.md#abi) - ---- - -### AbiEntry - -Re-exports [AbiEntry](namespaces/types.md#abientry) - ---- - -### EventEntry - -Re-exports [EventEntry](namespaces/types.md#evententry) - ---- - -### FunctionAbi - -Re-exports [FunctionAbi](namespaces/types.md#functionabi) - ---- - -### AbiStructs - -Re-exports [AbiStructs](namespaces/types.md#abistructs) - ---- - -### StructAbi - -Re-exports [StructAbi](namespaces/types.md#structabi) - ---- - -### AbiEnums - -Re-exports [AbiEnums](namespaces/types.md#abienums) - ---- - -### EnumAbi - -Re-exports [EnumAbi](namespaces/types.md#enumabi) - ---- - -### AbiEvents - -Re-exports [AbiEvents](namespaces/types.md#abievents) - ---- - -### EventAbi - -Re-exports [EventAbi](namespaces/types.md#eventabi) - ---- - -### Cairo1Event - -Re-exports [Cairo1Event](namespaces/types.md#cairo1event) - ---- - -### LegacyEvent - -Re-exports [LegacyEvent](namespaces/types.md#legacyevent) - ---- - -### LegacyContractClass - -Re-exports [LegacyContractClass](namespaces/types.md#legacycontractclass) - ---- - -### LegacyCompiledContract - -Re-exports [LegacyCompiledContract](namespaces/types.md#legacycompiledcontract) - ---- - -### Builtins - -Re-exports [Builtins](namespaces/types.md#builtins) - ---- - -### CompressedProgram - -Re-exports [CompressedProgram](namespaces/types.md#compressedprogram) - ---- - -### EntryPointsByType - -Re-exports [EntryPointsByType](namespaces/types.md#entrypointsbytype) - ---- - -### ContractEntryPointFields - -Re-exports [ContractEntryPointFields](namespaces/types.md#contractentrypointfields) - ---- - -### Program - -Re-exports [Program](interfaces/types.Program.md) - ---- - -### CairoAssembly - -Re-exports [CairoAssembly](namespaces/types.md#cairoassembly) - ---- - -### CompiledSierra - -Re-exports [CompiledSierra](namespaces/types.md#compiledsierra) - ---- - -### SierraContractClass - -Re-exports [SierraContractClass](namespaces/types.md#sierracontractclass) - ---- - -### CompiledSierraCasm - -Re-exports [CompiledSierraCasm](namespaces/types.md#compiledsierracasm) - ---- - -### ByteCode - -Re-exports [ByteCode](namespaces/types.md#bytecode) - ---- - -### PythonicHints - -Re-exports [PythonicHints](namespaces/types.md#pythonichints) - ---- - -### SierraProgramDebugInfo - -Re-exports [SierraProgramDebugInfo](namespaces/types.md#sierraprogramdebuginfo) - ---- - -### SierraEntryPointsByType - -Re-exports [SierraEntryPointsByType](namespaces/types.md#sierraentrypointsbytype) - ---- - -### SierraContractEntryPointFields - -Re-exports [SierraContractEntryPointFields](namespaces/types.md#sierracontractentrypointfields) - ---- - -### ProviderOptions - -Re-exports [ProviderOptions](interfaces/types.ProviderOptions.md) - ---- - -### RpcProviderOptions - -Re-exports [RpcProviderOptions](namespaces/types.md#rpcprovideroptions) - ---- - -### SequencerHttpMethod - -Re-exports [SequencerHttpMethod](namespaces/types.md#sequencerhttpmethod) - ---- - -### SequencerProviderOptions - -Re-exports [SequencerProviderOptions](namespaces/types.md#sequencerprovideroptions) - ---- - -### GetBlockResponse - -Re-exports [GetBlockResponse](interfaces/types.GetBlockResponse.md) - ---- - -### GetCodeResponse - -Re-exports [GetCodeResponse](interfaces/types.GetCodeResponse.md) - ---- - -### ContractEntryPoint - -Re-exports [ContractEntryPoint](interfaces/types.ContractEntryPoint.md) - ---- - -### GetTransactionResponse - -Re-exports [GetTransactionResponse](namespaces/types.md#gettransactionresponse) - ---- - -### CommonTransactionResponse - -Re-exports [CommonTransactionResponse](interfaces/types.CommonTransactionResponse.md) - ---- - -### InvokeTransactionResponse - -Re-exports [InvokeTransactionResponse](interfaces/types.InvokeTransactionResponse.md) - ---- - -### DeclareTransactionResponse - -Re-exports [DeclareTransactionResponse](interfaces/types.DeclareTransactionResponse.md) - ---- - -### MessageToL1 - -Re-exports [MessageToL1](interfaces/types.MessageToL1.md) - ---- - -### Event - -Re-exports [Event](interfaces/types.Event.md) - ---- - -### MessageToL2 - -Re-exports [MessageToL2](interfaces/types.MessageToL2.md) - ---- - -### RejectedTransactionResponse - -Re-exports [RejectedTransactionResponse](namespaces/types.md#rejectedtransactionresponse) - ---- - -### GetTransactionReceiptResponse - -Re-exports [GetTransactionReceiptResponse](namespaces/types.md#gettransactionreceiptresponse) - ---- - -### SuccessfulTransactionReceiptResponse - -Re-exports [SuccessfulTransactionReceiptResponse](namespaces/types.md#successfultransactionreceiptresponse) - ---- - -### InvokeTransactionReceiptResponse - -Re-exports [InvokeTransactionReceiptResponse](interfaces/types.InvokeTransactionReceiptResponse.md) - ---- - -### DeclareTransactionReceiptResponse - -Re-exports [DeclareTransactionReceiptResponse](namespaces/types.md#declaretransactionreceiptresponse) - ---- - -### DeployTransactionReceiptResponse - -Re-exports [DeployTransactionReceiptResponse](namespaces/types.md#deploytransactionreceiptresponse) - ---- - -### RejectedTransactionReceiptResponse - -Re-exports [RejectedTransactionReceiptResponse](namespaces/types.md#rejectedtransactionreceiptresponse) - ---- - -### RevertedTransactionReceiptResponse - -Re-exports [RevertedTransactionReceiptResponse](namespaces/types.md#revertedtransactionreceiptresponse) - ---- - -### EstimateFeeResponse - -Re-exports [EstimateFeeResponse](interfaces/types.EstimateFeeResponse.md) - ---- - -### InvokeFunctionResponse - -Re-exports [InvokeFunctionResponse](interfaces/types.InvokeFunctionResponse.md) - ---- - -### DeclareContractResponse - -Re-exports [DeclareContractResponse](interfaces/types.DeclareContractResponse.md) - ---- - -### CallContractResponse - -Re-exports [CallContractResponse](namespaces/types.md#callcontractresponse) - ---- - -### EstimateFeeAction - -Re-exports [EstimateFeeAction](namespaces/types.md#estimatefeeaction) - ---- - -### EstimateFeeResponseBulk - -Re-exports [EstimateFeeResponseBulk](namespaces/types.md#estimatefeeresponsebulk) - ---- - -### Storage - -Re-exports [Storage](namespaces/types.md#storage) - ---- - -### Nonce - -Re-exports [Nonce](namespaces/types.md#nonce) - ---- - -### SimulationFlags - -Re-exports [SimulationFlags](namespaces/types.md#simulationflags) - ---- - -### SimulatedTransaction - -Re-exports [SimulatedTransaction](namespaces/types.md#simulatedtransaction) - ---- - -### SimulateTransactionResponse - -Re-exports [SimulateTransactionResponse](namespaces/types.md#simulatetransactionresponse) - ---- - -### StateUpdateResponse - -Re-exports [StateUpdateResponse](interfaces/types.StateUpdateResponse.md) - ---- - -### ContractClassResponse - -Re-exports [ContractClassResponse](namespaces/types.md#contractclassresponse) - ---- - -### InvocationsSignerDetails - -Re-exports [InvocationsSignerDetails](interfaces/types.InvocationsSignerDetails.md) - ---- - -### DeclareSignerDetails - -Re-exports [DeclareSignerDetails](interfaces/types.DeclareSignerDetails.md) - ---- - -### DeployAccountSignerDetails - -Re-exports [DeployAccountSignerDetails](namespaces/types.md#deployaccountsignerdetails) - ---- - -### StarkNetMerkleType - -Re-exports [StarkNetMerkleType](namespaces/types.md#starknetmerkletype) - ---- - -### StarkNetType - -Re-exports [StarkNetType](namespaces/types.md#starknettype) - ---- - -### StarkNetDomain - -Re-exports [StarkNetDomain](interfaces/types.StarkNetDomain.md) - ---- - -### TypedData - -Re-exports [TypedData](interfaces/types.TypedData.md) - ---- - -### CairoEnum - -Re-exports [CairoEnum](namespaces/types.md#cairoenum) - -## Type Aliases - -### TypedContract - -Ƭ **TypedContract**<`TAbi`\>: `AbiWanTypedContract`<`TAbi`\> & [`ContractInterface`](classes/ContractInterface.md) - -#### Type parameters - -| Name | Type | -| :----- | :------------------ | -| `TAbi` | extends `AbiKanabi` | - -#### Defined in - -[src/contract/interface.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/interface.ts#L22) - ---- - -### ContractFactoryParams - -Ƭ **ContractFactoryParams**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :--------------------------------------------------------- | -| `compiledContract` | [`CompiledContract`](namespaces/types.md#compiledcontract) | -| `account` | `any` | -| `casm?` | [`CairoAssembly`](namespaces/types.md#cairoassembly) | -| `classHash?` | `string` | -| `compiledClassHash?` | `string` | -| `abi?` | [`Abi`](namespaces/types.md#abi) | - -#### Defined in - -[src/contract/contractFactory.ts:13](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/contractFactory.ts#L13) - ---- - -### CairoEnumRaw - -Ƭ **CairoEnumRaw**: `Object` - -#### Index signature - -▪ [key: `string`]: `any` - -#### Defined in - -[src/utils/calldata/enum/CairoCustomEnum.ts:1](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/enum/CairoCustomEnum.ts#L1) - -## Variables - -### number - -• `Const` **number**: [`num`](namespaces/num.md) = `num` - -**`Deprecated`** - -prefer the 'num' naming - -#### Defined in - -[src/index.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/index.ts#L46) - ---- - -### defaultProvider - -• `Const` **defaultProvider**: [`Provider`](classes/Provider.md) - -#### Defined in - -[src/provider/index.ts:9](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/index.ts#L9) - -## Functions - -### getCalldata - -▸ **getCalldata**(`args`, `callback`): [`Calldata`](namespaces/types.md#calldata) - -#### Parameters - -| Name | Type | -| :--------- | :--------------------------------------- | -| `args` | [`RawArgs`](namespaces/types.md#rawargs) | -| `callback` | `Function` | - -#### Returns - -[`Calldata`](namespaces/types.md#calldata) - -#### Defined in - -[src/contract/default.ts:108](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L108) - ---- - -### splitArgsAndOptions - -▸ **splitArgsAndOptions**(`args`): { `args`: [`ArgsOrCalldata`](namespaces/types.md#argsorcalldata) ; `options`: [`ContractOptions`](namespaces/types.md#contractoptions) } \| { `args`: [`ArgsOrCalldata`](namespaces/types.md#argsorcalldata) ; `options?`: `undefined` } - -#### Parameters - -| Name | Type | -| :----- | :--------------------------------------------------------------------------- | -| `args` | [`ArgsOrCalldataWithOptions`](namespaces/types.md#argsorcalldatawithoptions) | - -#### Returns - -{ `args`: [`ArgsOrCalldata`](namespaces/types.md#argsorcalldata) ; `options`: [`ContractOptions`](namespaces/types.md#contractoptions) } \| { `args`: [`ArgsOrCalldata`](namespaces/types.md#argsorcalldata) ; `options?`: `undefined` } - -#### Defined in - -[src/contract/default.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/contract/default.ts#L35) - ---- - -### fixStack - -▸ **fixStack**(`target`, `fn?`): `void` - -#### Parameters - -| Name | Type | Default value | -| :------- | :--------- | :------------------- | -| `target` | `Error` | `undefined` | -| `fn` | `Function` | `target.constructor` | - -#### Returns - -`void` - -#### Defined in - -[src/provider/errors.ts:2](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L2) - ---- - -### fixProto - -▸ **fixProto**(`target`, `prototype`): `void` - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `target` | `Error` | -| `prototype` | `Object` | - -#### Returns - -`void` - -#### Defined in - -[src/provider/errors.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/errors.ts#L8) - ---- - -### addAddressPadding - -▸ **addAddressPadding**(`address`): `string` - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------- | -| `address` | [`BigNumberish`](namespaces/types.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -[src/utils/address.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/address.ts#L10) - ---- - -### validateAndParseAddress - -▸ **validateAndParseAddress**(`address`): `string` - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------- | -| `address` | [`BigNumberish`](namespaces/types.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -[src/utils/address.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/address.ts#L14) - ---- - -### getChecksumAddress - -▸ **getChecksumAddress**(`address`): `string` - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------- | -| `address` | [`BigNumberish`](namespaces/types.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -[src/utils/address.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/address.ts#L27) - ---- - -### validateChecksumAddress - -▸ **validateChecksumAddress**(`address`): `boolean` - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `address` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/address.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/address.ts#L44) - ---- - -### isUrl - -▸ **isUrl**(`s?`): `boolean` - -Loosely validate a URL `string`. - -#### Parameters - -| Name | Type | -| :--- | :------- | -| `s?` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/url.ts:20](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/url.ts#L20) - ---- - -### buildUrl - -▸ **buildUrl**(`baseUrl`, `defaultPath`, `urlOrPath?`): `string` - -#### Parameters - -| Name | Type | -| :------------ | :------- | -| `baseUrl` | `string` | -| `defaultPath` | `string` | -| `urlOrPath?` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/url.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/url.ts#L49) - ---- - -### isSierra - -▸ **isSierra**(`contract`): contract is CompiledSierra \| SierraContractClass - -#### Parameters - -| Name | Type | -| :--------- | :--------------------------------------------------------------- | -| `contract` | `string` \| [`CairoContract`](namespaces/types.md#cairocontract) | - -#### Returns - -contract is CompiledSierra \| SierraContractClass - -#### Defined in - -[src/utils/contract.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/contract.ts#L14) - ---- - -### extractContractHashes - -▸ **extractContractHashes**(`payload`): [`CompleteDeclareContractPayload`](namespaces/types.md#completedeclarecontractpayload) - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------------------- | -| `payload` | [`DeclareContractPayload`](namespaces/types.md#declarecontractpayload) | - -#### Returns - -[`CompleteDeclareContractPayload`](namespaces/types.md#completedeclarecontractpayload) - -#### Defined in - -[src/utils/contract.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/contract.ts#L21) - ---- - -### contractClassResponseToLegacyCompiledContract - -▸ **contractClassResponseToLegacyCompiledContract**(`ccr`): [`LegacyCompiledContract`](namespaces/types.md#legacycompiledcontract) - -Helper to redeclare response Cairo0 contract - -#### Parameters - -| Name | Type | -| :---- | :------------------------------------------------------------------- | -| `ccr` | [`ContractClassResponse`](namespaces/types.md#contractclassresponse) | - -#### Returns - -[`LegacyCompiledContract`](namespaces/types.md#legacycompiledcontract) - -#### Defined in - -[src/utils/contract.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/contract.ts#L46) - ---- - -### parseUDCEvent - -▸ **parseUDCEvent**(`txReceipt`): `Object` - -Parse Transaction Receipt Event from UDC invoke transaction and -create DeployContractResponse compatible response with addition of the UDC Event data - -#### Parameters - -| Name | Type | -| :---------- | :----------------------------------------------------------------------------------------- | -| `txReceipt` | [`InvokeTransactionReceiptResponse`](interfaces/types.InvokeTransactionReceiptResponse.md) | - -#### Returns - -`Object` - -DeployContractResponse | UDC Event Response data - -| Name | Type | -| :----------------- | :------- | -| `transaction_hash` | `string` | -| `contract_address` | `any` | -| `address` | `any` | -| `deployer` | `any` | -| `unique` | `any` | -| `classHash` | `any` | -| `calldata_len` | `any` | -| `calldata` | `any` | -| `salt` | `any` | - -#### Defined in - -[src/utils/events.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/events.ts#L11) diff --git a/www/docs/API/namespaces/RPC.md b/www/docs/API/namespaces/RPC.md deleted file mode 100644 index f2d2b88d1..000000000 --- a/www/docs/API/namespaces/RPC.md +++ /dev/null @@ -1,382 +0,0 @@ ---- -id: 'RPC' -title: 'Namespace: RPC' -sidebar_label: 'RPC' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumerations - -- [TransactionType](../enums/RPC.TransactionType.md) - -## Type Aliases - -### Response - -Ƭ **Response**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----------------------------------------- | -| `id` | `number` | -| `jsonrpc` | `string` | -| `result?` | `any` | -| `error?` | { `code`: `string` ; `message`: `string` } | -| `error.code` | `string` | -| `error.message` | `string` | - -#### Defined in - -[src/types/api/rpc.ts:4](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L4) - ---- - -### ChainId - -Ƭ **ChainId**: `OPENRPC.CHAIN_ID` - -#### Defined in - -[src/types/api/rpc.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L14) - ---- - -### CallResponse - -Ƭ **CallResponse**: `OPENRPC.CallResponse` - -#### Defined in - -[src/types/api/rpc.ts:15](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L15) - ---- - -### ContractAddress - -Ƭ **ContractAddress**: `ADDRESS` - -#### Defined in - -[src/types/api/rpc.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L16) - ---- - -### Felt - -Ƭ **Felt**: `FELT` - -#### Defined in - -[src/types/api/rpc.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L17) - ---- - -### Nonce - -Ƭ **Nonce**: `OPENRPC.Nonce` - -#### Defined in - -[src/types/api/rpc.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L18) - ---- - -### ContractClass - -Ƭ **ContractClass**: `OPENRPC.ContractClass` - -#### Defined in - -[src/types/api/rpc.ts:19](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L19) - ---- - -### StateUpdate - -Ƭ **StateUpdate**: `OPENRPC.StateUpdate` - -#### Defined in - -[src/types/api/rpc.ts:20](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L20) - ---- - -### Transaction - -Ƭ **Transaction**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L21) - ---- - -### PendingTransactions - -Ƭ **PendingTransactions**: `OPENRPC.PendingTransactions` - -#### Defined in - -[src/types/api/rpc.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L22) - ---- - -### TransactionHash - -Ƭ **TransactionHash**: `OPENRPC.TransactionHash` - -#### Defined in - -[src/types/api/rpc.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L23) - ---- - -### Trace - -Ƭ **Trace**: `OPENRPC.Trace` - -#### Defined in - -[src/types/api/rpc.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L24) - ---- - -### Traces - -Ƭ **Traces**: `OPENRPC.Traces` - -#### Defined in - -[src/types/api/rpc.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L25) - ---- - -### BlockHash - -Ƭ **BlockHash**: `OPENRPC.BlockHash` - -#### Defined in - -[src/types/api/rpc.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L26) - ---- - -### BlockHashAndNumber - -Ƭ **BlockHashAndNumber**: `OPENRPC.BlockHashAndNumber` - -#### Defined in - -[src/types/api/rpc.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L27) - ---- - -### GetClassResponse - -Ƭ **GetClassResponse**: `OPENRPC.ContractClass` - -#### Defined in - -[src/types/api/rpc.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L28) - ---- - -### EstimateFeeResponse - -Ƭ **EstimateFeeResponse**: `OPENRPC.EstimatedFee` - -#### Defined in - -[src/types/api/rpc.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L29) - ---- - -### GetBlockWithTxHashesResponse - -Ƭ **GetBlockWithTxHashesResponse**: `OPENRPC.BlockWithTxHashes` - -#### Defined in - -[src/types/api/rpc.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L30) - ---- - -### GetBlockWithTxs - -Ƭ **GetBlockWithTxs**: `OPENRPC.BlockWithTxs` - -#### Defined in - -[src/types/api/rpc.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L31) - ---- - -### GetStorageAtResponse - -Ƭ **GetStorageAtResponse**: `OPENRPC.Storage` - -#### Defined in - -[src/types/api/rpc.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L32) - ---- - -### TransactionReceipt - -Ƭ **TransactionReceipt**: `OPENRPC.TransactionReceipt` - -#### Defined in - -[src/types/api/rpc.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L33) - ---- - -### GetTransactionByHashResponse - -Ƭ **GetTransactionByHashResponse**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L34) - ---- - -### GetTransactionByBlockIdAndIndex - -Ƭ **GetTransactionByBlockIdAndIndex**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L35) - ---- - -### GetTransactionCountResponse - -Ƭ **GetTransactionCountResponse**: `number` - -#### Defined in - -[src/types/api/rpc.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L36) - ---- - -### GetBlockNumberResponse - -Ƭ **GetBlockNumberResponse**: `OPENRPC.BlockNumber` - -#### Defined in - -[src/types/api/rpc.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L37) - ---- - -### GetSyncingStatsResponse - -Ƭ **GetSyncingStatsResponse**: `OPENRPC.SyncingStatus` - -#### Defined in - -[src/types/api/rpc.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L38) - ---- - -### EventFilter - -Ƭ **EventFilter**: `OPENRPC.EventFilter` - -#### Defined in - -[src/types/api/rpc.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L39) - ---- - -### GetEventsResponse - -Ƭ **GetEventsResponse**: `OPENRPC.Events` - -#### Defined in - -[src/types/api/rpc.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L40) - ---- - -### InvokedTransaction - -Ƭ **InvokedTransaction**: `OPENRPC.InvokedTransaction` - -#### Defined in - -[src/types/api/rpc.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L41) - ---- - -### DeclaredTransaction - -Ƭ **DeclaredTransaction**: `OPENRPC.DeclaredTransaction` - -#### Defined in - -[src/types/api/rpc.ts:42](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L42) - ---- - -### DeployedTransaction - -Ƭ **DeployedTransaction**: `OPENRPC.DeployedTransaction` - -#### Defined in - -[src/types/api/rpc.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L43) - ---- - -### Methods - -Ƭ **Methods**: `OPENRPC.Methods` - -#### Defined in - -[src/types/api/rpc.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L44) - ---- - -### Storage - -Ƭ **Storage**: `OPENRPC.Storage` - -#### Defined in - -[src/types/api/rpc.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L45) - ---- - -### StorageDiffs - -Ƭ **StorageDiffs**: `CONTRACT_STORAGE_DIFF_ITEM`[] - -#### Defined in - -[src/types/api/rpc.ts:56](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L56) - ---- - -### DeclaredContractHashes - -Ƭ **DeclaredContractHashes**: `FELT`[] - -#### Defined in - -[src/types/api/rpc.ts:57](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L57) - ---- - -### Nonces - -Ƭ **Nonces**: { `contract_address`: `ADDRESS` ; `nonce`: `FELT` }[] - -#### Defined in - -[src/types/api/rpc.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L58) diff --git a/www/docs/API/namespaces/Sequencer.md b/www/docs/API/namespaces/Sequencer.md deleted file mode 100644 index 798456a0d..000000000 --- a/www/docs/API/namespaces/Sequencer.md +++ /dev/null @@ -1,713 +0,0 @@ ---- -id: 'Sequencer' -title: 'Namespace: Sequencer' -sidebar_label: 'Sequencer' -sidebar_position: 0 -custom_edit_url: null ---- - -## Interfaces - -- [InvokeFunctionTransactionResponse](../interfaces/Sequencer.InvokeFunctionTransactionResponse.md) - -## Type Aliases - -### DeclareTransaction - -Ƭ **DeclareTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :--------------------------------------------- | -| `type` | `"DECLARE"` | -| `sender_address` | `string` | -| `contract_class` | [`ContractClass`](../modules.md#contractclass) | -| `signature?` | `string`[] | -| `nonce` | [`BigNumberish`](num.md#bignumberish) | -| `max_fee?` | [`BigNumberish`](num.md#bignumberish) | -| `version?` | [`BigNumberish`](num.md#bignumberish) | -| `compiled_class_hash?` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:81](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L81) - ---- - -### DeployTransaction - -Ƭ **DeployTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :--------------------------------------------- | -| `type` | `"DEPLOY"` | -| `contract_definition` | [`ContractClass`](../modules.md#contractclass) | -| `contract_address_salt` | [`BigNumberish`](num.md#bignumberish) | -| `constructor_calldata` | `string`[] | -| `nonce?` | [`BigNumberish`](num.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:92](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L92) - ---- - -### DeployAccountTransaction - -Ƭ **DeployAccountTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :------------------------------------ | -| `type` | `"DEPLOY_ACCOUNT"` | -| `class_hash` | `string` | -| `contract_address_salt` | [`BigNumberish`](num.md#bignumberish) | -| `constructor_calldata` | `string`[] | -| `signature?` | `string`[] | -| `max_fee?` | [`BigNumberish`](num.md#bignumberish) | -| `version?` | [`BigNumberish`](num.md#bignumberish) | -| `nonce?` | [`BigNumberish`](num.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L100) - ---- - -### InvokeFunctionTransaction - -Ƭ **InvokeFunctionTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------------------------------------------------ | -| `type` | `"INVOKE_FUNCTION"` | -| `sender_address` | `string` | -| `signature?` | `string`[] | -| `entry_point_type?` | [`EXTERNAL`](../enums/EntryPointType.md#external) | -| `calldata?` | [`RawCalldata`](../modules.md#rawcalldata) | -| `nonce` | [`BigNumberish`](num.md#bignumberish) | -| `max_fee?` | [`BigNumberish`](num.md#bignumberish) | -| `version?` | [`BigNumberish`](num.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:111](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L111) - ---- - -### Transaction - -Ƭ **Transaction**: [`DeclareTransaction`](Sequencer.md#declaretransaction) \| [`DeployTransaction`](Sequencer.md#deploytransaction) \| [`InvokeFunctionTransaction`](Sequencer.md#invokefunctiontransaction) \| [`DeployAccountTransaction`](Sequencer.md#deployaccounttransaction) - -#### Defined in - -[src/types/api/sequencer.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L122) - ---- - -### AddTransactionResponse - -Ƭ **AddTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :----------------------- | -| `transaction_hash` | `string` | -| `code?` | `"TRANSACTION_RECEIVED"` | -| `address?` | `string` | -| `class_hash?` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:128](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L128) - ---- - -### GetCodeResponse - -Ƭ **GetCodeResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----------------------------------- | -| `bytecode` | [`ByteCode`](../modules.md#bytecode) | -| `abi` | [`Abi`](../modules.md#abi) | - -#### Defined in - -[src/types/api/sequencer.ts:135](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L135) - ---- - -### TransactionResponse - -Ƭ **TransactionResponse**: [`DeclareTransaction`](Sequencer.md#declaretransaction) \| [`DeployTransaction`](Sequencer.md#deploytransaction) \| [`InvokeFunctionTransactionResponse`](../interfaces/Sequencer.InvokeFunctionTransactionResponse.md) - -#### Defined in - -[src/types/api/sequencer.ts:145](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L145) - ---- - -### SuccessfulTransactionResponse - -Ƭ **SuccessfulTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :-------------------------------------------------------- | -| `status` | [`Status`](../modules.md#status) | -| `transaction` | [`TransactionResponse`](Sequencer.md#transactionresponse) | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](../modules.md#blocknumber) | -| `transaction_index` | `number` | - -#### Defined in - -[src/types/api/sequencer.ts:150](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L150) - ---- - -### FailedTransactionResponse - -Ƭ **FailedTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :-------------------------------------------------------- | -| `status` | `"REJECTED"` | -| `transaction_failure_reason` | { `code`: `string` ; `error_message`: `string` } | -| `transaction_failure_reason.code` | `string` | -| `transaction_failure_reason.error_message` | `string` | -| `transaction` | [`TransactionResponse`](Sequencer.md#transactionresponse) | - -#### Defined in - -[src/types/api/sequencer.ts:158](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L158) - ---- - -### GetTransactionResponse - -Ƭ **GetTransactionResponse**: [`SuccessfulTransactionResponse`](Sequencer.md#successfultransactionresponse) \| [`FailedTransactionResponse`](Sequencer.md#failedtransactionresponse) - -#### Defined in - -[src/types/api/sequencer.ts:167](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L167) - ---- - -### TransactionReceiptResponse - -Ƭ **TransactionReceiptResponse**: [`SuccessfulTransactionReceiptResponse`](Sequencer.md#successfultransactionreceiptresponse) \| [`FailedTransactionReceiptResponse`](Sequencer.md#failedtransactionreceiptresponse) - -#### Defined in - -[src/types/api/sequencer.ts:169](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L169) - ---- - -### SuccessfulTransactionReceiptResponse - -Ƭ **SuccessfulTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------------------------------------------------------- | -| `status` | [`Status`](../modules.md#status) | -| `transaction_hash` | `string` | -| `transaction_index` | `number` | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](../modules.md#blocknumber) | -| `l2_to_l1_messages` | `string`[] | -| `events` | `string`[] | -| `actual_fee` | `string` | -| `execution_resources` | [`ExecutionResources`](../modules.md#executionresources) | - -#### Defined in - -[src/types/api/sequencer.ts:173](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L173) - ---- - -### FailedTransactionReceiptResponse - -Ƭ **FailedTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :----------------------------------------------- | -| `status` | `"REJECTED"` | -| `transaction_failure_reason` | { `code`: `string` ; `error_message`: `string` } | -| `transaction_failure_reason.code` | `string` | -| `transaction_failure_reason.error_message` | `string` | -| `transaction_hash` | `string` | -| `l2_to_l1_messages` | `string`[] | -| `events` | `string`[] | - -#### Defined in - -[src/types/api/sequencer.ts:185](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L185) - ---- - -### GetBlockResponse - -Ƭ **GetBlockResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `block_number` | `number` | -| `state_root` | `string` | -| `block_hash` | `string` | -| `transactions` | { `[txHash: string]`: [`TransactionResponse`](Sequencer.md#transactionresponse); } | -| `timestamp` | `number` | -| `transaction_receipts` | { `[txHash: string]`: { `block_hash`: `string` ; `transaction_hash`: `string` ; `l2_to_l1_messages`: { `to_address`: `string` ; `payload`: `string`[] ; `from_address`: `string` }[] ; `block_number`: [`BlockNumber`](../modules.md#blocknumber) ; `status`: [`Status`](../modules.md#status) ; `transaction_index`: `number` }; } | -| `parent_block_hash` | `string` | -| `status` | [`Status`](../modules.md#status) | -| `gas_price` | `string` | -| `sequencer_address` | `string` | -| `starknet_version` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:196](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L196) - ---- - -### CallContractTransaction - -Ƭ **CallContractTransaction**: { `calldata?`: [`RawCalldata`](../modules.md#rawcalldata) ; `max_fee?`: [`BigNumberish`](num.md#bignumberish) ; `version?`: [`BigNumberish`](num.md#bignumberish) ; `entry_point_selector`: `string` } & { `sender_address`: `string` ; `signature`: `string`[] } \| { `contract_address`: `string` ; `signature?`: `never` } - -#### Defined in - -[src/types/api/sequencer.ts:225](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L225) - ---- - -### CallContractResponse - -Ƭ **CallContractResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------- | -| `result` | `string`[] | - -#### Defined in - -[src/types/api/sequencer.ts:241](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L241) - ---- - -### InvokeEstimateFee - -Ƭ **InvokeEstimateFee**: `Omit`<[`InvokeFunctionTransaction`](Sequencer.md#invokefunctiontransaction), `"max_fee"` \| `"entry_point_type"`\> - -#### Defined in - -[src/types/api/sequencer.ts:245](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L245) - ---- - -### DeclareEstimateFee - -Ƭ **DeclareEstimateFee**: `Omit`<[`DeclareTransaction`](Sequencer.md#declaretransaction), `"max_fee"`\> - -#### Defined in - -[src/types/api/sequencer.ts:246](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L246) - ---- - -### DeployAccountEstimateFee - -Ƭ **DeployAccountEstimateFee**: `Omit`<[`DeployAccountTransaction`](Sequencer.md#deployaccounttransaction), `"max_fee"`\> - -#### Defined in - -[src/types/api/sequencer.ts:247](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L247) - ---- - -### DeployEstimateFee - -Ƭ **DeployEstimateFee**: [`DeployTransaction`](Sequencer.md#deploytransaction) - -#### Defined in - -[src/types/api/sequencer.ts:248](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L248) - ---- - -### EstimateFeeRequest - -Ƭ **EstimateFeeRequest**: [`InvokeEstimateFee`](Sequencer.md#invokeestimatefee) \| [`DeclareEstimateFee`](Sequencer.md#declareestimatefee) \| [`DeployEstimateFee`](Sequencer.md#deployestimatefee) \| [`DeployAccountEstimateFee`](Sequencer.md#deployaccountestimatefee) - -#### Defined in - -[src/types/api/sequencer.ts:250](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L250) - ---- - -### TransactionSimulationResponse - -Ƭ **TransactionSimulationResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------- | :------------------------------------------------------------------- | -| `trace` | [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) | -| `fee_estimation` | [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) | - -#### Defined in - -[src/types/api/sequencer.ts:256](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L256) - ---- - -### SimulateTransaction - -Ƭ **SimulateTransaction**: `Omit`<[`InvokeFunctionTransaction`](Sequencer.md#invokefunctiontransaction), `"entry_point_type"`\> - -#### Defined in - -[src/types/api/sequencer.ts:261](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L261) - ---- - -### EstimateFeeRequestBulk - -Ƭ **EstimateFeeRequestBulk**: [`AllowArray`](../modules.md#allowarray)<[`InvokeEstimateFee`](Sequencer.md#invokeestimatefee) \| [`DeclareEstimateFee`](Sequencer.md#declareestimatefee) \| [`DeployEstimateFee`](Sequencer.md#deployestimatefee) \| [`DeployAccountEstimateFee`](Sequencer.md#deployaccountestimatefee)\> - -#### Defined in - -[src/types/api/sequencer.ts:263](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L263) - ---- - -### EstimateFeeResponse - -Ƭ **EstimateFeeResponse**: { `overall_fee`: `number` ; `gas_price`: `number` ; `gas_usage`: `number` ; `uint`: `string` } \| { `amount`: `bigint` ; `unit`: `string` } - -#### Defined in - -[src/types/api/sequencer.ts:268](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L268) - ---- - -### EstimateFeeResponseBulk - -Ƭ **EstimateFeeResponseBulk**: [`AllowArray`](../modules.md#allowarray)<[`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse)\> - -#### Defined in - -[src/types/api/sequencer.ts:280](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L280) - ---- - -### BlockTransactionTracesResponse - -Ƭ **BlockTransactionTracesResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :-------------------------------------------------------------------------------------------------------- | -| `traces` | [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) & { `transaction_hash`: `string` }[] | - -#### Defined in - -[src/types/api/sequencer.ts:282](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L282) - ---- - -### Storage - -Ƭ **Storage**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:286](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L286) - ---- - -### StateUpdateResponse - -Ƭ **StateUpdateResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `block_hash` | `string` | -| `new_root` | `string` | -| `old_root` | `string` | -| `state_diff` | { `storage_diffs`: [`StorageDiffs`](Sequencer.md#storagediffs) ; `nonces`: [`Nonces`](Sequencer.md#nonces) ; `deployed_contracts`: [`DeployedContractItem`](../modules.md#deployedcontractitem)[] ; `old_declared_contracts`: [`OldDeclaredContracts`](Sequencer.md#olddeclaredcontracts) ; `declared_classes`: [`DeclaredClasses`](Sequencer.md#declaredclasses) ; `replaced_classes`: [`ReplacedClasses`](Sequencer.md#replacedclasses) } | -| `state_diff.storage_diffs` | [`StorageDiffs`](Sequencer.md#storagediffs) | -| `state_diff.nonces` | [`Nonces`](Sequencer.md#nonces) | -| `state_diff.deployed_contracts` | [`DeployedContractItem`](../modules.md#deployedcontractitem)[] | -| `state_diff.old_declared_contracts` | [`OldDeclaredContracts`](Sequencer.md#olddeclaredcontracts) | -| `state_diff.declared_classes` | [`DeclaredClasses`](Sequencer.md#declaredclasses) | -| `state_diff.replaced_classes` | [`ReplacedClasses`](Sequencer.md#replacedclasses) | - -#### Defined in - -[src/types/api/sequencer.ts:288](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L288) - ---- - -### StorageDiffs - -Ƭ **StorageDiffs**: `Object` - -#### Index signature - -▪ [address: `string`]: [`StateDiffItem`](Sequencer.md#statediffitem)[] - -#### Defined in - -[src/types/api/sequencer.ts:302](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L302) - ---- - -### StateDiffItem - -Ƭ **StateDiffItem**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------- | -| `key` | `string` | -| `value` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:304](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L304) - ---- - -### Nonces - -Ƭ **Nonces**: `Object` - -#### Index signature - -▪ [address: `string`]: [`Nonce`](Sequencer.md#nonce) - -#### Defined in - -[src/types/api/sequencer.ts:306](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L306) - ---- - -### Nonce - -Ƭ **Nonce**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:308](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L308) - ---- - -### DeployedContracts - -Ƭ **DeployedContracts**: [`DeployedContractItem`](../modules.md#deployedcontractitem)[] - -#### Defined in - -[src/types/api/sequencer.ts:310](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L310) - ---- - -### OldDeclaredContracts - -Ƭ **OldDeclaredContracts**: `string`[] - -#### Defined in - -[src/types/api/sequencer.ts:312](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L312) - ---- - -### DeclaredClasses - -Ƭ **DeclaredClasses**: [`DeclaredClass`](Sequencer.md#declaredclass)[] - -#### Defined in - -[src/types/api/sequencer.ts:314](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L314) - ---- - -### DeclaredClass - -Ƭ **DeclaredClass**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `class_hash` | `string` | -| `compiled_class_hash` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:316](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L316) - ---- - -### ReplacedClasses - -Ƭ **ReplacedClasses**: `string`[] - -#### Defined in - -[src/types/api/sequencer.ts:318](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L318) - ---- - -### Endpoints - -Ƭ **Endpoints**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `get_contract_addresses` | { `QUERY`: `never` ; `REQUEST`: `never` ; `RESPONSE`: [`GetContractAddressesResponse`](../modules.md#getcontractaddressesresponse) } | -| `get_contract_addresses.QUERY` | `never` | -| `get_contract_addresses.REQUEST` | `never` | -| `get_contract_addresses.RESPONSE` | [`GetContractAddressesResponse`](../modules.md#getcontractaddressesresponse) | -| `add_transaction` | { `QUERY`: `never` ; `REQUEST`: [`Transaction`](Sequencer.md#transaction) ; `RESPONSE`: [`AddTransactionResponse`](Sequencer.md#addtransactionresponse) } | -| `add_transaction.QUERY` | `never` | -| `add_transaction.REQUEST` | [`Transaction`](Sequencer.md#transaction) | -| `add_transaction.RESPONSE` | [`AddTransactionResponse`](Sequencer.md#addtransactionresponse) | -| `get_transaction` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetTransactionResponse`](Sequencer.md#gettransactionresponse) } | -| `get_transaction.QUERY` | { `transactionHash`: `string` } | -| `get_transaction.QUERY.transactionHash` | `string` | -| `get_transaction.REQUEST` | `never` | -| `get_transaction.RESPONSE` | [`GetTransactionResponse`](Sequencer.md#gettransactionresponse) | -| `get_transaction_status` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetTransactionStatusResponse`](../modules.md#gettransactionstatusresponse) } | -| `get_transaction_status.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_status.QUERY.transactionHash` | `string` | -| `get_transaction_status.REQUEST` | `never` | -| `get_transaction_status.RESPONSE` | [`GetTransactionStatusResponse`](../modules.md#gettransactionstatusresponse) | -| `get_transaction_trace` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) } | -| `get_transaction_trace.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_trace.QUERY.transactionHash` | `string` | -| `get_transaction_trace.REQUEST` | `never` | -| `get_transaction_trace.RESPONSE` | [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) | -| `get_transaction_receipt` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`TransactionReceiptResponse`](Sequencer.md#transactionreceiptresponse) } | -| `get_transaction_receipt.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_receipt.QUERY.transactionHash` | `string` | -| `get_transaction_receipt.REQUEST` | `never` | -| `get_transaction_receipt.RESPONSE` | [`TransactionReceiptResponse`](Sequencer.md#transactionreceiptresponse) | -| `get_nonce` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`Nonce`](Sequencer.md#nonce) } | -| `get_nonce.QUERY` | { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } | -| `get_nonce.QUERY.contractAddress` | `string` | -| `get_nonce.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_nonce.REQUEST` | `never` | -| `get_nonce.RESPONSE` | [`Nonce`](Sequencer.md#nonce) | -| `get_storage_at` | { `QUERY`: { `contractAddress`: `string` ; `key`: [`BigNumberish`](num.md#bignumberish) ; `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`Storage`](Sequencer.md#storage) } | -| `get_storage_at.QUERY` | { `contractAddress`: `string` ; `key`: [`BigNumberish`](num.md#bignumberish) ; `blockIdentifier`: `BlockIdentifier` } | -| `get_storage_at.QUERY.contractAddress` | `string` | -| `get_storage_at.QUERY.key` | [`BigNumberish`](num.md#bignumberish) | -| `get_storage_at.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_storage_at.REQUEST` | `never` | -| `get_storage_at.RESPONSE` | [`Storage`](Sequencer.md#storage) | -| `get_code` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetCodeResponse`](Sequencer.md#getcoderesponse) } | -| `get_code.QUERY` | { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } | -| `get_code.QUERY.contractAddress` | `string` | -| `get_code.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_code.REQUEST` | `never` | -| `get_code.RESPONSE` | [`GetCodeResponse`](Sequencer.md#getcoderesponse) | -| `get_block` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetBlockResponse`](Sequencer.md#getblockresponse) } | -| `get_block.QUERY` | { `blockIdentifier`: `BlockIdentifier` } | -| `get_block.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_block.REQUEST` | `never` | -| `get_block.RESPONSE` | [`GetBlockResponse`](Sequencer.md#getblockresponse) | -| `call_contract` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: [`CallContractTransaction`](Sequencer.md#callcontracttransaction) ; `RESPONSE`: [`CallContractResponse`](Sequencer.md#callcontractresponse) } | -| `call_contract.QUERY` | { `blockIdentifier`: `BlockIdentifier` } | -| `call_contract.QUERY.blockIdentifier` | `BlockIdentifier` | -| `call_contract.REQUEST` | [`CallContractTransaction`](Sequencer.md#callcontracttransaction) | -| `call_contract.RESPONSE` | [`CallContractResponse`](Sequencer.md#callcontractresponse) | -| `estimate_fee` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } ; `REQUEST`: [`EstimateFeeRequest`](Sequencer.md#estimatefeerequest) ; `RESPONSE`: [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) } | -| `estimate_fee.QUERY` | { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } | -| `estimate_fee.QUERY.blockIdentifier` | `BlockIdentifier` | -| `estimate_fee.QUERY.skipValidate` | `boolean` | -| `estimate_fee.REQUEST` | [`EstimateFeeRequest`](Sequencer.md#estimatefeerequest) | -| `estimate_fee.RESPONSE` | [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) | -| `get_class_by_hash` | { `QUERY`: { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`CompiledContract`](../modules.md#compiledcontract) } | -| `get_class_by_hash.QUERY` | { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_class_by_hash.QUERY.classHash` | `string` | -| `get_class_by_hash.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_class_by_hash.REQUEST` | `never` | -| `get_class_by_hash.RESPONSE` | [`CompiledContract`](../modules.md#compiledcontract) | -| `get_class_hash_at` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: `string` } | -| `get_class_hash_at.QUERY` | { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_class_hash_at.QUERY.contractAddress` | `string` | -| `get_class_hash_at.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_class_hash_at.REQUEST` | `never` | -| `get_class_hash_at.RESPONSE` | `string` | -| `get_state_update` | { `QUERY`: { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } ; `REQUEST`: `never` ; `RESPONSE`: [`StateUpdateResponse`](Sequencer.md#stateupdateresponse) } | -| `get_state_update.QUERY` | { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } | -| `get_state_update.QUERY.blockHash?` | `string` | -| `get_state_update.QUERY.blockNumber?` | [`BlockNumber`](../modules.md#blocknumber) | -| `get_state_update.REQUEST` | `never` | -| `get_state_update.RESPONSE` | [`StateUpdateResponse`](Sequencer.md#stateupdateresponse) | -| `get_full_contract` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`CompiledContract`](../modules.md#compiledcontract) } | -| `get_full_contract.QUERY` | { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_full_contract.QUERY.contractAddress` | `string` | -| `get_full_contract.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_full_contract.REQUEST` | `never` | -| `get_full_contract.RESPONSE` | [`CompiledContract`](../modules.md#compiledcontract) | -| `estimate_message_fee` | { `QUERY`: `any` ; `REQUEST`: `any` ; `RESPONSE`: [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) } | -| `estimate_message_fee.QUERY` | `any` | -| `estimate_message_fee.REQUEST` | `any` | -| `estimate_message_fee.RESPONSE` | [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) | -| `simulate_transaction` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } ; `REQUEST`: [`SimulateTransaction`](Sequencer.md#simulatetransaction) ; `RESPONSE`: [`TransactionSimulationResponse`](Sequencer.md#transactionsimulationresponse) } | -| `simulate_transaction.QUERY` | { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } | -| `simulate_transaction.QUERY.blockIdentifier` | `BlockIdentifier` | -| `simulate_transaction.QUERY.skipValidate` | `boolean` | -| `simulate_transaction.REQUEST` | [`SimulateTransaction`](Sequencer.md#simulatetransaction) | -| `simulate_transaction.RESPONSE` | [`TransactionSimulationResponse`](Sequencer.md#transactionsimulationresponse) | -| `estimate_fee_bulk` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: [`EstimateFeeRequestBulk`](Sequencer.md#estimatefeerequestbulk) ; `RESPONSE`: [`EstimateFeeResponseBulk`](Sequencer.md#estimatefeeresponsebulk) } | -| `estimate_fee_bulk.QUERY` | { `blockIdentifier`: `BlockIdentifier` } | -| `estimate_fee_bulk.QUERY.blockIdentifier` | `BlockIdentifier` | -| `estimate_fee_bulk.REQUEST` | [`EstimateFeeRequestBulk`](Sequencer.md#estimatefeerequestbulk) | -| `estimate_fee_bulk.RESPONSE` | [`EstimateFeeResponseBulk`](Sequencer.md#estimatefeeresponsebulk) | -| `get_block_traces` | { `QUERY`: { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } ; `REQUEST`: `never` ; `RESPONSE`: [`BlockTransactionTracesResponse`](Sequencer.md#blocktransactiontracesresponse) } | -| `get_block_traces.QUERY` | { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } | -| `get_block_traces.QUERY.blockHash?` | `string` | -| `get_block_traces.QUERY.blockNumber?` | [`BlockNumber`](../modules.md#blocknumber) | -| `get_block_traces.REQUEST` | `never` | -| `get_block_traces.RESPONSE` | [`BlockTransactionTracesResponse`](Sequencer.md#blocktransactiontracesresponse) | -| `get_compiled_class_by_class_hash` | { `QUERY`: { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `any` ; `RESPONSE`: [`CairoAssembly`](../modules.md#cairoassembly) } | -| `get_compiled_class_by_class_hash.QUERY` | { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_compiled_class_by_class_hash.QUERY.classHash` | `string` | -| `get_compiled_class_by_class_hash.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_compiled_class_by_class_hash.REQUEST` | `any` | -| `get_compiled_class_by_class_hash.RESPONSE` | [`CairoAssembly`](../modules.md#cairoassembly) | - -#### Defined in - -[src/types/api/sequencer.ts:320](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L320) diff --git a/www/docs/API/namespaces/_category_.yml b/www/docs/API/namespaces/_category_.yml deleted file mode 100644 index fdb625823..000000000 --- a/www/docs/API/namespaces/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: 'Namespaces' -position: 1 diff --git a/www/docs/API/namespaces/cairo.md b/www/docs/API/namespaces/cairo.md deleted file mode 100644 index 989403976..000000000 --- a/www/docs/API/namespaces/cairo.md +++ /dev/null @@ -1,484 +0,0 @@ ---- -id: 'cairo' -title: 'Namespace: cairo' -sidebar_label: 'cairo' -sidebar_position: 0 -custom_edit_url: null ---- - -## Functions - -### isCairo1Abi - -▸ **isCairo1Abi**(`abi`): `boolean` - -Test if an ABI comes from a Cairo 1 contract - -**`Example`** - -```typescript -const isCairo1: boolean = isCairo1Abi(myAbi: Abi); -``` - -#### Parameters - -| Name | Type | Description | -| :---- | :-------------------- | :--------------------------------------------- | -| `abi` | [`Abi`](types.md#abi) | representing the interface of a Cairo contract | - -#### Returns - -`boolean` - -TRUE if it is an ABI from a Cairo1 contract - -#### Defined in - -[src/utils/calldata/cairo.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L53) - ---- - -### getAbiContractVersion - -▸ **getAbiContractVersion**(`abi`): [`ContractVersion`](types.md#contractversion) - -Return ContractVersion (Abi version) based on Abi -or undefined for unknown version - -#### Parameters - -| Name | Type | -| :---- | :-------------------- | -| `abi` | [`Abi`](types.md#abi) | - -#### Returns - -[`ContractVersion`](types.md#contractversion) - -string - -#### Defined in - -[src/utils/calldata/cairo.ts:67](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L67) - ---- - -### felt - -▸ **felt**(`it`): `string` - -Create felt Cairo type (cairo type helper) - -#### Parameters - -| Name | Type | -| :--- | :-------------------------------------- | -| `it` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`string` - -format: felt-string - -#### Defined in - -[src/utils/calldata/cairo.ts:127](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L127) - ---- - -### isLen - -▸ **isLen**(`name`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `name` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L16) - ---- - -### isTypeFelt - -▸ **isTypeFelt**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L17) - ---- - -### isTypeArray - -▸ **isTypeArray**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L18) - ---- - -### isTypeTuple - -▸ **isTypeTuple**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L22) - ---- - -### isTypeNamedTuple - -▸ **isTypeNamedTuple**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L23) - ---- - -### isTypeStruct - -▸ **isTypeStruct**(`type`, `structs`): `boolean` - -#### Parameters - -| Name | Type | -| :-------- | :---------------------------------- | -| `type` | `string` | -| `structs` | [`AbiStructs`](types.md#abistructs) | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L24) - ---- - -### isTypeEnum - -▸ **isTypeEnum**(`type`, `enums`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------------------------------ | -| `type` | `string` | -| `enums` | [`AbiEnums`](types.md#abienums) | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L25) - ---- - -### isTypeOption - -▸ **isTypeOption**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L26) - ---- - -### isTypeResult - -▸ **isTypeResult**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L27) - ---- - -### isTypeUint - -▸ **isTypeUint**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L28) - ---- - -### isTypeLitteral - -▸ **isTypeLitteral**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L29) - ---- - -### isTypeUint256 - -▸ **isTypeUint256**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L30) - ---- - -### isTypeBool - -▸ **isTypeBool**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L31) - ---- - -### isTypeContractAddress - -▸ **isTypeContractAddress**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L32) - ---- - -### isTypeEthAddress - -▸ **isTypeEthAddress**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L34) - ---- - -### isCairo1Type - -▸ **isCairo1Type**(`type`): `boolean` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/calldata/cairo.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L36) - ---- - -### getArrayType - -▸ **getArrayType**(`type`): `string` - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `type` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/calldata/cairo.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L37) - ---- - -### uint256 - -▸ **uint256**(`it`): [`Uint256`](../interfaces/types.Uint256.md) - -Create Uint256 Cairo type (helper for common struct type) - -**`Example`** - -```typescript -uint256('892349863487563453485768723498'); -``` - -#### Parameters - -| Name | Type | -| :--- | :-------------------------------------- | -| `it` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -[`Uint256`](../interfaces/types.Uint256.md) - -#### Defined in - -[src/utils/calldata/cairo.ts:101](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L101) - ---- - -### tuple - -▸ **tuple**(`...args`): `Record`<`number`, `boolean` \| `object` \| [`BigNumberish`](types.md#bignumberish)\> - -Create unnamed tuple Cairo type (helper same as common struct type) - -**`Example`** - -```typescript -tuple(1,'0x101',16); -``` - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------------------------------- | -| `...args` | (`boolean` \| `object` \| [`BigNumberish`](types.md#bignumberish))[] | - -#### Returns - -`Record`<`number`, `boolean` \| `object` \| [`BigNumberish`](types.md#bignumberish)\> - -#### Defined in - -[src/utils/calldata/cairo.ts:119](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L119) diff --git a/www/docs/API/namespaces/constants.md b/www/docs/API/namespaces/constants.md deleted file mode 100644 index e5fe0d816..000000000 --- a/www/docs/API/namespaces/constants.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -id: 'constants' -title: 'Namespace: constants' -sidebar_label: 'constants' -sidebar_position: 0 -custom_edit_url: null ---- - -Utils - -## Enumerations - -- [BaseUrl](../enums/constants.BaseUrl.md) -- [NetworkName](../enums/constants.NetworkName.md) -- [StarknetChainId](../enums/constants.StarknetChainId.md) -- [TransactionHashPrefix](../enums/constants.TransactionHashPrefix.md) - -## Variables - -### IS_BROWSER - -• `Const` **IS_BROWSER**: `boolean` - -#### Defined in - -[src/utils/encode.ts:2](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L2) - ---- - -### TEXT_TO_FELT_MAX_LEN - -• `Const` **TEXT_TO_FELT_MAX_LEN**: `31` - -Cairo Felt support storing max 31 character - -#### Defined in - -[src/constants.ts:6](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L6) - ---- - -### HEX_STR_TRANSACTION_VERSION_1 - -• `Const` **HEX_STR_TRANSACTION_VERSION_1**: `"0x1"` - -#### Defined in - -[src/constants.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L8) - ---- - -### HEX_STR_TRANSACTION_VERSION_2 - -• `Const` **HEX_STR_TRANSACTION_VERSION_2**: `"0x2"` - -#### Defined in - -[src/constants.ts:9](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L9) - ---- - -### BN_TRANSACTION_VERSION_1 - -• `Const` **BN_TRANSACTION_VERSION_1**: `1n` - -#### Defined in - -[src/constants.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L10) - ---- - -### BN_TRANSACTION_VERSION_2 - -• `Const` **BN_TRANSACTION_VERSION_2**: `2n` - -#### Defined in - -[src/constants.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L11) - ---- - -### BN_FEE_TRANSACTION_VERSION_1 - -• `Const` **BN_FEE_TRANSACTION_VERSION_1**: `bigint` - -#### Defined in - -[src/constants.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L12) - ---- - -### BN_FEE_TRANSACTION_VERSION_2 - -• `Const` **BN_FEE_TRANSACTION_VERSION_2**: `bigint` - -#### Defined in - -[src/constants.ts:13](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L13) - ---- - -### ZERO - -• `Const` **ZERO**: `0n` - -#### Defined in - -[src/constants.ts:15](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L15) - ---- - -### MASK_250 - -• `Const` **MASK_250**: `bigint` - -#### Defined in - -[src/constants.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L16) - ---- - -### MASK_251 - -• `Const` **MASK_251**: `bigint` - -#### Defined in - -[src/constants.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L17) - ---- - -### API_VERSION - -• `Const` **API_VERSION**: `0n` - -#### Defined in - -[src/constants.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L18) - ---- - -### UDC - -• `Const` **UDC**: `Object` - -#### Type declaration - -| Name | Type | -| :----------- | :------- | -| `ADDRESS` | `string` | -| `ENTRYPOINT` | `string` | - -#### Defined in - -[src/constants.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/constants.ts#L43) diff --git a/www/docs/API/namespaces/ec.md b/www/docs/API/namespaces/ec.md deleted file mode 100644 index c06a61efe..000000000 --- a/www/docs/API/namespaces/ec.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: 'ec' -title: 'Namespace: ec' -sidebar_label: 'ec' -sidebar_position: 0 -custom_edit_url: null ---- - -## Namespaces - -- [starkCurve](ec.starkCurve.md) -- [weierstrass](ec.weierstrass.md) diff --git a/www/docs/API/namespaces/ec.starkCurve.md b/www/docs/API/namespaces/ec.starkCurve.md deleted file mode 100644 index d890906f2..000000000 --- a/www/docs/API/namespaces/ec.starkCurve.md +++ /dev/null @@ -1,533 +0,0 @@ ---- -id: 'ec.starkCurve' -title: 'Namespace: starkCurve' -sidebar_label: 'starkCurve' -custom_edit_url: null ---- - -[ec](ec.md).starkCurve - -## Type Aliases - -### ProjectivePoint - -Ƭ **ProjectivePoint**: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\> - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:6 - -node_modules/@scure/starknet/lib/index.d.ts:45 - ---- - -### PoseidonOpts - -Ƭ **PoseidonOpts**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :------------------ | -| `Fp` | `IField`<`bigint`\> | -| `rate` | `number` | -| `capacity` | `number` | -| `roundsFull` | `number` | -| `roundsPartial` | `number` | - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:62 - ---- - -### PoseidonFn - -Ƭ **PoseidonFn**: `ReturnType` & { `m`: `number` ; `rate`: `number` ; `capacity`: `number` } - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:69 - -## Variables - -### MAX_VALUE - -• `Const` **MAX_VALUE**: `bigint` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:7 - ---- - -### \_starkCurve - -• `Const` **\_starkCurve**: [`weierstrass`](ec.weierstrass.md) - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:8 - ---- - -### CURVE - -• `Const` **CURVE**: `Readonly`<{ `nBitLength`: `number` ; `nByteLength`: `number` ; `Fp`: `IField`<`bigint`\> ; `n`: `bigint` ; `h`: `bigint` ; `hEff?`: `bigint` ; `Gx`: `bigint` ; `Gy`: `bigint` ; `allowInfinityPoint?`: `boolean` ; `a`: `bigint` ; `b`: `bigint` ; `allowedPrivateKeyLengths?`: readonly `number`[] ; `wrapPrivateKey?`: `boolean` ; `endo?`: { `beta`: `bigint` ; `splitScalar`: (`k`: `bigint`) => { `k1neg`: `boolean` ; `k1`: `bigint` ; `k2neg`: `boolean` ; `k2`: `bigint` } } ; `isTorsionFree?`: (`c`: [`weierstrass`](ec.weierstrass.md), `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\>) => `boolean` ; `clearCofactor?`: (`c`: [`weierstrass`](ec.weierstrass.md), `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\>) => [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\> ; `hash`: `u.CHash` ; `hmac`: (`key`: `Uint8Array`, ...`messages`: `Uint8Array`[]) => `Uint8Array` ; `randomBytes`: (`bytesLength?`: `number`) => `Uint8Array` ; `lowS`: `boolean` ; `bits2int?`: (`bytes`: `Uint8Array`) => `bigint` ; `bits2int_modN?`: (`bytes`: `Uint8Array`) => `bigint` ; `p`: `bigint` }\> - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:13 - ---- - -### ProjectivePoint - -• **ProjectivePoint**: [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`bigint`\> - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:6 - -node_modules/@scure/starknet/lib/index.d.ts:45 - ---- - -### Signature - -• `Const` **Signature**: [`weierstrass`](ec.weierstrass.md) - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:45 - ---- - -### utils - -• `Const` **utils**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `normPrivateKeyToScalar` | (`key`: `u.PrivKey`) => `bigint` | -| `randomPrivateKey` | () => `Uint8Array` | -| `precompute` | (`windowSize?`: `number`, `point?`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\>) => [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\> | -| `isValidPrivateKey` | (`privateKey`: `PrivKey`) => `boolean` | - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:45 - ---- - -### Fp251 - -• `Const` **Fp251**: `Readonly`<`IField`<`bigint`\> & `Required`<`Pick`<`IField`<`bigint`\>, `"isOdd"`\>\>\> - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:60 - -## Functions - -### getPublicKey - -▸ **getPublicKey**(`privKey`, `isCompressed?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :-------------- | :-------- | -| `privKey` | `Hex` | -| `isCompressed?` | `boolean` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:9 - ---- - -### getSharedSecret - -▸ **getSharedSecret**(`privKeyA`, `pubKeyB`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :--------- | :---- | -| `privKeyA` | `Hex` | -| `pubKeyB` | `Hex` | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:10 - ---- - -### sign - -▸ **sign**(`msgHash`, `privKey`, `opts?`): [`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) - -#### Parameters - -| Name | Type | -| :-------- | :---- | -| `msgHash` | `Hex` | -| `privKey` | `Hex` | -| `opts?` | `any` | - -#### Returns - -[`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:11 - ---- - -### verify - -▸ **verify**(`signature`, `msgHash`, `pubKey`): `boolean` - -#### Parameters - -| Name | Type | -| :---------- | :------------------------------------------------------------------------ | -| `signature` | `Hex` \| [`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) | -| `msgHash` | `Hex` | -| `pubKey` | `Hex` | - -#### Returns - -`boolean` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:12 - ---- - -### grindKey - -▸ **grindKey**(`seed`): `string` - -#### Parameters - -| Name | Type | -| :----- | :---- | -| `seed` | `Hex` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:52 - ---- - -### getStarkKey - -▸ **getStarkKey**(`privateKey`): `string` - -#### Parameters - -| Name | Type | -| :----------- | :---- | -| `privateKey` | `Hex` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:53 - ---- - -### ethSigToPrivate - -▸ **ethSigToPrivate**(`signature`): `string` - -#### Parameters - -| Name | Type | -| :---------- | :------- | -| `signature` | `string` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:54 - ---- - -### getAccountPath - -▸ **getAccountPath**(`layer`, `application`, `ethereumAddress`, `index`): `string` - -#### Parameters - -| Name | Type | -| :---------------- | :------- | -| `layer` | `string` | -| `application` | `string` | -| `ethereumAddress` | `string` | -| `index` | `number` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:55 - ---- - -### pedersen - -▸ **pedersen**(`x`, `y`): `string` - -#### Parameters - -| Name | Type | -| :--- | :------------ | -| `x` | `PedersenArg` | -| `y` | `PedersenArg` | - -#### Returns - -`string` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:57 - ---- - -### \_poseidonMDS - -▸ **\_poseidonMDS**(`Fp`, `name`, `m`, `attempt?`): `bigint`[][] - -#### Parameters - -| Name | Type | -| :--------- | :------------------ | -| `Fp` | `IField`<`bigint`\> | -| `name` | `string` | -| `m` | `number` | -| `attempt?` | `number` | - -#### Returns - -`bigint`[][] - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:61 - ---- - -### poseidonBasic - -▸ **poseidonBasic**(`opts`, `mds`): [`PoseidonFn`](ec.starkCurve.md#poseidonfn) - -#### Parameters - -| Name | Type | -| :----- | :---------------------------------------------- | -| `opts` | [`PoseidonOpts`](ec.starkCurve.md#poseidonopts) | -| `mds` | `bigint`[][] | - -#### Returns - -[`PoseidonFn`](ec.starkCurve.md#poseidonfn) - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:74 - ---- - -### poseidonCreate - -▸ **poseidonCreate**(`opts`, `mdsAttempt?`): [`PoseidonFn`](ec.starkCurve.md#poseidonfn) - -#### Parameters - -| Name | Type | -| :------------ | :---------------------------------------------- | -| `opts` | [`PoseidonOpts`](ec.starkCurve.md#poseidonopts) | -| `mdsAttempt?` | `number` | - -#### Returns - -[`PoseidonFn`](ec.starkCurve.md#poseidonfn) - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:75 - ---- - -### poseidonHash - -▸ **poseidonHash**(`x`, `y`, `fn?`): `bigint` - -#### Parameters - -| Name | Type | -| :---- | :------------------------------------------ | -| `x` | `bigint` | -| `y` | `bigint` | -| `fn?` | [`PoseidonFn`](ec.starkCurve.md#poseidonfn) | - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:77 - ---- - -### poseidonHashFunc - -▸ **poseidonHashFunc**(`x`, `y`, `fn?`): `Uint8Array` - -#### Parameters - -| Name | Type | -| :---- | :------------------------------------------ | -| `x` | `Uint8Array` | -| `y` | `Uint8Array` | -| `fn?` | [`PoseidonFn`](ec.starkCurve.md#poseidonfn) | - -#### Returns - -`Uint8Array` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:78 - ---- - -### poseidonHashSingle - -▸ **poseidonHashSingle**(`x`, `fn?`): `bigint` - -#### Parameters - -| Name | Type | -| :---- | :------------------------------------------ | -| `x` | `bigint` | -| `fn?` | [`PoseidonFn`](ec.starkCurve.md#poseidonfn) | - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:79 - ---- - -### poseidonHashMany - -▸ **poseidonHashMany**(`values`, `fn?`): `bigint` - -#### Parameters - -| Name | Type | -| :------- | :------------------------------------------ | -| `values` | `bigint`[] | -| `fn?` | [`PoseidonFn`](ec.starkCurve.md#poseidonfn) | - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:80 - ---- - -### computeHashOnElements - -▸ **computeHashOnElements**(`data`, `fn?`): `PedersenArg` - -#### Parameters - -| Name | Type | -| :----- | :--------------------------------------------------- | -| `data` | `PedersenArg`[] | -| `fn?` | (`x`: `PedersenArg`, `y`: `PedersenArg`) => `string` | - -#### Returns - -`PedersenArg` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:58 - ---- - -### keccak - -▸ **keccak**(`data`): `bigint` - -#### Parameters - -| Name | Type | -| :----- | :----------- | -| `data` | `Uint8Array` | - -#### Returns - -`bigint` - -#### Defined in - -node_modules/@scure/starknet/lib/index.d.ts:59 - ---- - -### poseidonSmall - -▸ **poseidonSmall**(`values`): `bigint`[] - -#### Parameters - -| Name | Type | -| :------- | :--------- | -| `values` | `bigint`[] | - -#### Returns - -`bigint`[] - -#### Defined in - -node_modules/@noble/curves/abstract/poseidon.d.ts:27 diff --git a/www/docs/API/namespaces/ec.weierstrass.md b/www/docs/API/namespaces/ec.weierstrass.md deleted file mode 100644 index 010cd04ef..000000000 --- a/www/docs/API/namespaces/ec.weierstrass.md +++ /dev/null @@ -1,384 +0,0 @@ ---- -id: 'ec.weierstrass' -title: 'Namespace: weierstrass' -sidebar_label: 'weierstrass' -custom_edit_url: null ---- - -[ec](ec.md).weierstrass - -## Interfaces - -- [ProjPointType](../interfaces/ec.weierstrass.ProjPointType.md) -- [ProjConstructor](../interfaces/ec.weierstrass.ProjConstructor.md) -- [SignatureType](../interfaces/ec.weierstrass.SignatureType.md) - -## Type Aliases - -### AffinePoint - -Ƭ **AffinePoint**<`T`\>: { `x`: `T` ; `y`: `T` } & { `z?`: `never` ; `t?`: `never` } - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Defined in - -node_modules/@noble/curves/abstract/curve.d.ts:3 - ---- - -### BasicWCurve - -Ƭ **BasicWCurve**<`T`\>: `BasicCurve`<`T`\> & { `a`: `T` ; `b`: `T` ; `allowedPrivateKeyLengths?`: readonly `number`[] ; `wrapPrivateKey?`: `boolean` ; `endo?`: `EndomorphismOpts` ; `isTorsionFree?`: (`c`: [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`T`\>, `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`T`\>) => `boolean` ; `clearCofactor?`: (`c`: [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`T`\>, `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`T`\>) => [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`T`\> } - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:17 - ---- - -### SignOpts - -Ƭ **SignOpts**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :-------- | -| `lowS?` | `boolean` | -| `extraEntropy?` | `Entropy` | -| `prehash?` | `boolean` | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:27 - ---- - -### VerOpts - -Ƭ **VerOpts**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :-------- | -| `lowS?` | `boolean` | -| `prehash?` | `boolean` | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:32 - ---- - -### CurvePointsType - -Ƭ **CurvePointsType**<`T`\>: [`BasicWCurve`](ec.weierstrass.md#basicwcurve)<`T`\> & { `fromBytes?`: (`bytes`: `Uint8Array`) => [`AffinePoint`](ec.weierstrass.md#affinepoint)<`T`\> ; `toBytes?`: (`c`: [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`T`\>, `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`T`\>, `isCompressed`: `boolean`) => `Uint8Array` } - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:82 - ---- - -### CurvePointsRes - -Ƭ **CurvePointsRes**<`T`\>: `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Type declaration - -| Name | Type | -| :----------------------- | :------------------------------------------------------------------------- | -| `ProjectivePoint` | [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`T`\> | -| `normPrivateKeyToScalar` | (`key`: `PrivKey`) => `bigint` | -| `weierstrassEquation` | (`x`: `T`) => `T` | -| `isWithinCurveOrder` | (`num`: `bigint`) => `boolean` | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:86 - ---- - -### RecoveredSignatureType - -Ƭ **RecoveredSignatureType**: [`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) & { `recovery`: `number` } - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:154 - ---- - -### SignatureConstructor - -Ƭ **SignatureConstructor**: `Object` - -#### Call signature - -• **new SignatureConstructor**(`r`, `s`): [`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) - -##### Parameters - -| Name | Type | -| :--- | :------- | -| `r` | `bigint` | -| `s` | `bigint` | - -##### Returns - -[`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) - -#### Type declaration - -| Name | Type | -| :------------ | :--------------------------------------------------------------------------------- | -| `fromCompact` | (`hex`: `Hex`) => [`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) | -| `fromDER` | (`hex`: `Hex`) => [`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:157 - ---- - -### PubKey - -Ƭ **PubKey**: `Hex` \| [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\> - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:166 - ---- - -### CurveType - -Ƭ **CurveType**: [`BasicWCurve`](ec.weierstrass.md#basicwcurve)<`bigint`\> & { `hash`: `CHash` ; `hmac`: `HmacFnSync` ; `randomBytes`: (`bytesLength?`: `number`) => `Uint8Array` ; `lowS?`: `boolean` ; `bits2int?`: (`bytes`: `Uint8Array`) => `bigint` ; `bits2int_modN?`: (`bytes`: `Uint8Array`) => `bigint` } - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:167 - ---- - -### CurveFn - -Ƭ **CurveFn**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CURVE` | `ReturnType` | -| `getPublicKey` | (`privateKey`: `PrivKey`, `isCompressed?`: `boolean`) => `Uint8Array` | -| `getSharedSecret` | (`privateA`: `PrivKey`, `publicB`: `Hex`, `isCompressed?`: `boolean`) => `Uint8Array` | -| `sign` | (`msgHash`: `Hex`, `privKey`: `PrivKey`, `opts?`: [`SignOpts`](ec.weierstrass.md#signopts)) => [`RecoveredSignatureType`](ec.weierstrass.md#recoveredsignaturetype) | -| `verify` | (`signature`: `Hex` \| `SignatureLike`, `msgHash`: `Hex`, `publicKey`: `Hex`, `opts?`: [`VerOpts`](ec.weierstrass.md#veropts)) => `boolean` | -| `ProjectivePoint` | [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`bigint`\> | -| `Signature` | [`SignatureConstructor`](ec.weierstrass.md#signatureconstructor) | -| `utils` | { `normPrivateKeyToScalar`: (`key`: `PrivKey`) => `bigint` ; `randomPrivateKey`: () => `Uint8Array` ; `precompute`: (`windowSize?`: `number`, `point?`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\>) => [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\> ; `isValidPrivateKey`: (`privateKey`: `PrivKey`) => `boolean` } | -| `utils.normPrivateKeyToScalar` | (`key`: `PrivKey`) => `bigint` | -| `utils.randomPrivateKey` | () => `Uint8Array` | -| `utils.precompute` | (`windowSize?`: `number`, `point?`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\>) => [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`bigint`\> | -| `utils.isValidPrivateKey` | [object Object] | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:200 - -## Variables - -### DER - -• `Const` **DER**: `Object` - -#### Type declaration - -| Name | Type | -| :----------- | :---------------------------------------------------------------------------------- | -| `Err` | (`m?`: `string`) => { `name`: `string` ; `message`: `string` ; `stack?`: `string` } | -| `_parseInt` | (`data`: `Uint8Array`) => { `d`: `bigint` ; `l`: `Uint8Array` } | -| `toSig` | (`hex`: `string` \| `Uint8Array`) => { `r`: `bigint` ; `s`: `bigint` } | -| `hexFromSig` | (`sig`: { `r`: `bigint` ; `s`: `bigint` }) => `string` | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:92 - -## Functions - -### weierstrassPoints - -▸ **weierstrassPoints**<`T`\>(`opts`): `Object` - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Parameters - -| Name | Type | -| :----- | :----------------------------------------------------------- | -| `opts` | [`CurvePointsType`](ec.weierstrass.md#curvepointstype)<`T`\> | - -#### Returns - -`Object` - -| Name | Type | -| :----------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CURVE` | `Readonly`<{ `nBitLength`: `number` ; `nByteLength`: `number` ; `Fp`: `mod.IField`<`T`\> ; `n`: `bigint` ; `h`: `bigint` ; `hEff?`: `bigint` ; `Gx`: `T` ; `Gy`: `T` ; `allowInfinityPoint?`: `boolean` ; `a`: `T` ; `b`: `T` ; `allowedPrivateKeyLengths?`: readonly `number`[] ; `wrapPrivateKey?`: `boolean` ; `endo?`: `EndomorphismOpts` ; `isTorsionFree?`: (`c`: [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`T`\>, `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`T`\>) => `boolean` ; `clearCofactor?`: (`c`: [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`T`\>, `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`T`\>) => [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`T`\> ; `fromBytes?`: (`bytes`: `Uint8Array`) => [`AffinePoint`](ec.weierstrass.md#affinepoint)<`T`\> ; `toBytes?`: (`c`: [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`T`\>, `point`: [`ProjPointType`](../interfaces/ec.weierstrass.ProjPointType.md)<`T`\>, `isCompressed`: `boolean`) => `Uint8Array` ; `p`: `bigint` }\> | -| `ProjectivePoint` | [`ProjConstructor`](../interfaces/ec.weierstrass.ProjConstructor.md)<`T`\> | -| `normPrivateKeyToScalar` | (`key`: `PrivKey`) => `bigint` | -| `weierstrassEquation` | (`x`: `T`) => `T` | -| `isWithinCurveOrder` | (`num`: `bigint`) => `boolean` | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:113 - ---- - -### weierstrass - -▸ **weierstrass**(`curveDef`): [`CurveFn`](ec.weierstrass.md#curvefn) - -#### Parameters - -| Name | Type | -| :--------- | :----------------------------------------- | -| `curveDef` | [`CurveType`](ec.weierstrass.md#curvetype) | - -#### Returns - -[`CurveFn`](ec.weierstrass.md#curvefn) - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:215 - ---- - -### SWUFpSqrtRatio - -▸ **SWUFpSqrtRatio**<`T`\>(`Fp`, `Z`): (`u`: `T`, `v`: `T`) => { `isValid`: `boolean` ; `value`: `T` } - -Implementation of the Shallue and van de Woestijne method for any weierstrass curve. -TODO: check if there is a way to merge this with uvRatio in Edwards; move to modular. -b = True and y = sqrt(u / v) if (u / v) is square in F, and -b = False and y = sqrt(Z \* (u / v)) otherwise. - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Parameters - -| Name | Type | -| :--- | :------------- | -| `Fp` | `IField`<`T`\> | -| `Z` | `T` | - -#### Returns - -`fn` - -▸ (`u`, `v`): `Object` - -##### Parameters - -| Name | Type | -| :--- | :--- | -| `u` | `T` | -| `v` | `T` | - -##### Returns - -`Object` - -| Name | Type | -| :-------- | :-------- | -| `isValid` | `boolean` | -| `value` | `T` | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:225 - ---- - -### mapToCurveSimpleSWU - -▸ **mapToCurveSimpleSWU**<`T`\>(`Fp`, `opts`): (`u`: `T`) => { `x`: `T` ; `y`: `T` } - -Simplified Shallue-van de Woestijne-Ulas Method -https://www.rfc-editor.org/rfc/rfc9380#section-6.6.2 - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Parameters - -| Name | Type | -| :------- | :------------- | -| `Fp` | `IField`<`T`\> | -| `opts` | `Object` | -| `opts.A` | `T` | -| `opts.B` | `T` | -| `opts.Z` | `T` | - -#### Returns - -`fn` - -▸ (`u`): `Object` - -##### Parameters - -| Name | Type | -| :--- | :--- | -| `u` | `T` | - -##### Returns - -`Object` - -| Name | Type | -| :--- | :--- | -| `x` | `T` | -| `y` | `T` | - -#### Defined in - -node_modules/@noble/curves/abstract/weierstrass.d.ts:233 diff --git a/www/docs/API/namespaces/encode.md b/www/docs/API/namespaces/encode.md deleted file mode 100644 index 018ab6e14..000000000 --- a/www/docs/API/namespaces/encode.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -id: 'encode' -title: 'Namespace: encode' -sidebar_label: 'encode' -sidebar_position: 0 -custom_edit_url: null ---- - -## References - -### IS_BROWSER - -Re-exports [IS_BROWSER](constants.md#is_browser) - -## Functions - -### arrayBufferToString - -▸ **arrayBufferToString**(`array`): `string` - -Convert array buffer to string - -_[internal usage]_ - -#### Parameters - -| Name | Type | -| :------ | :------------ | -| `array` | `ArrayBuffer` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/encode.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L16) - ---- - -### stringToArrayBuffer - -▸ **stringToArrayBuffer**(`s`): `Uint8Array` - -Convert string to array buffer - -_[internal usage]_ - -#### Parameters - -| Name | Type | -| :--- | :------- | -| `s` | `string` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[src/utils/encode.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L25) - ---- - -### atobUniversal - -▸ **atobUniversal**(`a`): `Uint8Array` - -Convert string to array buffer (browser and node compatible) - -#### Parameters - -| Name | Type | -| :--- | :------- | -| `a` | `string` | - -#### Returns - -`Uint8Array` - -#### Defined in - -[src/utils/encode.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L32) - ---- - -### btoaUniversal - -▸ **btoaUniversal**(`b`): `string` - -Convert array buffer to string (browser and node compatible) - -#### Parameters - -| Name | Type | -| :--- | :------------ | -| `b` | `ArrayBuffer` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/encode.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L39) - ---- - -### buf2hex - -▸ **buf2hex**(`buffer`): `string` - -Convert array buffer to hex-string - -#### Parameters - -| Name | Type | -| :------- | :----------- | -| `buffer` | `Uint8Array` | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/encode.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L47) - ---- - -### removeHexPrefix - -▸ **removeHexPrefix**(`hex`): `string` - -Remove hex prefix '0x' from hex-string - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------- | -| `hex` | `string` | hex-string | - -#### Returns - -`string` - -format: base16-string - -#### Defined in - -[src/utils/encode.ts:56](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L56) - ---- - -### addHexPrefix - -▸ **addHexPrefix**(`hex`): `string` - -Add hex prefix '0x' to base16-string - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :------------ | -| `hex` | `string` | base16-string | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/encode.ts:65](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L65) - ---- - -### padLeft - -▸ **padLeft**(`str`, `length`, `padding?`): `string` - -Prepend string (default with '0') - -#### Parameters - -| Name | Type | Default value | -| :-------- | :------- | :------------ | -| `str` | `string` | `undefined` | -| `length` | `number` | `undefined` | -| `padding` | `string` | `STRING_ZERO` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/encode.ts:87](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L87) - ---- - -### calcByteLength - -▸ **calcByteLength**(`str`, `byteSize?`): `number` - -Calculate byte length of string - -_[no internal usage]_ - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------- | :------------ | -| `str` | `string` | `undefined` | -| `byteSize` | `number` | `8` | - -#### Returns - -`number` - -#### Defined in - -[src/utils/encode.ts:96](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L96) - ---- - -### sanitizeBytes - -▸ **sanitizeBytes**(`str`, `byteSize?`, `padding?`): `string` - -Prepend '0' to string bytes - -_[no internal usage]_ - -#### Parameters - -| Name | Type | Default value | -| :--------- | :------- | :------------ | -| `str` | `string` | `undefined` | -| `byteSize` | `number` | `8` | -| `padding` | `string` | `STRING_ZERO` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/encode.ts:107](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L107) - ---- - -### sanitizeHex - -▸ **sanitizeHex**(`hex`): `string` - -Prepend '0' to hex-string bytes - -_[no internal usage]_ - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------- | -| `hex` | `string` | hex-string | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/encode.ts:118](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L118) - ---- - -### utf8ToArray - -▸ **utf8ToArray**(`str`): `Uint8Array` - -Convert utf8-string to Uint8Array - -Implemented using TextEncoder to make it isomorphic - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------- | -| `str` | `string` | utf8-string | - -#### Returns - -`Uint8Array` - -#### Defined in - -[src/utils/encode.ts:133](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L133) - ---- - -### pascalToSnake - -▸ **pascalToSnake**(`text`): `string` - -String transformation util - -Pascal case to screaming snake case - -#### Parameters - -| Name | Type | -| :----- | :------- | -| `text` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/encode.ts:142](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/encode.ts#L142) diff --git a/www/docs/API/namespaces/events.md b/www/docs/API/namespaces/events.md deleted file mode 100644 index f3b030494..000000000 --- a/www/docs/API/namespaces/events.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: 'events' -title: 'Namespace: events' -sidebar_label: 'events' -sidebar_position: 0 -custom_edit_url: null ---- - -## Functions - -### getAbiEvents - -▸ **getAbiEvents**(`abi`): [`AbiEvents`](types.md#abievents) - -#### Parameters - -| Name | Type | -| :---- | :-------------------- | -| `abi` | [`Abi`](types.md#abi) | - -#### Returns - -[`AbiEvents`](types.md#abievents) - -#### Defined in - -[src/utils/events/index.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/events/index.ts#L17) - ---- - -### parseEvents - -▸ **parseEvents**(`providerReceivedEvents`, `abiEvents`, `abiStructs`, `abiEnums`): [`ParsedEvents`](types.md#parsedevents) - -Parse raw events and structure them into response object based on a contract structs and defined events - -#### Parameters - -| Name | Type | Description | -| :----------------------- | :---------------------------------------- | :-------------------------------------- | -| `providerReceivedEvents` | [`Event`](../interfaces/types.Event.md)[] | ProviderEvent[] - Array of raw events | -| `abiEvents` | [`AbiEvents`](types.md#abievents) | AbiEvents - Events defined in the abi | -| `abiStructs` | [`AbiStructs`](types.md#abistructs) | AbiStructs - Structs defined in the abi | -| `abiEnums` | [`AbiEnums`](types.md#abienums) | - | - -#### Returns - -[`ParsedEvents`](types.md#parsedevents) - -ParsedEvents - parsed events corresponding to the abi - -#### Defined in - -[src/utils/events/index.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/events/index.ts#L38) diff --git a/www/docs/API/namespaces/hash.md b/www/docs/API/namespaces/hash.md deleted file mode 100644 index 8aba5e95f..000000000 --- a/www/docs/API/namespaces/hash.md +++ /dev/null @@ -1,532 +0,0 @@ ---- -id: 'hash' -title: 'Namespace: hash' -sidebar_label: 'hash' -sidebar_position: 0 -custom_edit_url: null ---- - -## Namespaces - -- [poseidon](hash.poseidon.md) - -## Variables - -### transactionVersion - -• `Const` **transactionVersion**: `1n` - -#### Defined in - -[src/utils/hash.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L38) - ---- - -### transactionVersion_2 - -• `Const` **transactionVersion_2**: `2n` - -#### Defined in - -[src/utils/hash.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L39) - ---- - -### feeTransactionVersion - -• `Const` **feeTransactionVersion**: `bigint` = `BN_FEE_TRANSACTION_VERSION_1` - -#### Defined in - -[src/utils/hash.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L40) - ---- - -### feeTransactionVersion_2 - -• `Const` **feeTransactionVersion_2**: `bigint` = `BN_FEE_TRANSACTION_VERSION_2` - -#### Defined in - -[src/utils/hash.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L41) - -## Functions - -### getVersionsByType - -▸ **getVersionsByType**(`versionType?`): `Object` - -Return transaction versions based on version type, default version type is 'transaction' - -#### Parameters - -| Name | Type | -| :------------- | :------------------------- | -| `versionType?` | `"fee"` \| `"transaction"` | - -#### Returns - -`Object` - -| Name | Type | -| :--- | :------- | -| `v1` | `bigint` | -| `v2` | `bigint` | - -#### Defined in - -[src/utils/hash.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L46) - ---- - -### computeHashOnElements - -▸ **computeHashOnElements**(`data`): `string` - -Compute pedersen hash from data - -#### Parameters - -| Name | Type | -| :----- | :---------------------------------------- | -| `data` | [`BigNumberish`](types.md#bignumberish)[] | - -#### Returns - -`string` - -format: hex-string - pedersen hash - -#### Defined in - -[src/utils/hash.ts:56](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L56) - ---- - -### calculateTransactionHashCommon - -▸ **calculateTransactionHashCommon**(`txHashPrefix`, `version`, `contractAddress`, `entryPointSelector`, `calldata`, `maxFee`, `chainId`, `additionalData?`): `string` - -Calculate transaction pedersen hash for common properties - -Following implementation is based on this python [implementation #](https://github.com/starkware-libs/cairo-lang/blob/b614d1867c64f3fb2cf4a4879348cfcf87c3a5a7/src/starkware/starknet/core/os/transaction_hash/transaction_hash.py) - -#### Parameters - -| Name | Type | Default value | -| :------------------- | :--------------------------------------------------------------------- | :------------ | -| `txHashPrefix` | [`TransactionHashPrefix`](../enums/constants.TransactionHashPrefix.md) | `undefined` | -| `version` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `contractAddress` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `entryPointSelector` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `calldata` | [`RawCalldata`](types.md#rawcalldata) | `undefined` | -| `maxFee` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `chainId` | [`StarknetChainId`](../enums/constants.StarknetChainId.md) | `undefined` | -| `additionalData` | [`BigNumberish`](types.md#bignumberish)[] | `[]` | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:68](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L68) - ---- - -### calculateDeployTransactionHash - -▸ **calculateDeployTransactionHash**(`contractAddress`, `constructorCalldata`, `version`, `chainId`, `constructorName?`): `string` - -Calculate deploy transaction hash - -#### Parameters - -| Name | Type | Default value | -| :-------------------- | :--------------------------------------------------------- | :-------------- | -| `contractAddress` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `constructorCalldata` | [`RawCalldata`](types.md#rawcalldata) | `undefined` | -| `version` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `chainId` | [`StarknetChainId`](../enums/constants.StarknetChainId.md) | `undefined` | -| `constructorName` | `string` | `'constructor'` | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:96](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L96) - ---- - -### calculateDeclareTransactionHash - -▸ **calculateDeclareTransactionHash**(`classHash`, `senderAddress`, `version`, `maxFee`, `chainId`, `nonce`, `compiledClassHash?`): `string` - -Calculate declare transaction hash - -#### Parameters - -| Name | Type | Description | -| :------------------- | :--------------------------------------------------------- | :---------- | -| `classHash` | `string` | hex-string | -| `senderAddress` | [`BigNumberish`](types.md#bignumberish) | - | -| `version` | [`BigNumberish`](types.md#bignumberish) | - | -| `maxFee` | [`BigNumberish`](types.md#bignumberish) | - | -| `chainId` | [`StarknetChainId`](../enums/constants.StarknetChainId.md) | - | -| `nonce` | [`BigNumberish`](types.md#bignumberish) | - | -| `compiledClassHash?` | `string` | hex-string | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L120) - ---- - -### calculateDeployAccountTransactionHash - -▸ **calculateDeployAccountTransactionHash**(`contractAddress`, `classHash`, `constructorCalldata`, `salt`, `version`, `maxFee`, `chainId`, `nonce`): `string` - -Calculate deploy_account transaction hash - -#### Parameters - -| Name | Type | -| :-------------------- | :--------------------------------------------------------- | -| `contractAddress` | [`BigNumberish`](types.md#bignumberish) | -| `classHash` | [`BigNumberish`](types.md#bignumberish) | -| `constructorCalldata` | [`RawCalldata`](types.md#rawcalldata) | -| `salt` | [`BigNumberish`](types.md#bignumberish) | -| `version` | [`BigNumberish`](types.md#bignumberish) | -| `maxFee` | [`BigNumberish`](types.md#bignumberish) | -| `chainId` | [`StarknetChainId`](../enums/constants.StarknetChainId.md) | -| `nonce` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:145](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L145) - ---- - -### calculateTransactionHash - -▸ **calculateTransactionHash**(`contractAddress`, `version`, `calldata`, `maxFee`, `chainId`, `nonce`): `string` - -Calculate invoke transaction hash - -#### Parameters - -| Name | Type | -| :---------------- | :--------------------------------------------------------- | -| `contractAddress` | [`BigNumberish`](types.md#bignumberish) | -| `version` | [`BigNumberish`](types.md#bignumberish) | -| `calldata` | [`RawCalldata`](types.md#rawcalldata) | -| `maxFee` | [`BigNumberish`](types.md#bignumberish) | -| `chainId` | [`StarknetChainId`](../enums/constants.StarknetChainId.md) | -| `nonce` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:173](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L173) - ---- - -### calculateContractAddressFromHash - -▸ **calculateContractAddressFromHash**(`salt`, `classHash`, `constructorCalldata`, `deployerAddress`): `string` - -Calculate contract address from class hash - -#### Parameters - -| Name | Type | -| :-------------------- | :-------------------------------------- | -| `salt` | [`BigNumberish`](types.md#bignumberish) | -| `classHash` | [`BigNumberish`](types.md#bignumberish) | -| `constructorCalldata` | [`RawArgs`](types.md#rawargs) | -| `deployerAddress` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:197](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L197) - ---- - -### formatSpaces - -▸ **formatSpaces**(`json`): `string` - -Format json-string to conform starknet json-string - -#### Parameters - -| Name | Type | Description | -| :----- | :------- | :---------- | -| `json` | `string` | json-string | - -#### Returns - -`string` - -format: json-string - -#### Defined in - -[src/utils/hash.ts:234](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L234) - ---- - -### default - -▸ **default**(`compiledContract`): `string` - -Compute hinted class hash for legacy compiled contract (Cairo 0) - -#### Parameters - -| Name | Type | -| :----------------- | :---------------------------------------------------------- | -| `compiledContract` | [`LegacyCompiledContract`](types.md#legacycompiledcontract) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:256](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L256) - ---- - -### computeLegacyContractClassHash - -▸ **computeLegacyContractClassHash**(`contract`): `string` - -Computes the class hash for legacy compiled contract (Cairo 0) - -#### Parameters - -| Name | Type | -| :--------- | :---------------------------------------------------------------------- | -| `contract` | `string` \| [`LegacyCompiledContract`](types.md#legacycompiledcontract) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:268](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L268) - ---- - -### computeCompiledClassHash - -▸ **computeCompiledClassHash**(`casm`): `string` - -Compute compiled class hash for contract (Cairo 1) - -#### Parameters - -| Name | Type | -| :----- | :---------------------------------------- | -| `casm` | [`CairoAssembly`](types.md#cairoassembly) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:326](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L326) - ---- - -### computeSierraContractClassHash - -▸ **computeSierraContractClassHash**(`sierra`): `string` - -Compute sierra contract class hash (Cairo 1) - -#### Parameters - -| Name | Type | -| :------- | :------------------------------------------ | -| `sierra` | [`CompiledSierra`](types.md#compiledsierra) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:371](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L371) - ---- - -### computeContractClassHash - -▸ **computeContractClassHash**(`contract`): `string` - -Compute ClassHash (sierra or legacy) based on provided contract - -#### Parameters - -| Name | Type | -| :--------- | :---------------------------------------------------------- | -| `contract` | `string` \| [`CompiledContract`](types.md#compiledcontract) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/hash.ts:408](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/hash.ts#L408) - ---- - -### keccakBn - -▸ **keccakBn**(`value`): `string` - -Calculate hex-string keccak hash for a given BigNumberish - -BigNumberish -> hex-string keccak hash - -#### Parameters - -| Name | Type | -| :------ | :-------------------------------------- | -| `value` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/selector.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/selector.ts#L14) - ---- - -### starknetKeccak - -▸ **starknetKeccak**(`str`): `bigint` - -Calculate bigint keccak hash for a given string - -String -> bigint keccak hash - -[Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L17-L22) - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :--------------------------------------------- | -| `str` | `string` | the value you want to get the keccak hash from | - -#### Returns - -`bigint` - -starknet keccak hash as BigInt - -#### Defined in - -[src/utils/selector.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/selector.ts#L39) - ---- - -### getSelectorFromName - -▸ **getSelectorFromName**(`funcName`): `string` - -Calculate hex-string selector for a given abi-function-name - -Abi-function-name -> hex-string selector - -[Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/public/abi.py#L25-L26) - -#### Parameters - -| Name | Type | Description | -| :--------- | :------- | :---------------------------------- | -| `funcName` | `string` | ascii-string of 'abi function name' | - -#### Returns - -`string` - -format: hex-string; selector for 'abi function name' - -#### Defined in - -[src/utils/selector.ts:54](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/selector.ts#L54) - ---- - -### getSelector - -▸ **getSelector**(`value`): `string` - -Calculate hex-string selector from abi-function-name, decimal string or hex string - -('abi-function-name' or dec-string or hex-string) -> hex-string selector - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :--------------------------------------- | -| `value` | `string` | hex-string \| dec-string \| ascii-string | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/selector.ts:67](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/selector.ts#L67) diff --git a/www/docs/API/namespaces/hash.poseidon.md b/www/docs/API/namespaces/hash.poseidon.md deleted file mode 100644 index 5232317a1..000000000 --- a/www/docs/API/namespaces/hash.poseidon.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: 'hash.poseidon' -title: 'Namespace: poseidon' -sidebar_label: 'poseidon' -custom_edit_url: null ---- - -[hash](hash.md).poseidon - -## Type Aliases - -### PoseidonOpts - -Ƭ **PoseidonOpts**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :------------------ | -| `Fp` | `IField`<`bigint`\> | -| `t` | `number` | -| `roundsFull` | `number` | -| `roundsPartial` | `number` | -| `sboxPower?` | `number` | -| `reversePartialPowIdx?` | `boolean` | -| `mds` | `bigint`[][] | -| `roundConstants` | `bigint`[][] | - -#### Defined in - -node_modules/@noble/curves/abstract/poseidon.d.ts:3 - -## Functions - -### validateOpts - -▸ **validateOpts**(`opts`): `Readonly`<{ `rounds`: `number` ; `sboxFn`: (`n`: `bigint`) => `bigint` ; `roundConstants`: `bigint`[][] ; `mds`: `bigint`[][] ; `Fp`: `IField`<`bigint`\> ; `t`: `number` ; `roundsFull`: `number` ; `roundsPartial`: `number` ; `sboxPower?`: `number` ; `reversePartialPowIdx?`: `boolean` }\> - -#### Parameters - -| Name | Type | -| :----- | :---------------------------------------------- | -| `opts` | [`PoseidonOpts`](hash.poseidon.md#poseidonopts) | - -#### Returns - -`Readonly`<{ `rounds`: `number` ; `sboxFn`: (`n`: `bigint`) => `bigint` ; `roundConstants`: `bigint`[][] ; `mds`: `bigint`[][] ; `Fp`: `IField`<`bigint`\> ; `t`: `number` ; `roundsFull`: `number` ; `roundsPartial`: `number` ; `sboxPower?`: `number` ; `reversePartialPowIdx?`: `boolean` }\> - -#### Defined in - -node_modules/@noble/curves/abstract/poseidon.d.ts:13 - ---- - -### splitConstants - -▸ **splitConstants**(`rc`, `t`): `bigint`[][] - -#### Parameters - -| Name | Type | -| :--- | :--------- | -| `rc` | `bigint`[] | -| `t` | `number` | - -#### Returns - -`bigint`[][] - -#### Defined in - -node_modules/@noble/curves/abstract/poseidon.d.ts:25 - ---- - -### poseidon - -▸ **poseidon**(`opts`): (`values`: `bigint`[]) => `bigint`[] - -#### Parameters - -| Name | Type | -| :----- | :---------------------------------------------- | -| `opts` | [`PoseidonOpts`](hash.poseidon.md#poseidonopts) | - -#### Returns - -`fn` - -▸ (`values`): `bigint`[] - -##### Parameters - -| Name | Type | -| :------- | :--------- | -| `values` | `bigint`[] | - -##### Returns - -`bigint`[] - -| Name | Type | -| :--------------- | :----------- | -| `roundConstants` | `bigint`[][] | - -#### Defined in - -node_modules/@noble/curves/abstract/poseidon.d.ts:26 diff --git a/www/docs/API/namespaces/json.md b/www/docs/API/namespaces/json.md deleted file mode 100644 index f3b00f1a4..000000000 --- a/www/docs/API/namespaces/json.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -id: 'json' -title: 'Namespace: json' -sidebar_label: 'json' -sidebar_position: 0 -custom_edit_url: null ---- - -## Functions - -### parse - -▸ **parse**(`x`): `any` - -Convert JSON string to JSON object - -NOTE: the String() wrapping is used so the behavior conforms to JSON.parse() -which can accept simple data types but is not represented in the default typing - -#### Parameters - -| Name | Type | Description | -| :--- | :------- | :---------- | -| `x` | `string` | JSON string | - -#### Returns - -`any` - -#### Defined in - -[src/utils/json.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/json.ts#L21) - ---- - -### parseAlwaysAsBig - -▸ **parseAlwaysAsBig**(`x`): `any` - -Convert JSON string to JSON object with all numbers as bigint - -#### Parameters - -| Name | Type | Description | -| :--- | :------- | :---------- | -| `x` | `string` | JSON string | - -#### Returns - -`any` - -#### Defined in - -[src/utils/json.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/json.ts#L27) - ---- - -### stringify - -▸ **stringify**(`value`, `replacer?`, `space?`, `numberStringifiers?`): `string` - -Convert JSON object to JSON string - -NOTE: the not-null assertion is used so the return type conforms to JSON.stringify() -which can also return undefined but is not represented in the default typing - -#### Parameters - -| Name | Type | -| :-------------------- | :-------------------- | -| `value` | `unknown` | -| `replacer?` | `any` | -| `space?` | `string` \| `number` | -| `numberStringifiers?` | `NumberStringifier`[] | - -#### Returns - -`string` - -JSON string - -#### Defined in - -[src/utils/json.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/json.ts#L37) - ---- - -### stringifyAlwaysAsBig - -▸ **stringifyAlwaysAsBig**(`value`, `replacer?`, `space?`, `numberStringifiers?`): `string` - -**`Deprecated`** - -equivalent to 'stringify', alias will be removed - -#### Parameters - -| Name | Type | -| :-------------------- | :-------------------- | -| `value` | `unknown` | -| `replacer?` | `any` | -| `space?` | `string` \| `number` | -| `numberStringifiers?` | `NumberStringifier`[] | - -#### Returns - -`string` - -#### Defined in - -[src/utils/json.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/json.ts#L37) diff --git a/www/docs/API/namespaces/merkle.md b/www/docs/API/namespaces/merkle.md deleted file mode 100644 index 8866f2a63..000000000 --- a/www/docs/API/namespaces/merkle.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: 'merkle' -title: 'Namespace: merkle' -sidebar_label: 'merkle' -sidebar_position: 0 -custom_edit_url: null ---- - -## Classes - -- [MerkleTree](../classes/merkle.MerkleTree.md) - -## Functions - -### proofMerklePath - -▸ **proofMerklePath**(`root`, `leaf`, `path`): `boolean` - -Test Merkle tree path - -#### Parameters - -| Name | Type | Description | -| :----- | :--------- | :--------------- | -| `root` | `string` | hex-string | -| `leaf` | `string` | hex-string | -| `path` | `string`[] | hex-string array | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/merkle.ts:85](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/merkle.ts#L85) diff --git a/www/docs/API/namespaces/num.md b/www/docs/API/namespaces/num.md deleted file mode 100644 index fcc364567..000000000 --- a/www/docs/API/namespaces/num.md +++ /dev/null @@ -1,421 +0,0 @@ ---- -id: 'num' -title: 'Namespace: num' -sidebar_label: 'num' -sidebar_position: 0 -custom_edit_url: null ---- - -## References - -### BigNumberish - -Re-exports [BigNumberish](types.md#bignumberish) - -## Functions - -### isHex - -▸ **isHex**(`hex`): `boolean` - -Test if string is hex-string - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------- | -| `hex` | `string` | hex-string | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/num.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L14) - ---- - -### toBigInt - -▸ **toBigInt**(`value`): `bigint` - -Convert BigNumberish to bigint - -#### Parameters - -| Name | Type | -| :------ | :-------------------------------------- | -| `value` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`bigint` - -#### Defined in - -[src/utils/num.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L21) - ---- - -### isBigInt - -▸ **isBigInt**(`value`): value is bigint - -Test if value is bigint - -#### Parameters - -| Name | Type | -| :------ | :---- | -| `value` | `any` | - -#### Returns - -value is bigint - -#### Defined in - -[src/utils/num.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L28) - ---- - -### toHex - -▸ **toHex**(`number`): `string` - -Convert BigNumberish to hex-string - -#### Parameters - -| Name | Type | -| :------- | :-------------------------------------- | -| `number` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/num.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L36) - ---- - -### toStorageKey - -▸ **toStorageKey**(`number`): `string` - -Convert BigNumberish to storage-key-string - -Same as toHex but conforming to the STORAGE_KEY pattern `^0x0[0-7]{1}[a-fA-F0-9]{0,62}$`. - -A storage key is represented as up to 62 hex digits, 3 bits, and 5 leading zeroes: -`0x0 + [0-7] + 62 hex = 0x + 64 hex` - -#### Parameters - -| Name | Type | -| :------- | :-------------------------------------- | -| `number` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`string` - -format: storage-key-string - -#### Defined in - -[src/utils/num.ts:54](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L54) - ---- - -### hexToDecimalString - -▸ **hexToDecimalString**(`hex`): `string` - -Convert hexadecimal string to decimal string - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------- | -| `hex` | `string` | hex-string | - -#### Returns - -`string` - -format: decimal string - -#### Defined in - -[src/utils/num.ts:64](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L64) - ---- - -### assertInRange - -▸ **assertInRange**(`input`, `lowerBound`, `upperBound`, `inputName?`): `void` - -Asserts input is equal to or greater then lowerBound and lower then upperBound. - -The `inputName` parameter is used in the assertion message. - -#### Parameters - -| Name | Type | Default value | -| :----------- | :-------------------------------------- | :------------ | -| `input` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `lowerBound` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `upperBound` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `inputName` | `string` | `''` | - -#### Returns - -`void` - -#### Defined in - -[src/utils/num.ts:81](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L81) - ---- - -### bigNumberishArrayToDecimalStringArray - -▸ **bigNumberishArrayToDecimalStringArray**(`rawCalldata`): `string`[] - -Convert BigNumberish array to decimal string array - -#### Parameters - -| Name | Type | -| :------------ | :---------------------------------------- | -| `rawCalldata` | [`BigNumberish`](types.md#bignumberish)[] | - -#### Returns - -`string`[] - -format: decimal string array - -#### Defined in - -[src/utils/num.ts:102](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L102) - ---- - -### bigNumberishArrayToHexadecimalStringArray - -▸ **bigNumberishArrayToHexadecimalStringArray**(`rawCalldata`): `string`[] - -Convert BigNumberish array to hexadecimal string array - -#### Parameters - -| Name | Type | -| :------------ | :---------------------------------------- | -| `rawCalldata` | [`BigNumberish`](types.md#bignumberish)[] | - -#### Returns - -`string`[] - -format: hex-string array - -#### Defined in - -[src/utils/num.ts:110](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L110) - ---- - -### getDecimalString - -▸ **getDecimalString**(`value`): `string` - -Convert string to decimal string - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `value` | `string` | - -#### Returns - -`string` - -format: decimal string - -#### Defined in - -[src/utils/num.ts:123](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L123) - ---- - -### getHexString - -▸ **getHexString**(`value`): `string` - -Convert string to hexadecimal string - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `value` | `string` | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/num.ts:137](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L137) - ---- - -### getHexStringArray - -▸ **getHexStringArray**(`value`): `string`[] - -Convert string array to hex-string array - -#### Parameters - -| Name | Type | -| :------ | :--------- | -| `value` | `string`[] | - -#### Returns - -`string`[] - -format: hex-string array - -#### Defined in - -[src/utils/num.ts:151](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L151) - ---- - -### hexToBytes - -▸ **hexToBytes**(`value`): `Uint8Array` - -Convert hex-string to an array of Bytes (Uint8Array) - -#### Parameters - -| Name | Type | Description | -| :------ | :------- | :---------- | -| `value` | `string` | hex-string | - -#### Returns - -`Uint8Array` - -#### Defined in - -[src/utils/num.ts:164](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L164) - ---- - -### toHexString - -▸ **toHexString**(`number`): `string` - -Alias of ToHex - -#### Parameters - -| Name | Type | -| :------- | :-------------------------------------- | -| `number` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -[src/utils/num.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L36) - ---- - -### cleanHex - -▸ **cleanHex**(`hex`): `string` - -Remove hex string leading zero and lowercase it - -**`Example`** - -```ts -'0x01A...' -> '0x1a..' -``` - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :---------- | -| `hex` | `string` | hex-string | - -#### Returns - -`string` - -format: hex-string - -#### Defined in - -[src/utils/num.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L74) - ---- - -### isStringWholeNumber - -▸ **isStringWholeNumber**(`value`): `boolean` - -Test if string is whole number (0,1,2,3...) - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `value` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/num.ts:117](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L117) - ---- - -### toCairoBool - -▸ **toCairoBool**(`value`): `string` - -Convert boolean to "0" or "1" - -#### Parameters - -| Name | Type | -| :------ | :-------- | -| `value` | `boolean` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/num.ts:158](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/num.ts#L158) diff --git a/www/docs/API/namespaces/provider-1.md b/www/docs/API/namespaces/provider-1.md deleted file mode 100644 index b9d08554e..000000000 --- a/www/docs/API/namespaces/provider-1.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: 'provider-1' -title: 'Namespace: provider' -sidebar_label: 'provider' -sidebar_position: 0 -custom_edit_url: null ---- - -## Functions - -### wait - -▸ **wait**(`delay`): `Promise`<`unknown`\> - -Helper - Async Sleep for 'delay' time - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `delay` | `number` | - -#### Returns - -`Promise`<`unknown`\> - -#### Defined in - -[src/utils/provider.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/provider.ts#L16) - ---- - -### createSierraContractClass - -▸ **createSierraContractClass**(`contract`): [`SierraContractClass`](types.md#sierracontractclass) - -Create Sierra Contract Class from a given Compiled Sierra - -CompiledSierra -> SierraContractClass - -#### Parameters - -| Name | Type | -| :--------- | :------------------------------------------ | -| `contract` | [`CompiledSierra`](types.md#compiledsierra) | - -#### Returns - -[`SierraContractClass`](types.md#sierracontractclass) - -#### Defined in - -[src/utils/provider.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/provider.ts#L27) - ---- - -### parseContract - -▸ **parseContract**(`contract`): [`ContractClass`](types.md#contractclass) - -Create Contract Class from a given CompiledContract or string - -(CompiledContract or string) -> ContractClass - -#### Parameters - -| Name | Type | -| :--------- | :---------------------------------------------------------- | -| `contract` | `string` \| [`CompiledContract`](types.md#compiledcontract) | - -#### Returns - -[`ContractClass`](types.md#contractclass) - -#### Defined in - -[src/utils/provider.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/provider.ts#L41) diff --git a/www/docs/API/namespaces/selector.md b/www/docs/API/namespaces/selector.md deleted file mode 100644 index e8ba1cf14..000000000 --- a/www/docs/API/namespaces/selector.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -id: 'selector' -title: 'Namespace: selector' -sidebar_label: 'selector' -sidebar_position: 0 -custom_edit_url: null ---- - -## References - -### keccakBn - -Re-exports [keccakBn](hash.md#keccakbn) - ---- - -### starknetKeccak - -Re-exports [starknetKeccak](hash.md#starknetkeccak) - ---- - -### getSelectorFromName - -Re-exports [getSelectorFromName](hash.md#getselectorfromname) - ---- - -### getSelector - -Re-exports [getSelector](hash.md#getselector) diff --git a/www/docs/API/namespaces/shortString.md b/www/docs/API/namespaces/shortString.md deleted file mode 100644 index 76abf0817..000000000 --- a/www/docs/API/namespaces/shortString.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -id: 'shortString' -title: 'Namespace: shortString' -sidebar_label: 'shortString' -sidebar_position: 0 -custom_edit_url: null ---- - -## Functions - -### isASCII - -▸ **isASCII**(`str`): `boolean` - -Test if string contains only ASCII characters (string can be ascii text) - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `str` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/shortString.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/shortString.ts#L8) - ---- - -### isShortString - -▸ **isShortString**(`str`): `boolean` - -Test if string is a Cairo short string (string has less or equal 31 characters) - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `str` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/shortString.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/shortString.ts#L16) - ---- - -### isDecimalString - -▸ **isDecimalString**(`str`): `boolean` - -Test if string contains only numbers (string can be converted to decimal number) - -#### Parameters - -| Name | Type | -| :---- | :------- | -| `str` | `string` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/shortString.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/shortString.ts#L23) - ---- - -### isText - -▸ **isText**(`val`): `boolean` - -Test if value is a free-from string text, and not a hex string or number string - -#### Parameters - -| Name | Type | -| :---- | :---- | -| `val` | `any` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/shortString.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/shortString.ts#L30) - ---- - -### splitLongString - -▸ **splitLongString**(`longStr`): `string`[] - -Split long text into short strings - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `longStr` | `string` | - -#### Returns - -`string`[] - -#### Defined in - -[src/utils/shortString.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/shortString.ts#L47) - ---- - -### encodeShortString - -▸ **encodeShortString**(`str`): `string` - -Convert an ASCII string to a hexadecimal string. - -**`Example`** - -```typescript -const myEncodedString: string = encodeShortString("uri/pict/t38.jpg"); -// return hex string (ex."0x7572692f706963742f7433382e6a7067") -``` - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :--------------------------------------------- | -| `str` | `string` | short string (ASCII string, 31 characters max) | - -#### Returns - -`string` - -format: hex-string; 248 bits max - -#### Defined in - -[src/utils/shortString.ts:62](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/shortString.ts#L62) - ---- - -### decodeShortString - -▸ **decodeShortString**(`str`): `string` - -Convert a hexadecimal or decimal string to an ASCII string. - -**`Example`** - -```typescript -const myDecodedString: string = decodeShortString("0x7572692f706963742f7433382e6a7067"); -// return string (ex."uri/pict/t38.jpg") -``` - -#### Parameters - -| Name | Type | Description | -| :---- | :------- | :----------------------------------------------------------------------------- | -| `str` | `string` | representing a 248 bit max number (ex. "0x1A4F64EA56" or "236942575435676423") | - -#### Returns - -`string` - -format: short string; 31 characters max - -#### Defined in - -[src/utils/shortString.ts:78](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/shortString.ts#L78) - ---- - -### isShortText - -▸ **isShortText**(`val`): `boolean` - -Test if value is short text - -#### Parameters - -| Name | Type | -| :---- | :---- | -| `val` | `any` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/shortString.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/shortString.ts#L37) - ---- - -### isLongText - -▸ **isLongText**(`val`): `boolean` - -Test if value is long text - -#### Parameters - -| Name | Type | -| :---- | :---- | -| `val` | `any` | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/shortString.ts:42](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/shortString.ts#L42) diff --git a/www/docs/API/namespaces/stark.md b/www/docs/API/namespaces/stark.md deleted file mode 100644 index 8b80db3e8..000000000 --- a/www/docs/API/namespaces/stark.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -id: 'stark' -title: 'Namespace: stark' -sidebar_label: 'stark' -sidebar_position: 0 -custom_edit_url: null ---- - -## Functions - -### compressProgram - -▸ **compressProgram**(`jsonProgram`): [`CompressedProgram`](types.md#compressedprogram) - -Compress compiled Cairo program - -[Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/gateway/transaction.py#L54-L58) - -#### Parameters - -| Name | Type | Description | -| :------------ | :------------------------------------------------------ | :-------------------------------------- | -| `jsonProgram` | `string` \| [`Program`](../interfaces/types.Program.md) | Representing the compiled cairo program | - -#### Returns - -[`CompressedProgram`](types.md#compressedprogram) - -#### Defined in - -[src/utils/stark.ts:20](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/stark.ts#L20) - ---- - -### decompressProgram - -▸ **decompressProgram**(`base64`): `any` - -Decompress compressed compiled Cairo program - -#### Parameters - -| Name | Type | Description | -| :------- | :------- | :----------------- | -| `base64` | `string` | Compressed program | - -#### Returns - -`any` - -Parsed decompressed compiled Cairo program - -#### Defined in - -[src/utils/stark.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/stark.ts#L31) - ---- - -### randomAddress - -▸ **randomAddress**(): `string` - -Random Address based on random keyPair - -#### Returns - -`string` - -#### Defined in - -[src/utils/stark.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/stark.ts#L40) - ---- - -### makeAddress - -▸ **makeAddress**(`input`): `string` - -Lowercase and hex prefix string - -**`Deprecated`** - -Not used internally, naming is confusing based on functionality - -#### Parameters - -| Name | Type | -| :------ | :------- | -| `input` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/stark.ts:50](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/stark.ts#L50) - ---- - -### formatSignature - -▸ **formatSignature**(`sig?`): [`ArraySignatureType`](types.md#arraysignaturetype) - -Format Signature to standard type (hex array) - -#### Parameters - -| Name | Type | -| :----- | :-------------------------------- | -| `sig?` | [`Signature`](types.md#signature) | - -#### Returns - -[`ArraySignatureType`](types.md#arraysignaturetype) - -Custom hex array or weierstrass.SignatureType hex array - -#### Defined in - -[src/utils/stark.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/stark.ts#L58) - ---- - -### signatureToDecimalArray - -▸ **signatureToDecimalArray**(`sig?`): [`ArraySignatureType`](types.md#arraysignaturetype) - -Format Signature to decimal string array - -#### Parameters - -| Name | Type | -| :----- | :-------------------------------- | -| `sig?` | [`Signature`](types.md#signature) | - -#### Returns - -[`ArraySignatureType`](types.md#arraysignaturetype) - -#### Defined in - -[src/utils/stark.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/stark.ts#L74) - ---- - -### signatureToHexArray - -▸ **signatureToHexArray**(`sig?`): [`ArraySignatureType`](types.md#arraysignaturetype) - -Format Signature to hex string array - -#### Parameters - -| Name | Type | -| :----- | :-------------------------------- | -| `sig?` | [`Signature`](types.md#signature) | - -#### Returns - -[`ArraySignatureType`](types.md#arraysignaturetype) - -#### Defined in - -[src/utils/stark.ts:81](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/stark.ts#L81) - ---- - -### estimatedFeeToMaxFee - -▸ **estimatedFeeToMaxFee**(`estimatedFee`, `overhead?`): `bigint` - -Convert estimated fee to max fee with overhead - -#### Parameters - -| Name | Type | Default value | -| :------------- | :-------------------------------------- | :------------ | -| `estimatedFee` | [`BigNumberish`](types.md#bignumberish) | `undefined` | -| `overhead` | `number` | `0.5` | - -#### Returns - -`bigint` - -#### Defined in - -[src/utils/stark.ts:88](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/stark.ts#L88) diff --git a/www/docs/API/namespaces/starknetId.md b/www/docs/API/namespaces/starknetId.md deleted file mode 100644 index f1a7f0c0d..000000000 --- a/www/docs/API/namespaces/starknetId.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: 'starknetId' -title: 'Namespace: starknetId' -sidebar_label: 'starknetId' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumerations - -- [StarknetIdContract](../enums/starknetId.StarknetIdContract.md) - -## Functions - -### useDecoded - -▸ **useDecoded**(`encoded`): `string` - -#### Parameters - -| Name | Type | -| :-------- | :--------- | -| `encoded` | `bigint`[] | - -#### Returns - -`string` - -#### Defined in - -[src/utils/starknetId.ts:20](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/starknetId.ts#L20) - ---- - -### useEncoded - -▸ **useEncoded**(`decoded`): `bigint` - -#### Parameters - -| Name | Type | -| :-------- | :------- | -| `decoded` | `string` | - -#### Returns - -`bigint` - -#### Defined in - -[src/utils/starknetId.ts:61](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/starknetId.ts#L61) - ---- - -### getStarknetIdContract - -▸ **getStarknetIdContract**(`chainId`): `string` - -#### Parameters - -| Name | Type | -| :-------- | :--------------------------------------------------------- | -| `chainId` | [`StarknetChainId`](../enums/constants.StarknetChainId.md) | - -#### Returns - -`string` - -#### Defined in - -[src/utils/starknetId.ts:108](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/starknetId.ts#L108) diff --git a/www/docs/API/namespaces/transaction.md b/www/docs/API/namespaces/transaction.md deleted file mode 100644 index b20d6085e..000000000 --- a/www/docs/API/namespaces/transaction.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -id: 'transaction' -title: 'Namespace: transaction' -sidebar_label: 'transaction' -sidebar_position: 0 -custom_edit_url: null ---- - -## Functions - -### transformCallsToMulticallArrays - -▸ **transformCallsToMulticallArrays**(`calls`): `Object` - -Transforms a list of Calls, each with their own calldata, into -two arrays: one with the entrypoints, and one with the concatenated calldata. - -#### Parameters - -| Name | Type | -| :------ | :------------------------ | -| `calls` | [`Call`](types.md#call)[] | - -#### Returns - -`Object` - -| Name | Type | -| :---------- | :---------------------------------------- | -| `callArray` | [`ParsedStruct`](types.md#parsedstruct)[] | -| `calldata` | [`Calldata`](types.md#calldata) | - -#### Defined in - -[src/utils/transaction.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/transaction.ts#L10) - ---- - -### fromCallsToExecuteCalldata - -▸ **fromCallsToExecuteCalldata**(`calls`): [`Calldata`](types.md#calldata) - -Transforms a list of calls into the Cairo 0 `__execute__` calldata. - -#### Parameters - -| Name | Type | -| :------ | :------------------------ | -| `calls` | [`Call`](types.md#call)[] | - -#### Returns - -[`Calldata`](types.md#calldata) - -#### Defined in - -[src/utils/transaction.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/transaction.ts#L32) - ---- - -### fromCallsToExecuteCalldataWithNonce - -▸ **fromCallsToExecuteCalldataWithNonce**(`calls`, `nonce`): [`Calldata`](types.md#calldata) - -Transforms a list of calls into the Cairo 0 `__execute__` calldata including nonce. - -**`Deprecated`** - -#### Parameters - -| Name | Type | -| :------ | :-------------------------------------- | -| `calls` | [`Call`](types.md#call)[] | -| `nonce` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -[`Calldata`](types.md#calldata) - -#### Defined in - -[src/utils/transaction.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/transaction.ts#L43) - ---- - -### transformCallsToMulticallArrays_cairo1 - -▸ **transformCallsToMulticallArrays_cairo1**(`calls`): [`CallStruct`](../interfaces/types.CallStruct.md)[] - -Format Data inside Calls - -**`Deprecated`** - -Not required for getting execute Calldata - -#### Parameters - -| Name | Type | -| :------ | :------------------------ | -| `calls` | [`Call`](types.md#call)[] | - -#### Returns - -[`CallStruct`](../interfaces/types.CallStruct.md)[] - -#### Defined in - -[src/utils/transaction.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/transaction.ts#L52) - ---- - -### fromCallsToExecuteCalldata_cairo1 - -▸ **fromCallsToExecuteCalldata_cairo1**(`calls`): [`Calldata`](types.md#calldata) - -Transforms a list of calls into the Cairo 1 `__execute__` calldata. - -#### Parameters - -| Name | Type | -| :------ | :------------------------ | -| `calls` | [`Call`](types.md#call)[] | - -#### Returns - -[`Calldata`](types.md#calldata) - -#### Defined in - -[src/utils/transaction.ts:64](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/transaction.ts#L64) - ---- - -### getExecuteCalldata - -▸ **getExecuteCalldata**(`calls`, `cairoVersion?`): [`Calldata`](types.md#calldata) - -Create `__execute__` Calldata from Calls based on Cairo versions - -#### Parameters - -| Name | Type | Default value | -| :------------- | :-------------------------------------- | :------------ | -| `calls` | [`Call`](types.md#call)[] | `undefined` | -| `cairoVersion` | [`CairoVersion`](types.md#cairoversion) | `'0'` | - -#### Returns - -[`Calldata`](types.md#calldata) - -#### Defined in - -[src/utils/transaction.ts:78](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/transaction.ts#L78) diff --git a/www/docs/API/namespaces/typedData.md b/www/docs/API/namespaces/typedData.md deleted file mode 100644 index 807caaa14..000000000 --- a/www/docs/API/namespaces/typedData.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -id: 'typedData' -title: 'Namespace: typedData' -sidebar_label: 'typedData' -sidebar_position: 0 -custom_edit_url: null ---- - -## References - -### StarkNetMerkleType - -Re-exports [StarkNetMerkleType](types.md#starknetmerkletype) - ---- - -### StarkNetType - -Re-exports [StarkNetType](types.md#starknettype) - ---- - -### StarkNetDomain - -Re-exports [StarkNetDomain](../interfaces/types.StarkNetDomain.md) - ---- - -### TypedData - -Re-exports [TypedData](../interfaces/types.TypedData.md) - -## Functions - -### prepareSelector - -▸ **prepareSelector**(`selector`): `string` - -#### Parameters - -| Name | Type | -| :--------- | :------- | -| `selector` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/typedData.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData.ts#L36) - ---- - -### isMerkleTreeType - -▸ **isMerkleTreeType**(`type`): type is StarkNetMerkleType - -#### Parameters - -| Name | Type | -| :----- | :-------------------------------------- | -| `type` | [`StarkNetType`](types.md#starknettype) | - -#### Returns - -type is StarkNetMerkleType - -#### Defined in - -[src/utils/typedData.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData.ts#L40) - ---- - -### getDependencies - -▸ **getDependencies**(`types`, `type`, `dependencies?`): `string`[] - -Get the dependencies of a struct type. If a struct has the same dependency multiple times, it's only included once -in the resulting array. - -#### Parameters - -| Name | Type | Default value | -| :-------------- | :------------------------------------------------------------- | :------------ | -| `types` | `Record`<`string`, [`StarkNetType`](types.md#starknettype)[]\> | `undefined` | -| `type` | `string` | `undefined` | -| `dependencies?` | `string`[] | `[]` | - -#### Returns - -`string`[] - -#### Defined in - -[src/utils/typedData.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData.ts#L58) - ---- - -### encodeType - -▸ **encodeType**(`types`, `type`): `string` - -Encode a type to a string. All dependant types are alphabetically sorted. - -#### Parameters - -| Name | Type | -| :------ | :------------------------------------------------------------- | -| `types` | `Record`<`string`, [`StarkNetType`](types.md#starknettype)[]\> | -| `type` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/typedData.ts:110](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData.ts#L110) - ---- - -### getTypeHash - -▸ **getTypeHash**(`types`, `type`): `string` - -Get a type string as hash. - -#### Parameters - -| Name | Type | -| :------ | :------------------------------------------------------------- | -| `types` | `Record`<`string`, [`StarkNetType`](types.md#starknettype)[]\> | -| `type` | `string` | - -#### Returns - -`string` - -#### Defined in - -[src/utils/typedData.ts:124](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData.ts#L124) - ---- - -### encodeValue - -▸ **encodeValue**(`types`, `type`, `data`, `ctx?`): [`string`, `string`] - -Encodes a single value to an ABI serialisable string, number or Buffer. Returns the data as tuple, which consists of -an array of ABI compatible types, and an array of corresponding values. - -#### Parameters - -| Name | Type | -| :------ | :------------------------------------------------------------- | -| `types` | `Record`<`string`, [`StarkNetType`](types.md#starknettype)[]\> | -| `type` | `string` | -| `data` | `unknown` | -| `ctx` | `Context` | - -#### Returns - -[`string`, `string`] - -#### Defined in - -[src/utils/typedData.ts:132](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData.ts#L132) - ---- - -### encodeData - -▸ **encodeData**<`T`\>(`types`, `type`, `data`): `string`[][] - -Encode the data to an ABI encoded Buffer. The data should be a key -> value object with all the required values. All -dependant types are automatically encoded. - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------ | -| `T` | extends [`TypedData`](../interfaces/types.TypedData.md) | - -#### Parameters - -| Name | Type | -| :------ | :----------------- | -| `types` | `T`[``"types"``] | -| `type` | `string` | -| `data` | `T`[``"message"``] | - -#### Returns - -`string`[][] - -#### Defined in - -[src/utils/typedData.ts:180](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData.ts#L180) - ---- - -### getStructHash - -▸ **getStructHash**<`T`\>(`types`, `type`, `data`): `string` - -Get encoded data as a hash. The data should be a key -> value object with all the required values. All dependant -types are automatically encoded. - -#### Type parameters - -| Name | Type | -| :--- | :------------------------------------------------------ | -| `T` | extends [`TypedData`](../interfaces/types.TypedData.md) | - -#### Parameters - -| Name | Type | -| :------ | :----------------- | -| `types` | `T`[``"types"``] | -| `type` | `string` | -| `data` | `T`[``"message"``] | - -#### Returns - -`string` - -#### Defined in - -[src/utils/typedData.ts:212](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData.ts#L212) - ---- - -### getMessageHash - -▸ **getMessageHash**(`typedData`, `account`): `string` - -Get the EIP-191 encoded message to sign, from the typedData object. - -#### Parameters - -| Name | Type | -| :---------- | :---------------------------------------------- | -| `typedData` | [`TypedData`](../interfaces/types.TypedData.md) | -| `account` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`string` - -#### Defined in - -[src/utils/typedData.ts:223](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData.ts#L223) diff --git a/www/docs/API/namespaces/types.RPC.md b/www/docs/API/namespaces/types.RPC.md deleted file mode 100644 index 6af465117..000000000 --- a/www/docs/API/namespaces/types.RPC.md +++ /dev/null @@ -1,459 +0,0 @@ ---- -id: 'types.RPC' -title: 'Namespace: RPC' -sidebar_label: 'RPC' -custom_edit_url: null ---- - -[types](types.md).RPC - -## Type Aliases - -### Response - -Ƭ **Response**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----------------------------------------- | -| `id` | `number` | -| `jsonrpc` | `string` | -| `result?` | `any` | -| `error?` | { `code`: `string` ; `message`: `string` } | -| `error.code` | `string` | -| `error.message` | `string` | - -#### Defined in - -[src/types/api/rpc.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L12) - ---- - -### ChainId - -Ƭ **ChainId**: `OPENRPC.CHAIN_ID` - -#### Defined in - -[src/types/api/rpc.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L22) - ---- - -### CallResponse - -Ƭ **CallResponse**: `OPENRPC.CallResponse` - -#### Defined in - -[src/types/api/rpc.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L23) - ---- - -### ContractAddress - -Ƭ **ContractAddress**: `ADDRESS` - -#### Defined in - -[src/types/api/rpc.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L24) - ---- - -### Felt - -Ƭ **Felt**: `FELT` - -#### Defined in - -[src/types/api/rpc.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L25) - ---- - -### Nonce - -Ƭ **Nonce**: `OPENRPC.Nonce` - -#### Defined in - -[src/types/api/rpc.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L26) - ---- - -### ContractClass - -Ƭ **ContractClass**: `OPENRPC.ContractClass` \| `OPENRPC.DeprecatedContractClass` - -#### Defined in - -[src/types/api/rpc.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L27) - ---- - -### StateUpdate - -Ƭ **StateUpdate**: `OPENRPC.StateUpdate` - -#### Defined in - -[src/types/api/rpc.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L28) - ---- - -### Transaction - -Ƭ **Transaction**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L29) - ---- - -### PendingTransactions - -Ƭ **PendingTransactions**: `OPENRPC.PendingTransactions` - -#### Defined in - -[src/types/api/rpc.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L30) - ---- - -### TransactionHash - -Ƭ **TransactionHash**: `OPENRPC.TransactionHash` - -#### Defined in - -[src/types/api/rpc.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L31) - ---- - -### Trace - -Ƭ **Trace**: `OPENRPC.Trace` - -#### Defined in - -[src/types/api/rpc.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L32) - ---- - -### Traces - -Ƭ **Traces**: `OPENRPC.Traces` - -#### Defined in - -[src/types/api/rpc.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L33) - ---- - -### BlockHash - -Ƭ **BlockHash**: `OPENRPC.BlockHash` - -#### Defined in - -[src/types/api/rpc.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L34) - ---- - -### BlockHashAndNumber - -Ƭ **BlockHashAndNumber**: `OPENRPC.BlockHashAndNumber` - -#### Defined in - -[src/types/api/rpc.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L35) - ---- - -### EstimateFeeResponse - -Ƭ **EstimateFeeResponse**: `OPENRPC.EstimatedFee` - -#### Defined in - -[src/types/api/rpc.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L36) - ---- - -### GetBlockWithTxHashesResponse - -Ƭ **GetBlockWithTxHashesResponse**: `OPENRPC.BlockWithTxHashes` - -#### Defined in - -[src/types/api/rpc.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L37) - ---- - -### GetBlockWithTxs - -Ƭ **GetBlockWithTxs**: `OPENRPC.BlockWithTxs` - -#### Defined in - -[src/types/api/rpc.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L38) - ---- - -### GetStorageAtResponse - -Ƭ **GetStorageAtResponse**: `OPENRPC.Storage` - -#### Defined in - -[src/types/api/rpc.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L39) - ---- - -### TransactionReceipt - -Ƭ **TransactionReceipt**: `OPENRPC.TransactionReceipt` - -#### Defined in - -[src/types/api/rpc.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L40) - ---- - -### GetTransactionByHashResponse - -Ƭ **GetTransactionByHashResponse**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L41) - ---- - -### GetTransactionByBlockIdAndIndex - -Ƭ **GetTransactionByBlockIdAndIndex**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:42](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L42) - ---- - -### GetTransactionCountResponse - -Ƭ **GetTransactionCountResponse**: `number` - -#### Defined in - -[src/types/api/rpc.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L43) - ---- - -### GetBlockNumberResponse - -Ƭ **GetBlockNumberResponse**: `OPENRPC.BlockNumber` - -#### Defined in - -[src/types/api/rpc.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L44) - ---- - -### GetSyncingStatsResponse - -Ƭ **GetSyncingStatsResponse**: `OPENRPC.SyncingStatus` - -#### Defined in - -[src/types/api/rpc.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L45) - ---- - -### EventFilter - -Ƭ **EventFilter**: `OPENRPC.EventFilter` - -#### Defined in - -[src/types/api/rpc.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L46) - ---- - -### GetEventsResponse - -Ƭ **GetEventsResponse**: `OPENRPC.Events` - -#### Defined in - -[src/types/api/rpc.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L47) - ---- - -### InvokedTransaction - -Ƭ **InvokedTransaction**: `OPENRPC.InvokedTransaction` - -#### Defined in - -[src/types/api/rpc.ts:48](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L48) - ---- - -### DeclaredTransaction - -Ƭ **DeclaredTransaction**: `OPENRPC.DeclaredTransaction` - -#### Defined in - -[src/types/api/rpc.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L49) - ---- - -### DeployedTransaction - -Ƭ **DeployedTransaction**: `OPENRPC.DeployedTransaction` - -#### Defined in - -[src/types/api/rpc.ts:50](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L50) - ---- - -### SimulationFlags - -Ƭ **SimulationFlags**: `OPENRPC.SimulationFlags` - -#### Defined in - -[src/types/api/rpc.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L51) - ---- - -### EstimatedFee - -Ƭ **EstimatedFee**: `OPENRPC.EstimatedFee` - -#### Defined in - -[src/types/api/rpc.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L52) - ---- - -### Methods - -Ƭ **Methods**: `OPENRPC.Methods` - -#### Defined in - -[src/types/api/rpc.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L53) - ---- - -### Storage - -Ƭ **Storage**: `OPENRPC.Storage` - -#### Defined in - -[src/types/api/rpc.ts:54](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L54) - ---- - -### SimulateTransactionResponse - -Ƭ **SimulateTransactionResponse**: `OPENRPC.SimulatedTransactions` - -#### Defined in - -[src/types/api/rpc.ts:55](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L55) - ---- - -### BaseTransaction - -Ƭ **BaseTransaction**: `OPENRPC.BaseTransaction` & { `version`: `string` } - -#### Defined in - -[src/types/api/rpc.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L60) - ---- - -### StorageDiffs - -Ƭ **StorageDiffs**: `CONTRACT_STORAGE_DIFF_ITEM`[] - -#### Defined in - -[src/types/api/rpc.ts:63](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L63) - ---- - -### DeprecatedDeclaredClasses - -Ƭ **DeprecatedDeclaredClasses**: `FELT`[] - -#### Defined in - -[src/types/api/rpc.ts:64](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L64) - ---- - -### Nonces - -Ƭ **Nonces**: { `contract_address`: `ADDRESS` ; `nonce`: `FELT` }[] - -#### Defined in - -[src/types/api/rpc.ts:65](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L65) - ---- - -### ReplacedClasses - -Ƭ **ReplacedClasses**: { `contract_address`: `ADDRESS` ; `class_hash`: `FELT` }[] - -#### Defined in - -[src/types/api/rpc.ts:69](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L69) - -## Variables - -### TransactionType - -• `Const` **TransactionType**: typeof `TXN_TYPE` = `TXN_TYPE` - -#### Defined in - -[src/types/api/rpc.ts:56](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L56) - ---- - -### SimulationFlag - -• `Const` **SimulationFlag**: typeof `SIMULATION_FLAG` = `SIMULATION_FLAG` - -#### Defined in - -[src/types/api/rpc.ts:57](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L57) - ---- - -### TransactionFinalityStatus - -• `Const` **TransactionFinalityStatus**: typeof `TXN_FINALITY_STATUS` = `TXN_FINALITY_STATUS` - -#### Defined in - -[src/types/api/rpc.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L58) - ---- - -### TransactionExecutionStatus - -• `Const` **TransactionExecutionStatus**: typeof `TXN_EXECUTION_STATUS` = `TXN_EXECUTION_STATUS` - -#### Defined in - -[src/types/api/rpc.ts:59](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L59) diff --git a/www/docs/API/namespaces/types.Sequencer.md b/www/docs/API/namespaces/types.Sequencer.md deleted file mode 100644 index da93bbf1e..000000000 --- a/www/docs/API/namespaces/types.Sequencer.md +++ /dev/null @@ -1,824 +0,0 @@ ---- -id: 'types.Sequencer' -title: 'Namespace: Sequencer' -sidebar_label: 'Sequencer' -custom_edit_url: null ---- - -[types](types.md).Sequencer - -## Interfaces - -- [InvokeFunctionTransactionResponse](../interfaces/types.Sequencer.InvokeFunctionTransactionResponse.md) - -## References - -### GetTransactionStatusResponse - -Re-exports [GetTransactionStatusResponse](types.md#gettransactionstatusresponse) - ---- - -### GetContractAddressesResponse - -Re-exports [GetContractAddressesResponse](types.md#getcontractaddressesresponse) - ---- - -### FunctionInvocation - -Re-exports [FunctionInvocation](types.md#functioninvocation) - ---- - -### ExecutionResources - -Re-exports [ExecutionResources](types.md#executionresources) - ---- - -### CallL1Handler - -Re-exports [CallL1Handler](types.md#calll1handler) - ---- - -### DeployedContractItem - -Re-exports [DeployedContractItem](types.md#deployedcontractitem) - ---- - -### SequencerIdentifier - -Re-exports [SequencerIdentifier](types.md#sequenceridentifier) - -## Type Aliases - -### TransactionTraceResponse - -Ƭ **TransactionTraceResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------------- | :-------------------------------------------------- | -| `validate_invocation?` | [`FunctionInvocation`](types.md#functioninvocation) | -| `function_invocation?` | [`FunctionInvocation`](types.md#functioninvocation) | -| `fee_transfer_invocation?` | [`FunctionInvocation`](types.md#functioninvocation) | -| `constructor_invocation?` | [`FunctionInvocation`](types.md#functioninvocation) | -| `signature` | `string`[] | - -#### Defined in - -[src/types/api/sequencer.ts:81](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L81) - ---- - -### DeclareTransaction - -Ƭ **DeclareTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :----------------------------------------------------- | -| `type` | [`DECLARE`](../enums/types.TransactionType.md#declare) | -| `sender_address` | `string` | -| `contract_class` | [`ContractClass`](types.md#contractclass) | -| `signature?` | `string`[] | -| `nonce` | [`BigNumberish`](types.md#bignumberish) | -| `max_fee?` | [`BigNumberish`](types.md#bignumberish) | -| `version?` | [`BigNumberish`](types.md#bignumberish) | -| `compiled_class_hash?` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:89](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L89) - ---- - -### DeployTransaction - -Ƭ **DeployTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :--------------------------------------------------- | -| `type` | [`DEPLOY`](../enums/types.TransactionType.md#deploy) | -| `contract_definition` | [`ContractClass`](types.md#contractclass) | -| `contract_address_salt` | [`BigNumberish`](types.md#bignumberish) | -| `constructor_calldata` | `string`[] | -| `nonce?` | [`BigNumberish`](types.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L100) - ---- - -### DeployAccountTransaction - -Ƭ **DeployAccountTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :------------------------------------------------------------------- | -| `type` | [`DEPLOY_ACCOUNT`](../enums/types.TransactionType.md#deploy_account) | -| `class_hash` | `string` | -| `contract_address_salt` | [`BigNumberish`](types.md#bignumberish) | -| `constructor_calldata` | `string`[] | -| `signature?` | `string`[] | -| `max_fee?` | [`BigNumberish`](types.md#bignumberish) | -| `version?` | [`BigNumberish`](types.md#bignumberish) | -| `nonce?` | [`BigNumberish`](types.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:108](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L108) - ---- - -### InvokeFunctionTransaction - -Ƭ **InvokeFunctionTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------------------------------------------------------ | -| `type` | [`INVOKE`](../enums/types.TransactionType.md#invoke) | -| `sender_address` | `string` | -| `signature?` | `string`[] | -| `entry_point_type?` | [`EXTERNAL`](../enums/types.EntryPointType.md#external) | -| `calldata?` | [`RawCalldata`](types.md#rawcalldata) | -| `nonce` | [`BigNumberish`](types.md#bignumberish) | -| `max_fee?` | [`BigNumberish`](types.md#bignumberish) | -| `version?` | [`BigNumberish`](types.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:119](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L119) - ---- - -### Transaction - -Ƭ **Transaction**: [`DeclareTransaction`](types.Sequencer.md#declaretransaction) \| [`DeployTransaction`](types.Sequencer.md#deploytransaction) \| [`InvokeFunctionTransaction`](types.Sequencer.md#invokefunctiontransaction) \| [`DeployAccountTransaction`](types.Sequencer.md#deployaccounttransaction) - -#### Defined in - -[src/types/api/sequencer.ts:130](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L130) - ---- - -### AddTransactionResponse - -Ƭ **AddTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :----------------------- | -| `transaction_hash` | `string` | -| `code?` | `"TRANSACTION_RECEIVED"` | -| `address?` | `string` | -| `class_hash?` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:136](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L136) - ---- - -### GetCodeResponse - -Ƭ **GetCodeResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :------------------------------ | -| `bytecode` | [`ByteCode`](types.md#bytecode) | -| `abi` | [`Abi`](types.md#abi) | - -#### Defined in - -[src/types/api/sequencer.ts:143](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L143) - ---- - -### TransactionResponse - -Ƭ **TransactionResponse**: [`DeclareTransaction`](types.Sequencer.md#declaretransaction) \| [`DeployTransaction`](types.Sequencer.md#deploytransaction) \| [`InvokeFunctionTransactionResponse`](../interfaces/types.Sequencer.InvokeFunctionTransactionResponse.md) - -#### Defined in - -[src/types/api/sequencer.ts:153](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L153) - ---- - -### SuccessfulTransactionResponse - -Ƭ **SuccessfulTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------------------------------------------------------------------------- | -| `execution_status` | [`SUCCEEDED`](../enums/types.TransactionExecutionStatus.md#succeeded) | -| `finality_status` | [`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) | -| `status` | [`TransactionStatus`](../enums/types.TransactionStatus.md) | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](types.md#blocknumber) | -| `transaction_index` | `number` | -| `transaction` | [`TransactionResponse`](types.Sequencer.md#transactionresponse) | - -#### Defined in - -[src/types/api/sequencer.ts:158](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L158) - ---- - -### RevertedTransactionResponse - -Ƭ **RevertedTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------------------------------------------------------------------------- | -| `execution_status` | [`REVERTED`](../enums/types.TransactionExecutionStatus.md#reverted) | -| `finality_status` | [`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) | -| `status` | [`TransactionStatus`](../enums/types.TransactionStatus.md) | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](types.md#blocknumber) | -| `transaction_index` | `number` | -| `transaction` | [`TransactionResponse`](types.Sequencer.md#transactionresponse) | -| `revert_error` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:168](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L168) - ---- - -### FailedTransactionResponse - -Ƭ **FailedTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :-------------------------------------------------------------- | -| `status` | [`REJECTED`](../enums/types.TransactionStatus.md#rejected) | -| `transaction_failure_reason` | { `code`: `string` ; `error_message`: `string` } | -| `transaction_failure_reason.code` | `string` | -| `transaction_failure_reason.error_message` | `string` | -| `transaction` | [`TransactionResponse`](types.Sequencer.md#transactionresponse) | - -#### Defined in - -[src/types/api/sequencer.ts:179](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L179) - ---- - -### GetTransactionResponse - -Ƭ **GetTransactionResponse**: [`SuccessfulTransactionResponse`](types.Sequencer.md#successfultransactionresponse) \| [`RevertedTransactionResponse`](types.Sequencer.md#revertedtransactionresponse) \| [`FailedTransactionResponse`](types.Sequencer.md#failedtransactionresponse) - -#### Defined in - -[src/types/api/sequencer.ts:188](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L188) - ---- - -### TransactionReceiptResponse - -Ƭ **TransactionReceiptResponse**: [`SuccessfulTransactionReceiptResponse`](types.Sequencer.md#successfultransactionreceiptresponse) \| [`RevertedTransactionReceiptResponse`](types.Sequencer.md#revertedtransactionreceiptresponse) \| [`RejectedTransactionReceiptResponse`](types.Sequencer.md#rejectedtransactionreceiptresponse) - -#### Defined in - -[src/types/api/sequencer.ts:193](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L193) - ---- - -### SuccessfulTransactionReceiptResponse - -Ƭ **SuccessfulTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :------------------------------------------------------------------------- | -| `execution_status` | [`SUCCEEDED`](../enums/types.TransactionExecutionStatus.md#succeeded) | -| `finality_status` | [`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) | -| `status` | [`TransactionStatus`](../enums/types.TransactionStatus.md) | -| `actual_fee` | `string` | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](types.md#blocknumber) | -| `transaction_hash` | `string` | -| `transaction_index` | `number` | -| `l2_to_l1_messages` | `string`[] | -| `events` | `string`[] | -| `execution_resources?` | [`ExecutionResources`](types.md#executionresources) | - -#### Defined in - -[src/types/api/sequencer.ts:198](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L198) - ---- - -### RevertedTransactionReceiptResponse - -Ƭ **RevertedTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------------------------------------------------------------------------- | -| `execution_status` | [`REVERTED`](../enums/types.TransactionExecutionStatus.md#reverted) | -| `finality_status` | [`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) | -| `status` | [`REVERTED`](../enums/types.TransactionStatus.md#reverted) | -| `actual_fee` | `string` | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](types.md#blocknumber) | -| `transaction_hash` | `string` | -| `transaction_index` | `number` | -| `l2_to_l1_messages` | `string`[] | -| `events` | `string`[] | -| `revert_error` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:212](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L212) - ---- - -### RejectedTransactionReceiptResponse - -Ƭ **RejectedTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :------------------------------------------------------------------------- | -| `execution_status` | [`REJECTED`](../enums/types.TransactionExecutionStatus.md#rejected) | -| `finality_status` | [`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) | -| `status` | [`REJECTED`](../enums/types.TransactionStatus.md#rejected) | -| `transaction_hash` | `string` | -| `l2_to_l1_messages` | `string`[] | -| `events` | `string`[] | -| `transaction_failure_reason` | { `code`: `string` ; `error_message`: `string` } | -| `transaction_failure_reason.code` | `string` | -| `transaction_failure_reason.error_message` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:226](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L226) - ---- - -### GetBlockResponse - -Ƭ **GetBlockResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `block_number` | `number` | -| `state_root` | `string` | -| `block_hash` | `string` | -| `transactions` | { `[txHash: string]`: [`TransactionResponse`](types.Sequencer.md#transactionresponse); } | -| `timestamp` | `number` | -| `transaction_receipts` | { `[txHash: string]`: { `block_hash`: `string` ; `transaction_hash`: `string` ; `l2_to_l1_messages`: { `to_address`: `string` ; `payload`: `string`[] ; `from_address`: `string` }[] ; `block_number`: [`BlockNumber`](types.md#blocknumber) ; `status`: [`TransactionStatus`](../enums/types.TransactionStatus.md) ; `transaction_index`: `number` }; } | -| `parent_block_hash` | `string` | -| `status` | [`BlockStatus`](../enums/types.BlockStatus.md) | -| `gas_price` | `string` | -| `sequencer_address` | `string` | -| `starknet_version` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:239](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L239) - ---- - -### CallContractTransaction - -Ƭ **CallContractTransaction**: { `calldata?`: [`RawCalldata`](types.md#rawcalldata) ; `max_fee?`: [`BigNumberish`](types.md#bignumberish) ; `version?`: [`BigNumberish`](types.md#bignumberish) ; `entry_point_selector`: `string` } & { `sender_address`: `string` ; `signature`: `string`[] } \| { `contract_address`: `string` ; `signature?`: `never` } - -#### Defined in - -[src/types/api/sequencer.ts:268](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L268) - ---- - -### CallContractResponse - -Ƭ **CallContractResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------- | -| `result` | `string`[] | - -#### Defined in - -[src/types/api/sequencer.ts:284](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L284) - ---- - -### InvokeEstimateFee - -Ƭ **InvokeEstimateFee**: `Omit`<[`InvokeFunctionTransaction`](types.Sequencer.md#invokefunctiontransaction), `"max_fee"` \| `"entry_point_type"`\> - -#### Defined in - -[src/types/api/sequencer.ts:288](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L288) - ---- - -### DeclareEstimateFee - -Ƭ **DeclareEstimateFee**: `Omit`<[`DeclareTransaction`](types.Sequencer.md#declaretransaction), `"max_fee"`\> - -#### Defined in - -[src/types/api/sequencer.ts:289](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L289) - ---- - -### DeployAccountEstimateFee - -Ƭ **DeployAccountEstimateFee**: `Omit`<[`DeployAccountTransaction`](types.Sequencer.md#deployaccounttransaction), `"max_fee"`\> - -#### Defined in - -[src/types/api/sequencer.ts:290](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L290) - ---- - -### DeployEstimateFee - -Ƭ **DeployEstimateFee**: [`DeployTransaction`](types.Sequencer.md#deploytransaction) - -#### Defined in - -[src/types/api/sequencer.ts:291](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L291) - ---- - -### SimulateTransactionResponse - -Ƭ **SimulateTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------- | :------------------------------------------------------------------------ | -| `trace` | [`TransactionTraceResponse`](types.Sequencer.md#transactiontraceresponse) | -| `fee_estimation` | [`EstimateFeeResponse`](types.Sequencer.md#estimatefeeresponse) | - -#### Defined in - -[src/types/api/sequencer.ts:293](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L293) - ---- - -### AccountTransactionItem - -Ƭ **AccountTransactionItem**: [`InvokeEstimateFee`](types.Sequencer.md#invokeestimatefee) \| [`DeclareEstimateFee`](types.Sequencer.md#declareestimatefee) \| [`DeployEstimateFee`](types.Sequencer.md#deployestimatefee) \| [`DeployAccountEstimateFee`](types.Sequencer.md#deployaccountestimatefee) - -#### Defined in - -[src/types/api/sequencer.ts:298](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L298) - ---- - -### AccountTransaction - -Ƭ **AccountTransaction**: [`AllowArray`](types.md#allowarray)<[`AccountTransactionItem`](types.Sequencer.md#accounttransactionitem)\> - -Transaction filled with account data - -#### Defined in - -[src/types/api/sequencer.ts:307](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L307) - ---- - -### EstimateFeeResponse - -Ƭ **EstimateFeeResponse**: { `overall_fee`: `number` ; `gas_price`: `number` ; `gas_usage`: `number` ; `uint`: `string` } \| { `amount`: `bigint` ; `unit`: `string` } - -#### Defined in - -[src/types/api/sequencer.ts:310](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L310) - ---- - -### EstimateFeeResponseBulk - -Ƭ **EstimateFeeResponseBulk**: [`AllowArray`](types.md#allowarray)<[`EstimateFeeResponse`](types.Sequencer.md#estimatefeeresponse)\> - -#### Defined in - -[src/types/api/sequencer.ts:322](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L322) - ---- - -### BlockTransactionTracesResponse - -Ƭ **BlockTransactionTracesResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :------------------------------------------------------------------------------------------------------------- | -| `traces` | [`TransactionTraceResponse`](types.Sequencer.md#transactiontraceresponse) & { `transaction_hash`: `string` }[] | - -#### Defined in - -[src/types/api/sequencer.ts:324](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L324) - ---- - -### Storage - -Ƭ **Storage**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:328](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L328) - ---- - -### StateUpdateResponse - -Ƭ **StateUpdateResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `block_hash` | `string` | -| `new_root` | `string` | -| `old_root` | `string` | -| `state_diff` | { `storage_diffs`: [`StorageDiffs`](types.Sequencer.md#storagediffs) ; `nonces`: [`Nonces`](types.Sequencer.md#nonces) ; `deployed_contracts`: [`DeployedContractItem`](types.md#deployedcontractitem)[] ; `old_declared_contracts`: [`OldDeclaredContracts`](types.Sequencer.md#olddeclaredcontracts) ; `declared_classes`: [`DeclaredClasses`](types.Sequencer.md#declaredclasses) ; `replaced_classes`: [`ReplacedClasses`](types.Sequencer.md#replacedclasses) } | -| `state_diff.storage_diffs` | [`StorageDiffs`](types.Sequencer.md#storagediffs) | -| `state_diff.nonces` | [`Nonces`](types.Sequencer.md#nonces) | -| `state_diff.deployed_contracts` | [`DeployedContractItem`](types.md#deployedcontractitem)[] | -| `state_diff.old_declared_contracts` | [`OldDeclaredContracts`](types.Sequencer.md#olddeclaredcontracts) | -| `state_diff.declared_classes` | [`DeclaredClasses`](types.Sequencer.md#declaredclasses) | -| `state_diff.replaced_classes` | [`ReplacedClasses`](types.Sequencer.md#replacedclasses) | - -#### Defined in - -[src/types/api/sequencer.ts:330](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L330) - ---- - -### StorageDiffs - -Ƭ **StorageDiffs**: `Object` - -#### Index signature - -▪ [address: `string`]: [`StateDiffItem`](types.Sequencer.md#statediffitem)[] - -#### Defined in - -[src/types/api/sequencer.ts:344](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L344) - ---- - -### StateDiffItem - -Ƭ **StateDiffItem**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------- | -| `key` | `string` | -| `value` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:346](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L346) - ---- - -### Nonces - -Ƭ **Nonces**: `Object` - -#### Index signature - -▪ [address: `string`]: [`Nonce`](types.Sequencer.md#nonce) - -#### Defined in - -[src/types/api/sequencer.ts:348](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L348) - ---- - -### Nonce - -Ƭ **Nonce**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:350](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L350) - ---- - -### DeployedContracts - -Ƭ **DeployedContracts**: [`DeployedContractItem`](types.md#deployedcontractitem)[] - -#### Defined in - -[src/types/api/sequencer.ts:352](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L352) - ---- - -### OldDeclaredContracts - -Ƭ **OldDeclaredContracts**: `string`[] - -#### Defined in - -[src/types/api/sequencer.ts:354](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L354) - ---- - -### DeclaredClasses - -Ƭ **DeclaredClasses**: [`DeclaredClass`](types.Sequencer.md#declaredclass)[] - -#### Defined in - -[src/types/api/sequencer.ts:356](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L356) - ---- - -### DeclaredClass - -Ƭ **DeclaredClass**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `class_hash` | `string` | -| `compiled_class_hash` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:358](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L358) - ---- - -### ReplacedClasses - -Ƭ **ReplacedClasses**: `string`[] - -#### Defined in - -[src/types/api/sequencer.ts:360](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L360) - ---- - -### Endpoints - -Ƭ **Endpoints**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `get_contract_addresses` | { `QUERY`: `never` ; `REQUEST`: `never` ; `RESPONSE`: [`GetContractAddressesResponse`](types.md#getcontractaddressesresponse) } | -| `get_contract_addresses.QUERY` | `never` | -| `get_contract_addresses.REQUEST` | `never` | -| `get_contract_addresses.RESPONSE` | [`GetContractAddressesResponse`](types.md#getcontractaddressesresponse) | -| `add_transaction` | { `QUERY`: `never` ; `REQUEST`: [`Transaction`](types.Sequencer.md#transaction) ; `RESPONSE`: [`AddTransactionResponse`](types.Sequencer.md#addtransactionresponse) } | -| `add_transaction.QUERY` | `never` | -| `add_transaction.REQUEST` | [`Transaction`](types.Sequencer.md#transaction) | -| `add_transaction.RESPONSE` | [`AddTransactionResponse`](types.Sequencer.md#addtransactionresponse) | -| `get_transaction` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetTransactionResponse`](types.Sequencer.md#gettransactionresponse) } | -| `get_transaction.QUERY` | { `transactionHash`: `string` } | -| `get_transaction.QUERY.transactionHash` | `string` | -| `get_transaction.REQUEST` | `never` | -| `get_transaction.RESPONSE` | [`GetTransactionResponse`](types.Sequencer.md#gettransactionresponse) | -| `get_transaction_status` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetTransactionStatusResponse`](types.md#gettransactionstatusresponse) } | -| `get_transaction_status.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_status.QUERY.transactionHash` | `string` | -| `get_transaction_status.REQUEST` | `never` | -| `get_transaction_status.RESPONSE` | [`GetTransactionStatusResponse`](types.md#gettransactionstatusresponse) | -| `get_transaction_trace` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`TransactionTraceResponse`](types.Sequencer.md#transactiontraceresponse) } | -| `get_transaction_trace.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_trace.QUERY.transactionHash` | `string` | -| `get_transaction_trace.REQUEST` | `never` | -| `get_transaction_trace.RESPONSE` | [`TransactionTraceResponse`](types.Sequencer.md#transactiontraceresponse) | -| `get_transaction_receipt` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`TransactionReceiptResponse`](types.Sequencer.md#transactionreceiptresponse) } | -| `get_transaction_receipt.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_receipt.QUERY.transactionHash` | `string` | -| `get_transaction_receipt.REQUEST` | `never` | -| `get_transaction_receipt.RESPONSE` | [`TransactionReceiptResponse`](types.Sequencer.md#transactionreceiptresponse) | -| `get_nonce` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } ; `REQUEST`: `never` ; `RESPONSE`: [`Nonce`](types.Sequencer.md#nonce) } | -| `get_nonce.QUERY` | { `contractAddress`: `string` ; `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } | -| `get_nonce.QUERY.contractAddress` | `string` | -| `get_nonce.QUERY.blockIdentifier` | [`BlockIdentifier`](types.md#blockidentifier) | -| `get_nonce.REQUEST` | `never` | -| `get_nonce.RESPONSE` | [`Nonce`](types.Sequencer.md#nonce) | -| `get_storage_at` | { `QUERY`: { `contractAddress`: `string` ; `key`: [`BigNumberish`](types.md#bignumberish) ; `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } ; `REQUEST`: `never` ; `RESPONSE`: [`Storage`](types.Sequencer.md#storage) } | -| `get_storage_at.QUERY` | { `contractAddress`: `string` ; `key`: [`BigNumberish`](types.md#bignumberish) ; `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } | -| `get_storage_at.QUERY.contractAddress` | `string` | -| `get_storage_at.QUERY.key` | [`BigNumberish`](types.md#bignumberish) | -| `get_storage_at.QUERY.blockIdentifier` | [`BlockIdentifier`](types.md#blockidentifier) | -| `get_storage_at.REQUEST` | `never` | -| `get_storage_at.RESPONSE` | [`Storage`](types.Sequencer.md#storage) | -| `get_code` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } ; `REQUEST`: `never` ; `RESPONSE`: [`GetCodeResponse`](types.Sequencer.md#getcoderesponse) } | -| `get_code.QUERY` | { `contractAddress`: `string` ; `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } | -| `get_code.QUERY.contractAddress` | `string` | -| `get_code.QUERY.blockIdentifier` | [`BlockIdentifier`](types.md#blockidentifier) | -| `get_code.REQUEST` | `never` | -| `get_code.RESPONSE` | [`GetCodeResponse`](types.Sequencer.md#getcoderesponse) | -| `get_block` | { `QUERY`: { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } ; `REQUEST`: `never` ; `RESPONSE`: [`GetBlockResponse`](types.Sequencer.md#getblockresponse) } | -| `get_block.QUERY` | { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } | -| `get_block.QUERY.blockIdentifier` | [`BlockIdentifier`](types.md#blockidentifier) | -| `get_block.REQUEST` | `never` | -| `get_block.RESPONSE` | [`GetBlockResponse`](types.Sequencer.md#getblockresponse) | -| `call_contract` | { `QUERY`: { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } ; `REQUEST`: [`CallContractTransaction`](types.Sequencer.md#callcontracttransaction) ; `RESPONSE`: [`CallContractResponse`](types.Sequencer.md#callcontractresponse) } | -| `call_contract.QUERY` | { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) } | -| `call_contract.QUERY.blockIdentifier` | [`BlockIdentifier`](types.md#blockidentifier) | -| `call_contract.REQUEST` | [`CallContractTransaction`](types.Sequencer.md#callcontracttransaction) | -| `call_contract.RESPONSE` | [`CallContractResponse`](types.Sequencer.md#callcontractresponse) | -| `estimate_fee` | { `QUERY`: { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) ; `skipValidate`: `boolean` } ; `REQUEST`: [`AccountTransactionItem`](types.Sequencer.md#accounttransactionitem) ; `RESPONSE`: [`EstimateFeeResponse`](types.Sequencer.md#estimatefeeresponse) } | -| `estimate_fee.QUERY` | { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) ; `skipValidate`: `boolean` } | -| `estimate_fee.QUERY.blockIdentifier` | [`BlockIdentifier`](types.md#blockidentifier) | -| `estimate_fee.QUERY.skipValidate` | `boolean` | -| `estimate_fee.REQUEST` | [`AccountTransactionItem`](types.Sequencer.md#accounttransactionitem) | -| `estimate_fee.RESPONSE` | [`EstimateFeeResponse`](types.Sequencer.md#estimatefeeresponse) | -| `get_class_by_hash` | { `QUERY`: { `classHash`: `string` ; `blockIdentifier?`: [`BlockIdentifier`](types.md#blockidentifier) } ; `REQUEST`: `never` ; `RESPONSE`: [`CompiledContract`](types.md#compiledcontract) } | -| `get_class_by_hash.QUERY` | { `classHash`: `string` ; `blockIdentifier?`: [`BlockIdentifier`](types.md#blockidentifier) } | -| `get_class_by_hash.QUERY.classHash` | `string` | -| `get_class_by_hash.QUERY.blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `get_class_by_hash.REQUEST` | `never` | -| `get_class_by_hash.RESPONSE` | [`CompiledContract`](types.md#compiledcontract) | -| `get_class_hash_at` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier?`: [`BlockIdentifier`](types.md#blockidentifier) } ; `REQUEST`: `never` ; `RESPONSE`: `string` } | -| `get_class_hash_at.QUERY` | { `contractAddress`: `string` ; `blockIdentifier?`: [`BlockIdentifier`](types.md#blockidentifier) } | -| `get_class_hash_at.QUERY.contractAddress` | `string` | -| `get_class_hash_at.QUERY.blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `get_class_hash_at.REQUEST` | `never` | -| `get_class_hash_at.RESPONSE` | `string` | -| `get_state_update` | { `QUERY`: { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](types.md#blocknumber) } ; `REQUEST`: `never` ; `RESPONSE`: [`StateUpdateResponse`](types.Sequencer.md#stateupdateresponse) } | -| `get_state_update.QUERY` | { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](types.md#blocknumber) } | -| `get_state_update.QUERY.blockHash?` | `string` | -| `get_state_update.QUERY.blockNumber?` | [`BlockNumber`](types.md#blocknumber) | -| `get_state_update.REQUEST` | `never` | -| `get_state_update.RESPONSE` | [`StateUpdateResponse`](types.Sequencer.md#stateupdateresponse) | -| `get_full_contract` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier?`: [`BlockIdentifier`](types.md#blockidentifier) } ; `REQUEST`: `never` ; `RESPONSE`: [`CompiledContract`](types.md#compiledcontract) } | -| `get_full_contract.QUERY` | { `contractAddress`: `string` ; `blockIdentifier?`: [`BlockIdentifier`](types.md#blockidentifier) } | -| `get_full_contract.QUERY.contractAddress` | `string` | -| `get_full_contract.QUERY.blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `get_full_contract.REQUEST` | `never` | -| `get_full_contract.RESPONSE` | [`CompiledContract`](types.md#compiledcontract) | -| `estimate_message_fee` | { `QUERY`: `any` ; `REQUEST`: `any` ; `RESPONSE`: [`EstimateFeeResponse`](types.Sequencer.md#estimatefeeresponse) } | -| `estimate_message_fee.QUERY` | `any` | -| `estimate_message_fee.REQUEST` | `any` | -| `estimate_message_fee.RESPONSE` | [`EstimateFeeResponse`](types.Sequencer.md#estimatefeeresponse) | -| `simulate_transaction` | { `QUERY`: { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) ; `skipValidate`: `boolean` } ; `REQUEST`: [`AccountTransaction`](types.Sequencer.md#accounttransaction) ; `RESPONSE`: [`SimulateTransactionResponse`](types.Sequencer.md#simulatetransactionresponse) } | -| `simulate_transaction.QUERY` | { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) ; `skipValidate`: `boolean` } | -| `simulate_transaction.QUERY.blockIdentifier` | [`BlockIdentifier`](types.md#blockidentifier) | -| `simulate_transaction.QUERY.skipValidate` | `boolean` | -| `simulate_transaction.REQUEST` | [`AccountTransaction`](types.Sequencer.md#accounttransaction) | -| `simulate_transaction.RESPONSE` | [`SimulateTransactionResponse`](types.Sequencer.md#simulatetransactionresponse) | -| `estimate_fee_bulk` | { `QUERY`: { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) ; `skipValidate`: `boolean` } ; `REQUEST`: [`AccountTransaction`](types.Sequencer.md#accounttransaction) ; `RESPONSE`: [`EstimateFeeResponseBulk`](types.Sequencer.md#estimatefeeresponsebulk) } | -| `estimate_fee_bulk.QUERY` | { `blockIdentifier`: [`BlockIdentifier`](types.md#blockidentifier) ; `skipValidate`: `boolean` } | -| `estimate_fee_bulk.QUERY.blockIdentifier` | [`BlockIdentifier`](types.md#blockidentifier) | -| `estimate_fee_bulk.QUERY.skipValidate` | `boolean` | -| `estimate_fee_bulk.REQUEST` | [`AccountTransaction`](types.Sequencer.md#accounttransaction) | -| `estimate_fee_bulk.RESPONSE` | [`EstimateFeeResponseBulk`](types.Sequencer.md#estimatefeeresponsebulk) | -| `get_block_traces` | { `QUERY`: { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](types.md#blocknumber) } ; `REQUEST`: `never` ; `RESPONSE`: [`BlockTransactionTracesResponse`](types.Sequencer.md#blocktransactiontracesresponse) } | -| `get_block_traces.QUERY` | { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](types.md#blocknumber) } | -| `get_block_traces.QUERY.blockHash?` | `string` | -| `get_block_traces.QUERY.blockNumber?` | [`BlockNumber`](types.md#blocknumber) | -| `get_block_traces.REQUEST` | `never` | -| `get_block_traces.RESPONSE` | [`BlockTransactionTracesResponse`](types.Sequencer.md#blocktransactiontracesresponse) | -| `get_compiled_class_by_class_hash` | { `QUERY`: { `classHash`: `string` ; `blockIdentifier?`: [`BlockIdentifier`](types.md#blockidentifier) } ; `REQUEST`: `any` ; `RESPONSE`: [`CairoAssembly`](types.md#cairoassembly) } | -| `get_compiled_class_by_class_hash.QUERY` | { `classHash`: `string` ; `blockIdentifier?`: [`BlockIdentifier`](types.md#blockidentifier) } | -| `get_compiled_class_by_class_hash.QUERY.classHash` | `string` | -| `get_compiled_class_by_class_hash.QUERY.blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `get_compiled_class_by_class_hash.REQUEST` | `any` | -| `get_compiled_class_by_class_hash.RESPONSE` | [`CairoAssembly`](types.md#cairoassembly) | - -#### Defined in - -[src/types/api/sequencer.ts:362](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L362) diff --git a/www/docs/API/namespaces/types.md b/www/docs/API/namespaces/types.md deleted file mode 100644 index 337d2eec8..000000000 --- a/www/docs/API/namespaces/types.md +++ /dev/null @@ -1,1818 +0,0 @@ ---- -id: 'types' -title: 'Namespace: types' -sidebar_label: 'types' -sidebar_position: 0 -custom_edit_url: null ---- - -## Namespaces - -- [RPC](types.RPC.md) -- [Sequencer](types.Sequencer.md) - -## Enumerations - -- [SIMULATION_FLAG](../enums/types.SIMULATION_FLAG.md) -- [ValidateType](../enums/types.ValidateType.md) -- [Uint](../enums/types.Uint.md) -- [Litteral](../enums/types.Litteral.md) -- [TransactionType](../enums/types.TransactionType.md) -- [TransactionStatus](../enums/types.TransactionStatus.md) -- [TransactionFinalityStatus](../enums/types.TransactionFinalityStatus.md) -- [TransactionExecutionStatus](../enums/types.TransactionExecutionStatus.md) -- [BlockStatus](../enums/types.BlockStatus.md) -- [BlockTag](../enums/types.BlockTag.md) -- [EntryPointType](../enums/types.EntryPointType.md) - -## Interfaces - -- [EstimateFee](../interfaces/types.EstimateFee.md) -- [EstimateFeeDetails](../interfaces/types.EstimateFeeDetails.md) -- [DeployContractResponse](../interfaces/types.DeployContractResponse.md) -- [Uint256](../interfaces/types.Uint256.md) -- [CallStruct](../interfaces/types.CallStruct.md) -- [Program](../interfaces/types.Program.md) -- [ProviderOptions](../interfaces/types.ProviderOptions.md) -- [GetBlockResponse](../interfaces/types.GetBlockResponse.md) -- [GetCodeResponse](../interfaces/types.GetCodeResponse.md) -- [ContractEntryPoint](../interfaces/types.ContractEntryPoint.md) -- [CommonTransactionResponse](../interfaces/types.CommonTransactionResponse.md) -- [InvokeTransactionResponse](../interfaces/types.InvokeTransactionResponse.md) -- [DeclareTransactionResponse](../interfaces/types.DeclareTransactionResponse.md) -- [MessageToL1](../interfaces/types.MessageToL1.md) -- [Event](../interfaces/types.Event.md) -- [MessageToL2](../interfaces/types.MessageToL2.md) -- [InvokeTransactionReceiptResponse](../interfaces/types.InvokeTransactionReceiptResponse.md) -- [EstimateFeeResponse](../interfaces/types.EstimateFeeResponse.md) -- [InvokeFunctionResponse](../interfaces/types.InvokeFunctionResponse.md) -- [DeclareContractResponse](../interfaces/types.DeclareContractResponse.md) -- [StateUpdateResponse](../interfaces/types.StateUpdateResponse.md) -- [InvocationsSignerDetails](../interfaces/types.InvocationsSignerDetails.md) -- [DeclareSignerDetails](../interfaces/types.DeclareSignerDetails.md) -- [StarkNetDomain](../interfaces/types.StarkNetDomain.md) -- [TypedData](../interfaces/types.TypedData.md) - -## Type Aliases - -### 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:66](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L66) - ---- - -### DeployedContractItem - -Ƭ **DeployedContractItem**: `Object` - -#### Type declaration - -| Name | Type | -| :----------- | :------- | -| `address` | `string` | -| `class_hash` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L73) - ---- - -### 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:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L53) - ---- - -### FunctionInvocation - -Ƭ **FunctionInvocation**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------------------------------------------------------ | -| `caller_address` | `string` | -| `contract_address` | `string` | -| `calldata` | [`RawCalldata`](types.md#rawcalldata) | -| `call_type?` | `string` | -| `class_hash?` | `string` | -| `selector?` | `string` | -| `entry_point_type?` | [`EXTERNAL`](../enums/types.EntryPointType.md#external) | -| `result` | `any`[] | -| `execution_resources` | [`ExecutionResources`](types.md#executionresources) | -| `internal_calls` | [`FunctionInvocation`](types.md#functioninvocation)[] | -| `events` | `any`[] | -| `messages` | `any`[] | - -#### Defined in - -[src/types/api/sequencer.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L38) - ---- - -### GetContractAddressesResponse - -Ƭ **GetContractAddressesResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :------- | -| `Starknet` | `string` | -| `GpsStatementVerifier` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L33) - ---- - -### GetTransactionStatusResponse - -Ƭ **GetTransactionStatusResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------- | :--------------------------------------------------------------------------- | -| `tx_status` | [`TransactionStatus`](../enums/types.TransactionStatus.md) | -| `execution_status` | [`TransactionExecutionStatus`](../enums/types.TransactionExecutionStatus.md) | -| `finality_status` | [`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) | -| `block_hash?` | `string` | -| `tx_failure_reason?` | { `code`: `string` ; `error_message`: `string` } | -| `tx_failure_reason.code` | `string` | -| `tx_failure_reason.error_message` | `string` | -| `tx_revert_reason?` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L21) - ---- - -### SequencerIdentifier - -Ƭ **SequencerIdentifier**: { `blockHash`: `string` } \| { `blockNumber`: [`BlockNumber`](types.md#blocknumber) } - -#### Defined in - -[src/types/api/sequencer.ts:78](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L78) - ---- - -### EstimateFeeBulk - -Ƭ **EstimateFeeBulk**: [`EstimateFee`](../interfaces/types.EstimateFee.md)[] - -#### Defined in - -[src/types/account.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L8) - ---- - -### AccountInvocationsFactoryDetails - -Ƭ **AccountInvocationsFactoryDetails**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :-------------------------------------------- | -| `versions` | `bigint`[] | -| `nonce?` | [`BigNumberish`](types.md#bignumberish) | -| `blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | - -#### Defined in - -[src/types/account.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L10) - ---- - -### MultiDeployContractResponse - -Ƭ **MultiDeployContractResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :--------- | -| `contract_address` | `string`[] | -| `transaction_hash` | `string` | - -#### Defined in - -[src/types/account.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L27) - ---- - -### 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](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L32) - ---- - -### DeclareDeployUDCResponse - -Ƭ **DeclareDeployUDCResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `declare` | { `class_hash`: [`BigNumberish`](types.md#bignumberish) } & `Partial`<[`DeclareTransactionReceiptResponse`](types.md#declaretransactionreceiptresponse)\> | -| `deploy` | [`DeployContractUDCResponse`](types.md#deploycontractudcresponse) | - -#### Defined in - -[src/types/account.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L44) - ---- - -### SimulateTransactionDetails - -Ƭ **SimulateTransactionDetails**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :-------------------------------------------- | -| `nonce?` | [`BigNumberish`](types.md#bignumberish) | -| `blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `skipValidate?` | `boolean` | -| `skipExecute?` | `boolean` | - -#### Defined in - -[src/types/account.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L51) - ---- - -### AsyncContractFunction - -Ƭ **AsyncContractFunction**<`T`\>: (...`args`: [`ArgsOrCalldataWithOptions`](types.md#argsorcalldatawithoptions)) => `Promise`<`T`\> - -#### Type parameters - -| Name | Type | -| :--- | :---- | -| `T` | `any` | - -#### Type declaration - -▸ (`...args`): `Promise`<`T`\> - -##### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------- | -| `...args` | [`ArgsOrCalldataWithOptions`](types.md#argsorcalldatawithoptions) | - -##### Returns - -`Promise`<`T`\> - -#### Defined in - -[src/types/contract.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L11) - ---- - -### ContractFunction - -Ƭ **ContractFunction**: (...`args`: [`ArgsOrCalldataWithOptions`](types.md#argsorcalldatawithoptions)) => `any` - -#### Type declaration - -▸ (`...args`): `any` - -##### Parameters - -| Name | Type | -| :-------- | :---------------------------------------------------------------- | -| `...args` | [`ArgsOrCalldataWithOptions`](types.md#argsorcalldatawithoptions) | - -##### Returns - -`any` - -#### Defined in - -[src/types/contract.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L12) - ---- - -### Result - -Ƭ **Result**: { `[key: string]`: `any`; } \| [`Result`](types.md#result)[] \| `bigint` \| `string` \| `boolean` \| [`CairoEnum`](types.md#cairoenum) - -#### Defined in - -[src/types/contract.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L14) - ---- - -### ArgsOrCalldata - -Ƭ **ArgsOrCalldata**: [`RawArgsArray`](types.md#rawargsarray) \| [[`Calldata`](types.md#calldata)] \| [`Calldata`](types.md#calldata) - -#### Defined in - -[src/types/contract.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L24) - ---- - -### ArgsOrCalldataWithOptions - -Ƭ **ArgsOrCalldataWithOptions**: [`ArgsOrCalldata`](types.md#argsorcalldata) & [`ContractOptions`](types.md#contractoptions) - -#### Defined in - -[src/types/contract.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L25) - ---- - -### ContractOptions - -Ƭ **ContractOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :-------------------------------------------- | -| `blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `parseRequest?` | `boolean` | -| `parseResponse?` | `boolean` | -| `formatResponse?` | { `[key: string]`: `any`; } | -| `maxFee?` | [`BigNumberish`](types.md#bignumberish) | -| `nonce?` | [`BigNumberish`](types.md#bignumberish) | -| `signature?` | [`Signature`](types.md#signature) | -| `addressSalt?` | `string` | - -#### Defined in - -[src/types/contract.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L26) - ---- - -### CallOptions - -Ƭ **CallOptions**: `Pick`<[`ContractOptions`](types.md#contractoptions), `"blockIdentifier"` \| `"parseRequest"` \| `"parseResponse"` \| `"formatResponse"`\> - -#### Defined in - -[src/types/contract.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L37) - ---- - -### InvokeOptions - -Ƭ **InvokeOptions**: `Pick`<[`ContractOptions`](types.md#contractoptions), `"maxFee"` \| `"nonce"` \| `"signature"` \| `"parseRequest"`\> - -#### Defined in - -[src/types/contract.ts:42](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L42) - ---- - -### ParsedEvent - -Ƭ **ParsedEvent**: `Object` - -#### Index signature - -▪ [name: `string`]: [`ParsedStruct`](types.md#parsedstruct) - -#### Defined in - -[src/types/contract.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L47) - ---- - -### ParsedEvents - -Ƭ **ParsedEvents**: [`ParsedEvent`](types.md#parsedevent)[] - -#### Defined in - -[src/types/contract.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/types/contract.ts#L49) - ---- - -### WeierstrassSignatureType - -Ƭ **WeierstrassSignatureType**: [`SignatureType`](../interfaces/ec.weierstrass.SignatureType.md) - -#### Defined in - -[src/types/lib/index.ts:6](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L6) - ---- - -### ArraySignatureType - -Ƭ **ArraySignatureType**: `string`[] - -#### Defined in - -[src/types/lib/index.ts:7](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L7) - ---- - -### Signature - -Ƭ **Signature**: [`ArraySignatureType`](types.md#arraysignaturetype) \| [`WeierstrassSignatureType`](types.md#weierstrasssignaturetype) - -#### Defined in - -[src/types/lib/index.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L8) - ---- - -### BigNumberish - -Ƭ **BigNumberish**: `string` \| `number` \| `bigint` - -#### Defined in - -[src/types/lib/index.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L10) - ---- - -### Calldata - -Ƭ **Calldata**: `string`[] & { `__compiled__?`: `boolean` } - -Compiled calldata ready to be sent -decimal-string array - -#### Defined in - -[src/types/lib/index.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L16) - ---- - -### RawCalldata - -Ƭ **RawCalldata**: [`BigNumberish`](types.md#bignumberish)[] - -BigNumberish array -use CallData.compile() to convert to Calldata - -#### Defined in - -[src/types/lib/index.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L32) - ---- - -### HexCalldata - -Ƭ **HexCalldata**: `string`[] - -Hexadecimal-string array - -#### Defined in - -[src/types/lib/index.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L37) - ---- - -### AllowArray - -Ƭ **AllowArray**<`T`\>: `T` \| `T`[] - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Defined in - -[src/types/lib/index.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L39) - ---- - -### OptionalPayload - -Ƭ **OptionalPayload**<`T`\>: { `payload`: `T` } \| `T` - -#### Type parameters - -| Name | -| :--- | -| `T` | - -#### Defined in - -[src/types/lib/index.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L41) - ---- - -### RawArgs - -Ƭ **RawArgs**: [`RawArgsObject`](types.md#rawargsobject) \| [`RawArgsArray`](types.md#rawargsarray) - -#### Defined in - -[src/types/lib/index.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L43) - ---- - -### RawArgsObject - -Ƭ **RawArgsObject**: `Object` - -#### Index signature - -▪ [inputName: `string`]: [`MultiType`](types.md#multitype) \| [`MultiType`](types.md#multitype)[] \| [`RawArgs`](types.md#rawargs) - -#### Defined in - -[src/types/lib/index.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L45) - ---- - -### RawArgsArray - -Ƭ **RawArgsArray**: ([`MultiType`](types.md#multitype) \| [`MultiType`](types.md#multitype)[] \| [`RawArgs`](types.md#rawargs))[] - -#### Defined in - -[src/types/lib/index.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L49) - ---- - -### MultiType - -Ƭ **MultiType**: [`BigNumberish`](types.md#bignumberish) \| [`Uint256`](../interfaces/types.Uint256.md) \| `object` \| `boolean` \| [`CairoEnum`](types.md#cairoenum) - -#### Defined in - -[src/types/lib/index.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L51) - ---- - -### UniversalDeployerContractPayload - -Ƭ **UniversalDeployerContractPayload**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :-------------------------------------- | -| `classHash` | [`BigNumberish`](types.md#bignumberish) | -| `salt?` | `string` | -| `unique?` | `boolean` | -| `constructorCalldata?` | [`RawArgs`](types.md#rawargs) | - -#### Defined in - -[src/types/lib/index.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L53) - ---- - -### DeployAccountContractPayload - -Ƭ **DeployAccountContractPayload**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :-------------------------------------- | -| `classHash` | `string` | -| `constructorCalldata?` | [`RawArgs`](types.md#rawargs) | -| `addressSalt?` | [`BigNumberish`](types.md#bignumberish) | -| `contractAddress?` | `string` | - -#### Defined in - -[src/types/lib/index.ts:60](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L60) - ---- - -### DeployAccountContractTransaction - -Ƭ **DeployAccountContractTransaction**: `Omit`<[`DeployAccountContractPayload`](types.md#deployaccountcontractpayload), `"contractAddress"`\> & { `signature?`: [`Signature`](types.md#signature) } - -#### Defined in - -[src/types/lib/index.ts:67](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L67) - ---- - -### DeclareContractPayload - -Ƭ **DeclareContractPayload**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `contract` | [`CompiledContract`](types.md#compiledcontract) \| `string` | -| `classHash?` | `string` | -| `casm?` | [`CompiledSierraCasm`](types.md#compiledsierracasm) | -| `compiledClassHash?` | `string` | - -#### Defined in - -[src/types/lib/index.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L74) - ---- - -### CompleteDeclareContractPayload - -Ƭ **CompleteDeclareContractPayload**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :---------------------------------------------------------- | -| `contract` | [`CompiledContract`](types.md#compiledcontract) \| `string` | -| `classHash` | `string` | -| `casm?` | [`CompiledSierraCasm`](types.md#compiledsierracasm) | -| `compiledClassHash?` | `string` | - -#### Defined in - -[src/types/lib/index.ts:81](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L81) - ---- - -### DeclareAndDeployContractPayload - -Ƭ **DeclareAndDeployContractPayload**: `Omit`<[`UniversalDeployerContractPayload`](types.md#universaldeployercontractpayload), `"classHash"`\> & [`DeclareContractPayload`](types.md#declarecontractpayload) - -#### Defined in - -[src/types/lib/index.ts:88](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L88) - ---- - -### DeclareContractTransaction - -Ƭ **DeclareContractTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :---------------------------------------- | -| `contract` | [`ContractClass`](types.md#contractclass) | -| `senderAddress` | `string` | -| `signature?` | [`Signature`](types.md#signature) | -| `compiledClassHash?` | `string` | - -#### Defined in - -[src/types/lib/index.ts:91](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L91) - ---- - -### CallDetails - -Ƭ **CallDetails**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------- | :--------------------------------------------------------------- | -| `contractAddress` | `string` | -| `calldata?` | [`RawArgs`](types.md#rawargs) \| [`Calldata`](types.md#calldata) | -| `entrypoint?` | `string` | - -#### Defined in - -[src/types/lib/index.ts:98](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L98) - ---- - -### Invocation - -Ƭ **Invocation**: [`CallDetails`](types.md#calldetails) & { `signature?`: [`Signature`](types.md#signature) } - -#### Defined in - -[src/types/lib/index.ts:104](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L104) - ---- - -### Call - -Ƭ **Call**: [`CallDetails`](types.md#calldetails) & { `entrypoint`: `string` } - -#### Defined in - -[src/types/lib/index.ts:106](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L106) - ---- - -### CairoVersion - -Ƭ **CairoVersion**: `"0"` \| `"1"` \| `undefined` - -#### Defined in - -[src/types/lib/index.ts:108](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L108) - ---- - -### CompilerVersion - -Ƭ **CompilerVersion**: `"0"` \| `"1"` \| `"2"` \| `undefined` - -#### Defined in - -[src/types/lib/index.ts:109](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L109) - ---- - -### InvocationsDetails - -Ƭ **InvocationsDetails**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :-------------------------------------- | -| `nonce?` | [`BigNumberish`](types.md#bignumberish) | -| `maxFee?` | [`BigNumberish`](types.md#bignumberish) | -| `version?` | [`BigNumberish`](types.md#bignumberish) | - -#### Defined in - -[src/types/lib/index.ts:111](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L111) - ---- - -### Details - -Ƭ **Details**: `Object` - -Contain all additional details params - -#### Type declaration - -| Name | Type | -| :-------- | :--------------------------------------------------------- | -| `nonce` | [`BigNumberish`](types.md#bignumberish) | -| `maxFee` | [`BigNumberish`](types.md#bignumberish) | -| `version` | [`BigNumberish`](types.md#bignumberish) | -| `chainId` | [`StarknetChainId`](../enums/constants.StarknetChainId.md) | - -#### Defined in - -[src/types/lib/index.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L120) - ---- - -### InvocationsDetailsWithNonce - -Ƭ **InvocationsDetailsWithNonce**: [`InvocationsDetails`](types.md#invocationsdetails) & { `nonce`: [`BigNumberish`](types.md#bignumberish) } - -#### Defined in - -[src/types/lib/index.ts:127](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L127) - ---- - -### BlockNumber - -Ƭ **BlockNumber**: [`BlockTag`](../enums/types.BlockTag.md) \| `null` \| `number` - -#### Defined in - -[src/types/lib/index.ts:176](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L176) - ---- - -### BlockIdentifier - -Ƭ **BlockIdentifier**: [`BlockNumber`](types.md#blocknumber) \| [`BigNumberish`](types.md#bignumberish) - -hex string and BN are detected as block hashes -decimal string and number are detected as block numbers -null appends nothing to the request url - -#### Defined in - -[src/types/lib/index.ts:183](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L183) - ---- - -### AccountInvocationItem - -Ƭ **AccountInvocationItem**: { `type`: [`DECLARE`](../enums/types.TransactionType.md#declare) } & [`DeclareContractTransaction`](types.md#declarecontracttransaction) \| { `type`: [`DEPLOY_ACCOUNT`](../enums/types.TransactionType.md#deploy_account) } & [`DeployAccountContractTransaction`](types.md#deployaccountcontracttransaction) \| { `type`: [`INVOKE`](../enums/types.TransactionType.md#invoke) } & [`Invocation`](types.md#invocation) & [`InvocationsDetailsWithNonce`](types.md#invocationsdetailswithnonce) - -items used by AccountInvocations - -#### Defined in - -[src/types/lib/index.ts:188](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L188) - ---- - -### AccountInvocations - -Ƭ **AccountInvocations**: [`AccountInvocationItem`](types.md#accountinvocationitem)[] - -Complete invocations array with account details (internal type from account -> provider) - -#### Defined in - -[src/types/lib/index.ts:198](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L198) - ---- - -### Invocations - -Ƭ **Invocations**: ({ `type`: [`DECLARE`](../enums/types.TransactionType.md#declare) } & [`OptionalPayload`](types.md#optionalpayload)<[`DeclareContractPayload`](types.md#declarecontractpayload)\> \| { `type`: [`DEPLOY`](../enums/types.TransactionType.md#deploy) } & [`OptionalPayload`](types.md#optionalpayload)<[`AllowArray`](types.md#allowarray)<[`UniversalDeployerContractPayload`](types.md#universaldeployercontractpayload)\>\> \| { `type`: [`DEPLOY_ACCOUNT`](../enums/types.TransactionType.md#deploy_account) } & [`OptionalPayload`](types.md#optionalpayload)<[`DeployAccountContractPayload`](types.md#deployaccountcontractpayload)\> \| { `type`: [`INVOKE`](../enums/types.TransactionType.md#invoke) } & [`OptionalPayload`](types.md#optionalpayload)<[`AllowArray`](types.md#allowarray)<[`Call`](types.md#call)\>\>)[] - -Invocations array user provide to bulk method (simulate) - -#### Defined in - -[src/types/lib/index.ts:203](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L203) - ---- - -### Tupled - -Ƭ **Tupled**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------- | -| `element` | `any` | -| `type` | `string` | - -#### Defined in - -[src/types/lib/index.ts:212](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L212) - ---- - -### Args - -Ƭ **Args**: `Object` - -#### Index signature - -▪ [inputName: `string`]: [`BigNumberish`](types.md#bignumberish) \| [`BigNumberish`](types.md#bignumberish)[] \| [`ParsedStruct`](types.md#parsedstruct) \| [`ParsedStruct`](types.md#parsedstruct)[] - -#### Defined in - -[src/types/lib/index.ts:214](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L214) - ---- - -### ParsedStruct - -Ƭ **ParsedStruct**: `Object` - -#### Index signature - -▪ [key: `string`]: [`BigNumberish`](types.md#bignumberish) \| [`BigNumberish`](types.md#bignumberish)[] \| [`ParsedStruct`](types.md#parsedstruct) \| [`Uint256`](../interfaces/types.Uint256.md) - -#### Defined in - -[src/types/lib/index.ts:217](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L217) - ---- - -### waitForTransactionOptions - -Ƭ **waitForTransactionOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `retryInterval?` | `number` | -| `successStates?` | ([`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) \| [`TransactionExecutionStatus`](../enums/types.TransactionExecutionStatus.md))[] | -| `errorStates?` | ([`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) \| [`TransactionExecutionStatus`](../enums/types.TransactionExecutionStatus.md))[] | - -#### Defined in - -[src/types/lib/index.ts:221](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L221) - ---- - -### getSimulateTransactionOptions - -Ƭ **getSimulateTransactionOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :-------------------------------------------- | -| `blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `skipValidate?` | `boolean` | -| `skipExecute?` | `boolean` | -| `skipFeeCharge?` | `boolean` | - -#### Defined in - -[src/types/lib/index.ts:227](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L227) - ---- - -### getContractVersionOptions - -Ƭ **getContractVersionOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :-------------------------------------------- | -| `blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `compiler?` | `boolean` | - -#### Defined in - -[src/types/lib/index.ts:234](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L234) - ---- - -### getEstimateFeeBulkOptions - -Ƭ **getEstimateFeeBulkOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :-------------------------------------------- | -| `blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `skipValidate?` | `boolean` | - -#### Defined in - -[src/types/lib/index.ts:239](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L239) - ---- - -### ContractVersion - -Ƭ **ContractVersion**: `Object` - -Represent Contract version - -#### Type declaration - -| Name | Type | Description | -| :--------- | :-------------------------------------------- | :--------------------------------------------------------- | -| `cairo` | [`CairoVersion`](types.md#cairoversion) | version of the cairo language | -| `compiler` | [`CompilerVersion`](types.md#compilerversion) | version of the cairo compiler used to compile the contract | - -#### Defined in - -[src/types/lib/index.ts:253](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L253) - ---- - -### ContractClass - -Ƭ **ContractClass**: [`LegacyContractClass`](types.md#legacycontractclass) \| [`SierraContractClass`](types.md#sierracontractclass) - -format produced after compressing compiled contract -CompressedCompiledContract - -#### Defined in - -[src/types/lib/contract/index.ts:9](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L9) - ---- - -### CompiledContract - -Ƭ **CompiledContract**: [`LegacyCompiledContract`](types.md#legacycompiledcontract) \| [`CompiledSierra`](types.md#compiledsierra) - -format produced after compile .cairo to .json - -#### Defined in - -[src/types/lib/contract/index.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L14) - ---- - -### CairoContract - -Ƭ **CairoContract**: [`ContractClass`](types.md#contractclass) \| [`CompiledContract`](types.md#compiledcontract) - -Compressed or decompressed Cairo0 or Cairo1 Contract - -#### Defined in - -[src/types/lib/contract/index.ts:19](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L19) - ---- - -### Abi - -Ƭ **Abi**: ([`FunctionAbi`](types.md#functionabi) \| [`EventAbi`](types.md#eventabi) \| [`StructAbi`](types.md#structabi) \| `any`)[] - -ABI - -#### Defined in - -[src/types/lib/contract/abi.ts:2](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L2) - ---- - -### AbiEntry - -Ƭ **AbiEntry**: `Object` - -#### Type declaration - -| Name | Type | -| :----- | :-------------------------------- | -| `name` | `string` | -| `type` | `"felt"` \| `"felt*"` \| `string` | - -#### Defined in - -[src/types/lib/contract/abi.ts:5](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L5) - ---- - -### EventEntry - -Ƭ **EventEntry**: `Object` - -#### Type declaration - -| Name | Type | -| :----- | :-------------------------------- | -| `name` | `string` | -| `type` | `"felt"` \| `"felt*"` \| `string` | -| `kind` | `"key"` \| `"data"` | - -#### Defined in - -[src/types/lib/contract/abi.ts:7](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L7) - ---- - -### FunctionAbi - -Ƭ **FunctionAbi**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :-------------------------------- | -| `inputs` | [`AbiEntry`](types.md#abientry)[] | -| `name` | `string` | -| `outputs` | [`AbiEntry`](types.md#abientry)[] | -| `stateMutability?` | `"view"` | -| `state_mutability?` | `string` | -| `type` | `FunctionAbiType` | - -#### Defined in - -[src/types/lib/contract/abi.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L16) - ---- - -### AbiStructs - -Ƭ **AbiStructs**: `Object` - -#### Index signature - -▪ [name: `string`]: [`StructAbi`](types.md#structabi) - -#### Defined in - -[src/types/lib/contract/abi.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L25) - ---- - -### StructAbi - -Ƭ **StructAbi**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :--------------------------------------------------------- | -| `members` | [`AbiEntry`](types.md#abientry) & { `offset`: `number` }[] | -| `name` | `string` | -| `size` | `number` | -| `type` | `"struct"` | - -#### Defined in - -[src/types/lib/contract/abi.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L27) - ---- - -### AbiEnums - -Ƭ **AbiEnums**: `Object` - -#### Index signature - -▪ [name: `string`]: [`EnumAbi`](types.md#enumabi) - -#### Defined in - -[src/types/lib/contract/abi.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L34) - ---- - -### EnumAbi - -Ƭ **EnumAbi**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :--------------------------------------------------------- | -| `variants` | [`AbiEntry`](types.md#abientry) & { `offset`: `number` }[] | -| `name` | `string` | -| `size` | `number` | -| `type` | `"enum"` | - -#### Defined in - -[src/types/lib/contract/abi.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L35) - ---- - -### AbiEvents - -Ƭ **AbiEvents**: `Object` - -#### Index signature - -▪ [hash: `string`]: [`EventAbi`](types.md#eventabi) - -#### Defined in - -[src/types/lib/contract/abi.ts:42](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L42) - ---- - -### EventAbi - -Ƭ **EventAbi**: [`Cairo1Event`](types.md#cairo1event) \| [`LegacyEvent`](types.md#legacyevent) - -#### Defined in - -[src/types/lib/contract/abi.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L44) - ---- - -### Cairo1Event - -Ƭ **Cairo1Event**: `Object` - -#### Type declaration - -| Name | Type | -| :-------- | :------------------------------------ | -| `name` | `string` | -| `members` | [`EventEntry`](types.md#evententry)[] | -| `kind` | `"struct"` | -| `type` | `"event"` | - -#### Defined in - -[src/types/lib/contract/abi.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L46) - ---- - -### LegacyEvent - -Ƭ **LegacyEvent**: `Object` - -#### Type declaration - -| Name | Type | -| :----- | :------------------------------------ | -| `name` | `string` | -| `type` | `"event"` | -| `data` | [`EventEntry`](types.md#evententry)[] | -| `keys` | [`EventEntry`](types.md#evententry)[] | - -#### Defined in - -[src/types/lib/contract/abi.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/abi.ts#L53) - ---- - -### LegacyContractClass - -Ƭ **LegacyContractClass**: `Object` - -format produced after compressing 'program' property - -#### Type declaration - -| Name | Type | -| :--------------------- | :------------------------------------------------ | -| `program` | [`CompressedProgram`](types.md#compressedprogram) | -| `entry_points_by_type` | [`EntryPointsByType`](types.md#entrypointsbytype) | -| `abi` | [`Abi`](types.md#abi) | - -#### Defined in - -[src/types/lib/contract/legacy.ts:7](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L7) - ---- - -### LegacyCompiledContract - -Ƭ **LegacyCompiledContract**: `Omit`<[`LegacyContractClass`](types.md#legacycontractclass), `"program"`\> & { `program`: [`Program`](../interfaces/types.Program.md) } - -format produced after compile .cairo to .json - -#### Defined in - -[src/types/lib/contract/legacy.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L16) - ---- - -### Builtins - -Ƭ **Builtins**: `string`[] - -SUBTYPES - -#### Defined in - -[src/types/lib/contract/legacy.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L21) - ---- - -### CompressedProgram - -Ƭ **CompressedProgram**: `string` - -#### Defined in - -[src/types/lib/contract/legacy.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L22) - ---- - -### EntryPointsByType - -Ƭ **EntryPointsByType**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :---------------------------------------------------------------- | -| `CONSTRUCTOR` | [`ContractEntryPointFields`](types.md#contractentrypointfields)[] | -| `EXTERNAL` | [`ContractEntryPointFields`](types.md#contractentrypointfields)[] | -| `L1_HANDLER` | [`ContractEntryPointFields`](types.md#contractentrypointfields)[] | - -#### Defined in - -[src/types/lib/contract/legacy.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L24) - ---- - -### ContractEntryPointFields - -Ƭ **ContractEntryPointFields**: `Object` - -#### Type declaration - -| Name | Type | -| :---------- | :------------------------------ | -| `selector` | `string` | -| `offset` | `string` | -| `builtins?` | [`Builtins`](types.md#builtins) | - -#### Defined in - -[src/types/lib/contract/legacy.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L30) - ---- - -### CairoAssembly - -Ƭ **CairoAssembly**: `Object` - -SYSTEM TYPES - -#### Type declaration - -| Name | Type | -| :--------------------- | :------------------------------------------------ | -| `prime` | `string` | -| `compiler_version` | `string` | -| `bytecode` | [`ByteCode`](types.md#bytecode) | -| `hints` | `any`[] | -| `pythonic_hints` | [`PythonicHints`](types.md#pythonichints) | -| `entry_points_by_type` | [`EntryPointsByType`](types.md#entrypointsbytype) | - -#### Defined in - -[src/types/lib/contract/sierra.ts:5](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/sierra.ts#L5) - ---- - -### CompiledSierra - -Ƭ **CompiledSierra**: `Object` - -format produced after starknet-compile .cairo to .json -sierra_program is hex array - -#### Type declaration - -| Name | Type | -| :--------------------------- | :------------------------------------------------------------ | -| `sierra_program` | [`ByteCode`](types.md#bytecode) | -| `sierra_program_debug_info?` | [`SierraProgramDebugInfo`](types.md#sierraprogramdebuginfo) | -| `contract_class_version` | `string` | -| `entry_points_by_type` | [`SierraEntryPointsByType`](types.md#sierraentrypointsbytype) | -| `abi` | [`Abi`](types.md#abi) | - -#### Defined in - -[src/types/lib/contract/sierra.ts:19](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/sierra.ts#L19) - ---- - -### SierraContractClass - -Ƭ **SierraContractClass**: `Omit`<[`CompiledSierra`](types.md#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](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/sierra.ts#L31) - ---- - -### CompiledSierraCasm - -Ƭ **CompiledSierraCasm**: [`CairoAssembly`](types.md#cairoassembly) - -#### Defined in - -[src/types/lib/contract/sierra.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/sierra.ts#L35) - ---- - -### ByteCode - -Ƭ **ByteCode**: `string`[] - -SUBTYPES - -#### Defined in - -[src/types/lib/contract/sierra.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/sierra.ts#L38) - ---- - -### PythonicHints - -Ƭ **PythonicHints**: [`number`, `string`[]][] - -#### Defined in - -[src/types/lib/contract/sierra.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/sierra.ts#L39) - ---- - -### 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](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/sierra.ts#L41) - ---- - -### SierraEntryPointsByType - -Ƭ **SierraEntryPointsByType**: `Object` - -#### Type declaration - -| Name | Type | -| :------------ | :---------------------------------------------------------------------------- | -| `CONSTRUCTOR` | [`SierraContractEntryPointFields`](types.md#sierracontractentrypointfields)[] | -| `EXTERNAL` | [`SierraContractEntryPointFields`](types.md#sierracontractentrypointfields)[] | -| `L1_HANDLER` | [`SierraContractEntryPointFields`](types.md#sierracontractentrypointfields)[] | - -#### Defined in - -[src/types/lib/contract/sierra.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/sierra.ts#L47) - ---- - -### SierraContractEntryPointFields - -Ƭ **SierraContractEntryPointFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------------- | :------- | -| `selector` | `string` | -| `function_idx` | `number` | - -#### Defined in - -[src/types/lib/contract/sierra.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/sierra.ts#L53) - ---- - -### RpcProviderOptions - -Ƭ **RpcProviderOptions**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :--------------------------------------------------------- | -| `nodeUrl` | `string` | -| `retries?` | `number` | -| `headers?` | `object` | -| `blockIdentifier?` | [`BlockIdentifier`](types.md#blockidentifier) | -| `chainId?` | [`StarknetChainId`](../enums/constants.StarknetChainId.md) | - -#### Defined in - -[src/types/provider/configuration.ts:9](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/configuration.ts#L9) - ---- - -### SequencerHttpMethod - -Ƭ **SequencerHttpMethod**: `"POST"` \| `"GET"` - -#### Defined in - -[src/types/provider/configuration.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/configuration.ts#L17) - ---- - -### SequencerProviderOptions - -Ƭ **SequencerProviderOptions**: { `headers?`: `Record`<`string`, `string`\> ; `blockIdentifier?`: [`BlockIdentifier`](types.md#blockidentifier) ; `chainId?`: [`StarknetChainId`](../enums/constants.StarknetChainId.md) } & { `network`: [`NetworkName`](../enums/constants.NetworkName.md) \| [`StarknetChainId`](../enums/constants.StarknetChainId.md) } \| { `baseUrl`: `string` ; `feederGatewayUrl?`: `string` ; `gatewayUrl?`: `string` } - -#### Defined in - -[src/types/provider/configuration.ts:19](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/configuration.ts#L19) - ---- - -### GetTransactionResponse - -Ƭ **GetTransactionResponse**: [`InvokeTransactionResponse`](../interfaces/types.InvokeTransactionResponse.md) \| [`DeclareTransactionResponse`](../interfaces/types.DeclareTransactionResponse.md) \| [`RejectedTransactionResponse`](types.md#rejectedtransactionresponse) - -#### Defined in - -[src/types/provider/response.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L52) - ---- - -### RejectedTransactionResponse - -Ƭ **RejectedTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :----------------------------------------------- | -| `status` | \`${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:93](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L93) - ---- - -### GetTransactionReceiptResponse - -Ƭ **GetTransactionReceiptResponse**: [`SuccessfulTransactionReceiptResponse`](types.md#successfultransactionreceiptresponse) \| [`RevertedTransactionReceiptResponse`](types.md#revertedtransactionreceiptresponse) \| [`RejectedTransactionReceiptResponse`](types.md#rejectedtransactionreceiptresponse) - -#### Defined in - -[src/types/provider/response.ts:101](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L101) - ---- - -### SuccessfulTransactionReceiptResponse - -Ƭ **SuccessfulTransactionReceiptResponse**: [`InvokeTransactionReceiptResponse`](../interfaces/types.InvokeTransactionReceiptResponse.md) \| [`DeployTransactionReceiptResponse`](types.md#deploytransactionreceiptresponse) \| [`DeclareTransactionReceiptResponse`](types.md#declaretransactionreceiptresponse) - -#### Defined in - -[src/types/provider/response.ts:106](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L106) - ---- - -### DeclareTransactionReceiptResponse - -Ƭ **DeclareTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :--------------------------------------------------------------------------- | -| `type?` | [`TransactionType`](../enums/types.TransactionType.md) | -| `execution_status` | [`TransactionExecutionStatus`](../enums/types.TransactionExecutionStatus.md) | -| `finality_status` | [`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) | -| `status?` | \`${TransactionStatus}\` | -| `actual_fee` | `string` | -| `block_hash` | [`BlockHash`](types.RPC.md#blockhash) | -| `block_number` | [`BlockNumber`](types.md#blocknumber) | -| `transaction_hash` | `string` | -| `transaction_index?` | `number` | -| `messages_sent` | [`MessageToL1`](../interfaces/types.MessageToL1.md)[] | -| `events` | `any`[] | - -#### Defined in - -[src/types/provider/response.ts:126](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L126) - ---- - -### DeployTransactionReceiptResponse - -Ƭ **DeployTransactionReceiptResponse**: [`InvokeTransactionReceiptResponse`](../interfaces/types.InvokeTransactionReceiptResponse.md) - -#### Defined in - -[src/types/provider/response.ts:140](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L140) - ---- - -### RejectedTransactionReceiptResponse - -Ƭ **RejectedTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :----------------------------------------------- | -| `status` | \`${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:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L148) - ---- - -### RevertedTransactionReceiptResponse - -Ƭ **RevertedTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------- | :---------------------------------------------------------------------------------- | -| `type?` | [`TransactionType`](../enums/types.TransactionType.md) \| `any` | -| `execution_status` | [`REVERTED`](../enums/types.TransactionExecutionStatus.md#reverted) \| `any` | -| `finality_status` | [`TransactionFinalityStatus`](../enums/types.TransactionFinalityStatus.md) \| `any` | -| `status?` | [`TransactionStatus`](../enums/types.TransactionStatus.md) | -| `actual_fee` | `string` | -| `block_hash?` | `string` | -| `block_number?` | [`BlockNumber`](types.md#blocknumber) | -| `transaction_hash` | `string` | -| `transaction_index?` | `number` | -| `messages_sent` | [`MessageToL1`](../interfaces/types.MessageToL1.md)[] | -| `events` | `any`[] | -| `revert_reason?` | `string` | - -#### Defined in - -[src/types/provider/response.ts:156](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L156) - ---- - -### CallContractResponse - -Ƭ **CallContractResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------- | -| `result` | `string`[] | - -#### Defined in - -[src/types/provider/response.ts:187](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L187) - ---- - -### EstimateFeeAction - -Ƭ **EstimateFeeAction**: { `type`: [`INVOKE`](../enums/types.TransactionType.md#invoke) ; `payload`: [`AllowArray`](types.md#allowarray)<[`Call`](types.md#call)\> } \| { `type`: [`DECLARE`](../enums/types.TransactionType.md#declare) ; `payload`: [`DeclareContractPayload`](types.md#declarecontractpayload) } \| { `type`: [`DEPLOY_ACCOUNT`](../enums/types.TransactionType.md#deploy_account) ; `payload`: [`DeployAccountContractPayload`](types.md#deployaccountcontractpayload) } \| { `type`: [`DEPLOY`](../enums/types.TransactionType.md#deploy) ; `payload`: [`UniversalDeployerContractPayload`](types.md#universaldeployercontractpayload) } - -#### Defined in - -[src/types/provider/response.ts:191](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L191) - ---- - -### EstimateFeeResponseBulk - -Ƭ **EstimateFeeResponseBulk**: [`EstimateFeeResponse`](../interfaces/types.EstimateFeeResponse.md)[] - -#### Defined in - -[src/types/provider/response.ts:209](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L209) - ---- - -### Storage - -Ƭ **Storage**: [`Storage`](types.Sequencer.md#storage) - -#### Defined in - -[src/types/provider/response.ts:211](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L211) - ---- - -### Nonce - -Ƭ **Nonce**: [`Nonce`](types.Sequencer.md#nonce) - -#### Defined in - -[src/types/provider/response.ts:213](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L213) - ---- - -### SimulationFlags - -Ƭ **SimulationFlags**: [`SimulationFlags`](types.RPC.md#simulationflags) - -#### Defined in - -[src/types/provider/response.ts:215](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L215) - ---- - -### SimulatedTransaction - -Ƭ **SimulatedTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :--------------------------------------------------------------------------------------------------------------------------- | -| `transaction_trace` | [`Trace`](types.RPC.md#trace) \| [`TransactionTraceResponse`](types.Sequencer.md#transactiontraceresponse) | -| `fee_estimation` | [`EstimateFeeResponse`](types.RPC.md#estimatefeeresponse) \| [`EstimateFeeResponse`](types.Sequencer.md#estimatefeeresponse) | -| `suggestedMaxFee?` | `string` \| `bigint` | - -#### Defined in - -[src/types/provider/response.ts:217](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L217) - ---- - -### SimulateTransactionResponse - -Ƭ **SimulateTransactionResponse**: [`SimulatedTransaction`](types.md#simulatedtransaction)[] - -#### Defined in - -[src/types/provider/response.ts:223](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L223) - ---- - -### ContractClassResponse - -Ƭ **ContractClassResponse**: [`LegacyContractClass`](types.md#legacycontractclass) \| `Omit`<[`CompiledSierra`](types.md#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:247](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L247) - ---- - -### DeployAccountSignerDetails - -Ƭ **DeployAccountSignerDetails**: `Required`<[`DeployAccountContractPayload`](types.md#deployaccountcontractpayload)\> & `Required`<[`InvocationsDetails`](types.md#invocationsdetails)\> & { `contractAddress`: [`BigNumberish`](types.md#bignumberish) ; `chainId`: [`StarknetChainId`](../enums/constants.StarknetChainId.md) } - -#### Defined in - -[src/types/signer.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L25) - ---- - -### StarkNetMerkleType - -Ƭ **StarkNetMerkleType**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :------------- | -| `name` | `string` | -| `type` | `"merkletree"` | -| `contains` | `string` | - -#### Defined in - -[src/types/typedData.ts:1](https://github.com/0xs34n/starknet.js/blob/develop/src/types/typedData.ts#L1) - ---- - -### StarkNetType - -Ƭ **StarkNetType**: { `name`: `string` ; `type`: `string` } \| [`StarkNetMerkleType`](types.md#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](https://github.com/0xs34n/starknet.js/blob/develop/src/types/typedData.ts#L13) - ---- - -### CairoEnum - -Ƭ **CairoEnum**: [`CairoCustomEnum`](../classes/CairoCustomEnum.md) \| [`CairoOption`](../classes/CairoOption.md)<`any`\> \| [`CairoResult`](../classes/CairoResult.md)<`any`, `any`\> - -#### Defined in - -[src/types/cairoEnum.ts:3](https://github.com/0xs34n/starknet.js/blob/develop/src/types/cairoEnum.ts#L3) diff --git a/www/docs/API/namespaces/uint256.md b/www/docs/API/namespaces/uint256.md deleted file mode 100644 index b1c6e7ae0..000000000 --- a/www/docs/API/namespaces/uint256.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -id: 'uint256' -title: 'Namespace: uint256' -sidebar_label: 'uint256' -sidebar_position: 0 -custom_edit_url: null ---- - -## References - -### Uint256 - -Re-exports [Uint256](../interfaces/types.Uint256.md) - -## Variables - -### UINT_128_MAX - -• `Const` **UINT_128_MAX**: `bigint` - -#### Defined in - -[src/utils/uint256.ts:9](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L9) - ---- - -### UINT_256_MAX - -• `Const` **UINT_256_MAX**: `bigint` - -#### Defined in - -[src/utils/uint256.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L10) - -## Functions - -### uint256ToBN - -▸ **uint256ToBN**(`uint256`): `bigint` - -Convert Uint256 to bigint - -#### Parameters - -| Name | Type | -| :-------- | :------------------------------------------ | -| `uint256` | [`Uint256`](../interfaces/types.Uint256.md) | - -#### Returns - -`bigint` - -#### Defined in - -[src/utils/uint256.ts:15](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L15) - ---- - -### isUint256 - -▸ **isUint256**(`bn`): `boolean` - -Test BigNumberish is smaller or equal 2\*\*256-1 - -#### Parameters - -| Name | Type | -| :--- | :-------------------------------------- | -| `bn` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -`boolean` - -#### Defined in - -[src/utils/uint256.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L22) - ---- - -### bnToUint256 - -▸ **bnToUint256**(`bn`): [`Uint256`](../interfaces/types.Uint256.md) - -Convert BigNumberish (string | number | bigint) to Uint256 (hex) - -#### Parameters - -| Name | Type | -| :--- | :-------------------------------------- | -| `bn` | [`BigNumberish`](types.md#bignumberish) | - -#### Returns - -[`Uint256`](../interfaces/types.Uint256.md) - -#### Defined in - -[src/utils/uint256.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L29) diff --git a/www/tsconfig.json b/www/tsconfig.json index 88e7237fb..b2ad07243 100644 --- a/www/tsconfig.json +++ b/www/tsconfig.json @@ -3,6 +3,7 @@ "extends": "@tsconfig/docusaurus/tsconfig.json", "compilerOptions": { "jsx": "react", + "module": "Node16", "baseUrl": "." }, "exclude": ["node_modules", "docs"] diff --git a/www/versioned_docs/version-5.14.1/API/enums/EntryPointType.md b/www/versioned_docs/version-5.14.1/API/enums/EntryPointType.md deleted file mode 100644 index d12d855dd..000000000 --- a/www/versioned_docs/version-5.14.1/API/enums/EntryPointType.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'EntryPointType' -title: 'Enumeration: EntryPointType' -sidebar_label: 'EntryPointType' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### EXTERNAL - -• **EXTERNAL** = `"EXTERNAL"` - -#### Defined in - -[src/types/lib/contract/index.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L11) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"L1_HANDLER"` - -#### Defined in - -[src/types/lib/contract/index.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L12) - ---- - -### CONSTRUCTOR - -• **CONSTRUCTOR** = `"CONSTRUCTOR"` - -#### Defined in - -[src/types/lib/contract/index.ts:13](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L13) diff --git a/www/versioned_docs/version-5.14.1/API/enums/RPC.TransactionType.md b/www/versioned_docs/version-5.14.1/API/enums/RPC.TransactionType.md deleted file mode 100644 index ac692bad3..000000000 --- a/www/versioned_docs/version-5.14.1/API/enums/RPC.TransactionType.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: 'RPC.TransactionType' -title: 'Enumeration: TransactionType' -sidebar_label: 'TransactionType' -custom_edit_url: null ---- - -[RPC](../namespaces/RPC.md).TransactionType - -## Enumeration Members - -### DECLARE - -• **DECLARE** = `"DECLARE"` - -#### Defined in - -[src/types/api/rpc.ts:48](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L48) - ---- - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/api/rpc.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L49) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"DEPLOY_ACCOUNT"` - -#### Defined in - -[src/types/api/rpc.ts:50](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L50) - ---- - -### INVOKE - -• **INVOKE** = `"INVOKE"` - -#### Defined in - -[src/types/api/rpc.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L51) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"L1_HANDLER"` - -#### Defined in - -[src/types/api/rpc.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L52) diff --git a/www/versioned_docs/version-5.14.1/API/enums/TransactionStatus.md b/www/versioned_docs/version-5.14.1/API/enums/TransactionStatus.md deleted file mode 100644 index bb7db2b2e..000000000 --- a/www/versioned_docs/version-5.14.1/API/enums/TransactionStatus.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: 'TransactionStatus' -title: 'Enumeration: TransactionStatus' -sidebar_label: 'TransactionStatus' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### NOT_RECEIVED - -• **NOT_RECEIVED** = `"NOT_RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L120) - ---- - -### RECEIVED - -• **RECEIVED** = `"RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L121) - ---- - -### PENDING - -• **PENDING** = `"PENDING"` - -#### Defined in - -[src/types/lib/index.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L122) - ---- - -### ACCEPTED_ON_L2 - -• **ACCEPTED_ON_L2** = `"ACCEPTED_ON_L2"` - -#### Defined in - -[src/types/lib/index.ts:123](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L123) - ---- - -### ACCEPTED_ON_L1 - -• **ACCEPTED_ON_L1** = `"ACCEPTED_ON_L1"` - -#### Defined in - -[src/types/lib/index.ts:124](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L124) - ---- - -### REJECTED - -• **REJECTED** = `"REJECTED"` - -#### Defined in - -[src/types/lib/index.ts:125](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L125) diff --git a/www/versioned_docs/version-5.14.1/API/enums/TransactionType.md b/www/versioned_docs/version-5.14.1/API/enums/TransactionType.md deleted file mode 100644 index 13cfbb5f8..000000000 --- a/www/versioned_docs/version-5.14.1/API/enums/TransactionType.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: 'TransactionType' -title: 'Enumeration: TransactionType' -sidebar_label: 'TransactionType' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### INVOKE - -• **INVOKE** = `"INVOKE_FUNCTION"` - -#### Defined in - -[src/types/lib/index.ts:154](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L154) - ---- - -### DECLARE - -• **DECLARE** = `"DECLARE"` - -#### Defined in - -[src/types/lib/index.ts:155](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L155) - ---- - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/lib/index.ts:156](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L156) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"DEPLOY_ACCOUNT"` - -#### Defined in - -[src/types/lib/index.ts:157](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L157) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/CallStruct.md b/www/versioned_docs/version-5.14.1/API/interfaces/CallStruct.md deleted file mode 100644 index daa7d572d..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/CallStruct.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'CallStruct' -title: 'Interface: CallStruct' -sidebar_label: 'CallStruct' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### to - -• **to**: `string` - -#### Defined in - -[src/types/lib/index.ts:181](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L181) - ---- - -### selector - -• **selector**: `string` - -#### Defined in - -[src/types/lib/index.ts:182](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L182) - ---- - -### calldata - -• **calldata**: `string`[] - -#### Defined in - -[src/types/lib/index.ts:183](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L183) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/CommonTransactionReceiptResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/CommonTransactionReceiptResponse.md deleted file mode 100644 index dccb43798..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/CommonTransactionReceiptResponse.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: 'CommonTransactionReceiptResponse' -title: 'Interface: CommonTransactionReceiptResponse' -sidebar_label: 'CommonTransactionReceiptResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`CommonTransactionReceiptResponse`** - - ↳ [`InvokeTransactionReceiptResponse`](InvokeTransactionReceiptResponse.md) - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:72](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L72) - ---- - -### status - -• `Optional` **status**: [`Status`](../modules.md#status) - -#### Defined in - -[src/types/provider.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L73) - ---- - -### actual_fee - -• `Optional` **actual_fee**: `string` - -#### Defined in - -[src/types/provider.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L74) - ---- - -### status_data - -• `Optional` **status_data**: `string` - -#### Defined in - -[src/types/provider.ts:75](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L75) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/CommonTransactionResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/CommonTransactionResponse.md deleted file mode 100644 index 12cff7e67..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/CommonTransactionResponse.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: 'CommonTransactionResponse' -title: 'Interface: CommonTransactionResponse' -sidebar_label: 'CommonTransactionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`CommonTransactionResponse`** - - ↳ [`InvokeTransactionResponse`](InvokeTransactionResponse.md) - - ↳ [`DeclareTransactionResponse`](DeclareTransactionResponse.md) - -## Properties - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L43) - ---- - -### version - -• `Optional` **version**: `string` - -#### Defined in - -[src/types/provider.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L44) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../modules.md#signature) - -#### Defined in - -[src/types/provider.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L45) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Defined in - -[src/types/provider.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L46) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Defined in - -[src/types/provider.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L47) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/ContractEntryPoint.md b/www/versioned_docs/version-5.14.1/API/interfaces/ContractEntryPoint.md deleted file mode 100644 index af76821bb..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/ContractEntryPoint.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'ContractEntryPoint' -title: 'Interface: ContractEntryPoint' -sidebar_label: 'ContractEntryPoint' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### offset - -• **offset**: `string` - -#### Defined in - -[src/types/provider.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L58) - ---- - -### selector - -• **selector**: `string` - -#### Defined in - -[src/types/provider.ts:59](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L59) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/DeclareContractResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/DeclareContractResponse.md deleted file mode 100644 index 6c128e5f2..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/DeclareContractResponse.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'DeclareContractResponse' -title: 'Interface: DeclareContractResponse' -sidebar_label: 'DeclareContractResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L115) - ---- - -### class_hash - -• **class_hash**: `string` - -#### Defined in - -[src/types/provider.ts:116](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L116) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/DeclareSignerDetails.md b/www/versioned_docs/version-5.14.1/API/interfaces/DeclareSignerDetails.md deleted file mode 100644 index b0902db42..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/DeclareSignerDetails.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: 'DeclareSignerDetails' -title: 'Interface: DeclareSignerDetails' -sidebar_label: 'DeclareSignerDetails' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### classHash - -• **classHash**: `string` - -#### Defined in - -[src/types/signer.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L12) - ---- - -### senderAddress - -• **senderAddress**: `string` - -#### Defined in - -[src/types/signer.ts:13](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L13) - ---- - -### chainId - -• **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/types/signer.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L14) - ---- - -### maxFee - -• **maxFee**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:15](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L15) - ---- - -### version - -• **version**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L16) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L17) - ---- - -### compiledClassHash - -• `Optional` **compiledClassHash**: `string` - -#### Defined in - -[src/types/signer.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L18) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/DeclareTransactionResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/DeclareTransactionResponse.md deleted file mode 100644 index 7debede4b..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/DeclareTransactionResponse.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -id: 'DeclareTransactionResponse' -title: 'Interface: DeclareTransactionResponse' -sidebar_label: 'DeclareTransactionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionResponse`](CommonTransactionResponse.md) - - ↳ **`DeclareTransactionResponse`** - -## Properties - -### contract_class - -• `Optional` **contract_class**: `any` - -#### Defined in - -[src/types/provider.ts:63](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L63) - ---- - -### sender_address - -• `Optional` **sender_address**: `string` - -#### Defined in - -[src/types/provider.ts:64](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L64) - ---- - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[transaction_hash](CommonTransactionResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L43) - ---- - -### version - -• `Optional` **version**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[version](CommonTransactionResponse.md#version) - -#### Defined in - -[src/types/provider.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L44) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../modules.md#signature) - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[signature](CommonTransactionResponse.md#signature) - -#### Defined in - -[src/types/provider.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L45) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[max_fee](CommonTransactionResponse.md#max_fee) - -#### Defined in - -[src/types/provider.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L46) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[nonce](CommonTransactionResponse.md#nonce) - -#### Defined in - -[src/types/provider.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L47) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/DeployContractResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/DeployContractResponse.md deleted file mode 100644 index 032441b15..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/DeployContractResponse.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'DeployContractResponse' -title: 'Interface: DeployContractResponse' -sidebar_label: 'DeployContractResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### contract_address - -• **contract_address**: `string` - -#### Defined in - -[src/types/account.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L22) - ---- - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/account.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L23) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/EstimateFee.md b/www/versioned_docs/version-5.14.1/API/interfaces/EstimateFee.md deleted file mode 100644 index c2c1767fa..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/EstimateFee.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: 'EstimateFee' -title: 'Interface: EstimateFee' -sidebar_label: 'EstimateFee' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`EstimateFeeResponse`](EstimateFeeResponse.md) - - ↳ **`EstimateFee`** - -## Properties - -### suggestedMaxFee - -• **suggestedMaxFee**: `bigint` - -#### Overrides - -[EstimateFeeResponse](EstimateFeeResponse.md).[suggestedMaxFee](EstimateFeeResponse.md#suggestedmaxfee) - -#### Defined in - -[src/types/account.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L10) - ---- - -### overall_fee - -• **overall_fee**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](EstimateFeeResponse.md).[overall_fee](EstimateFeeResponse.md#overall_fee) - -#### Defined in - -[src/types/provider.ts:104](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L104) - ---- - -### gas_consumed - -• `Optional` **gas_consumed**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](EstimateFeeResponse.md).[gas_consumed](EstimateFeeResponse.md#gas_consumed) - -#### Defined in - -[src/types/provider.ts:105](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L105) - ---- - -### gas_price - -• `Optional` **gas_price**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](EstimateFeeResponse.md).[gas_price](EstimateFeeResponse.md#gas_price) - -#### Defined in - -[src/types/provider.ts:106](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L106) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/EstimateFeeDetails.md b/www/versioned_docs/version-5.14.1/API/interfaces/EstimateFeeDetails.md deleted file mode 100644 index 32bb54e93..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/EstimateFeeDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'EstimateFeeDetails' -title: 'Interface: EstimateFeeDetails' -sidebar_label: 'EstimateFeeDetails' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### nonce - -• `Optional` **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/account.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L16) - ---- - -### blockIdentifier - -• `Optional` **blockIdentifier**: `BlockIdentifier` - -#### Defined in - -[src/types/account.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L17) - ---- - -### skipValidate - -• `Optional` **skipValidate**: `boolean` - -#### Defined in - -[src/types/account.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L18) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/EstimateFeeResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/EstimateFeeResponse.md deleted file mode 100644 index f83d5eb02..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/EstimateFeeResponse.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: 'EstimateFeeResponse' -title: 'Interface: EstimateFeeResponse' -sidebar_label: 'EstimateFeeResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`EstimateFeeResponse`** - - ↳ [`EstimateFee`](EstimateFee.md) - -## Properties - -### overall_fee - -• **overall_fee**: `bigint` - -#### Defined in - -[src/types/provider.ts:104](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L104) - ---- - -### gas_consumed - -• `Optional` **gas_consumed**: `bigint` - -#### Defined in - -[src/types/provider.ts:105](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L105) - ---- - -### gas_price - -• `Optional` **gas_price**: `bigint` - -#### Defined in - -[src/types/provider.ts:106](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L106) - ---- - -### suggestedMaxFee - -• `Optional` **suggestedMaxFee**: `bigint` - -#### Defined in - -[src/types/provider.ts:107](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L107) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/Event.md b/www/versioned_docs/version-5.14.1/API/interfaces/Event.md deleted file mode 100644 index 7ee3df029..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/Event.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'Event' -title: 'Interface: Event' -sidebar_label: 'Event' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### from_address - -• **from_address**: `string` - -#### Defined in - -[src/types/provider.ts:84](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L84) - ---- - -### keys - -• **keys**: `string`[] - -#### Defined in - -[src/types/provider.ts:85](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L85) - ---- - -### data - -• **data**: `string`[] - -#### Defined in - -[src/types/provider.ts:86](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L86) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/GetBlockResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/GetBlockResponse.md deleted file mode 100644 index 5927a2005..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/GetBlockResponse.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -id: 'GetBlockResponse' -title: 'Interface: GetBlockResponse' -sidebar_label: 'GetBlockResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -[src/types/provider.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L22) - ---- - -### block_hash - -• **block_hash**: `string` - -#### Defined in - -[src/types/provider.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L23) - ---- - -### block_number - -• **block_number**: `number` - -#### Defined in - -[src/types/provider.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L24) - ---- - -### new_root - -• **new_root**: `string` - -#### Defined in - -[src/types/provider.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L25) - ---- - -### parent_hash - -• **parent_hash**: `string` - -#### Defined in - -[src/types/provider.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L26) - ---- - -### status - -• **status**: [`Status`](../modules.md#status) - -#### Defined in - -[src/types/provider.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L27) - ---- - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -[src/types/provider.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L28) - ---- - -### gas_price - -• `Optional` **gas_price**: `string` - -#### Defined in - -[src/types/provider.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L29) - ---- - -### sequencer_address - -• `Optional` **sequencer_address**: `string` - -#### Defined in - -[src/types/provider.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L30) - ---- - -### starknet_version - -• `Optional` **starknet_version**: `string` - -#### Defined in - -[src/types/provider.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L31) - ---- - -### transaction_receipts - -• `Optional` **transaction_receipts**: `any` - -#### Defined in - -[src/types/provider.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L32) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/GetCodeResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/GetCodeResponse.md deleted file mode 100644 index 3418b8433..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/GetCodeResponse.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: 'GetCodeResponse' -title: 'Interface: GetCodeResponse' -sidebar_label: 'GetCodeResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### bytecode - -• **bytecode**: [`ByteCode`](../modules.md#bytecode) - -#### Defined in - -[src/types/provider.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L36) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/InvocationsSignerDetails.md b/www/versioned_docs/version-5.14.1/API/interfaces/InvocationsSignerDetails.md deleted file mode 100644 index 9bfe79bc6..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/InvocationsSignerDetails.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: 'InvocationsSignerDetails' -title: 'Interface: InvocationsSignerDetails' -sidebar_label: 'InvocationsSignerDetails' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- `Required`<[`InvocationsDetails`](../modules.md#invocationsdetails)\> - - ↳ **`InvocationsSignerDetails`** - -## Properties - -### walletAddress - -• **walletAddress**: `string` - -#### Defined in - -[src/types/signer.ts:6](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L6) - ---- - -### chainId - -• **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/types/signer.ts:7](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L7) - ---- - -### cairoVersion - -• **cairoVersion**: [`CairoVersion`](../modules.md#cairoversion) - -#### Defined in - -[src/types/signer.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L8) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -Required.nonce - -#### Defined in - -[src/types/lib/index.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L100) - ---- - -### maxFee - -• **maxFee**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -Required.maxFee - -#### Defined in - -[src/types/lib/index.ts:101](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L101) - ---- - -### version - -• **version**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -Required.version - -#### Defined in - -[src/types/lib/index.ts:102](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L102) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/InvokeFunctionResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/InvokeFunctionResponse.md deleted file mode 100644 index b1109c1ad..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/InvokeFunctionResponse.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: 'InvokeFunctionResponse' -title: 'Interface: InvokeFunctionResponse' -sidebar_label: 'InvokeFunctionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:111](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L111) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/InvokeTransactionReceiptResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/InvokeTransactionReceiptResponse.md deleted file mode 100644 index f180775c1..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/InvokeTransactionReceiptResponse.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -id: 'InvokeTransactionReceiptResponse' -title: 'Interface: InvokeTransactionReceiptResponse' -sidebar_label: 'InvokeTransactionReceiptResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionReceiptResponse`](CommonTransactionReceiptResponse.md) - - ↳ **`InvokeTransactionReceiptResponse`** - -## Properties - -### messages_sent - -• `Optional` **messages_sent**: [`MessageToL1`](MessageToL1.md)[] - -**`Deprecated`** - -Use l2_to_l1_messages - -#### Defined in - -[src/types/provider.ts:96](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L96) - ---- - -### events - -• `Optional` **events**: [`Event`](Event.md)[] - -#### Defined in - -[src/types/provider.ts:97](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L97) - ---- - -### l1_origin_message - -• `Optional` **l1_origin_message**: [`MessageToL2`](MessageToL2.md) - -#### Defined in - -[src/types/provider.ts:98](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L98) - ---- - -### transaction_hash - -• **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[transaction_hash](CommonTransactionReceiptResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider.ts:72](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L72) - ---- - -### status - -• `Optional` **status**: [`Status`](../modules.md#status) - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[status](CommonTransactionReceiptResponse.md#status) - -#### Defined in - -[src/types/provider.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L73) - ---- - -### actual_fee - -• `Optional` **actual_fee**: `string` - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[actual_fee](CommonTransactionReceiptResponse.md#actual_fee) - -#### Defined in - -[src/types/provider.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L74) - ---- - -### status_data - -• `Optional` **status_data**: `string` - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[status_data](CommonTransactionReceiptResponse.md#status_data) - -#### Defined in - -[src/types/provider.ts:75](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L75) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/InvokeTransactionResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/InvokeTransactionResponse.md deleted file mode 100644 index 7ba4e5238..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/InvokeTransactionResponse.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -id: 'InvokeTransactionResponse' -title: 'Interface: InvokeTransactionResponse' -sidebar_label: 'InvokeTransactionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionResponse`](CommonTransactionResponse.md) - - ↳ **`InvokeTransactionResponse`** - -## Properties - -### contract_address - -• `Optional` **contract_address**: `string` - -#### Defined in - -[src/types/provider.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L51) - ---- - -### sender_address - -• `Optional` **sender_address**: `string` - -#### Defined in - -[src/types/provider.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L52) - ---- - -### entry_point_selector - -• `Optional` **entry_point_selector**: `string` - -#### Defined in - -[src/types/provider.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L53) - ---- - -### calldata - -• **calldata**: [`RawCalldata`](../modules.md#rawcalldata) - -#### Defined in - -[src/types/provider.ts:54](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L54) - ---- - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[transaction_hash](CommonTransactionResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L43) - ---- - -### version - -• `Optional` **version**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[version](CommonTransactionResponse.md#version) - -#### Defined in - -[src/types/provider.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L44) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../modules.md#signature) - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[signature](CommonTransactionResponse.md#signature) - -#### Defined in - -[src/types/provider.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L45) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[max_fee](CommonTransactionResponse.md#max_fee) - -#### Defined in - -[src/types/provider.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L46) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[nonce](CommonTransactionResponse.md#nonce) - -#### Defined in - -[src/types/provider.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L47) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/MessageToL1.md b/www/versioned_docs/version-5.14.1/API/interfaces/MessageToL1.md deleted file mode 100644 index 254f3287f..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/MessageToL1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'MessageToL1' -title: 'Interface: MessageToL1' -sidebar_label: 'MessageToL1' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### to_address - -• **to_address**: `string` - -#### Defined in - -[src/types/provider.ts:79](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L79) - ---- - -### payload - -• **payload**: `string`[] - -#### Defined in - -[src/types/provider.ts:80](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L80) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/MessageToL2.md b/www/versioned_docs/version-5.14.1/API/interfaces/MessageToL2.md deleted file mode 100644 index 7204c7a63..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/MessageToL2.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'MessageToL2' -title: 'Interface: MessageToL2' -sidebar_label: 'MessageToL2' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### from_address - -• **from_address**: `string` - -#### Defined in - -[src/types/provider.ts:90](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L90) - ---- - -### payload - -• **payload**: `string`[] - -#### Defined in - -[src/types/provider.ts:91](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L91) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/Program.md b/www/versioned_docs/version-5.14.1/API/interfaces/Program.md deleted file mode 100644 index 42e8eef92..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/Program.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: 'Program' -title: 'Interface: Program' -sidebar_label: 'Program' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- `Record`<`string`, `any`\> - - ↳ **`Program`** - -## Properties - -### builtins - -• **builtins**: `string`[] - -#### Defined in - -[src/types/lib/contract/legacy.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L31) - ---- - -### data - -• **data**: `string`[] - -#### Defined in - -[src/types/lib/contract/legacy.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L32) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/ProviderOptions.md b/www/versioned_docs/version-5.14.1/API/interfaces/ProviderOptions.md deleted file mode 100644 index bc68fc6c2..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/ProviderOptions.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'ProviderOptions' -title: 'Interface: ProviderOptions' -sidebar_label: 'ProviderOptions' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### sequencer - -• `Optional` **sequencer**: [`SequencerProviderOptions`](../modules.md#sequencerprovideroptions) - -#### Defined in - -[src/provider/default.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L35) - ---- - -### rpc - -• `Optional` **rpc**: [`RpcProviderOptions`](../modules.md#rpcprovideroptions) - -#### Defined in - -[src/provider/default.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L36) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md deleted file mode 100644 index fe907635e..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -id: 'Sequencer.InvokeFunctionTransactionResponse' -title: 'Interface: InvokeFunctionTransactionResponse' -sidebar_label: 'InvokeFunctionTransactionResponse' -custom_edit_url: null ---- - -[Sequencer](../namespaces/Sequencer.md).InvokeFunctionTransactionResponse - -## Hierarchy - -- [`InvokeFunctionTransaction`](../namespaces/Sequencer.md#invokefunctiontransaction) - - ↳ **`InvokeFunctionTransactionResponse`** - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:141](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L141) - ---- - -### entry_point_selector - -• **entry_point_selector**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:142](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L142) - ---- - -### type - -• **type**: `"INVOKE_FUNCTION"` - -#### Inherited from - -InvokeFunctionTransaction.type - -#### Defined in - -[src/types/api/sequencer.ts:112](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L112) - ---- - -### sender_address - -• **sender_address**: `string` - -#### Inherited from - -InvokeFunctionTransaction.sender_address - -#### Defined in - -[src/types/api/sequencer.ts:113](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L113) - ---- - -### signature - -• `Optional` **signature**: `string`[] - -#### Inherited from - -InvokeFunctionTransaction.signature - -#### Defined in - -[src/types/api/sequencer.ts:114](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L114) - ---- - -### entry_point_type - -• `Optional` **entry_point_type**: [`EXTERNAL`](../enums/EntryPointType.md#external) - -#### Inherited from - -InvokeFunctionTransaction.entry_point_type - -#### Defined in - -[src/types/api/sequencer.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L115) - ---- - -### calldata - -• `Optional` **calldata**: [`RawCalldata`](../modules.md#rawcalldata) - -#### Inherited from - -InvokeFunctionTransaction.calldata - -#### Defined in - -[src/types/api/sequencer.ts:116](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L116) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.nonce - -#### Defined in - -[src/types/api/sequencer.ts:117](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L117) - ---- - -### max_fee - -• `Optional` **max_fee**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.max_fee - -#### Defined in - -[src/types/api/sequencer.ts:118](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L118) - ---- - -### version - -• `Optional` **version**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.version - -#### Defined in - -[src/types/api/sequencer.ts:119](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L119) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/StateUpdateResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/StateUpdateResponse.md deleted file mode 100644 index 3ee6ec6bf..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/StateUpdateResponse.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: 'StateUpdateResponse' -title: 'Interface: StateUpdateResponse' -sidebar_label: 'StateUpdateResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### block_hash - -• **block_hash**: `string` - -#### Defined in - -[src/types/provider.ts:154](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L154) - ---- - -### new_root - -• **new_root**: `string` - -#### Defined in - -[src/types/provider.ts:155](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L155) - ---- - -### old_root - -• **old_root**: `string` - -#### Defined in - -[src/types/provider.ts:156](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L156) - ---- - -### state_diff - -• **state_diff**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------- | :------------------------------------------------------------------------ | -| `storage_diffs` | [`StorageDiffs`](../namespaces/RPC.md#storagediffs) | -| `declared_contract_hashes?` | [`DeclaredContractHashes`](../namespaces/RPC.md#declaredcontracthashes) | -| `deployed_contracts` | [`DeployedContracts`](../namespaces/Sequencer.md#deployedcontracts) | -| `nonces` | [`Nonces`](../namespaces/RPC.md#nonces) | -| `old_declared_contracts?` | [`OldDeclaredContracts`](../namespaces/Sequencer.md#olddeclaredcontracts) | -| `declared_classes?` | [`DeclaredClasses`](../namespaces/Sequencer.md#declaredclasses) | -| `replaced_classes?` | [`ReplacedClasses`](../namespaces/Sequencer.md#replacedclasses) | - -#### Defined in - -[src/types/provider.ts:157](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L157) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/TransactionSimulation.md b/www/versioned_docs/version-5.14.1/API/interfaces/TransactionSimulation.md deleted file mode 100644 index 073c9c5d8..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/TransactionSimulation.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: 'TransactionSimulation' -title: 'Interface: TransactionSimulation' -sidebar_label: 'TransactionSimulation' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`TransactionSimulationResponse`](TransactionSimulationResponse.md) - - ↳ **`TransactionSimulation`** - -## Properties - -### fee_estimation - -• **fee_estimation**: [`EstimateFee`](EstimateFee.md) - -#### Overrides - -[TransactionSimulationResponse](TransactionSimulationResponse.md).[fee_estimation](TransactionSimulationResponse.md#fee_estimation) - -#### Defined in - -[src/types/account.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L51) - ---- - -### trace - -• **trace**: [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) - -#### Inherited from - -[TransactionSimulationResponse](TransactionSimulationResponse.md).[trace](TransactionSimulationResponse.md#trace) - -#### Defined in - -[src/types/provider.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L148) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/TransactionSimulationResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/TransactionSimulationResponse.md deleted file mode 100644 index e9b0e9032..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/TransactionSimulationResponse.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: 'TransactionSimulationResponse' -title: 'Interface: TransactionSimulationResponse' -sidebar_label: 'TransactionSimulationResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`TransactionSimulationResponse`** - - ↳ [`TransactionSimulation`](TransactionSimulation.md) - -## Properties - -### trace - -• **trace**: [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) - -#### Defined in - -[src/types/provider.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L148) - ---- - -### fee_estimation - -• **fee_estimation**: [`EstimateFeeResponse`](EstimateFeeResponse.md) - -#### Defined in - -[src/types/provider.ts:149](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L149) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/typedData.StarkNetDomain.md b/www/versioned_docs/version-5.14.1/API/interfaces/typedData.StarkNetDomain.md deleted file mode 100644 index ba7547aea..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/typedData.StarkNetDomain.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: 'typedData.StarkNetDomain' -title: 'Interface: StarkNetDomain' -sidebar_label: 'StarkNetDomain' -custom_edit_url: null ---- - -[typedData](../namespaces/typedData.md).StarkNetDomain - -The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field. - -## Hierarchy - -- `Record`<`string`, `unknown`\> - - ↳ **`StarkNetDomain`** - -## Properties - -### name - -• `Optional` **name**: `string` - -#### Defined in - -[src/utils/typedData/types.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L24) - ---- - -### version - -• `Optional` **version**: `string` - -#### Defined in - -[src/utils/typedData/types.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L25) - ---- - -### chainId - -• `Optional` **chainId**: `string` \| `number` - -#### Defined in - -[src/utils/typedData/types.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L26) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/typedData.TypedData.md b/www/versioned_docs/version-5.14.1/API/interfaces/typedData.TypedData.md deleted file mode 100644 index 9a829a04b..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/typedData.TypedData.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: 'typedData.TypedData' -title: 'Interface: TypedData' -sidebar_label: 'TypedData' -custom_edit_url: null ---- - -[typedData](../namespaces/typedData.md).TypedData - -The complete typed data, with all the structs, domain data, primary type of the message, and the message itself. - -## Properties - -### types - -• **types**: `Record`<`string`, [`StarkNetType`](../namespaces/typedData.md#starknettype)[]\> - -#### Defined in - -[src/utils/typedData/types.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L33) - ---- - -### primaryType - -• **primaryType**: `string` - -#### Defined in - -[src/utils/typedData/types.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L34) - ---- - -### domain - -• **domain**: [`StarkNetDomain`](typedData.StarkNetDomain.md) - -#### Defined in - -[src/utils/typedData/types.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L35) - ---- - -### message - -• **message**: `Record`<`string`, `unknown`\> - -#### Defined in - -[src/utils/typedData/types.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L36) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/types.TransactionSimulation.md b/www/versioned_docs/version-5.14.1/API/interfaces/types.TransactionSimulation.md deleted file mode 100644 index d76c9f852..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/types.TransactionSimulation.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: 'types.TransactionSimulation' -title: 'Interface: TransactionSimulation' -sidebar_label: 'TransactionSimulation' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionSimulation - -## Hierarchy - -- [`TransactionSimulationResponse`](types.TransactionSimulationResponse.md) - - ↳ **`TransactionSimulation`** - -## Properties - -### fee_estimation - -• **fee_estimation**: [`EstimateFee`](types.EstimateFee.md) - -#### Overrides - -[TransactionSimulationResponse](types.TransactionSimulationResponse.md).[fee_estimation](types.TransactionSimulationResponse.md#fee_estimation) - -#### Defined in - -[src/types/account.ts:50](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L50) - ---- - -### trace - -• **trace**: [`TransactionTraceResponse`](../namespaces/types.md#transactiontraceresponse) - -#### Inherited from - -[TransactionSimulationResponse](types.TransactionSimulationResponse.md).[trace](types.TransactionSimulationResponse.md#trace) - -#### Defined in - -[src/types/provider/response.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L148) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/types.TransactionSimulationResponse.md b/www/versioned_docs/version-5.14.1/API/interfaces/types.TransactionSimulationResponse.md deleted file mode 100644 index 0495a39f3..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/types.TransactionSimulationResponse.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: 'types.TransactionSimulationResponse' -title: 'Interface: TransactionSimulationResponse' -sidebar_label: 'TransactionSimulationResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionSimulationResponse - -## Hierarchy - -- **`TransactionSimulationResponse`** - - ↳ [`TransactionSimulation`](types.TransactionSimulation.md) - -## Properties - -### trace - -• **trace**: [`TransactionTraceResponse`](../namespaces/types.md#transactiontraceresponse) - -#### Defined in - -[src/types/provider/response.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L148) - ---- - -### fee_estimation - -• **fee_estimation**: [`EstimateFeeResponse`](types.EstimateFeeResponse.md) - -#### Defined in - -[src/types/provider/response.ts:149](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L149) diff --git a/www/versioned_docs/version-5.14.1/API/interfaces/uint256.Uint256.md b/www/versioned_docs/version-5.14.1/API/interfaces/uint256.Uint256.md deleted file mode 100644 index a108bc422..000000000 --- a/www/versioned_docs/version-5.14.1/API/interfaces/uint256.Uint256.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'uint256.Uint256' -title: 'Interface: Uint256' -sidebar_label: 'Uint256' -custom_edit_url: null ---- - -[uint256](../namespaces/uint256.md).Uint256 - -## Properties - -### low - -• **low**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/utils/uint256.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L8) - ---- - -### high - -• **high**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/utils/uint256.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L10) diff --git a/www/versioned_docs/version-5.14.1/API/namespaces/RPC.md b/www/versioned_docs/version-5.14.1/API/namespaces/RPC.md deleted file mode 100644 index f2d2b88d1..000000000 --- a/www/versioned_docs/version-5.14.1/API/namespaces/RPC.md +++ /dev/null @@ -1,382 +0,0 @@ ---- -id: 'RPC' -title: 'Namespace: RPC' -sidebar_label: 'RPC' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumerations - -- [TransactionType](../enums/RPC.TransactionType.md) - -## Type Aliases - -### Response - -Ƭ **Response**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----------------------------------------- | -| `id` | `number` | -| `jsonrpc` | `string` | -| `result?` | `any` | -| `error?` | { `code`: `string` ; `message`: `string` } | -| `error.code` | `string` | -| `error.message` | `string` | - -#### Defined in - -[src/types/api/rpc.ts:4](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L4) - ---- - -### ChainId - -Ƭ **ChainId**: `OPENRPC.CHAIN_ID` - -#### Defined in - -[src/types/api/rpc.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L14) - ---- - -### CallResponse - -Ƭ **CallResponse**: `OPENRPC.CallResponse` - -#### Defined in - -[src/types/api/rpc.ts:15](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L15) - ---- - -### ContractAddress - -Ƭ **ContractAddress**: `ADDRESS` - -#### Defined in - -[src/types/api/rpc.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L16) - ---- - -### Felt - -Ƭ **Felt**: `FELT` - -#### Defined in - -[src/types/api/rpc.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L17) - ---- - -### Nonce - -Ƭ **Nonce**: `OPENRPC.Nonce` - -#### Defined in - -[src/types/api/rpc.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L18) - ---- - -### ContractClass - -Ƭ **ContractClass**: `OPENRPC.ContractClass` - -#### Defined in - -[src/types/api/rpc.ts:19](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L19) - ---- - -### StateUpdate - -Ƭ **StateUpdate**: `OPENRPC.StateUpdate` - -#### Defined in - -[src/types/api/rpc.ts:20](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L20) - ---- - -### Transaction - -Ƭ **Transaction**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L21) - ---- - -### PendingTransactions - -Ƭ **PendingTransactions**: `OPENRPC.PendingTransactions` - -#### Defined in - -[src/types/api/rpc.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L22) - ---- - -### TransactionHash - -Ƭ **TransactionHash**: `OPENRPC.TransactionHash` - -#### Defined in - -[src/types/api/rpc.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L23) - ---- - -### Trace - -Ƭ **Trace**: `OPENRPC.Trace` - -#### Defined in - -[src/types/api/rpc.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L24) - ---- - -### Traces - -Ƭ **Traces**: `OPENRPC.Traces` - -#### Defined in - -[src/types/api/rpc.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L25) - ---- - -### BlockHash - -Ƭ **BlockHash**: `OPENRPC.BlockHash` - -#### Defined in - -[src/types/api/rpc.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L26) - ---- - -### BlockHashAndNumber - -Ƭ **BlockHashAndNumber**: `OPENRPC.BlockHashAndNumber` - -#### Defined in - -[src/types/api/rpc.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L27) - ---- - -### GetClassResponse - -Ƭ **GetClassResponse**: `OPENRPC.ContractClass` - -#### Defined in - -[src/types/api/rpc.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L28) - ---- - -### EstimateFeeResponse - -Ƭ **EstimateFeeResponse**: `OPENRPC.EstimatedFee` - -#### Defined in - -[src/types/api/rpc.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L29) - ---- - -### GetBlockWithTxHashesResponse - -Ƭ **GetBlockWithTxHashesResponse**: `OPENRPC.BlockWithTxHashes` - -#### Defined in - -[src/types/api/rpc.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L30) - ---- - -### GetBlockWithTxs - -Ƭ **GetBlockWithTxs**: `OPENRPC.BlockWithTxs` - -#### Defined in - -[src/types/api/rpc.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L31) - ---- - -### GetStorageAtResponse - -Ƭ **GetStorageAtResponse**: `OPENRPC.Storage` - -#### Defined in - -[src/types/api/rpc.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L32) - ---- - -### TransactionReceipt - -Ƭ **TransactionReceipt**: `OPENRPC.TransactionReceipt` - -#### Defined in - -[src/types/api/rpc.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L33) - ---- - -### GetTransactionByHashResponse - -Ƭ **GetTransactionByHashResponse**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L34) - ---- - -### GetTransactionByBlockIdAndIndex - -Ƭ **GetTransactionByBlockIdAndIndex**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L35) - ---- - -### GetTransactionCountResponse - -Ƭ **GetTransactionCountResponse**: `number` - -#### Defined in - -[src/types/api/rpc.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L36) - ---- - -### GetBlockNumberResponse - -Ƭ **GetBlockNumberResponse**: `OPENRPC.BlockNumber` - -#### Defined in - -[src/types/api/rpc.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L37) - ---- - -### GetSyncingStatsResponse - -Ƭ **GetSyncingStatsResponse**: `OPENRPC.SyncingStatus` - -#### Defined in - -[src/types/api/rpc.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L38) - ---- - -### EventFilter - -Ƭ **EventFilter**: `OPENRPC.EventFilter` - -#### Defined in - -[src/types/api/rpc.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L39) - ---- - -### GetEventsResponse - -Ƭ **GetEventsResponse**: `OPENRPC.Events` - -#### Defined in - -[src/types/api/rpc.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L40) - ---- - -### InvokedTransaction - -Ƭ **InvokedTransaction**: `OPENRPC.InvokedTransaction` - -#### Defined in - -[src/types/api/rpc.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L41) - ---- - -### DeclaredTransaction - -Ƭ **DeclaredTransaction**: `OPENRPC.DeclaredTransaction` - -#### Defined in - -[src/types/api/rpc.ts:42](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L42) - ---- - -### DeployedTransaction - -Ƭ **DeployedTransaction**: `OPENRPC.DeployedTransaction` - -#### Defined in - -[src/types/api/rpc.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L43) - ---- - -### Methods - -Ƭ **Methods**: `OPENRPC.Methods` - -#### Defined in - -[src/types/api/rpc.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L44) - ---- - -### Storage - -Ƭ **Storage**: `OPENRPC.Storage` - -#### Defined in - -[src/types/api/rpc.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L45) - ---- - -### StorageDiffs - -Ƭ **StorageDiffs**: `CONTRACT_STORAGE_DIFF_ITEM`[] - -#### Defined in - -[src/types/api/rpc.ts:56](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L56) - ---- - -### DeclaredContractHashes - -Ƭ **DeclaredContractHashes**: `FELT`[] - -#### Defined in - -[src/types/api/rpc.ts:57](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L57) - ---- - -### Nonces - -Ƭ **Nonces**: { `contract_address`: `ADDRESS` ; `nonce`: `FELT` }[] - -#### Defined in - -[src/types/api/rpc.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L58) diff --git a/www/versioned_docs/version-5.14.1/API/namespaces/Sequencer.md b/www/versioned_docs/version-5.14.1/API/namespaces/Sequencer.md deleted file mode 100644 index 798456a0d..000000000 --- a/www/versioned_docs/version-5.14.1/API/namespaces/Sequencer.md +++ /dev/null @@ -1,713 +0,0 @@ ---- -id: 'Sequencer' -title: 'Namespace: Sequencer' -sidebar_label: 'Sequencer' -sidebar_position: 0 -custom_edit_url: null ---- - -## Interfaces - -- [InvokeFunctionTransactionResponse](../interfaces/Sequencer.InvokeFunctionTransactionResponse.md) - -## Type Aliases - -### DeclareTransaction - -Ƭ **DeclareTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :--------------------------------------------- | -| `type` | `"DECLARE"` | -| `sender_address` | `string` | -| `contract_class` | [`ContractClass`](../modules.md#contractclass) | -| `signature?` | `string`[] | -| `nonce` | [`BigNumberish`](num.md#bignumberish) | -| `max_fee?` | [`BigNumberish`](num.md#bignumberish) | -| `version?` | [`BigNumberish`](num.md#bignumberish) | -| `compiled_class_hash?` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:81](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L81) - ---- - -### DeployTransaction - -Ƭ **DeployTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :--------------------------------------------- | -| `type` | `"DEPLOY"` | -| `contract_definition` | [`ContractClass`](../modules.md#contractclass) | -| `contract_address_salt` | [`BigNumberish`](num.md#bignumberish) | -| `constructor_calldata` | `string`[] | -| `nonce?` | [`BigNumberish`](num.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:92](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L92) - ---- - -### DeployAccountTransaction - -Ƭ **DeployAccountTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :------------------------------------ | -| `type` | `"DEPLOY_ACCOUNT"` | -| `class_hash` | `string` | -| `contract_address_salt` | [`BigNumberish`](num.md#bignumberish) | -| `constructor_calldata` | `string`[] | -| `signature?` | `string`[] | -| `max_fee?` | [`BigNumberish`](num.md#bignumberish) | -| `version?` | [`BigNumberish`](num.md#bignumberish) | -| `nonce?` | [`BigNumberish`](num.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L100) - ---- - -### InvokeFunctionTransaction - -Ƭ **InvokeFunctionTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------------------------------------------------ | -| `type` | `"INVOKE_FUNCTION"` | -| `sender_address` | `string` | -| `signature?` | `string`[] | -| `entry_point_type?` | [`EXTERNAL`](../enums/EntryPointType.md#external) | -| `calldata?` | [`RawCalldata`](../modules.md#rawcalldata) | -| `nonce` | [`BigNumberish`](num.md#bignumberish) | -| `max_fee?` | [`BigNumberish`](num.md#bignumberish) | -| `version?` | [`BigNumberish`](num.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:111](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L111) - ---- - -### Transaction - -Ƭ **Transaction**: [`DeclareTransaction`](Sequencer.md#declaretransaction) \| [`DeployTransaction`](Sequencer.md#deploytransaction) \| [`InvokeFunctionTransaction`](Sequencer.md#invokefunctiontransaction) \| [`DeployAccountTransaction`](Sequencer.md#deployaccounttransaction) - -#### Defined in - -[src/types/api/sequencer.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L122) - ---- - -### AddTransactionResponse - -Ƭ **AddTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :----------------------- | -| `transaction_hash` | `string` | -| `code?` | `"TRANSACTION_RECEIVED"` | -| `address?` | `string` | -| `class_hash?` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:128](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L128) - ---- - -### GetCodeResponse - -Ƭ **GetCodeResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----------------------------------- | -| `bytecode` | [`ByteCode`](../modules.md#bytecode) | -| `abi` | [`Abi`](../modules.md#abi) | - -#### Defined in - -[src/types/api/sequencer.ts:135](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L135) - ---- - -### TransactionResponse - -Ƭ **TransactionResponse**: [`DeclareTransaction`](Sequencer.md#declaretransaction) \| [`DeployTransaction`](Sequencer.md#deploytransaction) \| [`InvokeFunctionTransactionResponse`](../interfaces/Sequencer.InvokeFunctionTransactionResponse.md) - -#### Defined in - -[src/types/api/sequencer.ts:145](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L145) - ---- - -### SuccessfulTransactionResponse - -Ƭ **SuccessfulTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :-------------------------------------------------------- | -| `status` | [`Status`](../modules.md#status) | -| `transaction` | [`TransactionResponse`](Sequencer.md#transactionresponse) | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](../modules.md#blocknumber) | -| `transaction_index` | `number` | - -#### Defined in - -[src/types/api/sequencer.ts:150](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L150) - ---- - -### FailedTransactionResponse - -Ƭ **FailedTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :-------------------------------------------------------- | -| `status` | `"REJECTED"` | -| `transaction_failure_reason` | { `code`: `string` ; `error_message`: `string` } | -| `transaction_failure_reason.code` | `string` | -| `transaction_failure_reason.error_message` | `string` | -| `transaction` | [`TransactionResponse`](Sequencer.md#transactionresponse) | - -#### Defined in - -[src/types/api/sequencer.ts:158](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L158) - ---- - -### GetTransactionResponse - -Ƭ **GetTransactionResponse**: [`SuccessfulTransactionResponse`](Sequencer.md#successfultransactionresponse) \| [`FailedTransactionResponse`](Sequencer.md#failedtransactionresponse) - -#### Defined in - -[src/types/api/sequencer.ts:167](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L167) - ---- - -### TransactionReceiptResponse - -Ƭ **TransactionReceiptResponse**: [`SuccessfulTransactionReceiptResponse`](Sequencer.md#successfultransactionreceiptresponse) \| [`FailedTransactionReceiptResponse`](Sequencer.md#failedtransactionreceiptresponse) - -#### Defined in - -[src/types/api/sequencer.ts:169](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L169) - ---- - -### SuccessfulTransactionReceiptResponse - -Ƭ **SuccessfulTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------------------------------------------------------- | -| `status` | [`Status`](../modules.md#status) | -| `transaction_hash` | `string` | -| `transaction_index` | `number` | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](../modules.md#blocknumber) | -| `l2_to_l1_messages` | `string`[] | -| `events` | `string`[] | -| `actual_fee` | `string` | -| `execution_resources` | [`ExecutionResources`](../modules.md#executionresources) | - -#### Defined in - -[src/types/api/sequencer.ts:173](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L173) - ---- - -### FailedTransactionReceiptResponse - -Ƭ **FailedTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :----------------------------------------------- | -| `status` | `"REJECTED"` | -| `transaction_failure_reason` | { `code`: `string` ; `error_message`: `string` } | -| `transaction_failure_reason.code` | `string` | -| `transaction_failure_reason.error_message` | `string` | -| `transaction_hash` | `string` | -| `l2_to_l1_messages` | `string`[] | -| `events` | `string`[] | - -#### Defined in - -[src/types/api/sequencer.ts:185](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L185) - ---- - -### GetBlockResponse - -Ƭ **GetBlockResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `block_number` | `number` | -| `state_root` | `string` | -| `block_hash` | `string` | -| `transactions` | { `[txHash: string]`: [`TransactionResponse`](Sequencer.md#transactionresponse); } | -| `timestamp` | `number` | -| `transaction_receipts` | { `[txHash: string]`: { `block_hash`: `string` ; `transaction_hash`: `string` ; `l2_to_l1_messages`: { `to_address`: `string` ; `payload`: `string`[] ; `from_address`: `string` }[] ; `block_number`: [`BlockNumber`](../modules.md#blocknumber) ; `status`: [`Status`](../modules.md#status) ; `transaction_index`: `number` }; } | -| `parent_block_hash` | `string` | -| `status` | [`Status`](../modules.md#status) | -| `gas_price` | `string` | -| `sequencer_address` | `string` | -| `starknet_version` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:196](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L196) - ---- - -### CallContractTransaction - -Ƭ **CallContractTransaction**: { `calldata?`: [`RawCalldata`](../modules.md#rawcalldata) ; `max_fee?`: [`BigNumberish`](num.md#bignumberish) ; `version?`: [`BigNumberish`](num.md#bignumberish) ; `entry_point_selector`: `string` } & { `sender_address`: `string` ; `signature`: `string`[] } \| { `contract_address`: `string` ; `signature?`: `never` } - -#### Defined in - -[src/types/api/sequencer.ts:225](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L225) - ---- - -### CallContractResponse - -Ƭ **CallContractResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------- | -| `result` | `string`[] | - -#### Defined in - -[src/types/api/sequencer.ts:241](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L241) - ---- - -### InvokeEstimateFee - -Ƭ **InvokeEstimateFee**: `Omit`<[`InvokeFunctionTransaction`](Sequencer.md#invokefunctiontransaction), `"max_fee"` \| `"entry_point_type"`\> - -#### Defined in - -[src/types/api/sequencer.ts:245](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L245) - ---- - -### DeclareEstimateFee - -Ƭ **DeclareEstimateFee**: `Omit`<[`DeclareTransaction`](Sequencer.md#declaretransaction), `"max_fee"`\> - -#### Defined in - -[src/types/api/sequencer.ts:246](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L246) - ---- - -### DeployAccountEstimateFee - -Ƭ **DeployAccountEstimateFee**: `Omit`<[`DeployAccountTransaction`](Sequencer.md#deployaccounttransaction), `"max_fee"`\> - -#### Defined in - -[src/types/api/sequencer.ts:247](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L247) - ---- - -### DeployEstimateFee - -Ƭ **DeployEstimateFee**: [`DeployTransaction`](Sequencer.md#deploytransaction) - -#### Defined in - -[src/types/api/sequencer.ts:248](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L248) - ---- - -### EstimateFeeRequest - -Ƭ **EstimateFeeRequest**: [`InvokeEstimateFee`](Sequencer.md#invokeestimatefee) \| [`DeclareEstimateFee`](Sequencer.md#declareestimatefee) \| [`DeployEstimateFee`](Sequencer.md#deployestimatefee) \| [`DeployAccountEstimateFee`](Sequencer.md#deployaccountestimatefee) - -#### Defined in - -[src/types/api/sequencer.ts:250](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L250) - ---- - -### TransactionSimulationResponse - -Ƭ **TransactionSimulationResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------- | :------------------------------------------------------------------- | -| `trace` | [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) | -| `fee_estimation` | [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) | - -#### Defined in - -[src/types/api/sequencer.ts:256](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L256) - ---- - -### SimulateTransaction - -Ƭ **SimulateTransaction**: `Omit`<[`InvokeFunctionTransaction`](Sequencer.md#invokefunctiontransaction), `"entry_point_type"`\> - -#### Defined in - -[src/types/api/sequencer.ts:261](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L261) - ---- - -### EstimateFeeRequestBulk - -Ƭ **EstimateFeeRequestBulk**: [`AllowArray`](../modules.md#allowarray)<[`InvokeEstimateFee`](Sequencer.md#invokeestimatefee) \| [`DeclareEstimateFee`](Sequencer.md#declareestimatefee) \| [`DeployEstimateFee`](Sequencer.md#deployestimatefee) \| [`DeployAccountEstimateFee`](Sequencer.md#deployaccountestimatefee)\> - -#### Defined in - -[src/types/api/sequencer.ts:263](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L263) - ---- - -### EstimateFeeResponse - -Ƭ **EstimateFeeResponse**: { `overall_fee`: `number` ; `gas_price`: `number` ; `gas_usage`: `number` ; `uint`: `string` } \| { `amount`: `bigint` ; `unit`: `string` } - -#### Defined in - -[src/types/api/sequencer.ts:268](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L268) - ---- - -### EstimateFeeResponseBulk - -Ƭ **EstimateFeeResponseBulk**: [`AllowArray`](../modules.md#allowarray)<[`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse)\> - -#### Defined in - -[src/types/api/sequencer.ts:280](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L280) - ---- - -### BlockTransactionTracesResponse - -Ƭ **BlockTransactionTracesResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :-------------------------------------------------------------------------------------------------------- | -| `traces` | [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) & { `transaction_hash`: `string` }[] | - -#### Defined in - -[src/types/api/sequencer.ts:282](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L282) - ---- - -### Storage - -Ƭ **Storage**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:286](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L286) - ---- - -### StateUpdateResponse - -Ƭ **StateUpdateResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `block_hash` | `string` | -| `new_root` | `string` | -| `old_root` | `string` | -| `state_diff` | { `storage_diffs`: [`StorageDiffs`](Sequencer.md#storagediffs) ; `nonces`: [`Nonces`](Sequencer.md#nonces) ; `deployed_contracts`: [`DeployedContractItem`](../modules.md#deployedcontractitem)[] ; `old_declared_contracts`: [`OldDeclaredContracts`](Sequencer.md#olddeclaredcontracts) ; `declared_classes`: [`DeclaredClasses`](Sequencer.md#declaredclasses) ; `replaced_classes`: [`ReplacedClasses`](Sequencer.md#replacedclasses) } | -| `state_diff.storage_diffs` | [`StorageDiffs`](Sequencer.md#storagediffs) | -| `state_diff.nonces` | [`Nonces`](Sequencer.md#nonces) | -| `state_diff.deployed_contracts` | [`DeployedContractItem`](../modules.md#deployedcontractitem)[] | -| `state_diff.old_declared_contracts` | [`OldDeclaredContracts`](Sequencer.md#olddeclaredcontracts) | -| `state_diff.declared_classes` | [`DeclaredClasses`](Sequencer.md#declaredclasses) | -| `state_diff.replaced_classes` | [`ReplacedClasses`](Sequencer.md#replacedclasses) | - -#### Defined in - -[src/types/api/sequencer.ts:288](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L288) - ---- - -### StorageDiffs - -Ƭ **StorageDiffs**: `Object` - -#### Index signature - -▪ [address: `string`]: [`StateDiffItem`](Sequencer.md#statediffitem)[] - -#### Defined in - -[src/types/api/sequencer.ts:302](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L302) - ---- - -### StateDiffItem - -Ƭ **StateDiffItem**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------- | -| `key` | `string` | -| `value` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:304](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L304) - ---- - -### Nonces - -Ƭ **Nonces**: `Object` - -#### Index signature - -▪ [address: `string`]: [`Nonce`](Sequencer.md#nonce) - -#### Defined in - -[src/types/api/sequencer.ts:306](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L306) - ---- - -### Nonce - -Ƭ **Nonce**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:308](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L308) - ---- - -### DeployedContracts - -Ƭ **DeployedContracts**: [`DeployedContractItem`](../modules.md#deployedcontractitem)[] - -#### Defined in - -[src/types/api/sequencer.ts:310](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L310) - ---- - -### OldDeclaredContracts - -Ƭ **OldDeclaredContracts**: `string`[] - -#### Defined in - -[src/types/api/sequencer.ts:312](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L312) - ---- - -### DeclaredClasses - -Ƭ **DeclaredClasses**: [`DeclaredClass`](Sequencer.md#declaredclass)[] - -#### Defined in - -[src/types/api/sequencer.ts:314](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L314) - ---- - -### DeclaredClass - -Ƭ **DeclaredClass**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `class_hash` | `string` | -| `compiled_class_hash` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:316](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L316) - ---- - -### ReplacedClasses - -Ƭ **ReplacedClasses**: `string`[] - -#### Defined in - -[src/types/api/sequencer.ts:318](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L318) - ---- - -### Endpoints - -Ƭ **Endpoints**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `get_contract_addresses` | { `QUERY`: `never` ; `REQUEST`: `never` ; `RESPONSE`: [`GetContractAddressesResponse`](../modules.md#getcontractaddressesresponse) } | -| `get_contract_addresses.QUERY` | `never` | -| `get_contract_addresses.REQUEST` | `never` | -| `get_contract_addresses.RESPONSE` | [`GetContractAddressesResponse`](../modules.md#getcontractaddressesresponse) | -| `add_transaction` | { `QUERY`: `never` ; `REQUEST`: [`Transaction`](Sequencer.md#transaction) ; `RESPONSE`: [`AddTransactionResponse`](Sequencer.md#addtransactionresponse) } | -| `add_transaction.QUERY` | `never` | -| `add_transaction.REQUEST` | [`Transaction`](Sequencer.md#transaction) | -| `add_transaction.RESPONSE` | [`AddTransactionResponse`](Sequencer.md#addtransactionresponse) | -| `get_transaction` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetTransactionResponse`](Sequencer.md#gettransactionresponse) } | -| `get_transaction.QUERY` | { `transactionHash`: `string` } | -| `get_transaction.QUERY.transactionHash` | `string` | -| `get_transaction.REQUEST` | `never` | -| `get_transaction.RESPONSE` | [`GetTransactionResponse`](Sequencer.md#gettransactionresponse) | -| `get_transaction_status` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetTransactionStatusResponse`](../modules.md#gettransactionstatusresponse) } | -| `get_transaction_status.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_status.QUERY.transactionHash` | `string` | -| `get_transaction_status.REQUEST` | `never` | -| `get_transaction_status.RESPONSE` | [`GetTransactionStatusResponse`](../modules.md#gettransactionstatusresponse) | -| `get_transaction_trace` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) } | -| `get_transaction_trace.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_trace.QUERY.transactionHash` | `string` | -| `get_transaction_trace.REQUEST` | `never` | -| `get_transaction_trace.RESPONSE` | [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) | -| `get_transaction_receipt` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`TransactionReceiptResponse`](Sequencer.md#transactionreceiptresponse) } | -| `get_transaction_receipt.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_receipt.QUERY.transactionHash` | `string` | -| `get_transaction_receipt.REQUEST` | `never` | -| `get_transaction_receipt.RESPONSE` | [`TransactionReceiptResponse`](Sequencer.md#transactionreceiptresponse) | -| `get_nonce` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`Nonce`](Sequencer.md#nonce) } | -| `get_nonce.QUERY` | { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } | -| `get_nonce.QUERY.contractAddress` | `string` | -| `get_nonce.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_nonce.REQUEST` | `never` | -| `get_nonce.RESPONSE` | [`Nonce`](Sequencer.md#nonce) | -| `get_storage_at` | { `QUERY`: { `contractAddress`: `string` ; `key`: [`BigNumberish`](num.md#bignumberish) ; `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`Storage`](Sequencer.md#storage) } | -| `get_storage_at.QUERY` | { `contractAddress`: `string` ; `key`: [`BigNumberish`](num.md#bignumberish) ; `blockIdentifier`: `BlockIdentifier` } | -| `get_storage_at.QUERY.contractAddress` | `string` | -| `get_storage_at.QUERY.key` | [`BigNumberish`](num.md#bignumberish) | -| `get_storage_at.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_storage_at.REQUEST` | `never` | -| `get_storage_at.RESPONSE` | [`Storage`](Sequencer.md#storage) | -| `get_code` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetCodeResponse`](Sequencer.md#getcoderesponse) } | -| `get_code.QUERY` | { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } | -| `get_code.QUERY.contractAddress` | `string` | -| `get_code.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_code.REQUEST` | `never` | -| `get_code.RESPONSE` | [`GetCodeResponse`](Sequencer.md#getcoderesponse) | -| `get_block` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetBlockResponse`](Sequencer.md#getblockresponse) } | -| `get_block.QUERY` | { `blockIdentifier`: `BlockIdentifier` } | -| `get_block.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_block.REQUEST` | `never` | -| `get_block.RESPONSE` | [`GetBlockResponse`](Sequencer.md#getblockresponse) | -| `call_contract` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: [`CallContractTransaction`](Sequencer.md#callcontracttransaction) ; `RESPONSE`: [`CallContractResponse`](Sequencer.md#callcontractresponse) } | -| `call_contract.QUERY` | { `blockIdentifier`: `BlockIdentifier` } | -| `call_contract.QUERY.blockIdentifier` | `BlockIdentifier` | -| `call_contract.REQUEST` | [`CallContractTransaction`](Sequencer.md#callcontracttransaction) | -| `call_contract.RESPONSE` | [`CallContractResponse`](Sequencer.md#callcontractresponse) | -| `estimate_fee` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } ; `REQUEST`: [`EstimateFeeRequest`](Sequencer.md#estimatefeerequest) ; `RESPONSE`: [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) } | -| `estimate_fee.QUERY` | { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } | -| `estimate_fee.QUERY.blockIdentifier` | `BlockIdentifier` | -| `estimate_fee.QUERY.skipValidate` | `boolean` | -| `estimate_fee.REQUEST` | [`EstimateFeeRequest`](Sequencer.md#estimatefeerequest) | -| `estimate_fee.RESPONSE` | [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) | -| `get_class_by_hash` | { `QUERY`: { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`CompiledContract`](../modules.md#compiledcontract) } | -| `get_class_by_hash.QUERY` | { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_class_by_hash.QUERY.classHash` | `string` | -| `get_class_by_hash.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_class_by_hash.REQUEST` | `never` | -| `get_class_by_hash.RESPONSE` | [`CompiledContract`](../modules.md#compiledcontract) | -| `get_class_hash_at` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: `string` } | -| `get_class_hash_at.QUERY` | { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_class_hash_at.QUERY.contractAddress` | `string` | -| `get_class_hash_at.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_class_hash_at.REQUEST` | `never` | -| `get_class_hash_at.RESPONSE` | `string` | -| `get_state_update` | { `QUERY`: { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } ; `REQUEST`: `never` ; `RESPONSE`: [`StateUpdateResponse`](Sequencer.md#stateupdateresponse) } | -| `get_state_update.QUERY` | { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } | -| `get_state_update.QUERY.blockHash?` | `string` | -| `get_state_update.QUERY.blockNumber?` | [`BlockNumber`](../modules.md#blocknumber) | -| `get_state_update.REQUEST` | `never` | -| `get_state_update.RESPONSE` | [`StateUpdateResponse`](Sequencer.md#stateupdateresponse) | -| `get_full_contract` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`CompiledContract`](../modules.md#compiledcontract) } | -| `get_full_contract.QUERY` | { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_full_contract.QUERY.contractAddress` | `string` | -| `get_full_contract.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_full_contract.REQUEST` | `never` | -| `get_full_contract.RESPONSE` | [`CompiledContract`](../modules.md#compiledcontract) | -| `estimate_message_fee` | { `QUERY`: `any` ; `REQUEST`: `any` ; `RESPONSE`: [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) } | -| `estimate_message_fee.QUERY` | `any` | -| `estimate_message_fee.REQUEST` | `any` | -| `estimate_message_fee.RESPONSE` | [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) | -| `simulate_transaction` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } ; `REQUEST`: [`SimulateTransaction`](Sequencer.md#simulatetransaction) ; `RESPONSE`: [`TransactionSimulationResponse`](Sequencer.md#transactionsimulationresponse) } | -| `simulate_transaction.QUERY` | { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } | -| `simulate_transaction.QUERY.blockIdentifier` | `BlockIdentifier` | -| `simulate_transaction.QUERY.skipValidate` | `boolean` | -| `simulate_transaction.REQUEST` | [`SimulateTransaction`](Sequencer.md#simulatetransaction) | -| `simulate_transaction.RESPONSE` | [`TransactionSimulationResponse`](Sequencer.md#transactionsimulationresponse) | -| `estimate_fee_bulk` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: [`EstimateFeeRequestBulk`](Sequencer.md#estimatefeerequestbulk) ; `RESPONSE`: [`EstimateFeeResponseBulk`](Sequencer.md#estimatefeeresponsebulk) } | -| `estimate_fee_bulk.QUERY` | { `blockIdentifier`: `BlockIdentifier` } | -| `estimate_fee_bulk.QUERY.blockIdentifier` | `BlockIdentifier` | -| `estimate_fee_bulk.REQUEST` | [`EstimateFeeRequestBulk`](Sequencer.md#estimatefeerequestbulk) | -| `estimate_fee_bulk.RESPONSE` | [`EstimateFeeResponseBulk`](Sequencer.md#estimatefeeresponsebulk) | -| `get_block_traces` | { `QUERY`: { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } ; `REQUEST`: `never` ; `RESPONSE`: [`BlockTransactionTracesResponse`](Sequencer.md#blocktransactiontracesresponse) } | -| `get_block_traces.QUERY` | { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } | -| `get_block_traces.QUERY.blockHash?` | `string` | -| `get_block_traces.QUERY.blockNumber?` | [`BlockNumber`](../modules.md#blocknumber) | -| `get_block_traces.REQUEST` | `never` | -| `get_block_traces.RESPONSE` | [`BlockTransactionTracesResponse`](Sequencer.md#blocktransactiontracesresponse) | -| `get_compiled_class_by_class_hash` | { `QUERY`: { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `any` ; `RESPONSE`: [`CairoAssembly`](../modules.md#cairoassembly) } | -| `get_compiled_class_by_class_hash.QUERY` | { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_compiled_class_by_class_hash.QUERY.classHash` | `string` | -| `get_compiled_class_by_class_hash.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_compiled_class_by_class_hash.REQUEST` | `any` | -| `get_compiled_class_by_class_hash.RESPONSE` | [`CairoAssembly`](../modules.md#cairoassembly) | - -#### Defined in - -[src/types/api/sequencer.ts:320](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L320) diff --git a/www/versioned_docs/version-5.19.5/API/enums/EntryPointType.md b/www/versioned_docs/version-5.19.5/API/enums/EntryPointType.md deleted file mode 100644 index d12d855dd..000000000 --- a/www/versioned_docs/version-5.19.5/API/enums/EntryPointType.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'EntryPointType' -title: 'Enumeration: EntryPointType' -sidebar_label: 'EntryPointType' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### EXTERNAL - -• **EXTERNAL** = `"EXTERNAL"` - -#### Defined in - -[src/types/lib/contract/index.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L11) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"L1_HANDLER"` - -#### Defined in - -[src/types/lib/contract/index.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L12) - ---- - -### CONSTRUCTOR - -• **CONSTRUCTOR** = `"CONSTRUCTOR"` - -#### Defined in - -[src/types/lib/contract/index.ts:13](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/index.ts#L13) diff --git a/www/versioned_docs/version-5.19.5/API/enums/RPC.TransactionType.md b/www/versioned_docs/version-5.19.5/API/enums/RPC.TransactionType.md deleted file mode 100644 index ac692bad3..000000000 --- a/www/versioned_docs/version-5.19.5/API/enums/RPC.TransactionType.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: 'RPC.TransactionType' -title: 'Enumeration: TransactionType' -sidebar_label: 'TransactionType' -custom_edit_url: null ---- - -[RPC](../namespaces/RPC.md).TransactionType - -## Enumeration Members - -### DECLARE - -• **DECLARE** = `"DECLARE"` - -#### Defined in - -[src/types/api/rpc.ts:48](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L48) - ---- - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/api/rpc.ts:49](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L49) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"DEPLOY_ACCOUNT"` - -#### Defined in - -[src/types/api/rpc.ts:50](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L50) - ---- - -### INVOKE - -• **INVOKE** = `"INVOKE"` - -#### Defined in - -[src/types/api/rpc.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L51) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"L1_HANDLER"` - -#### Defined in - -[src/types/api/rpc.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L52) diff --git a/www/versioned_docs/version-5.19.5/API/enums/TransactionStatus.md b/www/versioned_docs/version-5.19.5/API/enums/TransactionStatus.md deleted file mode 100644 index bb7db2b2e..000000000 --- a/www/versioned_docs/version-5.19.5/API/enums/TransactionStatus.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: 'TransactionStatus' -title: 'Enumeration: TransactionStatus' -sidebar_label: 'TransactionStatus' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### NOT_RECEIVED - -• **NOT_RECEIVED** = `"NOT_RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:120](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L120) - ---- - -### RECEIVED - -• **RECEIVED** = `"RECEIVED"` - -#### Defined in - -[src/types/lib/index.ts:121](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L121) - ---- - -### PENDING - -• **PENDING** = `"PENDING"` - -#### Defined in - -[src/types/lib/index.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L122) - ---- - -### ACCEPTED_ON_L2 - -• **ACCEPTED_ON_L2** = `"ACCEPTED_ON_L2"` - -#### Defined in - -[src/types/lib/index.ts:123](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L123) - ---- - -### ACCEPTED_ON_L1 - -• **ACCEPTED_ON_L1** = `"ACCEPTED_ON_L1"` - -#### Defined in - -[src/types/lib/index.ts:124](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L124) - ---- - -### REJECTED - -• **REJECTED** = `"REJECTED"` - -#### Defined in - -[src/types/lib/index.ts:125](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L125) diff --git a/www/versioned_docs/version-5.19.5/API/enums/TransactionType.md b/www/versioned_docs/version-5.19.5/API/enums/TransactionType.md deleted file mode 100644 index 13cfbb5f8..000000000 --- a/www/versioned_docs/version-5.19.5/API/enums/TransactionType.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: 'TransactionType' -title: 'Enumeration: TransactionType' -sidebar_label: 'TransactionType' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### INVOKE - -• **INVOKE** = `"INVOKE_FUNCTION"` - -#### Defined in - -[src/types/lib/index.ts:154](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L154) - ---- - -### DECLARE - -• **DECLARE** = `"DECLARE"` - -#### Defined in - -[src/types/lib/index.ts:155](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L155) - ---- - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/lib/index.ts:156](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L156) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"DEPLOY_ACCOUNT"` - -#### Defined in - -[src/types/lib/index.ts:157](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L157) diff --git a/www/versioned_docs/version-5.19.5/API/enums/cairo.Uint.md b/www/versioned_docs/version-5.19.5/API/enums/cairo.Uint.md deleted file mode 100644 index f5e07a894..000000000 --- a/www/versioned_docs/version-5.19.5/API/enums/cairo.Uint.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: 'cairo.Uint' -title: 'Enumeration: Uint' -sidebar_label: 'Uint' -custom_edit_url: null ---- - -[cairo](../namespaces/cairo.md).Uint - -## Enumeration Members - -### u8 - -• **u8** = `"core::integer::u8"` - -#### Defined in - -[src/utils/calldata/cairo.ts:7](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L7) - ---- - -### u16 - -• **u16** = `"core::integer::u16"` - -#### Defined in - -[src/utils/calldata/cairo.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L8) - ---- - -### u32 - -• **u32** = `"core::integer::u32"` - -#### Defined in - -[src/utils/calldata/cairo.ts:9](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L9) - ---- - -### u64 - -• **u64** = `"core::integer::u64"` - -#### Defined in - -[src/utils/calldata/cairo.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L10) - ---- - -### u128 - -• **u128** = `"core::integer::u128"` - -#### Defined in - -[src/utils/calldata/cairo.ts:11](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L11) - ---- - -### u256 - -• **u256** = `"core::integer::u256"` - -#### Defined in - -[src/utils/calldata/cairo.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/calldata/cairo.ts#L12) diff --git a/www/versioned_docs/version-5.19.5/API/enums/types.RPC.TransactionType.md b/www/versioned_docs/version-5.19.5/API/enums/types.RPC.TransactionType.md deleted file mode 100644 index 85bb03dae..000000000 --- a/www/versioned_docs/version-5.19.5/API/enums/types.RPC.TransactionType.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: 'types.RPC.TransactionType' -title: 'Enumeration: TransactionType' -sidebar_label: 'TransactionType' -custom_edit_url: null ---- - -[types](../namespaces/types.md).[RPC](../namespaces/types.RPC.md).TransactionType - -## Enumeration Members - -### DECLARE - -• **DECLARE** = `"DECLARE"` - -#### Defined in - -[src/types/api/rpc.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L51) - ---- - -### DEPLOY - -• **DEPLOY** = `"DEPLOY"` - -#### Defined in - -[src/types/api/rpc.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L52) - ---- - -### DEPLOY_ACCOUNT - -• **DEPLOY_ACCOUNT** = `"DEPLOY_ACCOUNT"` - -#### Defined in - -[src/types/api/rpc.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L53) - ---- - -### INVOKE - -• **INVOKE** = `"INVOKE"` - -#### Defined in - -[src/types/api/rpc.ts:54](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L54) - ---- - -### L1_HANDLER - -• **L1_HANDLER** = `"L1_HANDLER"` - -#### Defined in - -[src/types/api/rpc.ts:55](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L55) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/CallStruct.md b/www/versioned_docs/version-5.19.5/API/interfaces/CallStruct.md deleted file mode 100644 index daa7d572d..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/CallStruct.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'CallStruct' -title: 'Interface: CallStruct' -sidebar_label: 'CallStruct' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### to - -• **to**: `string` - -#### Defined in - -[src/types/lib/index.ts:181](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L181) - ---- - -### selector - -• **selector**: `string` - -#### Defined in - -[src/types/lib/index.ts:182](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L182) - ---- - -### calldata - -• **calldata**: `string`[] - -#### Defined in - -[src/types/lib/index.ts:183](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L183) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/CommonTransactionReceiptResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/CommonTransactionReceiptResponse.md deleted file mode 100644 index dccb43798..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/CommonTransactionReceiptResponse.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: 'CommonTransactionReceiptResponse' -title: 'Interface: CommonTransactionReceiptResponse' -sidebar_label: 'CommonTransactionReceiptResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`CommonTransactionReceiptResponse`** - - ↳ [`InvokeTransactionReceiptResponse`](InvokeTransactionReceiptResponse.md) - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:72](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L72) - ---- - -### status - -• `Optional` **status**: [`Status`](../modules.md#status) - -#### Defined in - -[src/types/provider.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L73) - ---- - -### actual_fee - -• `Optional` **actual_fee**: `string` - -#### Defined in - -[src/types/provider.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L74) - ---- - -### status_data - -• `Optional` **status_data**: `string` - -#### Defined in - -[src/types/provider.ts:75](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L75) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/CommonTransactionResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/CommonTransactionResponse.md deleted file mode 100644 index 12cff7e67..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/CommonTransactionResponse.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: 'CommonTransactionResponse' -title: 'Interface: CommonTransactionResponse' -sidebar_label: 'CommonTransactionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`CommonTransactionResponse`** - - ↳ [`InvokeTransactionResponse`](InvokeTransactionResponse.md) - - ↳ [`DeclareTransactionResponse`](DeclareTransactionResponse.md) - -## Properties - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L43) - ---- - -### version - -• `Optional` **version**: `string` - -#### Defined in - -[src/types/provider.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L44) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../modules.md#signature) - -#### Defined in - -[src/types/provider.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L45) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Defined in - -[src/types/provider.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L46) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Defined in - -[src/types/provider.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L47) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/ContractEntryPoint.md b/www/versioned_docs/version-5.19.5/API/interfaces/ContractEntryPoint.md deleted file mode 100644 index af76821bb..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/ContractEntryPoint.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'ContractEntryPoint' -title: 'Interface: ContractEntryPoint' -sidebar_label: 'ContractEntryPoint' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### offset - -• **offset**: `string` - -#### Defined in - -[src/types/provider.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L58) - ---- - -### selector - -• **selector**: `string` - -#### Defined in - -[src/types/provider.ts:59](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L59) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/DeclareContractResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/DeclareContractResponse.md deleted file mode 100644 index 6c128e5f2..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/DeclareContractResponse.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'DeclareContractResponse' -title: 'Interface: DeclareContractResponse' -sidebar_label: 'DeclareContractResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L115) - ---- - -### class_hash - -• **class_hash**: `string` - -#### Defined in - -[src/types/provider.ts:116](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L116) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/DeclareSignerDetails.md b/www/versioned_docs/version-5.19.5/API/interfaces/DeclareSignerDetails.md deleted file mode 100644 index b0902db42..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/DeclareSignerDetails.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: 'DeclareSignerDetails' -title: 'Interface: DeclareSignerDetails' -sidebar_label: 'DeclareSignerDetails' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### classHash - -• **classHash**: `string` - -#### Defined in - -[src/types/signer.ts:12](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L12) - ---- - -### senderAddress - -• **senderAddress**: `string` - -#### Defined in - -[src/types/signer.ts:13](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L13) - ---- - -### chainId - -• **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/types/signer.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L14) - ---- - -### maxFee - -• **maxFee**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:15](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L15) - ---- - -### version - -• **version**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L16) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/signer.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L17) - ---- - -### compiledClassHash - -• `Optional` **compiledClassHash**: `string` - -#### Defined in - -[src/types/signer.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L18) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/DeclareTransactionResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/DeclareTransactionResponse.md deleted file mode 100644 index 7debede4b..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/DeclareTransactionResponse.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -id: 'DeclareTransactionResponse' -title: 'Interface: DeclareTransactionResponse' -sidebar_label: 'DeclareTransactionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionResponse`](CommonTransactionResponse.md) - - ↳ **`DeclareTransactionResponse`** - -## Properties - -### contract_class - -• `Optional` **contract_class**: `any` - -#### Defined in - -[src/types/provider.ts:63](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L63) - ---- - -### sender_address - -• `Optional` **sender_address**: `string` - -#### Defined in - -[src/types/provider.ts:64](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L64) - ---- - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[transaction_hash](CommonTransactionResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L43) - ---- - -### version - -• `Optional` **version**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[version](CommonTransactionResponse.md#version) - -#### Defined in - -[src/types/provider.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L44) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../modules.md#signature) - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[signature](CommonTransactionResponse.md#signature) - -#### Defined in - -[src/types/provider.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L45) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[max_fee](CommonTransactionResponse.md#max_fee) - -#### Defined in - -[src/types/provider.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L46) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[nonce](CommonTransactionResponse.md#nonce) - -#### Defined in - -[src/types/provider.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L47) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/DeployContractResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/DeployContractResponse.md deleted file mode 100644 index 032441b15..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/DeployContractResponse.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'DeployContractResponse' -title: 'Interface: DeployContractResponse' -sidebar_label: 'DeployContractResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### contract_address - -• **contract_address**: `string` - -#### Defined in - -[src/types/account.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L22) - ---- - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/account.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L23) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/EstimateFee.md b/www/versioned_docs/version-5.19.5/API/interfaces/EstimateFee.md deleted file mode 100644 index c2c1767fa..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/EstimateFee.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: 'EstimateFee' -title: 'Interface: EstimateFee' -sidebar_label: 'EstimateFee' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`EstimateFeeResponse`](EstimateFeeResponse.md) - - ↳ **`EstimateFee`** - -## Properties - -### suggestedMaxFee - -• **suggestedMaxFee**: `bigint` - -#### Overrides - -[EstimateFeeResponse](EstimateFeeResponse.md).[suggestedMaxFee](EstimateFeeResponse.md#suggestedmaxfee) - -#### Defined in - -[src/types/account.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L10) - ---- - -### overall_fee - -• **overall_fee**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](EstimateFeeResponse.md).[overall_fee](EstimateFeeResponse.md#overall_fee) - -#### Defined in - -[src/types/provider.ts:104](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L104) - ---- - -### gas_consumed - -• `Optional` **gas_consumed**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](EstimateFeeResponse.md).[gas_consumed](EstimateFeeResponse.md#gas_consumed) - -#### Defined in - -[src/types/provider.ts:105](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L105) - ---- - -### gas_price - -• `Optional` **gas_price**: `bigint` - -#### Inherited from - -[EstimateFeeResponse](EstimateFeeResponse.md).[gas_price](EstimateFeeResponse.md#gas_price) - -#### Defined in - -[src/types/provider.ts:106](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L106) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/EstimateFeeDetails.md b/www/versioned_docs/version-5.19.5/API/interfaces/EstimateFeeDetails.md deleted file mode 100644 index 32bb54e93..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/EstimateFeeDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'EstimateFeeDetails' -title: 'Interface: EstimateFeeDetails' -sidebar_label: 'EstimateFeeDetails' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### nonce - -• `Optional` **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/types/account.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L16) - ---- - -### blockIdentifier - -• `Optional` **blockIdentifier**: `BlockIdentifier` - -#### Defined in - -[src/types/account.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L17) - ---- - -### skipValidate - -• `Optional` **skipValidate**: `boolean` - -#### Defined in - -[src/types/account.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L18) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/EstimateFeeResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/EstimateFeeResponse.md deleted file mode 100644 index f83d5eb02..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/EstimateFeeResponse.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: 'EstimateFeeResponse' -title: 'Interface: EstimateFeeResponse' -sidebar_label: 'EstimateFeeResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`EstimateFeeResponse`** - - ↳ [`EstimateFee`](EstimateFee.md) - -## Properties - -### overall_fee - -• **overall_fee**: `bigint` - -#### Defined in - -[src/types/provider.ts:104](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L104) - ---- - -### gas_consumed - -• `Optional` **gas_consumed**: `bigint` - -#### Defined in - -[src/types/provider.ts:105](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L105) - ---- - -### gas_price - -• `Optional` **gas_price**: `bigint` - -#### Defined in - -[src/types/provider.ts:106](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L106) - ---- - -### suggestedMaxFee - -• `Optional` **suggestedMaxFee**: `bigint` - -#### Defined in - -[src/types/provider.ts:107](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L107) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/Event.md b/www/versioned_docs/version-5.19.5/API/interfaces/Event.md deleted file mode 100644 index 7ee3df029..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/Event.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: 'Event' -title: 'Interface: Event' -sidebar_label: 'Event' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### from_address - -• **from_address**: `string` - -#### Defined in - -[src/types/provider.ts:84](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L84) - ---- - -### keys - -• **keys**: `string`[] - -#### Defined in - -[src/types/provider.ts:85](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L85) - ---- - -### data - -• **data**: `string`[] - -#### Defined in - -[src/types/provider.ts:86](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L86) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/GetBlockResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/GetBlockResponse.md deleted file mode 100644 index 5927a2005..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/GetBlockResponse.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -id: 'GetBlockResponse' -title: 'Interface: GetBlockResponse' -sidebar_label: 'GetBlockResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### timestamp - -• **timestamp**: `number` - -#### Defined in - -[src/types/provider.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L22) - ---- - -### block_hash - -• **block_hash**: `string` - -#### Defined in - -[src/types/provider.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L23) - ---- - -### block_number - -• **block_number**: `number` - -#### Defined in - -[src/types/provider.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L24) - ---- - -### new_root - -• **new_root**: `string` - -#### Defined in - -[src/types/provider.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L25) - ---- - -### parent_hash - -• **parent_hash**: `string` - -#### Defined in - -[src/types/provider.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L26) - ---- - -### status - -• **status**: [`Status`](../modules.md#status) - -#### Defined in - -[src/types/provider.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L27) - ---- - -### transactions - -• **transactions**: `string`[] - -#### Defined in - -[src/types/provider.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L28) - ---- - -### gas_price - -• `Optional` **gas_price**: `string` - -#### Defined in - -[src/types/provider.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L29) - ---- - -### sequencer_address - -• `Optional` **sequencer_address**: `string` - -#### Defined in - -[src/types/provider.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L30) - ---- - -### starknet_version - -• `Optional` **starknet_version**: `string` - -#### Defined in - -[src/types/provider.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L31) - ---- - -### transaction_receipts - -• `Optional` **transaction_receipts**: `any` - -#### Defined in - -[src/types/provider.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L32) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/GetCodeResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/GetCodeResponse.md deleted file mode 100644 index 3418b8433..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/GetCodeResponse.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: 'GetCodeResponse' -title: 'Interface: GetCodeResponse' -sidebar_label: 'GetCodeResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### bytecode - -• **bytecode**: [`ByteCode`](../modules.md#bytecode) - -#### Defined in - -[src/types/provider.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L36) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/InvocationsSignerDetails.md b/www/versioned_docs/version-5.19.5/API/interfaces/InvocationsSignerDetails.md deleted file mode 100644 index 9bfe79bc6..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/InvocationsSignerDetails.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: 'InvocationsSignerDetails' -title: 'Interface: InvocationsSignerDetails' -sidebar_label: 'InvocationsSignerDetails' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- `Required`<[`InvocationsDetails`](../modules.md#invocationsdetails)\> - - ↳ **`InvocationsSignerDetails`** - -## Properties - -### walletAddress - -• **walletAddress**: `string` - -#### Defined in - -[src/types/signer.ts:6](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L6) - ---- - -### chainId - -• **chainId**: [`StarknetChainId`](../enums/constants.StarknetChainId.md) - -#### Defined in - -[src/types/signer.ts:7](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L7) - ---- - -### cairoVersion - -• **cairoVersion**: [`CairoVersion`](../modules.md#cairoversion) - -#### Defined in - -[src/types/signer.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/types/signer.ts#L8) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -Required.nonce - -#### Defined in - -[src/types/lib/index.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L100) - ---- - -### maxFee - -• **maxFee**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -Required.maxFee - -#### Defined in - -[src/types/lib/index.ts:101](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L101) - ---- - -### version - -• **version**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -Required.version - -#### Defined in - -[src/types/lib/index.ts:102](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/index.ts#L102) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/InvokeFunctionResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/InvokeFunctionResponse.md deleted file mode 100644 index b1109c1ad..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/InvokeFunctionResponse.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: 'InvokeFunctionResponse' -title: 'Interface: InvokeFunctionResponse' -sidebar_label: 'InvokeFunctionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider.ts:111](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L111) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/InvokeTransactionReceiptResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/InvokeTransactionReceiptResponse.md deleted file mode 100644 index f180775c1..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/InvokeTransactionReceiptResponse.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -id: 'InvokeTransactionReceiptResponse' -title: 'Interface: InvokeTransactionReceiptResponse' -sidebar_label: 'InvokeTransactionReceiptResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionReceiptResponse`](CommonTransactionReceiptResponse.md) - - ↳ **`InvokeTransactionReceiptResponse`** - -## Properties - -### messages_sent - -• `Optional` **messages_sent**: [`MessageToL1`](MessageToL1.md)[] - -**`Deprecated`** - -Use l2_to_l1_messages - -#### Defined in - -[src/types/provider.ts:96](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L96) - ---- - -### events - -• `Optional` **events**: [`Event`](Event.md)[] - -#### Defined in - -[src/types/provider.ts:97](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L97) - ---- - -### l1_origin_message - -• `Optional` **l1_origin_message**: [`MessageToL2`](MessageToL2.md) - -#### Defined in - -[src/types/provider.ts:98](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L98) - ---- - -### transaction_hash - -• **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[transaction_hash](CommonTransactionReceiptResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider.ts:72](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L72) - ---- - -### status - -• `Optional` **status**: [`Status`](../modules.md#status) - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[status](CommonTransactionReceiptResponse.md#status) - -#### Defined in - -[src/types/provider.ts:73](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L73) - ---- - -### actual_fee - -• `Optional` **actual_fee**: `string` - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[actual_fee](CommonTransactionReceiptResponse.md#actual_fee) - -#### Defined in - -[src/types/provider.ts:74](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L74) - ---- - -### status_data - -• `Optional` **status_data**: `string` - -#### Inherited from - -[CommonTransactionReceiptResponse](CommonTransactionReceiptResponse.md).[status_data](CommonTransactionReceiptResponse.md#status_data) - -#### Defined in - -[src/types/provider.ts:75](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L75) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/InvokeTransactionResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/InvokeTransactionResponse.md deleted file mode 100644 index 7ba4e5238..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/InvokeTransactionResponse.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -id: 'InvokeTransactionResponse' -title: 'Interface: InvokeTransactionResponse' -sidebar_label: 'InvokeTransactionResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionResponse`](CommonTransactionResponse.md) - - ↳ **`InvokeTransactionResponse`** - -## Properties - -### contract_address - -• `Optional` **contract_address**: `string` - -#### Defined in - -[src/types/provider.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L51) - ---- - -### sender_address - -• `Optional` **sender_address**: `string` - -#### Defined in - -[src/types/provider.ts:52](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L52) - ---- - -### entry_point_selector - -• `Optional` **entry_point_selector**: `string` - -#### Defined in - -[src/types/provider.ts:53](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L53) - ---- - -### calldata - -• **calldata**: [`RawCalldata`](../modules.md#rawcalldata) - -#### Defined in - -[src/types/provider.ts:54](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L54) - ---- - -### transaction_hash - -• `Optional` **transaction_hash**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[transaction_hash](CommonTransactionResponse.md#transaction_hash) - -#### Defined in - -[src/types/provider.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L43) - ---- - -### version - -• `Optional` **version**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[version](CommonTransactionResponse.md#version) - -#### Defined in - -[src/types/provider.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L44) - ---- - -### signature - -• `Optional` **signature**: [`Signature`](../modules.md#signature) - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[signature](CommonTransactionResponse.md#signature) - -#### Defined in - -[src/types/provider.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L45) - ---- - -### max_fee - -• `Optional` **max_fee**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[max_fee](CommonTransactionResponse.md#max_fee) - -#### Defined in - -[src/types/provider.ts:46](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L46) - ---- - -### nonce - -• `Optional` **nonce**: `string` - -#### Inherited from - -[CommonTransactionResponse](CommonTransactionResponse.md).[nonce](CommonTransactionResponse.md#nonce) - -#### Defined in - -[src/types/provider.ts:47](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L47) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/MessageToL1.md b/www/versioned_docs/version-5.19.5/API/interfaces/MessageToL1.md deleted file mode 100644 index 254f3287f..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/MessageToL1.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'MessageToL1' -title: 'Interface: MessageToL1' -sidebar_label: 'MessageToL1' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### to_address - -• **to_address**: `string` - -#### Defined in - -[src/types/provider.ts:79](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L79) - ---- - -### payload - -• **payload**: `string`[] - -#### Defined in - -[src/types/provider.ts:80](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L80) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/MessageToL2.md b/www/versioned_docs/version-5.19.5/API/interfaces/MessageToL2.md deleted file mode 100644 index 7204c7a63..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/MessageToL2.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'MessageToL2' -title: 'Interface: MessageToL2' -sidebar_label: 'MessageToL2' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### from_address - -• **from_address**: `string` - -#### Defined in - -[src/types/provider.ts:90](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L90) - ---- - -### payload - -• **payload**: `string`[] - -#### Defined in - -[src/types/provider.ts:91](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L91) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/Program.md b/www/versioned_docs/version-5.19.5/API/interfaces/Program.md deleted file mode 100644 index 42e8eef92..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/Program.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: 'Program' -title: 'Interface: Program' -sidebar_label: 'Program' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- `Record`<`string`, `any`\> - - ↳ **`Program`** - -## Properties - -### builtins - -• **builtins**: `string`[] - -#### Defined in - -[src/types/lib/contract/legacy.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L31) - ---- - -### data - -• **data**: `string`[] - -#### Defined in - -[src/types/lib/contract/legacy.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/lib/contract/legacy.ts#L32) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/ProviderOptions.md b/www/versioned_docs/version-5.19.5/API/interfaces/ProviderOptions.md deleted file mode 100644 index bc68fc6c2..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/ProviderOptions.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: 'ProviderOptions' -title: 'Interface: ProviderOptions' -sidebar_label: 'ProviderOptions' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### sequencer - -• `Optional` **sequencer**: [`SequencerProviderOptions`](../modules.md#sequencerprovideroptions) - -#### Defined in - -[src/provider/default.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L35) - ---- - -### rpc - -• `Optional` **rpc**: [`RpcProviderOptions`](../modules.md#rpcprovideroptions) - -#### Defined in - -[src/provider/default.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/provider/default.ts#L36) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md deleted file mode 100644 index fe907635e..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/Sequencer.InvokeFunctionTransactionResponse.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -id: 'Sequencer.InvokeFunctionTransactionResponse' -title: 'Interface: InvokeFunctionTransactionResponse' -sidebar_label: 'InvokeFunctionTransactionResponse' -custom_edit_url: null ---- - -[Sequencer](../namespaces/Sequencer.md).InvokeFunctionTransactionResponse - -## Hierarchy - -- [`InvokeFunctionTransaction`](../namespaces/Sequencer.md#invokefunctiontransaction) - - ↳ **`InvokeFunctionTransactionResponse`** - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:141](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L141) - ---- - -### entry_point_selector - -• **entry_point_selector**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:142](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L142) - ---- - -### type - -• **type**: `"INVOKE_FUNCTION"` - -#### Inherited from - -InvokeFunctionTransaction.type - -#### Defined in - -[src/types/api/sequencer.ts:112](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L112) - ---- - -### sender_address - -• **sender_address**: `string` - -#### Inherited from - -InvokeFunctionTransaction.sender_address - -#### Defined in - -[src/types/api/sequencer.ts:113](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L113) - ---- - -### signature - -• `Optional` **signature**: `string`[] - -#### Inherited from - -InvokeFunctionTransaction.signature - -#### Defined in - -[src/types/api/sequencer.ts:114](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L114) - ---- - -### entry_point_type - -• `Optional` **entry_point_type**: [`EXTERNAL`](../enums/EntryPointType.md#external) - -#### Inherited from - -InvokeFunctionTransaction.entry_point_type - -#### Defined in - -[src/types/api/sequencer.ts:115](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L115) - ---- - -### calldata - -• `Optional` **calldata**: [`RawCalldata`](../modules.md#rawcalldata) - -#### Inherited from - -InvokeFunctionTransaction.calldata - -#### Defined in - -[src/types/api/sequencer.ts:116](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L116) - ---- - -### nonce - -• **nonce**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.nonce - -#### Defined in - -[src/types/api/sequencer.ts:117](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L117) - ---- - -### max_fee - -• `Optional` **max_fee**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.max_fee - -#### Defined in - -[src/types/api/sequencer.ts:118](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L118) - ---- - -### version - -• `Optional` **version**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Inherited from - -InvokeFunctionTransaction.version - -#### Defined in - -[src/types/api/sequencer.ts:119](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L119) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/StateUpdateResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/StateUpdateResponse.md deleted file mode 100644 index 3ee6ec6bf..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/StateUpdateResponse.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: 'StateUpdateResponse' -title: 'Interface: StateUpdateResponse' -sidebar_label: 'StateUpdateResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Properties - -### block_hash - -• **block_hash**: `string` - -#### Defined in - -[src/types/provider.ts:154](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L154) - ---- - -### new_root - -• **new_root**: `string` - -#### Defined in - -[src/types/provider.ts:155](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L155) - ---- - -### old_root - -• **old_root**: `string` - -#### Defined in - -[src/types/provider.ts:156](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L156) - ---- - -### state_diff - -• **state_diff**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------- | :------------------------------------------------------------------------ | -| `storage_diffs` | [`StorageDiffs`](../namespaces/RPC.md#storagediffs) | -| `declared_contract_hashes?` | [`DeclaredContractHashes`](../namespaces/RPC.md#declaredcontracthashes) | -| `deployed_contracts` | [`DeployedContracts`](../namespaces/Sequencer.md#deployedcontracts) | -| `nonces` | [`Nonces`](../namespaces/RPC.md#nonces) | -| `old_declared_contracts?` | [`OldDeclaredContracts`](../namespaces/Sequencer.md#olddeclaredcontracts) | -| `declared_classes?` | [`DeclaredClasses`](../namespaces/Sequencer.md#declaredclasses) | -| `replaced_classes?` | [`ReplacedClasses`](../namespaces/Sequencer.md#replacedclasses) | - -#### Defined in - -[src/types/provider.ts:157](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L157) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/TransactionSimulation.md b/www/versioned_docs/version-5.19.5/API/interfaces/TransactionSimulation.md deleted file mode 100644 index 073c9c5d8..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/TransactionSimulation.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: 'TransactionSimulation' -title: 'Interface: TransactionSimulation' -sidebar_label: 'TransactionSimulation' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`TransactionSimulationResponse`](TransactionSimulationResponse.md) - - ↳ **`TransactionSimulation`** - -## Properties - -### fee_estimation - -• **fee_estimation**: [`EstimateFee`](EstimateFee.md) - -#### Overrides - -[TransactionSimulationResponse](TransactionSimulationResponse.md).[fee_estimation](TransactionSimulationResponse.md#fee_estimation) - -#### Defined in - -[src/types/account.ts:51](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L51) - ---- - -### trace - -• **trace**: [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) - -#### Inherited from - -[TransactionSimulationResponse](TransactionSimulationResponse.md).[trace](TransactionSimulationResponse.md#trace) - -#### Defined in - -[src/types/provider.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L148) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/TransactionSimulationResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/TransactionSimulationResponse.md deleted file mode 100644 index e9b0e9032..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/TransactionSimulationResponse.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: 'TransactionSimulationResponse' -title: 'Interface: TransactionSimulationResponse' -sidebar_label: 'TransactionSimulationResponse' -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`TransactionSimulationResponse`** - - ↳ [`TransactionSimulation`](TransactionSimulation.md) - -## Properties - -### trace - -• **trace**: [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) - -#### Defined in - -[src/types/provider.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L148) - ---- - -### fee_estimation - -• **fee_estimation**: [`EstimateFeeResponse`](EstimateFeeResponse.md) - -#### Defined in - -[src/types/provider.ts:149](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider.ts#L149) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/typedData.StarkNetDomain.md b/www/versioned_docs/version-5.19.5/API/interfaces/typedData.StarkNetDomain.md deleted file mode 100644 index ba7547aea..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/typedData.StarkNetDomain.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: 'typedData.StarkNetDomain' -title: 'Interface: StarkNetDomain' -sidebar_label: 'StarkNetDomain' -custom_edit_url: null ---- - -[typedData](../namespaces/typedData.md).StarkNetDomain - -The EIP712 domain struct. Any of these fields are optional, but it must contain at least one field. - -## Hierarchy - -- `Record`<`string`, `unknown`\> - - ↳ **`StarkNetDomain`** - -## Properties - -### name - -• `Optional` **name**: `string` - -#### Defined in - -[src/utils/typedData/types.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L24) - ---- - -### version - -• `Optional` **version**: `string` - -#### Defined in - -[src/utils/typedData/types.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L25) - ---- - -### chainId - -• `Optional` **chainId**: `string` \| `number` - -#### Defined in - -[src/utils/typedData/types.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L26) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/typedData.TypedData.md b/www/versioned_docs/version-5.19.5/API/interfaces/typedData.TypedData.md deleted file mode 100644 index 9a829a04b..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/typedData.TypedData.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: 'typedData.TypedData' -title: 'Interface: TypedData' -sidebar_label: 'TypedData' -custom_edit_url: null ---- - -[typedData](../namespaces/typedData.md).TypedData - -The complete typed data, with all the structs, domain data, primary type of the message, and the message itself. - -## Properties - -### types - -• **types**: `Record`<`string`, [`StarkNetType`](../namespaces/typedData.md#starknettype)[]\> - -#### Defined in - -[src/utils/typedData/types.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L33) - ---- - -### primaryType - -• **primaryType**: `string` - -#### Defined in - -[src/utils/typedData/types.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L34) - ---- - -### domain - -• **domain**: [`StarkNetDomain`](typedData.StarkNetDomain.md) - -#### Defined in - -[src/utils/typedData/types.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L35) - ---- - -### message - -• **message**: `Record`<`string`, `unknown`\> - -#### Defined in - -[src/utils/typedData/types.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/typedData/types.ts#L36) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/types.CommonTransactionReceiptResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/types.CommonTransactionReceiptResponse.md deleted file mode 100644 index 534ffc6e1..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/types.CommonTransactionReceiptResponse.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: 'types.CommonTransactionReceiptResponse' -title: 'Interface: CommonTransactionReceiptResponse' -sidebar_label: 'CommonTransactionReceiptResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).CommonTransactionReceiptResponse - -## Hierarchy - -- **`CommonTransactionReceiptResponse`** - - ↳ [`InvokeTransactionReceiptResponse`](types.InvokeTransactionReceiptResponse.md) - -## Properties - -### transaction_hash - -• **transaction_hash**: `string` - -#### Defined in - -[src/types/provider/response.ts:75](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L75) - ---- - -### status - -• `Optional` **status**: `"NOT_RECEIVED"` \| `"RECEIVED"` \| `"ACCEPTED_ON_L2"` \| `"ACCEPTED_ON_L1"` \| `"REJECTED"` - -#### Defined in - -[src/types/provider/response.ts:76](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L76) - ---- - -### actual_fee - -• `Optional` **actual_fee**: `string` - -#### Defined in - -[src/types/provider/response.ts:77](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L77) - ---- - -### status_data - -• `Optional` **status_data**: `string` - -#### Defined in - -[src/types/provider/response.ts:78](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L78) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/types.TransactionSimulation.md b/www/versioned_docs/version-5.19.5/API/interfaces/types.TransactionSimulation.md deleted file mode 100644 index d76c9f852..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/types.TransactionSimulation.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: 'types.TransactionSimulation' -title: 'Interface: TransactionSimulation' -sidebar_label: 'TransactionSimulation' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionSimulation - -## Hierarchy - -- [`TransactionSimulationResponse`](types.TransactionSimulationResponse.md) - - ↳ **`TransactionSimulation`** - -## Properties - -### fee_estimation - -• **fee_estimation**: [`EstimateFee`](types.EstimateFee.md) - -#### Overrides - -[TransactionSimulationResponse](types.TransactionSimulationResponse.md).[fee_estimation](types.TransactionSimulationResponse.md#fee_estimation) - -#### Defined in - -[src/types/account.ts:50](https://github.com/0xs34n/starknet.js/blob/develop/src/types/account.ts#L50) - ---- - -### trace - -• **trace**: [`TransactionTraceResponse`](../namespaces/types.md#transactiontraceresponse) - -#### Inherited from - -[TransactionSimulationResponse](types.TransactionSimulationResponse.md).[trace](types.TransactionSimulationResponse.md#trace) - -#### Defined in - -[src/types/provider/response.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L148) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/types.TransactionSimulationResponse.md b/www/versioned_docs/version-5.19.5/API/interfaces/types.TransactionSimulationResponse.md deleted file mode 100644 index 0495a39f3..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/types.TransactionSimulationResponse.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: 'types.TransactionSimulationResponse' -title: 'Interface: TransactionSimulationResponse' -sidebar_label: 'TransactionSimulationResponse' -custom_edit_url: null ---- - -[types](../namespaces/types.md).TransactionSimulationResponse - -## Hierarchy - -- **`TransactionSimulationResponse`** - - ↳ [`TransactionSimulation`](types.TransactionSimulation.md) - -## Properties - -### trace - -• **trace**: [`TransactionTraceResponse`](../namespaces/types.md#transactiontraceresponse) - -#### Defined in - -[src/types/provider/response.ts:148](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L148) - ---- - -### fee_estimation - -• **fee_estimation**: [`EstimateFeeResponse`](types.EstimateFeeResponse.md) - -#### Defined in - -[src/types/provider/response.ts:149](https://github.com/0xs34n/starknet.js/blob/develop/src/types/provider/response.ts#L149) diff --git a/www/versioned_docs/version-5.19.5/API/interfaces/uint256.Uint256.md b/www/versioned_docs/version-5.19.5/API/interfaces/uint256.Uint256.md deleted file mode 100644 index a108bc422..000000000 --- a/www/versioned_docs/version-5.19.5/API/interfaces/uint256.Uint256.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: 'uint256.Uint256' -title: 'Interface: Uint256' -sidebar_label: 'Uint256' -custom_edit_url: null ---- - -[uint256](../namespaces/uint256.md).Uint256 - -## Properties - -### low - -• **low**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/utils/uint256.ts:8](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L8) - ---- - -### high - -• **high**: [`BigNumberish`](../namespaces/num.md#bignumberish) - -#### Defined in - -[src/utils/uint256.ts:10](https://github.com/0xs34n/starknet.js/blob/develop/src/utils/uint256.ts#L10) diff --git a/www/versioned_docs/version-5.19.5/API/namespaces/RPC.md b/www/versioned_docs/version-5.19.5/API/namespaces/RPC.md deleted file mode 100644 index f2d2b88d1..000000000 --- a/www/versioned_docs/version-5.19.5/API/namespaces/RPC.md +++ /dev/null @@ -1,382 +0,0 @@ ---- -id: 'RPC' -title: 'Namespace: RPC' -sidebar_label: 'RPC' -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumerations - -- [TransactionType](../enums/RPC.TransactionType.md) - -## Type Aliases - -### Response - -Ƭ **Response**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------- | :----------------------------------------- | -| `id` | `number` | -| `jsonrpc` | `string` | -| `result?` | `any` | -| `error?` | { `code`: `string` ; `message`: `string` } | -| `error.code` | `string` | -| `error.message` | `string` | - -#### Defined in - -[src/types/api/rpc.ts:4](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L4) - ---- - -### ChainId - -Ƭ **ChainId**: `OPENRPC.CHAIN_ID` - -#### Defined in - -[src/types/api/rpc.ts:14](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L14) - ---- - -### CallResponse - -Ƭ **CallResponse**: `OPENRPC.CallResponse` - -#### Defined in - -[src/types/api/rpc.ts:15](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L15) - ---- - -### ContractAddress - -Ƭ **ContractAddress**: `ADDRESS` - -#### Defined in - -[src/types/api/rpc.ts:16](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L16) - ---- - -### Felt - -Ƭ **Felt**: `FELT` - -#### Defined in - -[src/types/api/rpc.ts:17](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L17) - ---- - -### Nonce - -Ƭ **Nonce**: `OPENRPC.Nonce` - -#### Defined in - -[src/types/api/rpc.ts:18](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L18) - ---- - -### ContractClass - -Ƭ **ContractClass**: `OPENRPC.ContractClass` - -#### Defined in - -[src/types/api/rpc.ts:19](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L19) - ---- - -### StateUpdate - -Ƭ **StateUpdate**: `OPENRPC.StateUpdate` - -#### Defined in - -[src/types/api/rpc.ts:20](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L20) - ---- - -### Transaction - -Ƭ **Transaction**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:21](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L21) - ---- - -### PendingTransactions - -Ƭ **PendingTransactions**: `OPENRPC.PendingTransactions` - -#### Defined in - -[src/types/api/rpc.ts:22](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L22) - ---- - -### TransactionHash - -Ƭ **TransactionHash**: `OPENRPC.TransactionHash` - -#### Defined in - -[src/types/api/rpc.ts:23](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L23) - ---- - -### Trace - -Ƭ **Trace**: `OPENRPC.Trace` - -#### Defined in - -[src/types/api/rpc.ts:24](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L24) - ---- - -### Traces - -Ƭ **Traces**: `OPENRPC.Traces` - -#### Defined in - -[src/types/api/rpc.ts:25](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L25) - ---- - -### BlockHash - -Ƭ **BlockHash**: `OPENRPC.BlockHash` - -#### Defined in - -[src/types/api/rpc.ts:26](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L26) - ---- - -### BlockHashAndNumber - -Ƭ **BlockHashAndNumber**: `OPENRPC.BlockHashAndNumber` - -#### Defined in - -[src/types/api/rpc.ts:27](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L27) - ---- - -### GetClassResponse - -Ƭ **GetClassResponse**: `OPENRPC.ContractClass` - -#### Defined in - -[src/types/api/rpc.ts:28](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L28) - ---- - -### EstimateFeeResponse - -Ƭ **EstimateFeeResponse**: `OPENRPC.EstimatedFee` - -#### Defined in - -[src/types/api/rpc.ts:29](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L29) - ---- - -### GetBlockWithTxHashesResponse - -Ƭ **GetBlockWithTxHashesResponse**: `OPENRPC.BlockWithTxHashes` - -#### Defined in - -[src/types/api/rpc.ts:30](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L30) - ---- - -### GetBlockWithTxs - -Ƭ **GetBlockWithTxs**: `OPENRPC.BlockWithTxs` - -#### Defined in - -[src/types/api/rpc.ts:31](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L31) - ---- - -### GetStorageAtResponse - -Ƭ **GetStorageAtResponse**: `OPENRPC.Storage` - -#### Defined in - -[src/types/api/rpc.ts:32](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L32) - ---- - -### TransactionReceipt - -Ƭ **TransactionReceipt**: `OPENRPC.TransactionReceipt` - -#### Defined in - -[src/types/api/rpc.ts:33](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L33) - ---- - -### GetTransactionByHashResponse - -Ƭ **GetTransactionByHashResponse**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:34](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L34) - ---- - -### GetTransactionByBlockIdAndIndex - -Ƭ **GetTransactionByBlockIdAndIndex**: `OPENRPC.Transaction` - -#### Defined in - -[src/types/api/rpc.ts:35](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L35) - ---- - -### GetTransactionCountResponse - -Ƭ **GetTransactionCountResponse**: `number` - -#### Defined in - -[src/types/api/rpc.ts:36](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L36) - ---- - -### GetBlockNumberResponse - -Ƭ **GetBlockNumberResponse**: `OPENRPC.BlockNumber` - -#### Defined in - -[src/types/api/rpc.ts:37](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L37) - ---- - -### GetSyncingStatsResponse - -Ƭ **GetSyncingStatsResponse**: `OPENRPC.SyncingStatus` - -#### Defined in - -[src/types/api/rpc.ts:38](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L38) - ---- - -### EventFilter - -Ƭ **EventFilter**: `OPENRPC.EventFilter` - -#### Defined in - -[src/types/api/rpc.ts:39](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L39) - ---- - -### GetEventsResponse - -Ƭ **GetEventsResponse**: `OPENRPC.Events` - -#### Defined in - -[src/types/api/rpc.ts:40](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L40) - ---- - -### InvokedTransaction - -Ƭ **InvokedTransaction**: `OPENRPC.InvokedTransaction` - -#### Defined in - -[src/types/api/rpc.ts:41](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L41) - ---- - -### DeclaredTransaction - -Ƭ **DeclaredTransaction**: `OPENRPC.DeclaredTransaction` - -#### Defined in - -[src/types/api/rpc.ts:42](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L42) - ---- - -### DeployedTransaction - -Ƭ **DeployedTransaction**: `OPENRPC.DeployedTransaction` - -#### Defined in - -[src/types/api/rpc.ts:43](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L43) - ---- - -### Methods - -Ƭ **Methods**: `OPENRPC.Methods` - -#### Defined in - -[src/types/api/rpc.ts:44](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L44) - ---- - -### Storage - -Ƭ **Storage**: `OPENRPC.Storage` - -#### Defined in - -[src/types/api/rpc.ts:45](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L45) - ---- - -### StorageDiffs - -Ƭ **StorageDiffs**: `CONTRACT_STORAGE_DIFF_ITEM`[] - -#### Defined in - -[src/types/api/rpc.ts:56](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L56) - ---- - -### DeclaredContractHashes - -Ƭ **DeclaredContractHashes**: `FELT`[] - -#### Defined in - -[src/types/api/rpc.ts:57](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L57) - ---- - -### Nonces - -Ƭ **Nonces**: { `contract_address`: `ADDRESS` ; `nonce`: `FELT` }[] - -#### Defined in - -[src/types/api/rpc.ts:58](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/rpc.ts#L58) diff --git a/www/versioned_docs/version-5.19.5/API/namespaces/Sequencer.md b/www/versioned_docs/version-5.19.5/API/namespaces/Sequencer.md deleted file mode 100644 index 798456a0d..000000000 --- a/www/versioned_docs/version-5.19.5/API/namespaces/Sequencer.md +++ /dev/null @@ -1,713 +0,0 @@ ---- -id: 'Sequencer' -title: 'Namespace: Sequencer' -sidebar_label: 'Sequencer' -sidebar_position: 0 -custom_edit_url: null ---- - -## Interfaces - -- [InvokeFunctionTransactionResponse](../interfaces/Sequencer.InvokeFunctionTransactionResponse.md) - -## Type Aliases - -### DeclareTransaction - -Ƭ **DeclareTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :--------------------------------------------- | -| `type` | `"DECLARE"` | -| `sender_address` | `string` | -| `contract_class` | [`ContractClass`](../modules.md#contractclass) | -| `signature?` | `string`[] | -| `nonce` | [`BigNumberish`](num.md#bignumberish) | -| `max_fee?` | [`BigNumberish`](num.md#bignumberish) | -| `version?` | [`BigNumberish`](num.md#bignumberish) | -| `compiled_class_hash?` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:81](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L81) - ---- - -### DeployTransaction - -Ƭ **DeployTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :--------------------------------------------- | -| `type` | `"DEPLOY"` | -| `contract_definition` | [`ContractClass`](../modules.md#contractclass) | -| `contract_address_salt` | [`BigNumberish`](num.md#bignumberish) | -| `constructor_calldata` | `string`[] | -| `nonce?` | [`BigNumberish`](num.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:92](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L92) - ---- - -### DeployAccountTransaction - -Ƭ **DeployAccountTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------- | :------------------------------------ | -| `type` | `"DEPLOY_ACCOUNT"` | -| `class_hash` | `string` | -| `contract_address_salt` | [`BigNumberish`](num.md#bignumberish) | -| `constructor_calldata` | `string`[] | -| `signature?` | `string`[] | -| `max_fee?` | [`BigNumberish`](num.md#bignumberish) | -| `version?` | [`BigNumberish`](num.md#bignumberish) | -| `nonce?` | [`BigNumberish`](num.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:100](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L100) - ---- - -### InvokeFunctionTransaction - -Ƭ **InvokeFunctionTransaction**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :------------------------------------------------ | -| `type` | `"INVOKE_FUNCTION"` | -| `sender_address` | `string` | -| `signature?` | `string`[] | -| `entry_point_type?` | [`EXTERNAL`](../enums/EntryPointType.md#external) | -| `calldata?` | [`RawCalldata`](../modules.md#rawcalldata) | -| `nonce` | [`BigNumberish`](num.md#bignumberish) | -| `max_fee?` | [`BigNumberish`](num.md#bignumberish) | -| `version?` | [`BigNumberish`](num.md#bignumberish) | - -#### Defined in - -[src/types/api/sequencer.ts:111](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L111) - ---- - -### Transaction - -Ƭ **Transaction**: [`DeclareTransaction`](Sequencer.md#declaretransaction) \| [`DeployTransaction`](Sequencer.md#deploytransaction) \| [`InvokeFunctionTransaction`](Sequencer.md#invokefunctiontransaction) \| [`DeployAccountTransaction`](Sequencer.md#deployaccounttransaction) - -#### Defined in - -[src/types/api/sequencer.ts:122](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L122) - ---- - -### AddTransactionResponse - -Ƭ **AddTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------- | :----------------------- | -| `transaction_hash` | `string` | -| `code?` | `"TRANSACTION_RECEIVED"` | -| `address?` | `string` | -| `class_hash?` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:128](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L128) - ---- - -### GetCodeResponse - -Ƭ **GetCodeResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------- | :----------------------------------- | -| `bytecode` | [`ByteCode`](../modules.md#bytecode) | -| `abi` | [`Abi`](../modules.md#abi) | - -#### Defined in - -[src/types/api/sequencer.ts:135](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L135) - ---- - -### TransactionResponse - -Ƭ **TransactionResponse**: [`DeclareTransaction`](Sequencer.md#declaretransaction) \| [`DeployTransaction`](Sequencer.md#deploytransaction) \| [`InvokeFunctionTransactionResponse`](../interfaces/Sequencer.InvokeFunctionTransactionResponse.md) - -#### Defined in - -[src/types/api/sequencer.ts:145](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L145) - ---- - -### SuccessfulTransactionResponse - -Ƭ **SuccessfulTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------------------ | :-------------------------------------------------------- | -| `status` | [`Status`](../modules.md#status) | -| `transaction` | [`TransactionResponse`](Sequencer.md#transactionresponse) | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](../modules.md#blocknumber) | -| `transaction_index` | `number` | - -#### Defined in - -[src/types/api/sequencer.ts:150](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L150) - ---- - -### FailedTransactionResponse - -Ƭ **FailedTransactionResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :-------------------------------------------------------- | -| `status` | `"REJECTED"` | -| `transaction_failure_reason` | { `code`: `string` ; `error_message`: `string` } | -| `transaction_failure_reason.code` | `string` | -| `transaction_failure_reason.error_message` | `string` | -| `transaction` | [`TransactionResponse`](Sequencer.md#transactionresponse) | - -#### Defined in - -[src/types/api/sequencer.ts:158](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L158) - ---- - -### GetTransactionResponse - -Ƭ **GetTransactionResponse**: [`SuccessfulTransactionResponse`](Sequencer.md#successfultransactionresponse) \| [`FailedTransactionResponse`](Sequencer.md#failedtransactionresponse) - -#### Defined in - -[src/types/api/sequencer.ts:167](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L167) - ---- - -### TransactionReceiptResponse - -Ƭ **TransactionReceiptResponse**: [`SuccessfulTransactionReceiptResponse`](Sequencer.md#successfultransactionreceiptresponse) \| [`FailedTransactionReceiptResponse`](Sequencer.md#failedtransactionreceiptresponse) - -#### Defined in - -[src/types/api/sequencer.ts:169](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L169) - ---- - -### SuccessfulTransactionReceiptResponse - -Ƭ **SuccessfulTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------------------------------------------------------- | -| `status` | [`Status`](../modules.md#status) | -| `transaction_hash` | `string` | -| `transaction_index` | `number` | -| `block_hash` | `string` | -| `block_number` | [`BlockNumber`](../modules.md#blocknumber) | -| `l2_to_l1_messages` | `string`[] | -| `events` | `string`[] | -| `actual_fee` | `string` | -| `execution_resources` | [`ExecutionResources`](../modules.md#executionresources) | - -#### Defined in - -[src/types/api/sequencer.ts:173](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L173) - ---- - -### FailedTransactionReceiptResponse - -Ƭ **FailedTransactionReceiptResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :----------------------------------------- | :----------------------------------------------- | -| `status` | `"REJECTED"` | -| `transaction_failure_reason` | { `code`: `string` ; `error_message`: `string` } | -| `transaction_failure_reason.code` | `string` | -| `transaction_failure_reason.error_message` | `string` | -| `transaction_hash` | `string` | -| `l2_to_l1_messages` | `string`[] | -| `events` | `string`[] | - -#### Defined in - -[src/types/api/sequencer.ts:185](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L185) - ---- - -### GetBlockResponse - -Ƭ **GetBlockResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `block_number` | `number` | -| `state_root` | `string` | -| `block_hash` | `string` | -| `transactions` | { `[txHash: string]`: [`TransactionResponse`](Sequencer.md#transactionresponse); } | -| `timestamp` | `number` | -| `transaction_receipts` | { `[txHash: string]`: { `block_hash`: `string` ; `transaction_hash`: `string` ; `l2_to_l1_messages`: { `to_address`: `string` ; `payload`: `string`[] ; `from_address`: `string` }[] ; `block_number`: [`BlockNumber`](../modules.md#blocknumber) ; `status`: [`Status`](../modules.md#status) ; `transaction_index`: `number` }; } | -| `parent_block_hash` | `string` | -| `status` | [`Status`](../modules.md#status) | -| `gas_price` | `string` | -| `sequencer_address` | `string` | -| `starknet_version` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:196](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L196) - ---- - -### CallContractTransaction - -Ƭ **CallContractTransaction**: { `calldata?`: [`RawCalldata`](../modules.md#rawcalldata) ; `max_fee?`: [`BigNumberish`](num.md#bignumberish) ; `version?`: [`BigNumberish`](num.md#bignumberish) ; `entry_point_selector`: `string` } & { `sender_address`: `string` ; `signature`: `string`[] } \| { `contract_address`: `string` ; `signature?`: `never` } - -#### Defined in - -[src/types/api/sequencer.ts:225](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L225) - ---- - -### CallContractResponse - -Ƭ **CallContractResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :--------- | -| `result` | `string`[] | - -#### Defined in - -[src/types/api/sequencer.ts:241](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L241) - ---- - -### InvokeEstimateFee - -Ƭ **InvokeEstimateFee**: `Omit`<[`InvokeFunctionTransaction`](Sequencer.md#invokefunctiontransaction), `"max_fee"` \| `"entry_point_type"`\> - -#### Defined in - -[src/types/api/sequencer.ts:245](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L245) - ---- - -### DeclareEstimateFee - -Ƭ **DeclareEstimateFee**: `Omit`<[`DeclareTransaction`](Sequencer.md#declaretransaction), `"max_fee"`\> - -#### Defined in - -[src/types/api/sequencer.ts:246](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L246) - ---- - -### DeployAccountEstimateFee - -Ƭ **DeployAccountEstimateFee**: `Omit`<[`DeployAccountTransaction`](Sequencer.md#deployaccounttransaction), `"max_fee"`\> - -#### Defined in - -[src/types/api/sequencer.ts:247](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L247) - ---- - -### DeployEstimateFee - -Ƭ **DeployEstimateFee**: [`DeployTransaction`](Sequencer.md#deploytransaction) - -#### Defined in - -[src/types/api/sequencer.ts:248](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L248) - ---- - -### EstimateFeeRequest - -Ƭ **EstimateFeeRequest**: [`InvokeEstimateFee`](Sequencer.md#invokeestimatefee) \| [`DeclareEstimateFee`](Sequencer.md#declareestimatefee) \| [`DeployEstimateFee`](Sequencer.md#deployestimatefee) \| [`DeployAccountEstimateFee`](Sequencer.md#deployaccountestimatefee) - -#### Defined in - -[src/types/api/sequencer.ts:250](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L250) - ---- - -### TransactionSimulationResponse - -Ƭ **TransactionSimulationResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :--------------- | :------------------------------------------------------------------- | -| `trace` | [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) | -| `fee_estimation` | [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) | - -#### Defined in - -[src/types/api/sequencer.ts:256](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L256) - ---- - -### SimulateTransaction - -Ƭ **SimulateTransaction**: `Omit`<[`InvokeFunctionTransaction`](Sequencer.md#invokefunctiontransaction), `"entry_point_type"`\> - -#### Defined in - -[src/types/api/sequencer.ts:261](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L261) - ---- - -### EstimateFeeRequestBulk - -Ƭ **EstimateFeeRequestBulk**: [`AllowArray`](../modules.md#allowarray)<[`InvokeEstimateFee`](Sequencer.md#invokeestimatefee) \| [`DeclareEstimateFee`](Sequencer.md#declareestimatefee) \| [`DeployEstimateFee`](Sequencer.md#deployestimatefee) \| [`DeployAccountEstimateFee`](Sequencer.md#deployaccountestimatefee)\> - -#### Defined in - -[src/types/api/sequencer.ts:263](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L263) - ---- - -### EstimateFeeResponse - -Ƭ **EstimateFeeResponse**: { `overall_fee`: `number` ; `gas_price`: `number` ; `gas_usage`: `number` ; `uint`: `string` } \| { `amount`: `bigint` ; `unit`: `string` } - -#### Defined in - -[src/types/api/sequencer.ts:268](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L268) - ---- - -### EstimateFeeResponseBulk - -Ƭ **EstimateFeeResponseBulk**: [`AllowArray`](../modules.md#allowarray)<[`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse)\> - -#### Defined in - -[src/types/api/sequencer.ts:280](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L280) - ---- - -### BlockTransactionTracesResponse - -Ƭ **BlockTransactionTracesResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :------- | :-------------------------------------------------------------------------------------------------------- | -| `traces` | [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) & { `transaction_hash`: `string` }[] | - -#### Defined in - -[src/types/api/sequencer.ts:282](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L282) - ---- - -### Storage - -Ƭ **Storage**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:286](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L286) - ---- - -### StateUpdateResponse - -Ƭ **StateUpdateResponse**: `Object` - -#### Type declaration - -| Name | Type | -| :---------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `block_hash` | `string` | -| `new_root` | `string` | -| `old_root` | `string` | -| `state_diff` | { `storage_diffs`: [`StorageDiffs`](Sequencer.md#storagediffs) ; `nonces`: [`Nonces`](Sequencer.md#nonces) ; `deployed_contracts`: [`DeployedContractItem`](../modules.md#deployedcontractitem)[] ; `old_declared_contracts`: [`OldDeclaredContracts`](Sequencer.md#olddeclaredcontracts) ; `declared_classes`: [`DeclaredClasses`](Sequencer.md#declaredclasses) ; `replaced_classes`: [`ReplacedClasses`](Sequencer.md#replacedclasses) } | -| `state_diff.storage_diffs` | [`StorageDiffs`](Sequencer.md#storagediffs) | -| `state_diff.nonces` | [`Nonces`](Sequencer.md#nonces) | -| `state_diff.deployed_contracts` | [`DeployedContractItem`](../modules.md#deployedcontractitem)[] | -| `state_diff.old_declared_contracts` | [`OldDeclaredContracts`](Sequencer.md#olddeclaredcontracts) | -| `state_diff.declared_classes` | [`DeclaredClasses`](Sequencer.md#declaredclasses) | -| `state_diff.replaced_classes` | [`ReplacedClasses`](Sequencer.md#replacedclasses) | - -#### Defined in - -[src/types/api/sequencer.ts:288](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L288) - ---- - -### StorageDiffs - -Ƭ **StorageDiffs**: `Object` - -#### Index signature - -▪ [address: `string`]: [`StateDiffItem`](Sequencer.md#statediffitem)[] - -#### Defined in - -[src/types/api/sequencer.ts:302](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L302) - ---- - -### StateDiffItem - -Ƭ **StateDiffItem**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------- | -| `key` | `string` | -| `value` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:304](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L304) - ---- - -### Nonces - -Ƭ **Nonces**: `Object` - -#### Index signature - -▪ [address: `string`]: [`Nonce`](Sequencer.md#nonce) - -#### Defined in - -[src/types/api/sequencer.ts:306](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L306) - ---- - -### Nonce - -Ƭ **Nonce**: `string` - -#### Defined in - -[src/types/api/sequencer.ts:308](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L308) - ---- - -### DeployedContracts - -Ƭ **DeployedContracts**: [`DeployedContractItem`](../modules.md#deployedcontractitem)[] - -#### Defined in - -[src/types/api/sequencer.ts:310](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L310) - ---- - -### OldDeclaredContracts - -Ƭ **OldDeclaredContracts**: `string`[] - -#### Defined in - -[src/types/api/sequencer.ts:312](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L312) - ---- - -### DeclaredClasses - -Ƭ **DeclaredClasses**: [`DeclaredClass`](Sequencer.md#declaredclass)[] - -#### Defined in - -[src/types/api/sequencer.ts:314](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L314) - ---- - -### DeclaredClass - -Ƭ **DeclaredClass**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------- | :------- | -| `class_hash` | `string` | -| `compiled_class_hash` | `string` | - -#### Defined in - -[src/types/api/sequencer.ts:316](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L316) - ---- - -### ReplacedClasses - -Ƭ **ReplacedClasses**: `string`[] - -#### Defined in - -[src/types/api/sequencer.ts:318](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L318) - ---- - -### Endpoints - -Ƭ **Endpoints**: `Object` - -#### Type declaration - -| Name | Type | -| :-------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `get_contract_addresses` | { `QUERY`: `never` ; `REQUEST`: `never` ; `RESPONSE`: [`GetContractAddressesResponse`](../modules.md#getcontractaddressesresponse) } | -| `get_contract_addresses.QUERY` | `never` | -| `get_contract_addresses.REQUEST` | `never` | -| `get_contract_addresses.RESPONSE` | [`GetContractAddressesResponse`](../modules.md#getcontractaddressesresponse) | -| `add_transaction` | { `QUERY`: `never` ; `REQUEST`: [`Transaction`](Sequencer.md#transaction) ; `RESPONSE`: [`AddTransactionResponse`](Sequencer.md#addtransactionresponse) } | -| `add_transaction.QUERY` | `never` | -| `add_transaction.REQUEST` | [`Transaction`](Sequencer.md#transaction) | -| `add_transaction.RESPONSE` | [`AddTransactionResponse`](Sequencer.md#addtransactionresponse) | -| `get_transaction` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetTransactionResponse`](Sequencer.md#gettransactionresponse) } | -| `get_transaction.QUERY` | { `transactionHash`: `string` } | -| `get_transaction.QUERY.transactionHash` | `string` | -| `get_transaction.REQUEST` | `never` | -| `get_transaction.RESPONSE` | [`GetTransactionResponse`](Sequencer.md#gettransactionresponse) | -| `get_transaction_status` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetTransactionStatusResponse`](../modules.md#gettransactionstatusresponse) } | -| `get_transaction_status.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_status.QUERY.transactionHash` | `string` | -| `get_transaction_status.REQUEST` | `never` | -| `get_transaction_status.RESPONSE` | [`GetTransactionStatusResponse`](../modules.md#gettransactionstatusresponse) | -| `get_transaction_trace` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) } | -| `get_transaction_trace.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_trace.QUERY.transactionHash` | `string` | -| `get_transaction_trace.REQUEST` | `never` | -| `get_transaction_trace.RESPONSE` | [`TransactionTraceResponse`](../modules.md#transactiontraceresponse) | -| `get_transaction_receipt` | { `QUERY`: { `transactionHash`: `string` } ; `REQUEST`: `never` ; `RESPONSE`: [`TransactionReceiptResponse`](Sequencer.md#transactionreceiptresponse) } | -| `get_transaction_receipt.QUERY` | { `transactionHash`: `string` } | -| `get_transaction_receipt.QUERY.transactionHash` | `string` | -| `get_transaction_receipt.REQUEST` | `never` | -| `get_transaction_receipt.RESPONSE` | [`TransactionReceiptResponse`](Sequencer.md#transactionreceiptresponse) | -| `get_nonce` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`Nonce`](Sequencer.md#nonce) } | -| `get_nonce.QUERY` | { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } | -| `get_nonce.QUERY.contractAddress` | `string` | -| `get_nonce.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_nonce.REQUEST` | `never` | -| `get_nonce.RESPONSE` | [`Nonce`](Sequencer.md#nonce) | -| `get_storage_at` | { `QUERY`: { `contractAddress`: `string` ; `key`: [`BigNumberish`](num.md#bignumberish) ; `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`Storage`](Sequencer.md#storage) } | -| `get_storage_at.QUERY` | { `contractAddress`: `string` ; `key`: [`BigNumberish`](num.md#bignumberish) ; `blockIdentifier`: `BlockIdentifier` } | -| `get_storage_at.QUERY.contractAddress` | `string` | -| `get_storage_at.QUERY.key` | [`BigNumberish`](num.md#bignumberish) | -| `get_storage_at.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_storage_at.REQUEST` | `never` | -| `get_storage_at.RESPONSE` | [`Storage`](Sequencer.md#storage) | -| `get_code` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetCodeResponse`](Sequencer.md#getcoderesponse) } | -| `get_code.QUERY` | { `contractAddress`: `string` ; `blockIdentifier`: `BlockIdentifier` } | -| `get_code.QUERY.contractAddress` | `string` | -| `get_code.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_code.REQUEST` | `never` | -| `get_code.RESPONSE` | [`GetCodeResponse`](Sequencer.md#getcoderesponse) | -| `get_block` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`GetBlockResponse`](Sequencer.md#getblockresponse) } | -| `get_block.QUERY` | { `blockIdentifier`: `BlockIdentifier` } | -| `get_block.QUERY.blockIdentifier` | `BlockIdentifier` | -| `get_block.REQUEST` | `never` | -| `get_block.RESPONSE` | [`GetBlockResponse`](Sequencer.md#getblockresponse) | -| `call_contract` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: [`CallContractTransaction`](Sequencer.md#callcontracttransaction) ; `RESPONSE`: [`CallContractResponse`](Sequencer.md#callcontractresponse) } | -| `call_contract.QUERY` | { `blockIdentifier`: `BlockIdentifier` } | -| `call_contract.QUERY.blockIdentifier` | `BlockIdentifier` | -| `call_contract.REQUEST` | [`CallContractTransaction`](Sequencer.md#callcontracttransaction) | -| `call_contract.RESPONSE` | [`CallContractResponse`](Sequencer.md#callcontractresponse) | -| `estimate_fee` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } ; `REQUEST`: [`EstimateFeeRequest`](Sequencer.md#estimatefeerequest) ; `RESPONSE`: [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) } | -| `estimate_fee.QUERY` | { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } | -| `estimate_fee.QUERY.blockIdentifier` | `BlockIdentifier` | -| `estimate_fee.QUERY.skipValidate` | `boolean` | -| `estimate_fee.REQUEST` | [`EstimateFeeRequest`](Sequencer.md#estimatefeerequest) | -| `estimate_fee.RESPONSE` | [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) | -| `get_class_by_hash` | { `QUERY`: { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`CompiledContract`](../modules.md#compiledcontract) } | -| `get_class_by_hash.QUERY` | { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_class_by_hash.QUERY.classHash` | `string` | -| `get_class_by_hash.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_class_by_hash.REQUEST` | `never` | -| `get_class_by_hash.RESPONSE` | [`CompiledContract`](../modules.md#compiledcontract) | -| `get_class_hash_at` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: `string` } | -| `get_class_hash_at.QUERY` | { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_class_hash_at.QUERY.contractAddress` | `string` | -| `get_class_hash_at.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_class_hash_at.REQUEST` | `never` | -| `get_class_hash_at.RESPONSE` | `string` | -| `get_state_update` | { `QUERY`: { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } ; `REQUEST`: `never` ; `RESPONSE`: [`StateUpdateResponse`](Sequencer.md#stateupdateresponse) } | -| `get_state_update.QUERY` | { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } | -| `get_state_update.QUERY.blockHash?` | `string` | -| `get_state_update.QUERY.blockNumber?` | [`BlockNumber`](../modules.md#blocknumber) | -| `get_state_update.REQUEST` | `never` | -| `get_state_update.RESPONSE` | [`StateUpdateResponse`](Sequencer.md#stateupdateresponse) | -| `get_full_contract` | { `QUERY`: { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `never` ; `RESPONSE`: [`CompiledContract`](../modules.md#compiledcontract) } | -| `get_full_contract.QUERY` | { `contractAddress`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_full_contract.QUERY.contractAddress` | `string` | -| `get_full_contract.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_full_contract.REQUEST` | `never` | -| `get_full_contract.RESPONSE` | [`CompiledContract`](../modules.md#compiledcontract) | -| `estimate_message_fee` | { `QUERY`: `any` ; `REQUEST`: `any` ; `RESPONSE`: [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) } | -| `estimate_message_fee.QUERY` | `any` | -| `estimate_message_fee.REQUEST` | `any` | -| `estimate_message_fee.RESPONSE` | [`EstimateFeeResponse`](Sequencer.md#estimatefeeresponse) | -| `simulate_transaction` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } ; `REQUEST`: [`SimulateTransaction`](Sequencer.md#simulatetransaction) ; `RESPONSE`: [`TransactionSimulationResponse`](Sequencer.md#transactionsimulationresponse) } | -| `simulate_transaction.QUERY` | { `blockIdentifier`: `BlockIdentifier` ; `skipValidate`: `boolean` } | -| `simulate_transaction.QUERY.blockIdentifier` | `BlockIdentifier` | -| `simulate_transaction.QUERY.skipValidate` | `boolean` | -| `simulate_transaction.REQUEST` | [`SimulateTransaction`](Sequencer.md#simulatetransaction) | -| `simulate_transaction.RESPONSE` | [`TransactionSimulationResponse`](Sequencer.md#transactionsimulationresponse) | -| `estimate_fee_bulk` | { `QUERY`: { `blockIdentifier`: `BlockIdentifier` } ; `REQUEST`: [`EstimateFeeRequestBulk`](Sequencer.md#estimatefeerequestbulk) ; `RESPONSE`: [`EstimateFeeResponseBulk`](Sequencer.md#estimatefeeresponsebulk) } | -| `estimate_fee_bulk.QUERY` | { `blockIdentifier`: `BlockIdentifier` } | -| `estimate_fee_bulk.QUERY.blockIdentifier` | `BlockIdentifier` | -| `estimate_fee_bulk.REQUEST` | [`EstimateFeeRequestBulk`](Sequencer.md#estimatefeerequestbulk) | -| `estimate_fee_bulk.RESPONSE` | [`EstimateFeeResponseBulk`](Sequencer.md#estimatefeeresponsebulk) | -| `get_block_traces` | { `QUERY`: { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } ; `REQUEST`: `never` ; `RESPONSE`: [`BlockTransactionTracesResponse`](Sequencer.md#blocktransactiontracesresponse) } | -| `get_block_traces.QUERY` | { `blockHash?`: `string` ; `blockNumber?`: [`BlockNumber`](../modules.md#blocknumber) } | -| `get_block_traces.QUERY.blockHash?` | `string` | -| `get_block_traces.QUERY.blockNumber?` | [`BlockNumber`](../modules.md#blocknumber) | -| `get_block_traces.REQUEST` | `never` | -| `get_block_traces.RESPONSE` | [`BlockTransactionTracesResponse`](Sequencer.md#blocktransactiontracesresponse) | -| `get_compiled_class_by_class_hash` | { `QUERY`: { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } ; `REQUEST`: `any` ; `RESPONSE`: [`CairoAssembly`](../modules.md#cairoassembly) } | -| `get_compiled_class_by_class_hash.QUERY` | { `classHash`: `string` ; `blockIdentifier?`: `BlockIdentifier` } | -| `get_compiled_class_by_class_hash.QUERY.classHash` | `string` | -| `get_compiled_class_by_class_hash.QUERY.blockIdentifier?` | `BlockIdentifier` | -| `get_compiled_class_by_class_hash.REQUEST` | `any` | -| `get_compiled_class_by_class_hash.RESPONSE` | [`CairoAssembly`](../modules.md#cairoassembly) | - -#### Defined in - -[src/types/api/sequencer.ts:320](https://github.com/0xs34n/starknet.js/blob/develop/src/types/api/sequencer.ts#L320)