@taquito/taquito 24.2.0 → 24.3.0-beta.0

package/dist/types/operations/types.d.ts

@@ -17,13 +17,17 @@ export declare const isKind: <T extends {
 }, K extends OpKind>(op: T, kind: K) => op is withKind<T, K>;
 export type RPCOpWithFee = RPCTransferOperation | RPCOriginationOperation | RPCDelegateOperation | RPCRevealOperation | RPCRegisterGlobalConstantOperation | RPCIncreasePaidStorageOperation | RPCTransferTicketOperation | RPCUpdateConsensusKeyOperation | RPCUpdateCompanionKeyOperation | RPCSmartRollupAddMessagesOperation | RPCSmartRollupOriginateOperation | RPCSmartRollupOutboxMessageOperation;
 export type RPCOpWithSource = RPCTransferOperation | RPCOriginationOperation | RPCDelegateOperation | RPCRevealOperation | RPCRegisterGlobalConstantOperation | RPCIncreasePaidStorageOperation | RPCTransferTicketOperation | RPCUpdateConsensusKeyOperation | RPCUpdateCompanionKeyOperation | RPCSmartRollupAddMessagesOperation | RPCSmartRollupOriginateOperation | RPCSmartRollupOutboxMessageOperation | RPCBallotOperation | RPCProposalsOperation;
+declare const feeConsumingOpKinds: readonly [OpKind.TRANSACTION, OpKind.DELEGATION, OpKind.ORIGINATION, OpKind.REVEAL, OpKind.REGISTER_GLOBAL_CONSTANT, OpKind.INCREASE_PAID_STORAGE, OpKind.TRANSFER_TICKET, OpKind.UPDATE_CONSENSUS_KEY, OpKind.UPDATE_COMPANION_KEY, OpKind.SMART_ROLLUP_ADD_MESSAGES, OpKind.SMART_ROLLUP_ORIGINATE, OpKind.SMART_ROLLUP_EXECUTE_OUTBOX_MESSAGE];
+type FeeConsumingOpKind = (typeof feeConsumingOpKinds)[number];
 export declare const isOpWithGasBuffer: <T extends {
     kind: OpKind;
     destination?: string;
 }>(op: T) => boolean;
 export declare const isOpWithFee: <T extends {
     kind: OpKind;
-}>(op: T) => op is withKind<T, Exclude<Exclude<OpKind, OpKind.ACTIVATION>, OpKind.FAILING_NOOP>>;
+}>(op: T) => op is Extract<T, {
+    kind: FeeConsumingOpKind;
+}>;
 export declare const isOpRequireReveal: <T extends {
     kind: OpKind;
 }>(op: T) => op is withKind<T, Exclude<InternalOperationResultKindEnum, OpKind.REVEAL>>;
