Class PrepareProvider

PrepareProvider is a utility class to output the prepared format of an operation

Hierarchy

Provider
- PrepareProvider

Implements

PreparationProvider

Constructors

constructor

new PrepareProvider(context: Context): PrepareProvider
Parameters
- context: Context
Returns PrepareProvider
Overrides Provider.constructor
- Defined in packages/taquito/src/prepare/prepare-provider.ts:112

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

activate

activate(__namedParameters: ActivationParams): Promise<PreparedOperation>
Method to prepare an activation operation
Parameters
- __namedParameters: ActivationParams
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.activate
- Defined in packages/taquito/src/prepare/prepare-provider.ts:392

ballot

ballot(params: BallotParams): Promise<PreparedOperation>
Method to prepare a ballot operation
Parameters
- params: BallotParams
  ballot operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.ballot
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1087

batch

batch(
batchParams: ParamsWithKind[],
estimates?: Estimate[],
): Promise<PreparedOperation>
Method to prepare a batch operation
Parameters
- batchParams: ParamsWithKind[]
  batch operation parameters
- Optionalestimates: Estimate[]
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.batch
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1424

contractCall

contractCall(
contractMethod: ContractMethodObject<ContractProvider>,
): Promise<PreparedOperation>
Method to prepare a contract call operation
Parameters
- contractMethod: ContractMethodObject<ContractProvider>
  ContractMethodObject retrieved from smart contract
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.contractCall
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1528

delegation

delegation(__namedParameters: DelegateParams): Promise<PreparedOperation>
Method to prepare a delegation operation
Parameters
- __namedParameters: DelegateParams
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.delegation
- Defined in packages/taquito/src/prepare/prepare-provider.ts:753

drainDelegate

drainDelegate(
params: DrainDelegateParams,
source?: string,
): Promise<PreparedOperation>
Method to prepare a drain_delegate operation
Parameters
- params: DrainDelegateParams
  drainDelegate operation parameters
- Optionalsource: string
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.drainDelegate
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1184

`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(
__namedParameters: FinalizeUnstakeParams,
): Promise<PreparedOperation>
Method to prepare a finalize_unstake pseudo-operation
Parameters
- __namedParameters: FinalizeUnstakeParams
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/prepare-provider.ts:696

`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(
__namedParameters: IncreasePaidStorageParams,
): Promise<PreparedOperation>
Method to prepare an increase_paid_storage operation
Parameters
- __namedParameters: IncreasePaidStorageParams
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.increasePaidStorage
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1034

`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<TContract extends DefaultContractType = DefaultContractType>(
__namedParameters: OriginateParams<ContractStorageType<TContract>>,
source?: string,
): Promise<PreparedOperation>
Method to prepare an origination operation
Type Parameters
- TContract extends DefaultContractType = DefaultContractType
Parameters
- __namedParameters: OriginateParams<ContractStorageType<TContract>>
- Optionalsource: string
  string or undefined source pkh
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.originate
- Defined in packages/taquito/src/prepare/prepare-provider.ts:486

proposals

proposals(params: ProposalsParams): Promise<PreparedOperation>
Method to prepare a proposals operation
Parameters
- params: ProposalsParams
  proposals operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.proposals
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1135

registerDelegate

registerDelegate(
__namedParameters: RegisterDelegateParams,
source?: string,
): Promise<PreparedOperation>
Method to prepare a register delegate operation
Parameters
- __namedParameters: RegisterDelegateParams
- Optionalsource: string
  string or undefined source pkh
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/prepare-provider.ts:806

registerGlobalConstant

registerGlobalConstant(
__namedParameters: RegisterGlobalConstantParams,
): Promise<PreparedOperation>
Method to prepare a register_global_constant operation
Parameters
- __namedParameters: RegisterGlobalConstantParams
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.registerGlobalConstant
- Defined in packages/taquito/src/prepare/prepare-provider.ts:861

reveal

reveal(__namedParameters: RevealParams): Promise<PreparedOperation>
Method to prepare a reveal operation
Parameters
- __namedParameters: RevealParams
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.reveal
- Defined in packages/taquito/src/prepare/prepare-provider.ts:423

`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(
__namedParameters: SmartRollupAddMessagesParams,
): Promise<PreparedOperation>
Method to prepare a smart_rollup_add_messages operation
Parameters
- __namedParameters: SmartRollupAddMessagesParams
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.smartRollupAddMessages
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1270

smartRollupExecuteOutboxMessage

