Interface PreparationProvider

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

interface PreparationProvider {
    activate(params: ActivationParams): Promise<PreparedOperation>;
    ballot(params: BallotParams): Promise<PreparedOperation>;
    batch(batchParams: ParamsWithKind[]): Promise<PreparedOperation>;
    contractCall(
        contractMethod: ContractMethodObject<ContractProvider>,
    ): Promise<PreparedOperation>;
    delegation(params: DelegateParams): Promise<PreparedOperation>;
    drainDelegate(params: DrainDelegateParams): Promise<PreparedOperation>;
    increasePaidStorage(
        params: IncreasePaidStorageParams,
    ): Promise<PreparedOperation>;
    originate(params: OriginateParams): Promise<PreparedOperation>;
    proposals(params: ProposalsParams): Promise<PreparedOperation>;
    registerGlobalConstant(
        params: RegisterGlobalConstantParams,
    ): Promise<PreparedOperation>;
    reveal(params: RevealParams): Promise<PreparedOperation>;
    smartRollupAddMessages(
        params: SmartRollupAddMessagesParams,
    ): Promise<PreparedOperation>;
    smartRollupOriginate(
        params: SmartRollupOriginateParams,
    ): Promise<PreparedOperation>;
    toForge(param: PreparedOperation): ForgeParams;
    toPreapply(prepared: PreparedOperation): Promise<PreapplyParams>;
    transaction(params: TransferParams): Promise<PreparedOperation>;
    transferTicket(params: TransferTicketParams): Promise<PreparedOperation>;
    updateCompanionKey(
        params: UpdateCompanionKeyParams,
    ): Promise<PreparedOperation>;
    updateConsensusKey(
        params: UpdateConsensusKeyParams,
    ): Promise<PreparedOperation>;
}

Implemented by

PrepareProvider

Index

Methods

activate ballot batch contractCall delegation drainDelegate increasePaidStorage originate proposals registerGlobalConstant reveal smartRollupAddMessages smartRollupOriginate toForge toPreapply transaction transferTicket updateCompanionKey updateConsensusKey

Methods

activate

activate(params: ActivationParams): Promise<PreparedOperation>
Method to prepare an activation operation
Parameters
- params: ActivationParams
  activation operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:33

ballot

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

batch

batch(batchParams: ParamsWithKind[]): Promise<PreparedOperation>
Method to prepare a batch operation
Parameters
- batchParams: ParamsWithKind[]
  batch operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:146

contractCall

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

delegation

delegation(params: DelegateParams): Promise<PreparedOperation>
Method to prepare a delegation operation
Parameters
- params: DelegateParams
  delegation operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:66

drainDelegate

drainDelegate(params: DrainDelegateParams): Promise<PreparedOperation>
Method to prepare a drain_delegate operation
Parameters
- params: DrainDelegateParams
  drainDelegate operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:124

increasePaidStorage

increasePaidStorage(
params: IncreasePaidStorageParams,
): Promise<PreparedOperation>
Method to prepare an increase_paid_storage operation
Parameters
- params: IncreasePaidStorageParams
  increasePaidStorage operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:102

originate

originate(params: OriginateParams): Promise<PreparedOperation>
Method to prepare an origination operation
Parameters
- params: OriginateParams
  originate operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:48

proposals

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

registerGlobalConstant

registerGlobalConstant(
params: RegisterGlobalConstantParams,
): Promise<PreparedOperation>
Method to prepare a register_global_constant operation
Parameters
- params: RegisterGlobalConstantParams
  registerGlobalConstant operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:73

reveal

reveal(params: RevealParams): Promise<PreparedOperation>
Method to prepare a reveal operation
Parameters
- params: RevealParams
  reveal operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:41

smartRollupAddMessages

smartRollupAddMessages(
params: SmartRollupAddMessagesParams,
): Promise<PreparedOperation>
Method to prepare a smart_rollup_add_messages operation
Parameters
- params: SmartRollupAddMessagesParams
  smartRollupAddMessages operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:131

smartRollupOriginate

smartRollupOriginate(
params: SmartRollupOriginateParams,
): Promise<PreparedOperation>
Method to prepare a smart_rollup_originate operation
Parameters
- params: SmartRollupOriginateParams
  smartRollupOriginate operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:138

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
- Defined in packages/taquito/src/prepare/interface.ts:169

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
- Defined in packages/taquito/src/prepare/interface.ts:161

transaction

transaction(params: TransferParams): Promise<PreparedOperation>
Method to prepare a transaction operation
Parameters
- params: TransferParams
  transaction operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:58

transferTicket

transferTicket(params: TransferTicketParams): Promise<PreparedOperation>
Method to prepare a transfer_ticket operation
Parameters
- params: TransferTicketParams
  TransferTicket operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:95

updateCompanionKey

updateCompanionKey(params: UpdateCompanionKeyParams): Promise<PreparedOperation>
Method to prepare an update_companion_key operation
Parameters
- params: UpdateCompanionKeyParams
  updateCompanionKey operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:87

updateConsensusKey

updateConsensusKey(params: UpdateConsensusKeyParams): Promise<PreparedOperation>
Method to prepare an update_consensus_key operation
Parameters
- params: UpdateConsensusKeyParams
  updateConsensusKey operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object
- Defined in packages/taquito/src/prepare/interface.ts:80