Class AccountInterfaceAbstract

Hierarchy

  • ProviderInterface
    • AccountInterface

Constructors

constructor

Properties

chainId address signer

Methods

getChainId callContract getBlock getCode getClassAt getClassHashAt getClassByHash getNonceForAddress getStorageAt getTransaction getTransactionReceipt deployAccountContract invokeFunction declareContract getEstimateFee getInvokeEstimateFee getDeclareEstimateFee getDeployAccountEstimateFee waitForTransaction estimateFee estimateInvokeFee estimateDeclareFee estimateAccountDeployFee estimateDeployFee execute declare deploy deployContract declareDeploy deployAccount signMessage hashMessage verifyMessage verifyMessageHash getNonce getSuggestedMaxFee

Constructors

constructor

Properties

Abstract chainId

chainId: StarknetChainId

Abstract address

address: string

Abstract signer

signer: SignerInterface

Methods

Abstract getChainId

  • Gets the Starknet chain Id

    Returns

    the chain Id

    Returns Promise<StarknetChainId>

Abstract callContract

  • Calls a function on the StarkNet contract.

    Returns

    the result of the function on the smart contract.

    Parameters

    • call: Call

      transaction to be called

    • Optional blockIdentifier: BlockIdentifier

      block identifier

    Returns Promise<CallContractResponse>

Abstract getBlock

  • Gets the block information

    Returns

    the block object

    Parameters

    • blockIdentifier: BlockIdentifier

      block identifier

    Returns Promise<GetBlockResponse>

Abstract getCode

  • Deprecated

    The method should not be used

    Parameters

    • contractAddress: string
    • Optional blockIdentifier: BlockIdentifier

    Returns Promise<GetCodeResponse>

Abstract getClassAt

  • Gets the contract class of the deployed contract.

    Returns

    Contract class of compiled contract

    Parameters

    • contractAddress: string

      contract address

    • Optional blockIdentifier: BlockIdentifier

      block identifier

    Returns Promise<ContractClass>

Abstract getClassHashAt

  • Returns the class hash deployed under the given address.

    Returns

    Class hash

    Parameters

    • contractAddress: string

      contract address

    • Optional blockIdentifier: BlockIdentifier

      block identifier

    Returns Promise<string>

Abstract getClassByHash

  • Returns the contract class deployed under the given class hash.

    Returns

    Contract class of compiled contract

    Parameters

    • classHash: string

      class hash

    Returns Promise<ContractClass>

Abstract getNonceForAddress

  • Gets the nonce of a contract with respect to a specific block

    Returns

    the hex nonce

    Parameters

    • contractAddress: string

      contract address

    • Optional blockIdentifier: BlockIdentifier

    Returns Promise<BigNumberish>

Abstract getStorageAt

  • Gets the contract's storage variable at a specific key.

    Returns

    the value of the storage variable

    Parameters

    • contractAddress: string
    • key: BigNumberish

      from getStorageVarAddress('') (WIP)

    • Optional blockIdentifier: BlockIdentifier

      block identifier

    Returns Promise<BigNumberish>

Abstract getTransaction

  • Gets the transaction information from a tx id.

    Returns

    the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }

    Parameters

    • transactionHash: BigNumberish

    Returns Promise<GetTransactionResponse>

Abstract getTransactionReceipt

  • Gets the transaction receipt from a tx hash.

    Returns

    the transaction receipt object

    Parameters

    • transactionHash: BigNumberish

    Returns Promise<GetTransactionReceiptResponse>

Abstract deployAccountContract

  • Deploys a given compiled Account contract (json) to starknet

    Returns

    a confirmation of sending a transaction on the starknet contract

    Parameters

    • payload: DeployAccountContractPayload

      payload to be deployed containing:

      • compiled contract code
      • constructor calldata
      • address salt
    • details: InvocationsDetailsWithNonce

    Returns Promise<DeployContractResponse>

Abstract invokeFunction

  • 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

    Returns

    response from addTransaction

    Parameters

    • invocation: 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

      optional details containing:

      • nonce - optional nonce
      • version - optional version
      • maxFee - optional maxFee

    Returns Promise<InvokeFunctionResponse>

Abstract declareContract

  • Declares a given compiled contract (json) to starknet

    Returns

    a confirmation of sending a transaction on the starknet contract

    Parameters

    • transaction: DeclareContractTransaction

      transaction payload to be deployed containing:

      • compiled contract code
      • sender address
      • signature
    • details: InvocationsDetailsWithNonce

      Invocation Details containing:

      • nonce
      • optional version
      • optional maxFee

    Returns Promise<DeclareContractResponse>