@@ -63,16 +67,45 @@ export interface FeeConsumingOperation {
     fee: number;
 }
 export type OriginateParamsBase = {
+    /**
+     * Initial contract balance.
+     *
+     * Interpreted as tez by default. Set `mutez: true` to pass this value in mutez.
+     */
     balance?: string | number;
+    /**
+     * Contract code in Micheline JSON (`object[]`) or Michelson string.
+     */
     code: string | object[];
+    /**
+     * Optional delegate for the originated contract.
+     */
     delegate?: string;
+    /**
+     * Fee in mutez.
+     *
+     * If omitted, Taquito estimates and fills a fee.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     *
+     * If omitted, Taquito derives it from protocol constants and simulation.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     *
+     * If omitted, Taquito derives it from protocol constants and simulation.
+     */
     storageLimit?: number;
+    /**
+     * When `true`, `balance` is interpreted as mutez.
+     */
     mutez?: boolean;
 };
 /**
- * @description Parameters for originate method
+ * Parameters for originate method
  */
 export type OriginateParams<TStorage = any> = OriginateParamsBase & ({
     init?: never;
@@ -88,7 +121,7 @@ export interface ActivationParams {
     secret: string;
 }
 /**
- * @description RPC origination operation
+ * RPC origination operation
  */
 export interface RPCOriginationOperation {
     kind: OpKind.ORIGINATION;
@@ -104,7 +137,7 @@ export interface RPCOriginationOperation {
     };
 }
 /**
- * @description RPC reveal operation
+ * RPC reveal operation
  */
 export interface RPCRevealOperation {
     kind: OpKind.REVEAL;
@@ -116,13 +149,27 @@ export interface RPCRevealOperation {
     proof?: string;
 }
 export interface RevealParams {
+    /**
+     * Reveal fee in mutez.
+     */
     fee?: number;
+    /**
+     * Reveal gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Reveal storage limit.
+     */
     storageLimit?: number;
+    /**
+     * Proof of possession for BLS (`tz4`) reveal.
+     *
+     * Required for BLS reveal and ignored for non-BLS sources.
+     */
     proof?: string;
 }
 /**
- * @description Result of a forge operation contains the operation plus its encoded version
+ * Result of a forge operation contains the operation plus its encoded version
  */
 export interface ForgedBytes {
     opbytes: string;
@@ -130,25 +177,51 @@ export interface ForgedBytes {
     counter: number;
 }
 /**
- * @description Parameters for setDelegate method
+ * Parameters for setDelegate method
  */
 export interface DelegateParams {
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Delegate address.
+     *
+     * Omit to clear delegation.
+     */
     delegate?: string;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
 }
 /**
- * @description Parameters for registerDelegate method
+ * Parameters for registerDelegate method
  */
 export interface RegisterDelegateParams {
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
 }
 /**
- * @description RPC delegation operation
+ * RPC delegation operation
  */
 export interface RPCDelegateOperation {
     kind: OpKind.DELEGATION;
@@ -159,59 +232,170 @@ export interface RPCDelegateOperation {
     delegate?: string;
 }
 /**
- * @description Parameters for transfer method
+ * Parameters for transfer method
  */
 export interface TransferParams {
+    /**
+     * Destination account or contract address.
+     */
     to: string;
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Transfer amount.
+     *
+     * Interpreted as tez by default. Set `mutez: true` to pass mutez.
+     */
     amount: number;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Optional transaction parameter for contract calls.
+     */
     parameter?: TransactionOperationParameter;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * When `true`, `amount` is interpreted as mutez.
+     */
     mutez?: boolean;
 }
 /**
- * @description RPC Stake pseudo operation params
+ * RPC Stake pseudo operation params
  */
 export interface StakeParams {
+    /**
+     * Destination staking contract/account.
+     *
+     * Defaults to source when omitted.
+     */
     to?: string;
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Amount to stake.
+     *
+     * Interpreted as tez by default. Set `mutez: true` to pass mutez.
+     */
     amount: number;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Optional RPC-level parameter override.
+     */
     parameter?: TransactionOperationParameter;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * When `true`, `amount` is interpreted as mutez.
+     */
     mutez?: boolean;
 }
 /**
- * @description RPC unstake pseudo operation params
+ * RPC unstake pseudo operation params
  */
 export interface UnstakeParams {
+    /**
+     * Destination staking contract/account.
+     *
+     * Defaults to source when omitted.
+     */
     to?: string;
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Amount to unstake.
+     *
+     * Interpreted as tez by default. Set `mutez: true` to pass mutez.
+     */
     amount: number;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Optional RPC-level parameter override.
+     */
     parameter?: TransactionOperationParameter;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * When `true`, `amount` is interpreted as mutez.
+     */
     mutez?: boolean;
 }
 /**
- * @description RPC finalize_unstake pseudo operation params
+ * RPC finalize_unstake pseudo operation params
  */
 export interface FinalizeUnstakeParams {
+    /**
+     * Destination account for finalized funds.
+     *
+     * Defaults to source when omitted.
+     */
     to?: string;
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Transaction amount in mutez for the underlying `finalize_unstake` transaction.
+     *
+     * Protocol requires this to be `0` when present. Non-zero values are rejected with
+     * `operations.invalid_nonzero_transaction_amount`.
+     */
     amount?: number;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Optional RPC-level parameter override.
+     */
     parameter?: TransactionOperationParameter;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * When `true`, numeric amounts are interpreted as mutez.
+     */
     mutez?: boolean;
 }
 /**
- * @description RPC register global constant operation
+ * RPC register global constant operation
  */
 export interface RPCRegisterGlobalConstantOperation {
     kind: OpKind.REGISTER_GLOBAL_CONSTANT;
@@ -222,17 +406,32 @@ export interface RPCRegisterGlobalConstantOperation {
     value: MichelsonV1Expression;
 }
 /**
- * @description Parameters for the `registerGlobalConstant` method
+ * Parameters for the `registerGlobalConstant` method
  */
 export interface RegisterGlobalConstantParams {
+    /**
+     * Micheline expression to register.
+     */
     value: MichelsonV1Expression;
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
 }
 /**
- * @description RPC transfer operation
+ * RPC transfer operation
  */
 export interface RPCTransferOperation {
     kind: OpKind.TRANSACTION;
@@ -245,7 +444,7 @@ export interface RPCTransferOperation {
     parameters?: TransactionOperationParameter;
 }
 /**
- * @description RPC activate account operation
+ * RPC activate account operation
  */
 export interface RPCActivateOperation {
     kind: OpKind.ACTIVATION;
@@ -253,22 +452,55 @@ export interface RPCActivateOperation {
     secret: string;
 }
 /**
- * @description Parameters for the transferTicket contract provider
+ * Parameters for the transferTicket contract provider
  */
 export interface TransferTicketParams {
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * Ticket payload.
+     */
     ticketContents: MichelsonV1Expression;
+    /**
+     * Ticket Micheline type.
+     */
     ticketTy: MichelsonV1Expression;
+    /**
+     * Ticket ticketer contract address.
+     */
     ticketTicketer: string;
+    /**
+     * Quantity of tickets to transfer.
+     */
     ticketAmount: number;
+    /**
+     * Destination contract or implicit account.
+     */
     destination: string;
+    /**
+     * Destination entrypoint name (1-31 bytes).
+     *
+     * For implicit destinations (`tz...`), this must be `default`; otherwise protocol
+     * rejects with `michelson_v1.no_such_entrypoint`.
+     */
     entrypoint: string;
 }
 /**
- * @description Rpc transfer-ticket operation
+ * Rpc transfer-ticket operation
  */
 export interface RPCTransferTicketOperation {
     kind: OpKind.TRANSFER_TICKET;
@@ -284,18 +516,38 @@ export interface RPCTransferTicketOperation {
     entrypoint: string;
 }
 /**
- * @description Parameters for the increasePaidStorage method
+ * Parameters for the increasePaidStorage method
  */
 export interface IncreasePaidStorageParams {
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * Additional storage bytes to pre-pay for the target contract.
+     *
+     * Must be a positive integer. Burn cost is `amount * cost_per_byte`.
+     */
     amount: number;
+    /**
+     * Destination contract address.
+     */
     destination: string;
 }
 /**
- * @description RPC IncreasePaidStorage operation
+ * RPC IncreasePaidStorage operation
  */
 export interface RPCIncreasePaidStorageOperation {
     kind: OpKind.INCREASE_PAID_STORAGE;
@@ -307,7 +559,7 @@ export interface RPCIncreasePaidStorageOperation {
     destination: string;
 }
 /**
- * @description Parameters for the DrainDelegate method
+ * Parameters for the DrainDelegate method
  */
 export interface DrainDelegateParams {
     consensus_key: string;
@@ -315,7 +567,7 @@ export interface DrainDelegateParams {
     destination: string;
 }
 /**
- * @description RPC DrainDelegate operation
+ * RPC DrainDelegate operation
  */
 export interface RPCDrainDelegateOperation {
     kind: OpKind.DRAIN_DELEGATE;
@@ -324,7 +576,7 @@ export interface RPCDrainDelegateOperation {
     destination: string;
 }
 /**
- * @description Ballot operation params
+ * Ballot operation params
  */
 export interface BallotParams {
     source?: string;
@@ -349,11 +601,33 @@ export interface RPCProposalsOperation {
     proposals: string[];
 }
 export interface UpdateConsensusKeyParams {
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * New consensus public key.
+     */
     pk: string;
+    /**
+     * BLS proof-of-possession for `pk`.
+     *
+     * Required when `pk` is a BLS (`tz4`) key, otherwise validation fails with
+     * `validate.operation.missing_bls_proof`. Invalid proofs fail with
+     * `validate.operation.incorrect_bls_proof`. Must be omitted for non-BLS keys.
+     */
     proof?: string;
 }
 export interface RPCUpdateConsensusKeyOperation {
@@ -366,11 +640,34 @@ export interface RPCUpdateConsensusKeyOperation {
     proof?: string;
 }
 export interface UpdateCompanionKeyParams {
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * New companion public key (BLS).
+     */
     pk: string;
+    /**
+     * BLS proof-of-possession for the companion key.
+     *
+     * Companion keys must be `tz4`; non-BLS keys fail with
+     * `validate.operation.update_companion_key_not_tz4`.
+     * Missing proof fails with `validate.operation.missing_bls_proof` and invalid proof
+     * fails with `validate.operation.incorrect_bls_proof`.
+     */
     proof?: string;
 }
 export interface RPCUpdateCompanionKeyOperation {
@@ -383,10 +680,27 @@ export interface RPCUpdateCompanionKeyOperation {
     proof?: string;
 }
 export interface SmartRollupAddMessagesParams {
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * Hex-encoded message bytes posted to the global smart-rollup inbox.
+     *
+     * At least one message is required. Each message is limited to 4096 bytes after decoding.
+     */
     message: string[];
 }
 export interface RPCSmartRollupAddMessagesOperation {
@@ -398,12 +712,37 @@ export interface RPCSmartRollupAddMessagesOperation {
     message: string[];
 }
 export interface SmartRollupOriginateParams {
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * PVM kind for the rollup.
+     */
     pvmKind: PvmKind;
+    /**
+     * Hex-encoded boot sector binary for the selected PVM.
+     *
+     * Effective size is constrained by the operation data size limit.
+     */
     kernel: string;
+    /**
+     * Micheline type for L1-to-rollup deposited values.
+     *
+     * Must be a valid Michelson type accepted by protocol rollup parameter typing rules.
+     */
     parametersType: MichelsonV1Expression;
 }
 export interface RPCSmartRollupOriginateOperation {
@@ -417,12 +756,35 @@ export interface RPCSmartRollupOriginateOperation {
     parameters_ty: MichelsonV1Expression;
 }
 export interface SmartRollupExecuteOutboxMessageParams {
+    /**
+     * Operation source. Defaults to the active signer pkh.
+     */
     source?: string;
+    /**
+     * Fee in mutez.
+     */
     fee?: number;
+    /**
+     * Gas limit.
+     */
     gasLimit?: number;
+    /**
+     * Storage limit.
+     */
     storageLimit?: number;
+    /**
+     * Target smart-rollup address (`sr1...`).
+     */
     rollup: string;
+    /**
+     * Cemented commitment hash (`src1...`) referenced by the outbox proof.
+     *
+     * Must still be present in the chain of stored cemented commitments.
+     */
     cementedCommitment: string;
+    /**
+     * Hex-encoded PVM outbox proof bytes produced by a rollup node.
+     */
     outputProof: string;
 }
 export interface RPCSmartRollupOutboxMessageOperation {
@@ -436,14 +798,14 @@ export interface RPCSmartRollupOutboxMessageOperation {
     output_proof: string;
 }
 /**
- * @description RPC failing noop operation
+ * RPC failing noop operation
  */
 export interface RPCFailingNoopOperation {
     kind: OpKind.FAILING_NOOP;
     arbitrary: string;
 }
 /**
- * @description Parameters for the `failingNoop` method
+ * Parameters for the `failingNoop` method
  */
 export interface FailingNoopParams {
     arbitrary: string;

package/dist/types/operations/update-companion-key-operation.d.ts

@@ -4,7 +4,7 @@ import { Operation } from './operations';
 import { FeeConsumingOperation, ForgedBytes, GasConsumingOperation, StorageConsumingOperation } from './types';
 /**
  *
- * @description UpdateCompanionKeyOperation provides utility to fetch properties for Operation of kind UpdateCompanionKey
+ * UpdateCompanionKeyOperation provides utility to fetch properties for Operation of kind UpdateCompanionKey
  *
  */
 export declare class UpdateCompanionKeyOperation extends Operation implements GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation {

package/dist/types/operations/update-consensus-key-operation.d.ts

@@ -4,7 +4,7 @@ import { Operation } from './operations';
 import { FeeConsumingOperation, ForgedBytes, GasConsumingOperation, StorageConsumingOperation } from './types';
 /**
  *
- * @description UpdateConsensusKeyOperation provides utility to fetch properties for Operation of kind UpdateConsensusKey
+ * UpdateConsensusKeyOperation provides utility to fetch properties for Operation of kind UpdateConsensusKey
  *
  */
 export declare class UpdateConsensusKeyOperation extends Operation implements GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation {