Interface PreparationProvider

Description

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: ContractMethod<ContractProvider> | 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>;
    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 updateConsensusKey

Methods

activate

activate(params): Promise<PreparedOperation>
Parameters
- params: ActivationParams
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare an activation operation
- Defined in packages/taquito/src/prepare/interface.ts:34

ballot

ballot(params): Promise<PreparedOperation>
Parameters
- params: BallotParams
  ballot operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a ballot operation
- Defined in packages/taquito/src/prepare/interface.ts:111

batch

batch(batchParams): Promise<PreparedOperation>
Parameters
- batchParams: ParamsWithKind[]
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a batch operation
- Defined in packages/taquito/src/prepare/interface.ts:148

contractCall

contractCall(contractMethod): Promise<PreparedOperation>
Parameters
- contractMethod: ContractMethod<ContractProvider> | ContractMethodObject<ContractProvider>
  ContractMethod or ContractMethodObject retrieved from smart contract
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a contract call (transfer) operation
- Defined in packages/taquito/src/prepare/interface.ts:155

delegation

delegation(params): Promise<PreparedOperation>
Parameters
- params: DelegateParams
  delegation operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a delegation operation
- Defined in packages/taquito/src/prepare/interface.ts:71

drainDelegate

drainDelegate(params): Promise<PreparedOperation>
Parameters
- params: DrainDelegateParams
  drainDelegate operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a drain_delegate operation
- Defined in packages/taquito/src/prepare/interface.ts:126

increasePaidStorage

increasePaidStorage(params): Promise<PreparedOperation>
Parameters
- params: IncreasePaidStorageParams
  increasePaidStorage operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare an increase_paid_storage operation
- Defined in packages/taquito/src/prepare/interface.ts:104

originate

originate(params): Promise<PreparedOperation>
Parameters
- params: OriginateParams
  originate operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare an origination operation
- Defined in packages/taquito/src/prepare/interface.ts:51

proposals

proposals(params): Promise<PreparedOperation>
Parameters
- params: ProposalsParams
  proposals operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a proposals operation
- Defined in packages/taquito/src/prepare/interface.ts:119

registerGlobalConstant

registerGlobalConstant(params): Promise<PreparedOperation>
Parameters
- params: RegisterGlobalConstantParams
  registerGlobalConstant operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a register_global_constant operation
- Defined in packages/taquito/src/prepare/interface.ts:79

reveal

reveal(params): Promise<PreparedOperation>
Parameters
- params: RevealParams
  reveal operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a reveal operation
- Defined in packages/taquito/src/prepare/interface.ts:43

smartRollupAddMessages

smartRollupAddMessages(params): Promise<PreparedOperation>
Parameters
- params: SmartRollupAddMessagesParams
  smartRollupAddMessages operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a smart_rollup_add_messages operation
- Defined in packages/taquito/src/prepare/interface.ts:133

smartRollupOriginate

smartRollupOriginate(params): Promise<PreparedOperation>
Parameters
- params: SmartRollupOriginateParams
  smartRollupOriginate operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a smart_rollup_originate operation
- Defined in packages/taquito/src/prepare/interface.ts:140

toForge

toForge(param): ForgeParams
Parameters
- param: PreparedOperation
  a Prepared Operation
Returns ForgeParams
a ForgeParams object

Description
Method to convert a PreparedOperation to the params needed for forging
- Defined in packages/taquito/src/prepare/interface.ts:173

toPreapply

toPreapply(prepared): Promise<PreapplyParams>
Parameters
- prepared: PreparedOperation
  a Prepared Operation
Returns Promise<PreapplyParams>
a PreapplyParams object

Description
Method to convert a PreparedOperation to the params needed for the preapplyOperation method
- Defined in packages/taquito/src/prepare/interface.ts:165

transaction

transaction(params): Promise<PreparedOperation>
Parameters
- params: TransferParams
  transaction operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a transaction operation
- Defined in packages/taquito/src/prepare/interface.ts:62

transferTicket

transferTicket(params): Promise<PreparedOperation>
Parameters
- params: TransferTicketParams
  TransferTicketx operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare a transfer_ticket operation
- Defined in packages/taquito/src/prepare/interface.ts:96

updateConsensusKey

updateConsensusKey(params): Promise<PreparedOperation>
Parameters
- params: UpdateConsensusKeyParams
  updateConsensusKey operation parameters
Returns Promise<PreparedOperation>
a PreparedOperation object

Description
Method to prepare an update_consensus_key operation
- Defined in packages/taquito/src/prepare/interface.ts:87