Abstract getEstimateFee

  • Estimates the fee for a given INVOKE transaction

    Deprecated

    Please use getInvokeEstimateFee or getDeclareEstimateFee instead. Should not be used outside of Account class

    Returns

    the estimated fee

    Parameters

    • invocation: 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

      optional details containing:

      • nonce - optional nonce
      • version - optional version
    • blockIdentifier: BlockIdentifier

      block identifier

    Returns Promise<EstimateFeeResponse>

Abstract getInvokeEstimateFee

  • Estimates the fee for a given INVOKE transaction

    Returns

    the estimated fee

    Parameters

    • invocation: 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

      optional details containing:

      • nonce - optional nonce
      • version - optional version
    • Optional blockIdentifier: BlockIdentifier

      block identifier

    Returns Promise<EstimateFeeResponse>

Abstract getDeclareEstimateFee

  • Estimates the fee for a given DECLARE transaction

    Returns

    the estimated fee

    Parameters

    • transaction: DeclareContractTransaction

      transaction payload to be declared containing:

      • compiled contract code
      • sender address
      • signature - (defaults to []) the signature
    • details: InvocationsDetailsWithNonce

      optional details containing:

      • nonce
      • version - optional version
      • optional maxFee
    • Optional blockIdentifier: BlockIdentifier

      block identifier

    Returns Promise<EstimateFeeResponse>

Abstract getDeployAccountEstimateFee

  • Estimates the fee for a given DEPLOY_ACCOUNT transaction

    Returns

    the estimated fee

    Parameters

    • transaction: DeployAccountContractTransaction

      transaction payload to be deployed containing:

      • classHash
      • constructorCalldata
      • addressSalt
      • signature - (defaults to []) the signature
    • details: InvocationsDetailsWithNonce

      optional details containing:

      • nonce
      • version - optional version
      • optional maxFee
    • Optional blockIdentifier: BlockIdentifier

      block identifier

    Returns Promise<EstimateFeeResponse>

Abstract waitForTransaction

  • Wait for the transaction to be accepted

    Returns

    GetTransactionReceiptResponse

    Parameters

    • txHash: BigNumberish

      transaction hash

    • Optional retryInterval: number

      retry interval

    • Optional successStates: Status[]

    Returns Promise<GetTransactionReceiptResponse>

Abstract estimateFee

  • Deprecated

    Use estimateInvokeFee or estimateDeclareFee instead Estimate Fee for executing an INVOKE transaction on starknet

    Returns

    response from estimate_fee

    Parameters

    • calls: AllowArray<Call>

      the invocation object containing:

      • contractAddress - the address of the contract
      • entrypoint - the entrypoint of the contract
      • calldata - (defaults to []) the calldata
    • Optional estimateFeeDetails: EstimateFeeDetails

    Returns Promise<EstimateFeeResponse>

Abstract estimateInvokeFee

  • Estimate Fee for executing an INVOKE transaction on starknet

    Returns

    response from estimate_fee

    Parameters

    • calls: AllowArray<Call>

      the invocation object containing:

      • contractAddress - the address of the contract
      • entrypoint - the entrypoint of the contract
      • calldata - (defaults to []) the calldata
    • Optional estimateFeeDetails: EstimateFeeDetails

    Returns Promise<EstimateFeeResponse>

Abstract estimateDeclareFee

  • Estimate Fee for executing a DECLARE transaction on starknet

    Returns

    response from estimate_fee

    Parameters

    • contractPayload: 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.
    • Optional estimateFeeDetails: EstimateFeeDetails

    Returns Promise<EstimateFeeResponse>

Abstract estimateAccountDeployFee

  • Estimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet

    Returns

    response from estimate_fee

    Parameters

    • contractPayload: DeployAccountContractPayload

      contract - the compiled contract to be deployed

      • classHash - the class hash of the compiled contract. This can be obtained by using starknet-cli.
    • Optional estimateFeeDetails: EstimateFeeDetails

      optional blockIdentifier

      • constant nonce = 0

    Returns Promise<EstimateFeeResponse>

Abstract estimateDeployFee

  • 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

    • deployContractPayload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[]

      containing

      • classHash: computed class hash of compiled contract
      • salt: address salt
      • unique: bool if true ensure unique salt
      • calldata: constructor calldata
    • Optional transactionsDetail: InvocationsDetails

      Invocation Details containing:

      • optional nonce
      • optional version
      • optional maxFee

    Returns Promise<EstimateFeeResponse>

Abstract execute

  • Invoke execute function in account contract

    Returns

    response from addTransaction

    Parameters

    • transactions: AllowArray<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
    • Optional abis: Abi[]
    • Optional transactionsDetail: InvocationsDetails

    Returns Promise<InvokeFunctionResponse>

