Class RPCEstimateProvider

Estimates gas, storage, and fees by simulating operations against the node RPC.

On Tezos L1, Taquito historically matched estimation with built-in fee defaults because the fee-per-byte and fee-per-gas terms were usually close to those values. Tezos X / Tezlink keeps the same fee formula shape, but those terms are surfaced through mempool/filter and may be significantly higher or dynamic, so this provider reads them from RPC before computing fees.

Hierarchy

Provider
- RPCEstimateProvider

Implements

EstimationProvider

Constructors

constructor

new RPCEstimateProvider(context: Context): RPCEstimateProvider
Parameters
- context: Context
Returns RPCEstimateProvider
Inherited from Provider.constructor
- Defined in packages/taquito/src/provider.ts:273

Properties

`Protected`context

context: Context

Accessors

rpc

get rpc(): RpcClientInterface
Returns RpcClientInterface
Inherited from Provider.rpc
- Defined in packages/taquito/src/provider.ts:265

signer

get signer(): Signer
Returns Signer
Inherited from Provider.signer
- Defined in packages/taquito/src/provider.ts:269

Methods

batch

batch(params: ParamsWithKind[]): Promise<Estimate[]>
Estimate gasLimit, storageLimit and fees for a each operation in the batch
Parameters
- params: ParamsWithKind[]
Returns Promise<Estimate[]>
An array of Estimate objects. If a reveal operation is needed, the first element of the array is the Estimate for the reveal operation.
Implementation of EstimationProvider.batch
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:775

contractCall

contractCall(
contractMethod: ContractMethodObject<ContractProvider>,
): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for contract call
Parameters
- contractMethod: ContractMethodObject<ContractProvider>
  ContractMethodObject for the contract call
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the contract call
Implementation of EstimationProvider.contractCall
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:1069

`Protected`estimate

estimate<T extends { fee?: number; gasLimit?: number; storageLimit?: number }>(
    __namedParameters: T,
    estimator: (param: T) => Promise<Estimate>,
): Promise<
    {
        fee: number
        | undefined;
        gasLimit: number | undefined;
        storageLimit: number | undefined;
    },
>
Type Parameters
- T extends { fee?: number; gasLimit?: number; storageLimit?: number }
Parameters
- __namedParameters: T
- estimator: (param: T) => Promise<Estimate>
Returns Promise<
    {
        fee: number
        | undefined;
        gasLimit: number | undefined;
        storageLimit: number | undefined;
    },
>
Inherited from Provider.estimate
- Defined in packages/taquito/src/provider.ts:288

finalizeUnstake

