@taquito/taquito 24.2.0 → 24.3.0-beta.0

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

@@ -5,7 +5,7 @@ export interface TezosOperationErrorWithMessage extends TezosGenericOperationErr
 }
 /**
  *  @category Error
- *  @description Generic tezos error that will be thrown when a mistake occurs when doing an operation; more details here https://tezos.gitlab.io/api/errors.html
+ *  Generic tezos error that will be thrown when a mistake occurs when doing an operation; more details here https://tezos.gitlab.io/api/errors.html
  */
 export declare class TezosOperationError extends RpcError {
     readonly errors: TezosGenericOperationError[];
@@ -18,7 +18,7 @@ export declare class TezosOperationError extends RpcError {
 }
 /**
  *  @category Error
- *  @description Tezos error that will be thrown when a mistake happens during the preapply stage
+ *  Tezos error that will be thrown when a mistake happens during the preapply stage
  */
 export declare class TezosPreapplyFailureError extends Error {
     readonly result: any;
@@ -29,12 +29,12 @@ export type MergedOperationResult = OperationResultTransaction & OperationResult
 };
 export declare const flattenOperationResult: (response: PreapplyResponse | PreapplyResponse[]) => MergedOperationResult[];
 /***
- * @description Flatten all error from preapply response (including internal error)
+ * Flatten all error from preapply response (including internal error)
  */
 export declare const flattenErrors: (response: PreapplyResponse | PreapplyResponse[], status?: string) => TezosGenericOperationError[];
 /**
  *  @category Error
- *  @description Error that indicates a general failure happening during an origination operation.
+ *  Error that indicates a general failure happening during an origination operation.
  */
 export declare class OriginationOperationError extends TaquitoError {
     readonly message: string;
@@ -42,7 +42,7 @@ export declare class OriginationOperationError extends TaquitoError {
 }
 /**
  *  @category Error
- *  @description Error that indicates an invalid estimate value being passed
+ *  Error that indicates an invalid estimate value being passed
  */
 export declare class InvalidEstimateValueError extends ParameterValidationError {
     readonly message: string;

package/dist/types/operations/failing-noop-operation.d.ts

@@ -1,6 +1,6 @@
 import { OpKind } from '@taquito/rpc';
 /**
- * @description FailingNoopOperation interface that contains information about a signed failing_noop operation
+ * FailingNoopOperation interface that contains information about a signed failing_noop operation
  */
 export interface FailingNoopOperation {
     signedContent: {

package/dist/types/operations/increase-paid-storage-operation.d.ts

@@ -4,7 +4,7 @@ import { Operation } from './operations';
 import { FeeConsumingOperation, ForgedBytes, GasConsumingOperation, StorageConsumingOperation } from './types';
 /**
  *
- * @description IncreasePaidStorageOperation provides utility functions to fetch a new operation of kind increase_paid_storage
+ * IncreasePaidStorageOperation provides utility functions to fetch a new operation of kind increase_paid_storage
  *
  */
 export declare class IncreasePaidStorageOperation extends Operation implements GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation {

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

@@ -2,7 +2,7 @@ import { OperationContentsAndResult, OperationContentsAndResultReveal } from '@t
 import { Context } from '../context';
 import { ForgedBytes } from './types';
 /**
- * @description Utility class to interact with Tezos operations
+ * Utility class to interact with Tezos operations
  */
 export declare class Operation {
     readonly hash: string;
@@ -20,7 +20,7 @@ export declare class Operation {
      * @param hash Operation hash
      * @param raw Raw operation that was injected
      * @param context Taquito context allowing access to rpc and signer
-     * @throws {@link InvalidOperationHashError}
+     * @throws InvalidOperationHashError
      */
     constructor(hash: string, raw: ForgedBytes, results: OperationContentsAndResult[], context: Context);
     get revealOperation(): false | OperationContentsAndResultReveal | undefined;

package/dist/types/operations/origination-operation.d.ts

@@ -5,15 +5,15 @@ import { RpcContractProvider } from '../contract/rpc-contract-provider';
 import { Operation } from './operations';
 import { FeeConsumingOperation, ForgedBytes, GasConsumingOperation, StorageConsumingOperation } from './types';
 /**
- * @description Origination operation provide utility function to fetch newly originated contract
+ * Origination operation provide utility function to fetch newly originated contract
  *
- * @warn Currently support only one origination per operation
+ * @remarks Currently support only one origination per operation
  */
 export declare class OriginationOperation<TContract extends DefaultContractType = DefaultContractType> extends Operation implements GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation {
     private readonly params;
     private contractProvider;
     /**
-     * @description Contract address of the newly originated contract
+     * Contract address of the newly originated contract
      */
     readonly contractAddress?: string;
     constructor(hash: string, params: OperationContentsOrigination, raw: ForgedBytes, results: OperationContentsAndResult[], context: Context, contractProvider: RpcContractProvider);
@@ -28,8 +28,8 @@ export declare class OriginationOperation<TContract extends DefaultContractType
     get storageSize(): string | undefined;
     get errors(): import("@taquito/rpc").TezosGenericOperationError[] | undefined;
     /**
-     * @description Provide the contract abstract of the newly originated contract
-     * @throws {@link OriginationOperationError}
+     * Provide the contract abstract of the newly originated contract
+     * @throws OriginationOperationError
      */
     contract(confirmations?: number, timeout?: number): Promise<TContract>;
 }

package/dist/types/operations/proposals-operation.d.ts

@@ -4,7 +4,7 @@ import { Operation } from './operations';
 import { ForgedBytes } from './types';
 /**
  *
- * @description ProposalsOperation provides utility functions to fetch a new operation of kind proposals
+ * ProposalsOperation provides utility functions to fetch a new operation of kind proposals
  *
  */
 export declare class ProposalsOperation extends Operation {

package/dist/types/operations/register-global-constant-operation.d.ts

@@ -3,13 +3,13 @@ import { Context } from '../context';
 import { Operation } from './operations';
 import { FeeConsumingOperation, ForgedBytes, GasConsumingOperation, StorageConsumingOperation } from './types';
 /**
- * @description RegisterGlobalConstantOperation provides utility functions to fetch a newly issued operation of kind register_global_constant
+ * RegisterGlobalConstantOperation provides utility functions to fetch a newly issued operation of kind register_global_constant
  */
 export declare class RegisterGlobalConstantOperation extends Operation implements GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation {
     private readonly params;
     readonly source: string;
     /**
-     * @description Hash (index) of the newly registered constant
+     * Hash (index) of the newly registered constant
      */
     readonly globalConstantHash?: string;
     constructor(hash: string, params: OperationContentsRegisterGlobalConstant, source: string, raw: ForgedBytes, results: OperationContentsAndResult[], context: Context);

package/dist/types/operations/reveal-operation.d.ts

@@ -3,7 +3,7 @@ import { Context } from '../context';
 import { Operation } from './operations';
 import { FeeConsumingOperation, ForgedBytes, GasConsumingOperation, StorageConsumingOperation } from './types';
 /**
- * @description Reveal operation provides utility functions to fetch a newly issued revelation
+ * Reveal operation provides utility functions to fetch a newly issued revelation
  */
 export declare class RevealOperation extends Operation implements GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation {
     private readonly params;

package/dist/types/operations/smart-rollup-add-messages-operation.d.ts

@@ -3,7 +3,7 @@ import { Context } from '../context';
 import { Operation } from './operations';
 import { FeeConsumingOperation, ForgedBytes, GasConsumingOperation, StorageConsumingOperation } from './types';
 /**
- * @description SmartRollupAddMessagesOperation provides utility to fetch properties of SmartRollupAddMessages
+ * SmartRollupAddMessagesOperation provides utility to fetch properties of SmartRollupAddMessages
  */
 export declare class SmartRollupAddMessagesOperation extends Operation implements GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation {
     private readonly params;

package/dist/types/operations/smart-rollup-execute-outbox-message-operation.d.ts

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

package/dist/types/operations/smart-rollup-originate-operation.d.ts

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

package/dist/types/operations/transaction-operation.d.ts

@@ -4,9 +4,9 @@ import { Context } from '../context';
 import { Operation } from './operations';
 import { FeeConsumingOperation, ForgedBytes, GasConsumingOperation, StorageConsumingOperation } from './types';
 /**
- * @description Transaction operation provides utility functions to fetch a newly issued transaction
+ * Transaction operation provides utility functions to fetch a newly issued transaction
  *
- * @warn Currently supports one transaction per operation
+ * @remarks Currently supports one transaction per operation
  */
 export declare class TransactionOperation extends Operation implements GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation {
     private readonly params;

package/dist/types/operations/transfer-ticket-operation.d.ts

@@ -4,9 +4,9 @@ import { Operation } from './operations';
 import { GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation, ForgedBytes } from './types';
 /**
  *
- * @description Transfer tickets from a Tezos address (tz1, tz2 or tz3) to a smart contract address (KT1) (everything on layer 1 at this step)
+ * Transfer tickets from a Tezos address (tz1, tz2 or tz3) to a smart contract address (KT1) (everything on layer 1 at this step)
  *
- * @warn Currently only supports one L2 ticket holder transfer at once. ie. one collection of tickets owned by tz1, tz2 or tz3 to a smart contract.
+ * @remarks Currently only supports one L2 ticket holder transfer at once. ie. one collection of tickets owned by tz1, tz2 or tz3 to a smart contract.
  */
 export declare class TransferTicketOperation extends Operation implements GasConsumingOperation, StorageConsumingOperation, FeeConsumingOperation {
     private readonly params;