smartRollupExecuteOutboxMessage(
__namedParameters: SmartRollupExecuteOutboxMessageParams,
): Promise<PreparedOperation>
Method to prepare a smart_rollup_execute_outbox_message operation
Parameters
- __namedParameters: SmartRollupExecuteOutboxMessageParams
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1372

smartRollupOriginate

smartRollupOriginate(
__namedParameters: SmartRollupOriginateParams,
): Promise<PreparedOperation>
Method to prepare a smart_rollup_originate operation
Parameters
- __namedParameters: SmartRollupOriginateParams
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.smartRollupOriginate
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1321

stake

stake(__namedParameters: StakeParams): Promise<PreparedOperation>
Method to prepare a stake pseudo-operation
Parameters
- __namedParameters: StakeParams
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/prepare-provider.ts:589

toForge

toForge(param: PreparedOperation): ForgeParams
Method to convert a PreparedOperation to the params needed for forging
Parameters
- param: PreparedOperation
  a Prepared Operation
Returns ForgeParams
a ForgeParams object
Implementation of PreparationProvider.toForge
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1611

toPreapply

toPreapply(prepared: PreparedOperation): Promise<PreapplyParams>
Method to convert a PreparedOperation to the params needed for the preapplyOperation method
Parameters
- prepared: PreparedOperation
  a Prepared Operation
Returns Promise<PreapplyParams>
a PreapplyParams object
Implementation of PreparationProvider.toPreapply
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1594

transaction

transaction(__namedParameters: TransferParams): Promise<PreparedOperation>
Method to prepare a transaction operation
Parameters
- __namedParameters: TransferParams
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.transaction
- Defined in packages/taquito/src/prepare/prepare-provider.ts:538

transferTicket

transferTicket(
__namedParameters: TransferTicketParams,
): Promise<PreparedOperation>
Method to prepare a transfer_ticket operation
Parameters
- __namedParameters: TransferTicketParams
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.transferTicket
- Defined in packages/taquito/src/prepare/prepare-provider.ts:1218

unstake

unstake(__namedParameters: UnstakeParams): Promise<PreparedOperation>
Method to prepare a unstake pseudo-operation
Parameters
- __namedParameters: UnstakeParams
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/prepare-provider.ts:641

updateCompanionKey

updateCompanionKey(
__namedParameters: UpdateCompanionKeyParams,
source?: string,
): Promise<PreparedOperation>
Method to prepare an update_companion_key operation
Parameters
- __namedParameters: UpdateCompanionKeyParams
- Optionalsource: string
  string or undefined source pkh
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.updateCompanionKey
- Defined in packages/taquito/src/prepare/prepare-provider.ts:977

updateConsensusKey

updateConsensusKey(
__namedParameters: UpdateConsensusKeyParams,
source?: string,
): Promise<PreparedOperation>
Method to prepare an update_consensus_key operation
Parameters
- __namedParameters: UpdateConsensusKeyParams
- Optionalsource: string
  string or undefined source pkh
Returns Promise<PreparedOperation>
a PreparedOperation object
Implementation of PreparationProvider.updateConsensusKey
- Defined in packages/taquito/src/prepare/prepare-provider.ts:914

Class PrepareProvider

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PrepareProvider

Properties

Protectedcontext

Accessors

rpc

Returns RpcClientInterface

signer

Returns Signer

Methods

activate

Parameters

Returns Promise<PreparedOperation>

ballot

Parameters

Returns Promise<PreparedOperation>

batch

Parameters

Returns Promise<PreparedOperation>

contractCall

Parameters

Returns Promise<PreparedOperation>

delegation

Parameters

Returns Promise<PreparedOperation>

drainDelegate

Parameters

Returns Promise<PreparedOperation>

Protectedestimate

Type Parameters

Parameters

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

finalizeUnstake

Parameters

Returns Promise<PreparedOperation>

Protectedforge

Parameters

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

getRPCOp

Parameters

increasePaidStorage

Parameters

Returns Promise<PreparedOperation>

ProtectedisAccountRevealRequired

Parameters

Returns Promise<boolean>

ProtectedisRevealOpNeeded

Parameters

Returns Promise<boolean>

ProtectedisRevealRequiredForOpType

Parameters

Returns boolean

originate

Type Parameters

Parameters

Returns Promise<PreparedOperation>

proposals

Parameters

Returns Promise<PreparedOperation>

registerDelegate

Parameters

Returns Promise<PreparedOperation>

registerGlobalConstant

Parameters

Returns Promise<PreparedOperation>

reveal

Parameters

Returns Promise<PreparedOperation>

ProtectedsignAndInject

Parameters

`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;
},
>