finalizeUnstake(finalize_unstake: FinalizeUnstakeParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for an finalize_unstake pseudo-operation
Parameters
- finalize_unstake: FinalizeUnstakeParams
  pseudo-operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.finalizeUnstake
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:654

`Protected`forge

forge(
    __namedParameters: PreparedOperation,
): Promise<
    {
        counter: number;
        opbytes: string;
        opOb: { branch: string; contents: OperationContents[]; protocol: string };
    },
>
Parameters
- __namedParameters: PreparedOperation
Returns Promise<
    {
        counter: number;
        opbytes: string;
        opOb: { branch: string; contents: OperationContents[]; protocol: string };
    },
>
Inherited from Provider.forge
- Defined in packages/taquito/src/provider.ts:275

getRPCOp

getRPCOp(
    param: ParamsWithKind,
): Promise<
    | RPCTransferOperation
    | RPCOriginationOperation
    | RPCDelegateOperation
    | RPCRegisterGlobalConstantOperation
    | RPCIncreasePaidStorageOperation
    | RPCTransferTicketOperation
    | RPCUpdateConsensusKeyOperation
    | RPCUpdateCompanionKeyOperation
    | RPCSmartRollupAddMessagesOperation
    | RPCSmartRollupOriginateOperation
    | RPCSmartRollupOutboxMessageOperation,
>
Parameters
- param: ParamsWithKind
Returns Promise<
    | RPCTransferOperation
    | RPCOriginationOperation
    | RPCDelegateOperation
    | RPCRegisterGlobalConstantOperation
    | RPCIncreasePaidStorageOperation
    | RPCTransferTicketOperation
    | RPCUpdateConsensusKeyOperation
    | RPCUpdateCompanionKeyOperation
    | RPCSmartRollupAddMessagesOperation
    | RPCSmartRollupOriginateOperation
    | RPCSmartRollupOutboxMessageOperation,
>
Inherited from Provider.getRPCOp
- Defined in packages/taquito/src/provider.ts:324

increasePaidStorage

increasePaidStorage(params: IncreasePaidStorageParams): Promise<Estimate>
Estimate gasLimit, storageLimit, and fees for an increasePaidStorage operation
Parameters
- params: IncreasePaidStorageParams
  increasePaidStorage operation parameters
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit, and fees for the operation
Implementation of EstimationProvider.increasePaidStorage
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:900

`Protected`isAccountRevealRequired

isAccountRevealRequired(publicKeyHash: string): Promise<boolean>
Parameters
- publicKeyHash: string
Returns Promise<boolean>
Inherited from Provider.isAccountRevealRequired
- Defined in packages/taquito/src/provider.ts:435

`Protected`isRevealOpNeeded

isRevealOpNeeded(
op: RPCOperation[] | ParamsWithKind[],
pkh: string,
): Promise<boolean>
Parameters
- op: RPCOperation[] | ParamsWithKind[]
- pkh: string
Returns Promise<boolean>
Inherited from Provider.isRevealOpNeeded
- Defined in packages/taquito/src/provider.ts:429

`Protected`isRevealRequiredForOpType

isRevealRequiredForOpType(op: RPCOperation[] | ParamsWithKind[]): boolean
Parameters
- op: RPCOperation[] | ParamsWithKind[]
Returns boolean
Inherited from Provider.isRevealRequiredForOpType
- Defined in packages/taquito/src/provider.ts:439

originate

originate(params: OriginateParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for an origination operation
Parameters
- params: OriginateParams
  Originate operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.originate
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:497

registerDelegate

registerDelegate(
__namedParameters: RegisterDelegateParams,
source?: string,
): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for a delegate operation
Parameters
- __namedParameters: RegisterDelegateParams
- Optionalsource: string
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.registerDelegate
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:790

registerGlobalConstant

registerGlobalConstant(params: RegisterGlobalConstantParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for an registerGlobalConstant operation
Parameters
- params: RegisterGlobalConstantParams
  registerGlobalConstant operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.registerGlobalConstant
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:864

reveal

reveal(params?: RevealParams): Promise<Estimate | undefined>
Estimate gasLimit, storageLimit and fees to reveal the current account
Parameters
- Optionalparams: RevealParams
  Reveal operation parameter
Returns Promise<Estimate | undefined>
An estimation of gasLimit, storageLimit and fees for the operation or undefined if the account is already revealed
Implementation of EstimationProvider.reveal
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:824

setDelegate

setDelegate(__namedParameters: DelegateParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for a delegate operation
Parameters
- __namedParameters: DelegateParams
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.setDelegate
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:737

`Protected`signAndInject

signAndInject(
    forgedBytes: ForgedBytes,
): Promise<
    {
        context: Context;
        forgedBytes: ForgedBytes;
        hash: string;
        opResponse: OperationContentsAndResult[];
    },
>
Parameters
- forgedBytes: ForgedBytes
Returns Promise<
    {
        context: Context;
        forgedBytes: ForgedBytes;
        hash: string;
        opResponse: OperationContentsAndResult[];
    },
>
Inherited from Provider.signAndInject
- Defined in packages/taquito/src/provider.ts:449

`Protected`simulate

simulate(
    op: RPCSimulateOperationParam,
    preparedOperation?: PreparedOperation,
): Promise<
    {
        context: Context;
        op: RPCSimulateOperationParam;
        opResponse: PreapplyResponse;
    },
>
Parameters
- op: RPCSimulateOperationParam
- OptionalpreparedOperation: PreparedOperation
Returns Promise<
    {
        context: Context;
        op: RPCSimulateOperationParam;
        opResponse: PreapplyResponse;
    },
>
Inherited from Provider.simulate
- Defined in packages/taquito/src/provider.ts:377

smartRollupAddMessages

smartRollupAddMessages(params: SmartRollupAddMessagesParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for a smart_rollup_add_messages operation
Parameters
- params: SmartRollupAddMessagesParams
  SmartRollupAddMessages operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.smartRollupAddMessages
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:999

smartRollupExecuteOutboxMessage

smartRollupExecuteOutboxMessage(
params: SmartRollupExecuteOutboxMessageParams,
): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for a smart_rollup_execute_outbox_message operation
Parameters
- params: SmartRollupExecuteOutboxMessageParams
  SmartRollupExecuteOutboxMessage operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.smartRollupExecuteOutboxMessage
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:1049

smartRollupOriginate

smartRollupOriginate(params: SmartRollupOriginateParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for an Smart Rollup Originate operation
Parameters
- params: SmartRollupOriginateParams
  SmartRollupOriginate operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.smartRollupOriginate
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:1024

stake

stake(Stake: StakeParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for an stake pseudo-operation
Parameters
- Stake: StakeParams
  pseudo-operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.stake
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:564

transfer

transfer(TransferOperation: TransferParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for an transfer operation
Parameters
- TransferOperation: TransferParams
  Originate operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.transfer
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:523

transferTicket

transferTicket(TransferTicketParams: TransferTicketParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for a transferTicket operation
Parameters
- TransferTicketParams: TransferTicketParams
  operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.transferTicket
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:700

unstake

unstake(Unstake: UnstakeParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for an Unstake pseudo-operation
Parameters
- Unstake: UnstakeParams
  pseudo-operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.unstake
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:609

updateCompanionKey

updateCompanionKey(params: UpdateCompanionKeyParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for an Update Companion Key operation
Parameters
- params: UpdateCompanionKeyParams
  UpdateCompanionKey operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.updateCompanionKey
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:967

updateConsensusKey

updateConsensusKey(params: UpdateConsensusKeyParams): Promise<Estimate>
Estimate gasLimit, storageLimit and fees for an Update Consensus Key operation
Parameters
- params: UpdateConsensusKeyParams
  UpdateConsensusKey operation parameter
Returns Promise<Estimate>
An estimation of gasLimit, storageLimit and fees for the operation
Implementation of EstimationProvider.updateConsensusKey
- Defined in packages/taquito/src/estimate/rpc-estimate-provider.ts:932

Class RPCEstimateProvider

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RPCEstimateProvider

Properties

Protectedcontext

Accessors

rpc

Returns RpcClientInterface

signer

Returns Signer

Methods

batch

Parameters

Returns Promise<Estimate[]>

contractCall

Parameters

Returns Promise<Estimate>

Protectedestimate

Type Parameters

Parameters

Returns Promise< { fee: number | undefined; gasLimit: number | undefined; storageLimit: number | undefined; },>

finalizeUnstake

Parameters

Returns Promise<Estimate>

Protectedforge

Parameters

Returns Promise< { counter: number; opbytes: string; opOb: { branch: string; contents: OperationContents[]; protocol: string }; },>

getRPCOp

Parameters

increasePaidStorage

Parameters

Returns Promise<Estimate>

ProtectedisAccountRevealRequired

Parameters

Returns Promise<boolean>

ProtectedisRevealOpNeeded

Parameters

Returns Promise<boolean>

ProtectedisRevealRequiredForOpType

Parameters

Returns boolean

originate

Parameters

Returns Promise<Estimate>

registerDelegate

Parameters

Returns Promise<Estimate>

registerGlobalConstant

Parameters

Returns Promise<Estimate>

reveal

Parameters

Returns Promise<Estimate | undefined>

setDelegate

Parameters

Returns Promise<Estimate>

ProtectedsignAndInject

Parameters

Returns Promise< { context: Context; forgedBytes: ForgedBytes; hash: string; opResponse: OperationContentsAndResult[]; },>

Protectedsimulate

Parameters

Returns Promise< { context: Context; op: RPCSimulateOperationParam; opResponse: PreapplyResponse; },>

smartRollupAddMessages

Parameters

Returns Promise<Estimate>

smartRollupExecuteOutboxMessage

Parameters

Returns Promise<Estimate>

smartRollupOriginate

Parameters

Returns Promise<Estimate>

`Protected`context

`Protected`estimate

Returns Promise<
{
fee: number
| undefined;
gasLimit: number | undefined;
storageLimit: number | undefined;
},
>

`Protected`forge

Returns Promise<
{
counter: number;
opbytes: string;
opOb: { branch: string; contents: OperationContents[]; protocol: string };
},
>

`Protected`isAccountRevealRequired

`Protected`isRevealOpNeeded

`Protected`isRevealRequiredForOpType

`Protected`signAndInject

Returns Promise<
{
context: Context;
forgedBytes: ForgedBytes;
hash: string;
opResponse: OperationContentsAndResult[];
},
>

`Protected`simulate

Returns Promise<
{
context: Context;
op: RPCSimulateOperationParam;
opResponse: PreapplyResponse;
},
>