Class OperationBatch

Hierarchy

Provider
- OperationBatch

Constructors

constructor

new OperationBatch(
context: Context,
estimator: EstimationProvider,
): OperationBatch
Parameters
- context: Context
- estimator: EstimationProvider
Returns OperationBatch
Overrides Provider.constructor
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:60

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

`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

`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,
>
Overrides Provider.getRPCOp
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:260

`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

send

send(params?: { source?: string }): Promise<BatchOperation>
Forge and Inject the operation batch
Parameters
- Optionalparams: { source?: string }
  Optionally specify the source of the operation
Returns Promise<BatchOperation>
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:367

`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

with

with(params: ParamsWithKind[]): OperationBatch
Add a group operation to the batch. Operation will be applied in the order they are in the params array
Parameters
- params: ParamsWithKind[]
  Operations parameter
Returns OperationBatch
Throws
InvalidOperationKindError
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:320

withActivation

withActivation(params: ActivationParams): OperationBatch
Add an activation operation to the batch
Parameters
- params: ActivationParams
  Activation operation parameter
Returns OperationBatch
Throws
InvalidKeyHashError
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:142

withContractCall

withContractCall(
params: ContractMethodObject<ContractProvider>,
options?: Partial<SendParams>,
): OperationBatch
Add a contract call to the batch
Parameters
- params: ContractMethodObject<ContractProvider>
  Call a contract method
- options: Partial<SendParams> = {}
  Generic operation parameters
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:109

withDelegation

withDelegation(params: DelegateParams): OperationBatch
Add a delegation operation to the batch
Parameters
- params: DelegateParams
  Delegation operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:122

withIncreasePaidStorage

withIncreasePaidStorage(params: IncreasePaidStorageParams): OperationBatch
Add an increase paid storage operation to the batch
Parameters
- params: IncreasePaidStorageParams
  IncreasePaidStorage operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:181

withOrigination

withOrigination<TContract extends DefaultContractType = DefaultContractType>(
params: OriginateParams<PromiseReturnType<TContract["storage"]>>,
): OperationBatch
Add an origination operation to the batch
Type Parameters
- TContract extends DefaultContractType = DefaultContractType
Parameters
- params: OriginateParams<PromiseReturnType<TContract["storage"]>>
  Origination operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:157

withRegisterGlobalConstant

withRegisterGlobalConstant(params: RegisterGlobalConstantParams): OperationBatch
Add a register a global constant operation to the batch
Parameters
- params: RegisterGlobalConstantParams
  RegisterGlobalConstant operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:170

withSmartRollupAddMessages

withSmartRollupAddMessages(params: SmartRollupAddMessagesParams): OperationBatch
Add a smart rollup add messages operation to the batch
Parameters
- params: SmartRollupAddMessagesParams
  Rollup origination operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:233

withSmartRollupExecuteOutboxMessage

withSmartRollupExecuteOutboxMessage(
params: SmartRollupExecuteOutboxMessageParams,
): OperationBatch
Add a smart rollup execute outbox message to the batch
Parameters
- params: SmartRollupExecuteOutboxMessageParams
  Smart Rollup Execute Outbox Message operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:255

withSmartRollupOriginate

withSmartRollupOriginate(params: SmartRollupOriginateParams): OperationBatch
Add a smart rollup originate operation to the batch
Parameters
- params: SmartRollupOriginateParams
  Smart Rollup Originate operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:244

withTransfer

withTransfer(params: TransferParams): OperationBatch
Add a transaction operation to the batch
Parameters
- params: TransferParams
  Transfer operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:75

withTransferTicket

withTransferTicket(params: TransferTicketParams): OperationBatch
Transfer tickets from a Tezos address (tz1,tz2 or tz3) to a smart contract address( KT1)
Parameters
- params: TransferTicketParams
  Transfer operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:93

withUpdateCompanionKey

withUpdateCompanionKey(params: UpdateCompanionKeyParams): OperationBatch
Add a update companion key operation to the batch
Parameters
- params: UpdateCompanionKeyParams
  UpdateCompanionKey operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:215

withUpdateConsensusKey

withUpdateConsensusKey(params: UpdateConsensusKeyParams): OperationBatch
Add a update consensus key operation to the batch
Parameters
- params: UpdateConsensusKeyParams
  UpdateConsensusKey operation parameter
Returns OperationBatch
- Defined in packages/taquito/src/batch/rpc-batch-provider.ts:192

Class OperationBatch

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OperationBatch

Properties

Protectedcontext

Accessors

rpc

Returns RpcClientInterface

signer

Returns Signer

Methods

Protectedestimate

Type Parameters

Parameters

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

Protectedforge

Parameters

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

getRPCOp

Parameters

ProtectedisAccountRevealRequired

Parameters

Returns Promise<boolean>

ProtectedisRevealOpNeeded

Parameters

Returns Promise<boolean>

ProtectedisRevealRequiredForOpType

Parameters

Returns boolean

send

Parameters

Returns Promise<BatchOperation>

ProtectedsignAndInject

Parameters

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

Protectedsimulate

Parameters

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

with

Parameters

Returns OperationBatch

Throws

withActivation

Parameters

Returns OperationBatch

Throws

withContractCall

Parameters

Returns OperationBatch

withDelegation

Parameters

Returns OperationBatch

withIncreasePaidStorage

Parameters

Returns OperationBatch

withOrigination

Type Parameters

Parameters

Returns OperationBatch

withRegisterGlobalConstant

Parameters

Returns OperationBatch

withSmartRollupAddMessages

Parameters

Returns OperationBatch

withSmartRollupExecuteOutboxMessage

Parameters

Returns OperationBatch

withSmartRollupOriginate

Parameters

Returns OperationBatch

withTransfer

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