Interface TzReadProvider

interface TzReadProvider {
    getAdaptiveIssuanceLaunchCycle(block: BlockIdentifier): Promise<AILaunchCycleResponse>;
    getBalance(address: string, block: BlockIdentifier): Promise<BigNumber>;
    getBigMapValue(bigMapQuery: BigMapQuery, block: BlockIdentifier): Promise<MichelsonV1Expression>;
    getBlock(block: BlockIdentifier): Promise<BlockResponse>;
    getBlockHash(block: BlockIdentifier): Promise<string>;
    getBlockLevel(block: BlockIdentifier): Promise<number>;
    getBlockTimestamp(block: BlockIdentifier): Promise<string>;
    getChainId(): Promise<string>;
    getCounter(pkh: string, block: BlockIdentifier): Promise<string>;
    getDelegate(address: string, block: BlockIdentifier): Promise<null | string>;
    getEntrypoints(contract: string): Promise<EntrypointsResponse>;
    getLiveBlocks(block: BlockIdentifier): Promise<string[]>;
    getNextProtocol(block: BlockIdentifier): Promise<string>;
    getProtocolConstants(block: BlockIdentifier): 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: string, block: BlockIdentifier): Promise<SaplingDiffResponse>;
    getSaplingDiffById(saplingStateQuery: SaplingStateQuery, block: BlockIdentifier): Promise<SaplingDiffResponse>;
    getScript(contract: string, block: BlockIdentifier): Promise<ScriptedContracts>;
    getStorage(contract: string, block: BlockIdentifier): Promise<MichelsonV1Expression>;
    isAccountRevealed(publicKeyHash: string, block: BlockIdentifier): Promise<boolean>;
}

Implemented by

RpcReadAdapter

Index

Methods

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

Methods

getAdaptiveIssuanceLaunchCycle

getAdaptiveIssuanceLaunchCycle(block): Promise<AILaunchCycleResponse>
Parameters
- block: BlockIdentifier
  from which we want to retrieve the information
Returns Promise<AILaunchCycleResponse>
Description
Returns the cycle at which the launch of the Adaptive Issuance feature is set to happen. A result of null means that the feature is not yet set to launch.
- Defined in packages/taquito/src/read-provider/interface.ts:160

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 spendable balance of a contract, excluding frozen bonds.
- Defined in packages/taquito/src/read-provider/interface.ts:30

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.
- Defined in packages/taquito/src/read-provider/interface.ts:104

getBlock

getBlock(block): Promise<BlockResponse>
Parameters
- block: BlockIdentifier
  from which we want to retrieve the information
Returns Promise<BlockResponse>
Description
Return all the information about a block
- Defined in packages/taquito/src/read-provider/interface.ts:148

getBlockHash

getBlockHash(block): Promise<string>
Parameters
- block: BlockIdentifier
Returns Promise<string>
Description
Access the block hash
- Defined in packages/taquito/src/read-provider/interface.ts:78

getBlockLevel

getBlockLevel(block): Promise<number>
Parameters
- block: BlockIdentifier
Returns Promise<number>
Description
Access the block level
- Defined in packages/taquito/src/read-provider/interface.ts:83

getBlockTimestamp

getBlockTimestamp(block): Promise<string>
Parameters
- block: BlockIdentifier
  from which we want to retrieve the timestamp
Returns Promise<string>
date ISO format zero UTC offset ("2022-01-19T22:37:07Z")

Description
Access the timestamp of a block
- Defined in packages/taquito/src/read-provider/interface.ts:97

getChainId

getChainId(): Promise<string>
Returns Promise<string>
Description
Access the chain id
- Defined in packages/taquito/src/read-provider/interface.ts:135

getCounter

getCounter(pkh, block): Promise<string>
Parameters
- pkh: string
  from which we want to retrieve the counter
- block: BlockIdentifier
  from which we want to retrieve the counter
Returns Promise<string>
Description
Access the counter of an address
- Defined in packages/taquito/src/read-provider/interface.ts:90

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.
- Defined in packages/taquito/src/read-provider/interface.ts:38

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
- Defined in packages/taquito/src/read-provider/interface.ts:130

getLiveBlocks

getLiveBlocks(block): Promise<string[]>
Parameters
- block: BlockIdentifier
  from which we want to retrieve the information
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.
- Defined in packages/taquito/src/read-provider/interface.ts:154

getNextProtocol

getNextProtocol(block): Promise<string>
Parameters
- block: BlockIdentifier
  from which we want to retrieve the next protocol hash
Returns Promise<string>
Description
Access the next protocol hash
- Defined in packages/taquito/src/read-provider/interface.ts:44

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
- block: BlockIdentifier
  from which we want to retrieve the constants
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
- Defined in packages/taquito/src/read-provider/interface.ts:50

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.
- Defined in packages/taquito/src/read-provider/interface.ts:121

getSaplingDiffById

getSaplingDiffById(saplingStateQuery, block): Promise<SaplingDiffResponse>
Parameters
- saplingStateQuery: SaplingStateQuery
- block: BlockIdentifier
  from which we want to retrieve the sapling state
Returns Promise<SaplingDiffResponse>
Description
Access the value associated with a sapling state ID.
- Defined in packages/taquito/src/read-provider/interface.ts:111

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
- Defined in packages/taquito/src/read-provider/interface.ts:66

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
- Defined in packages/taquito/src/read-provider/interface.ts:73

isAccountRevealed

isAccountRevealed(publicKeyHash, block): Promise<boolean>
Parameters
- publicKeyHash: string
  of the account
- block: BlockIdentifier
  from which we want to know if the account is revealed
Returns Promise<boolean>
Description
Indicate if an account is revealed
- Defined in packages/taquito/src/read-provider/interface.ts:142

Interface TzReadProvider

Implemented by

Index

Methods

Methods

getAdaptiveIssuanceLaunchCycle

Parameters

Returns Promise<AILaunchCycleResponse>

Description

getBalance

Parameters

Returns Promise<BigNumber>

Description

getBigMapValue

Parameters

Returns Promise<MichelsonV1Expression>

Description

getBlock

Parameters

Returns Promise<BlockResponse>

Description

getBlockHash

Parameters

Returns Promise<string>

Description

getBlockLevel

Parameters

Returns Promise<number>

Description

getBlockTimestamp

Parameters

Returns Promise<string>

Description

getChainId

Returns Promise<string>

Description

getCounter

Parameters

Returns Promise<string>

Description

getDelegate

Parameters

Returns Promise<null | string>

Description

getEntrypoints

Parameters

Returns Promise<EntrypointsResponse>

Description

getLiveBlocks

Parameters

Returns Promise<string[]>

Description

getNextProtocol

Parameters

Returns Promise<string>

Description

getProtocolConstants

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

getSaplingDiffByContract

Parameters

Returns Promise<SaplingDiffResponse>

Description

getSaplingDiffById

Parameters

Returns Promise<SaplingDiffResponse>

Description

getScript

Parameters

Returns Promise<ScriptedContracts>

Description

getStorage

Parameters

Returns Promise<MichelsonV1Expression>

Description

isAccountRevealed

Parameters

Returns Promise<boolean>

Description

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[];
}>