Abstract declare

  • Declares a given compiled contract (json) to starknet

    Returns

    a confirmation of sending a transaction on the starknet contract

    Parameters

    • contractPayload: DeclareContractPayload

      transaction payload to be deployed containing:

      • contract: compiled contract code
      • classHash: computed class hash of compiled contract
    • Optional transactionsDetail: InvocationsDetails

      Invocation Details containing:

      • optional nonce
      • optional version
      • optional maxFee

    Returns Promise<DeclareContractResponse>

Abstract deploy

  • Deploys a declared contract to starknet - using Universal Deployer Contract (UDC) support multicall

    Returns

    • contract_address[]
    • transaction_hash

    Parameters

    • payload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[]

      classHash: computed class hash of compiled contract

      • [constructorCalldata] contract constructor calldata
      • [salt=pseudorandom] deploy address salt
      • [unique=true] ensure unique salt
    • Optional details: InvocationsDetails

      [nonce=getNonce]

      • [version=transactionVersion]
      • [maxFee=getSuggestedMaxFee]

    Returns Promise<MultiDeployContractResponse>

Abstract deployContract

  • Simplify deploy simulating old DeployContract with same response + UDC specific response Internal wait for L2 transaction, support multicall

    Returns

    • contract_address
    • transaction_hash
    • address
    • deployer
    • unique
    • classHash
    • calldata_len
    • calldata
    • salt

    Parameters

    • payload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[]

      classHash: computed class hash of compiled contract

      • [constructorCalldata] contract constructor calldata
      • [salt=pseudorandom] deploy address salt
      • [unique=true] ensure unique salt
    • Optional details: InvocationsDetails

      [nonce=getNonce]

      • [version=transactionVersion]
      • [maxFee=getSuggestedMaxFee]

    Returns Promise<DeployContractUDCResponse>

Abstract declareDeploy

  • Declares and Deploy a given compiled contract (json) to starknet using UDC Internal wait for L2 transaction, do not support multicall

    Returns

    • declare
      • transaction_hash
    • deploy
      • contract_address
      • transaction_hash
      • address
      • deployer
      • unique
      • classHash
      • calldata_len
      • calldata
      • salt

    Parameters

    • payload: DeclareDeployContractPayload
    • Optional details: InvocationsDetails

      [nonce=getNonce]

      • [version=transactionVersion]
      • [maxFee=getSuggestedMaxFee]

    Returns Promise<DeclareDeployUDCResponse>

Abstract deployAccount

  • Deploy the account on Starknet

    Returns

    a confirmation of sending a transaction on the starknet contract

    Parameters

    • contractPayload: DeployAccountContractPayload

      transaction payload to be deployed containing:

      • classHash: computed class hash of compiled contract
      • optional constructor calldata
      • optional address salt
      • optional contractAddress
    • Optional transactionsDetail: InvocationsDetails

      Invocation Details containing:

      • constant nonce = 0
      • optional version
      • optional maxFee

    Returns Promise<DeployContractResponse>

Abstract signMessage

  • 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

    Returns

    the signature of the JSON object

    Throws

    if the JSON object is not a valid JSON

    Parameters

    • typedData: TypedData

    Returns Promise<Signature>

Abstract hashMessage

  • Hash a JSON object with pederson hash and return the hash This adds a message prefix so it cant be interchanged with transactions

    Returns

    the hash of the JSON object

    Throws

    if the JSON object is not a valid JSON

    Parameters

    • typedData: TypedData

    Returns Promise<string>

Abstract verifyMessage

  • Verify a signature of a JSON object

    Returns

    true if the signature is valid, false otherwise

    Throws

    if the JSON object is not a valid JSON or the signature is not a valid signature

    Parameters

    • typedData: TypedData

      JSON object to be verified

    • signature: Signature

      signature of the JSON object

    Returns Promise<boolean>

Abstract verifyMessageHash

  • Verify a signature of a given hash

    Warning

    This method is not recommended, use verifyMessage instead

    Returns

    true if the signature is valid, false otherwise

    Throws

    if the signature is not a valid signature

    Parameters

    • hash: BigNumberish

      hash to be verified

    • signature: Signature

      signature of the hash

    Returns Promise<boolean>

Abstract getNonce

  • Gets the nonce of the account with respect to a specific block

    Returns

    nonce of the account

    Parameters

    • Optional blockIdentifier: BlockIdentifier

      optional blockIdentifier. Defaults to 'pending'

    Returns Promise<BigNumberish>

Abstract getSuggestedMaxFee

  • Gets Suggested Max Fee based on the transaction type

    Returns

    suggestedMaxFee

    Parameters

    • estimateFeeAction: EstimateFeeAction
    • details: EstimateFeeDetails

    Returns Promise<BigNumberish>

Settings

Member Visibility

Theme

Generated using TypeDoc