Abstract
Abstract
chainAbstract
addressAbstract
signerAbstract
getAbstract
callCalls a function on the StarkNet contract.
the result of the function on the smart contract.
transaction to be called
Optional
blockIdentifier: BlockIdentifierblock identifier
Abstract
getAbstract
getAbstract
getGets the contract class of the deployed contract.
Contract class of compiled contract
contract address
Optional
blockIdentifier: BlockIdentifierblock identifier
Abstract
getReturns the class hash deployed under the given address.
Class hash
contract address
Optional
blockIdentifier: BlockIdentifierblock identifier
Abstract
getAbstract
getGets the nonce of a contract with respect to a specific block
the hex nonce
contract address
Optional
blockIdentifier: BlockIdentifierAbstract
getGets the contract's storage variable at a specific key.
the value of the storage variable
from getStorageVarAddress('
Optional
blockIdentifier: BlockIdentifierblock identifier
Abstract
getGets the transaction information from a tx id.
the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }
Abstract
getAbstract
deployDeploys a given compiled Account contract (json) to starknet
a confirmation of sending a transaction on the starknet contract
payload to be deployed containing:
Abstract
invokeInvokes a function on starknet
This method wont be supported as soon as fees are mandatory. Should not be used outside of Account class
response from addTransaction
the invocation object containing:
optional details containing:
Abstract
declareDeclares a given compiled contract (json) to starknet
a confirmation of sending a transaction on the starknet contract
transaction payload to be deployed containing:
Invocation Details containing:
Abstract
getEstimates the fee for a given INVOKE transaction
Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class
the estimated fee
the invocation object containing:
optional details containing:
block identifier
Abstract
getEstimates the fee for a given INVOKE transaction
the estimated fee
the invocation object containing:
optional details containing:
Optional
blockIdentifier: BlockIdentifierblock identifier
Abstract
getEstimates the fee for a given DECLARE transaction
the estimated fee
transaction payload to be declared containing:
optional details containing:
Optional
blockIdentifier: BlockIdentifierblock identifier
Abstract
getEstimates the fee for a given DEPLOY_ACCOUNT transaction
the estimated fee
transaction payload to be deployed containing:
optional details containing:
Optional
blockIdentifier: BlockIdentifierblock identifier
Abstract
waitWait for the transaction to be accepted
GetTransactionReceiptResponse
transaction hash
Optional
retryInterval: numberretry interval
Optional
successStates: Status[]Abstract
estimateUse estimateInvokeFee or estimateDeclareFee instead Estimate Fee for executing an INVOKE transaction on starknet
response from estimate_fee
the invocation object containing:
Optional
estimateFeeDetails: EstimateFeeDetailsAbstract
estimateEstimate Fee for executing an INVOKE transaction on starknet
response from estimate_fee
the invocation object containing:
Optional
estimateFeeDetails: EstimateFeeDetailsAbstract
estimateEstimate Fee for executing a DECLARE transaction on starknet
response from estimate_fee
the payload object containing:
Optional
estimateFeeDetails: EstimateFeeDetailsAbstract
estimateEstimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet
response from estimate_fee
contract - the compiled contract to be deployed
Optional
estimateFeeDetails: EstimateFeeDetailsoptional blockIdentifier
Abstract
estimateEstimate 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)
containing
Optional
transactionsDetail: InvocationsDetailsInvocation Details containing:
Abstract
executeInvoke execute function in account contract
response from addTransaction
the invocation object or an array of them, containing:
Optional
abis: Abi[]Optional
transactionsDetail: InvocationsDetailsAbstract
declareDeclares a given compiled contract (json) to starknet
a confirmation of sending a transaction on the starknet contract
transaction payload to be deployed containing:
Optional
transactionsDetail: InvocationsDetailsInvocation Details containing:
Abstract
deployDeploys a declared contract to starknet - using Universal Deployer Contract (UDC) support multicall
classHash: computed class hash of compiled contract
Optional
details: InvocationsDetails[nonce=getNonce]
Abstract
deploySimplify deploy simulating old DeployContract with same response + UDC specific response Internal wait for L2 transaction, support multicall
classHash: computed class hash of compiled contract
Optional
details: InvocationsDetails[nonce=getNonce]
Abstract
declareDeclares and Deploy a given compiled contract (json) to starknet using UDC Internal wait for L2 transaction, do not support multicall
Optional
details: InvocationsDetails[nonce=getNonce]
Abstract
deployDeploy the account on Starknet
a confirmation of sending a transaction on the starknet contract
transaction payload to be deployed containing:
Optional
transactionsDetail: InvocationsDetailsInvocation Details containing:
Abstract
signSign 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
the signature of the JSON object
if the JSON object is not a valid JSON
Abstract
hashHash a JSON object with pederson hash and return the hash This adds a message prefix so it cant be interchanged with transactions
the hash of the JSON object
if the JSON object is not a valid JSON
Abstract
verifyVerify a signature of a JSON object
true if the signature is valid, false otherwise
if the JSON object is not a valid JSON or the signature is not a valid signature
JSON object to be verified
signature of the JSON object
Abstract
verifyVerify a signature of a given hash
This method is not recommended, use verifyMessage instead
true if the signature is valid, false otherwise
if the signature is not a valid signature
hash to be verified
signature of the hash
Abstract
getAbstract
getGenerated using TypeDoc
Gets the Starknet chain Id
Returns
the chain Id