Interface TzReadProvider

interface TzReadProvider {
    getBalance(address, block): Promise<BigNumber>;
    getBigMapValue(bigMapQuery, block): Promise<MichelsonV1Expression>;
    getBlock(block): Promise<BlockResponse>;
    getBlockHash(block): Promise<string>;
    getBlockLevel(block): Promise<number>;
    getBlockTimestamp(block): Promise<string>;
    getChainId(): Promise<string>;
    getCounter(pkh, block): Promise<string>;
    getDelegate(address, block): Promise<null | string>;
    getEntrypoints(contract): Promise<EntrypointsResponse>;
    getLiveBlocks(block): Promise<string[]>;
    getNextProtocol(block): Promise<string>;
    getProtocolConstants(block): Promise<{
        cost_per_byte: BigNumber;
        hard_gas_limit_per_block: BigNumber;
        hard_gas_limit_per_operation: BigNumber;
        hard_storage_limit_per_operation: BigNumber;
        minimal_block_delay?: BigNumber;
        smart_rollup_origination_size: number;
        time_between_blocks?: BigNumber[];
    }>;
    getSaplingDiffByContract(contractAddress, block): Promise<SaplingDiffResponse>;
    getSaplingDiffById(saplingStateQuery, block): Promise<SaplingDiffResponse>;
    getScript(contract, block): Promise<ScriptedContracts>;
    getStorage(contract, block): Promise<MichelsonV1Expression>;
    isAccountRevealed(publicKeyHash, block): Promise<boolean>;
}

Implemented by

Methods

getBalance getBigMapValue getBlock getBlockHash getBlockLevel getBlockTimestamp getChainId getCounter getDelegate getEntrypoints getLiveBlocks getNextProtocol getProtocolConstants getSaplingDiffByContract getSaplingDiffById getScript getStorage isAccountRevealed

Methods

getBalance

  • getBalance(address, block): Promise<BigNumber>

  • Parameters

    • address: string

      address from which we want to retrieve the balance

    • block: BlockIdentifier

      from which we want to retrieve the balance

    Returns Promise<BigNumber>

    the balance in mutez

    Description

    Access the balance of a contract.

getBigMapValue

  • getBigMapValue(bigMapQuery, block): Promise<MichelsonV1Expression>

  • Parameters

    • bigMapQuery: BigMapQuery

      Big Map ID and Expression hash to query (A b58check encoded Blake2b hash of the expression)

    • block: BlockIdentifier

      from which we want to retrieve the big map value

    Returns Promise<MichelsonV1Expression>

    Description

    Access the value associated with a key in a big map.

getBlock

getBlockHash

getBlockLevel

getBlockTimestamp

getChainId

getCounter

getDelegate

  • getDelegate(address, block): Promise<null | string>

  • Parameters

    • address: string

      contract address from which we want to retrieve the delegate (baker)

    • block: BlockIdentifier

      from which we want to retrieve the delegate

    Returns Promise<null | string>

    the public key hash of the delegate or null if no delegate

    Description

    Access the delegate of a contract, if any.

getEntrypoints

  • getEntrypoints(contract): Promise<EntrypointsResponse>

  • Parameters

    • contract: string

      address of the contract we want to get the entrypoints of

    Returns Promise<EntrypointsResponse>

    Description

    Return the list of entrypoints of the contract

getLiveBlocks

  • getLiveBlocks(block): Promise<string[]>

  • Parameters

    Returns Promise<string[]>

    Description

    Return a list of the ancestors of the given block which, if referred to as the branch in an operation header, are recent enough for that operation to be included in the current block.

getNextProtocol

getProtocolConstants

  • getProtocolConstants(block): Promise<{
        cost_per_byte: BigNumber;
        hard_gas_limit_per_block: BigNumber;
        hard_gas_limit_per_operation: BigNumber;
        hard_storage_limit_per_operation: BigNumber;
        minimal_block_delay?: BigNumber;
        smart_rollup_origination_size: number;
        time_between_blocks?: BigNumber[];
    }>

  • Parameters

    Returns Promise<{
        cost_per_byte: BigNumber;
        hard_gas_limit_per_block: BigNumber;
        hard_gas_limit_per_operation: BigNumber;
        hard_storage_limit_per_operation: BigNumber;
        minimal_block_delay?: BigNumber;
        smart_rollup_origination_size: number;
        time_between_blocks?: BigNumber[];
    }>

    Description

    Access protocol constants used in Taquito

getSaplingDiffByContract

  • getSaplingDiffByContract(contractAddress, block): Promise<SaplingDiffResponse>

  • Parameters

    • contractAddress: string

      The address of the smart contract

    • block: BlockIdentifier

      The block you want to retrieve the sapling state from

    Returns Promise<SaplingDiffResponse>

    Description

    Access the sapling state of a smart contract.

getSaplingDiffById

getScript

  • getScript(contract, block): Promise<ScriptedContracts>

  • Parameters

    • contract: string

      contract address from which we want to retrieve the script

    • block: BlockIdentifier

      from which we want to retrieve the storage value

    Returns Promise<ScriptedContracts>

    Note: The code must be in the JSON format and not contain global constant

    Description

    Access the script (code and storage) of a smart contract

getStorage

  • getStorage(contract, block): Promise<MichelsonV1Expression>

  • Parameters

    • contract: string

      contract address from which we want to retrieve the storage

    • block: BlockIdentifier

      from which we want to retrieve the storage value

    Returns Promise<MichelsonV1Expression>

    Description

    Access the storage of a contract

isAccountRevealed

Settings

Member Visibility

Theme

On This Page

getBalancegetBigMapValuegetBlockgetBlockHashgetBlockLevelgetBlockTimestampgetChainIdgetCountergetDelegategetEntrypointsgetLiveBlocksgetNextProtocolgetProtocolConstantsgetSaplingDiffByContractgetSaplingDiffByIdgetScriptgetStorageisAccountRevealed

Generated using TypeDoc