@taquito/taquito 24.2.0 → 24.3.0-beta.0

package/dist/types/read-provider/rpc-read-adapter.d.ts

@@ -2,39 +2,39 @@ import { BlockResponse, EntrypointsResponse, MichelsonV1Expression, RpcClientInt
 import BigNumber from 'bignumber.js';
 import { BigMapQuery, BlockIdentifier, SaplingStateQuery, TzReadProvider } from './interface';
 /**
- * @description Converts calls from TzReadProvider into calls to the wrapped RpcClient in a format it can understand.
+ * Converts calls from TzReadProvider into calls to the wrapped RpcClient in a format it can understand.
  */
 export declare class RpcReadAdapter implements TzReadProvider {
     private rpc;
     constructor(rpc: RpcClientInterface);
     /**
-     * @description The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'spendable' RPC.
+     * The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'spendable' RPC.
      * @param address address from which we want to retrieve the spendable balance
      * @param block from which we want to retrieve the balance
      * @returns the balance in mutez
      */
     getBalance(address: string, block: BlockIdentifier): Promise<BigNumber>;
     /**
-     * @description The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'balance' RPC.
+     * The spendable balance of a contract (in mutez), also known as liquid balance. Corresponds to tez owned by the contract that are neither staked, nor in unstaked requests, nor in frozen bonds. Identical to the 'balance' RPC.
      * @param address address from which we want to retrieve the spendable balance
      * @param block from which we want to retrieve the balance
      * @returns the balance in mutez
      */
     getSpendable(address: string, block: BlockIdentifier): Promise<BigNumber>;
     /**
-     * @description Access the delegate of a contract, if any.
+     * Access the delegate of a contract, if any.
      * @param address contract address from which we want to retrieve the delegate (baker)
      * @param block from which we want to retrieve the delegate
      * @returns the public key hash of the delegate or null if no delegate
      */
     getDelegate(address: string, block: BlockIdentifier): Promise<string | null>;
     /**
-     * @description Access the next protocol hash
+     * Access the next protocol hash
      * @param block from which we want to retrieve the next protocol hash
      */
     getNextProtocol(block: BlockIdentifier): Promise<string>;
     /**
-     * @description Access protocol constants used in Taquito
+     * Access protocol constants used in Taquito
      * @param block from which we want to retrieve the constants
      */
     getProtocolConstants(block: BlockIdentifier): Promise<{
@@ -47,83 +47,83 @@ export declare class RpcReadAdapter implements TzReadProvider {
         smart_rollup_origination_size: number;
     }>;
     /**
-     * @description Access the script (code and storage) of a smart contract
+     * Access the script (code and storage) of a smart contract
      * @param contract contract address from which we want to retrieve the script
      * @param block from which we want to retrieve the storage value
      * @returns Note: The code must be in the JSON format and not contain global constant
      */
     getScript(contract: string, block: BlockIdentifier): Promise<ScriptedContracts>;
     /**
-     * @description Access the storage value of a contract
+     * Access the storage value of a contract
      * @param contract contract address from which we want to retrieve the storage
      * @param block from which we want to retrieve the storage value
      */
     getStorage(contract: string, block: BlockIdentifier): Promise<MichelsonV1Expression>;
     /**
-     * @description Access the block hash
+     * Access the block hash
      */
     getBlockHash(block: BlockIdentifier): Promise<string>;
     /**
-     * @description Access the block level
+     * Access the block level
      */
     getBlockLevel(block: BlockIdentifier): Promise<number>;
     /**
-     * @description Access the counter of an address
+     * Access the counter of an address
      * @param pkh from which we want to retrieve the counter
      * @param block from which we want to retrieve the counter
      */
     getCounter(pkh: string, block: BlockIdentifier): Promise<string>;
     /**
-     * @description Access the timestamp of a block
+     * Access the timestamp of a block
      * @param block from which we want to retrieve the timestamp
      * @returns date ISO format zero UTC offset ("2022-01-19T22:37:07Z")
      */
     getBlockTimestamp(block: BlockIdentifier): Promise<string>;
     /**
-     * @description Access the value associated with a key in a big map.
+     * Access the value associated with a key in a big map.
      * @param bigMapQuery Big Map ID and Expression hash to query (A b58check encoded Blake2b hash of the expression)
      * @param block from which we want to retrieve the big map value
      */
     getBigMapValue(bigMapQuery: BigMapQuery, block: BlockIdentifier): Promise<MichelsonV1Expression>;
     /**
-     * @description Access the value associated with a sapling state ID.
-     * @param id Sapling state ID
+     * Access the value associated with a sapling state ID.
+     * @param saplingStateQuery Sapling state ID query
      * @param block from which we want to retrieve the sapling state
      */
     getSaplingDiffById(saplingStateQuery: SaplingStateQuery, block: BlockIdentifier): Promise<SaplingDiffResponse>;
     /**
-     * @description Access the sapling state of a smart contract.
+     * Access the sapling state of a smart contract.
      * @param contractAddress The address of the smart contract
      * @param block The block you want to retrieve the sapling state from
      */
     getSaplingDiffByContract(contractAddress: string, block: BlockIdentifier): Promise<SaplingDiffResponse>;
     /**
-     * @description Return the list of entrypoints of the contract
+     * Return the list of entrypoints of the contract
      * @param contract address of the contract we want to get the entrypoints of
      */
     getEntrypoints(contract: string): Promise<EntrypointsResponse>;
     /**
-     * @description Access the chain id
+     * Access the chain id
      */
     getChainId(): Promise<string>;
     /**
-     * @description Indicate if an account is revealed
+     * Indicate if an account is revealed
      * @param publicKeyHash of the account
      * @param block from which we want to know if the account is revealed
      */
     isAccountRevealed(publicKeyHash: string, block: BlockIdentifier): Promise<boolean>;
     /**
-     * @description Return all the information about a block
+     * Return all the information about a block
      * @param block from which we want to retrieve the information
      */
     getBlock(block: BlockIdentifier): Promise<BlockResponse>;
     /**
-     * @description Return a list of the ancestors of the given block which, if referred to as the branch in an operation header, are recent enough for that operation to be included in the current block.
+     * Return a list of the ancestors of the given block which, if referred to as the branch in an operation header, are recent enough for that operation to be included in the current block.
      * @param block from which we want to retrieve the information
      */
     getLiveBlocks(block: BlockIdentifier): Promise<string[]>;
     /**
-     * @description Returns the cycle at which the launch of the Adaptive Issuance feature is set to happen. A result of null means that the feature is not yet set to launch.
+     * Returns the cycle at which the launch of the Adaptive Issuance feature is set to happen. A result of null means that the feature is not yet set to launch.
      * @param block from which we want to retrieve the information
      */
     getAdaptiveIssuanceLaunchCycle(block: BlockIdentifier): Promise<AILaunchCycleResponse>;

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

@@ -1,7 +1,7 @@
 import { TezosToolkitConfigError } from '@taquito/core';
 /**
  *  @category Error
- *  @description Error that indicates no signer has been configured in the TezosToolkit instance
+ *  Error that indicates no signer has been configured in the TezosToolkit instance
  */
 export declare class UnconfiguredSignerError extends TezosToolkitConfigError {
     constructor();

package/dist/types/signer/noop.d.ts

@@ -1,6 +1,6 @@
 import { Signer } from '@taquito/core';
 /**
- * @description Default signer implementation which does nothing and produce invalid signature
+ * Default signer implementation which does nothing and produce invalid signature
  * @throw {@link UnconfiguredSignerError}
  */
 export declare class NoopSigner implements Signer {

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

@@ -2,7 +2,7 @@ import { ParameterValidationError } from '@taquito/core';
 import { FilterExpression } from '../taquito';
 /**
  *  @category Error
- *  @description Error that indicates an unsupported event being passed or used
+ *  Error that indicates an unsupported event being passed or used
  */
 export declare class UnsupportedEventError extends ParameterValidationError {
     readonly type: string;
@@ -10,7 +10,7 @@ export declare class UnsupportedEventError extends ParameterValidationError {
 }
 /**
  *  @category Error
- *  @description Error that indicates an invalid filter expression being passed or used
+ *  Error that indicates an invalid filter expression being passed or used
  */
 export declare class InvalidFilterExpressionError extends ParameterValidationError {
     readonly invalidExpression: FilterExpression;

package/dist/types/taquito.d.ts

@@ -77,7 +77,7 @@ export interface VersionInfo {
     version: string;
 }
 /**
- * @description Facade class that surfaces all of the libraries capability and allow it's configuration
+ * Facade class that surfaces all of the libraries capability and allow it's configuration
  *
  * @param _rpc The RPC server to use
  */
@@ -90,7 +90,7 @@ export declare class TezosToolkit {
     readonly format: typeof format;
     constructor(_rpc: RpcClientInterface | string);
     /**
-     * @description Sets configuration on the Tezos Taquito instance. Allows user to choose which signer, rpc client, rpc url, forger and so forth
+     * Sets configuration on the Tezos Taquito instance. Allows user to choose which signer, rpc client, rpc url, forger and so forth
      *
      * @param options rpc url or rpcClient to use to interact with the Tezos network
      *
@@ -100,64 +100,64 @@ export declare class TezosToolkit {
      */
     setProvider({ rpc, stream, signer, protocol, config, forger, wallet, packer, globalConstantsProvider, readProvider, parserProvider, injectorProvider, }: SetProviderOptions): void;
     /**
-     * @description Sets signer provider on the Tezos Taquito instance.
+     * Sets signer provider on the Tezos Taquito instance.
      *
-     * @param options signer to use to interact with the Tezos network
+     * @param signer signer to use to interact with the Tezos network
      *
      * @example Tezos.setSignerProvider(new InMemorySigner.fromSecretKey('edsk...'))
      *
      */
     setSignerProvider(signer?: SetProviderOptions['signer']): void;
     /**
-     * @description Sets rpc provider on the Tezos Taquito instance
+     * Sets rpc provider on the Tezos Taquito instance
      *
-     * @param options rpc url or rpcClient to use to interact with the Tezos network
+     * @param rpc rpc url or rpcClient to use to interact with the Tezos network
      *
      * @example Tezos.setRpcProvider('https://mainnet.tezos.ecadinfra.com/')
      *
      */
     setRpcProvider(rpc?: SetProviderOptions['rpc']): void;
     /**
-     * @description Sets forger provider on the Tezos Taquito instance
+     * Sets forger provider on the Tezos Taquito instance
      * The `LocalForger` from `@taquito/local-forging` is set by default.
      *
-     * @param options forger to use to interact with the Tezos network
+     * @param forger forger to use to interact with the Tezos network
      *
      * @example Tezos.setForgerProvider(this.getFactory(RpcForger)())
      *
      */
     setForgerProvider(forger?: SetProviderOptions['forger']): void;
     /**
-     * @description Sets stream provider on the Tezos Taquito instance
+     * Sets stream provider on the Tezos Taquito instance
      *
-     * @param options stream to use to interact with the Tezos network
+     * @param stream stream to use to interact with the Tezos network
      *
      * @example Tezos.setStreamProvider(...)
      *
      */
     setStreamProvider(stream?: SetProviderOptions['stream']): void;
     /**
-     * @description Sets wallet provider on the Tezos Taquito instance
+     * Sets wallet provider on the Tezos Taquito instance
      *
-     * @param options wallet to use to interact with the Tezos network
+     * @param wallet wallet to use to interact with the Tezos network
      *
      * @example Tezos.setWalletProvider(...)
      *
      */
     setWalletProvider(wallet?: SetProviderOptions['wallet']): void;
     /**
-     * @description Sets Packer provider on the Tezos Taquito instance
+     * Sets Packer provider on the Tezos Taquito instance
      *
-     * @param options packer to use to interact with the Tezos network
+     * @param packer packer to use to interact with the Tezos network
      *
      * @example Tezos.setPackerProvider(new MichelCodecPacker())
      *
      */
     setPackerProvider(packer?: SetProviderOptions['packer']): void;
     /**
-     * @description Sets global constants provider on the Tezos Taquito instance
+     * Sets global constants provider on the Tezos Taquito instance
      *
-     * @param options globalConstantsProvider to use to interact with the Tezos network
+     * @param globalConstantsProvider globalConstantsProvider to use to interact with the Tezos network
      *
      * @example
      * ```
@@ -172,68 +172,68 @@ export declare class TezosToolkit {
      */
     setGlobalConstantsProvider(globalConstantsProvider?: SetProviderOptions['globalConstantsProvider']): void;
     /**
-     * @description Sets read provider on the Tezos Taquito instance
+     * Sets read provider on the Tezos Taquito instance
      * By default reads are done from the RPC usign the RpcReadAdapter class, this can be overridden to read from an indexer that implements the TzReadProvider interface
      *
-     * @param options TzReadProvider to use to interact with the Tezos network
+     * @param readProvider TzReadProvider to use to interact with the Tezos network
      *
      */
     setReadProvider(readProvider?: SetProviderOptions['readProvider']): void;
     /**
-     * @description Sets parser provider on the Tezos Taquito instance
+     * Sets parser provider on the Tezos Taquito instance
      *
-     * @param options parserProvider to use to interact with the Tezos network
+     * @param parserProvider parserProvider to use to interact with the Tezos network
      *
      */
     setParserProvider(parserProvider?: SetProviderOptions['parserProvider']): void;
     /**
-     * @description Sets injector provider on the Tezos Taquito instance
+     * Sets injector provider on the Tezos Taquito instance
      *
-     * @param options Injector to use to interact with the Tezos network by default RpcInjector
+     * @param injectorProvider Injector to use to interact with the Tezos network by default RpcInjector
      *
      */
     setInjectorProvider(injectorProvider?: SetProviderOptions['injectorProvider']): void;
     /**
-     * @description Sets the strategy used for field numbering in Token execute/encode/decode to convert Michelson values to/from javascript objects
+     * Sets the strategy used for field numbering in Token execute/encode/decode to convert Michelson values to/from javascript objects
      * @param strategy a value of type FieldNumberingStrategy that controls how field numbers are calculated
      */
     setFieldNumberingStrategy(strategy: FieldNumberingStrategy): void;
     /**
-     * @description Provide access to tezos account management
+     * Provide access to tezos account management
      */
     get tz(): TzProvider;
     /**
-     * @description Provide access to smart contract utilities
+     * Provide access to smart contract utilities
      */
     get contract(): ContractProvider;
     /**
-     * @description Provide access to tezos operation preparation utilities
+     * Provide access to tezos operation preparation utilities
      */
     get prepare(): PreparationProvider;
     get wallet(): Wallet;
     get operation(): OperationFactory;
     /**
-     * @description Provide access to operation estimation utilities
+     * Provide access to operation estimation utilities
      */
     get estimate(): EstimationProvider;
     /**
-     * @description Provide access to streaming utilities backed by an streamer implementation
+     * Provide access to streaming utilities backed by an streamer implementation
      */
     get stream(): SubscribeProvider;
     /**
-     * @description Provide access to the currently used rpc client
+     * Provide access to the currently used rpc client
      */
     get rpc(): RpcClientInterface;
     /**
-     * @description Provide access to the currently used signer
+     * Provide access to the currently used signer
      */
     get signer(): Signer;
     /**
-     * @description Provide access to the currently used globalConstantsProvider
+     * Provide access to the currently used globalConstantsProvider
      */
     get globalConstants(): GlobalConstantsProvider;
     /**
-     * @description Allow to add a module to the TezosToolkit instance. This method adds the appropriate Providers(s) required by the module to the internal context.
+     * Allow to add a module to the TezosToolkit instance. This method adds the appropriate Providers(s) required by the module to the internal context.
      *
      * @param module extension to add to the TezosToolkit instance
      *
@@ -242,7 +242,7 @@ export declare class TezosToolkit {
     addExtension(module: Extension | Extension[]): void;
     getFactory<T, K extends Array<any>>(ctor: TaquitoProvider<T, K>): (...args: K) => T;
     /**
-     * @description Gets an object containing the version of Taquito library and git sha of the commit this library is compiled from
+     * Gets an object containing the version of Taquito library and git sha of the commit this library is compiled from
      */
     getVersionInfo(): VersionInfo;
 }

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

@@ -1,16 +1,24 @@
 import { TezosToolkitConfigError, NetworkError } from '@taquito/core';
 /**
  *  @category Error
- *  @description Error that indicates undefined confirmation has not been specified or configured
+ *  Error that indicates undefined confirmation has not been specified or configured
  */
 export declare class ConfirmationUndefinedError extends TezosToolkitConfigError {
     constructor();
 }
 /**
  *  @category Error
- *  @description Error that indicates a generic failure when trying to fetch an observable
+ *  Error that indicates a generic failure when trying to fetch an observable
  */
 export declare class ObservableError extends NetworkError {
     readonly message: string;
     constructor(message: string);
 }
+/**
+ *  @category Error
+ *  Error that indicates a newly originated wallet contract could not be resolved
+ */
+export declare class OriginationWalletOperationError extends ObservableError {
+    readonly message: string;
+    constructor(message: string);
+}

package/dist/types/wallet/interface.d.ts

@@ -12,55 +12,55 @@ export type WalletTransferTicketParams = Omit<TransferTicketParams, WalletDefine
 export type WalletRegisterGlobalConstantParams = Omit<RegisterGlobalConstantParams, WalletDefinedFields>;
 export interface WalletProvider {
     /**
-     * @description Request the public key hash from the wallet
+     * Request the public key hash from the wallet
      */
     getPKH: () => Promise<string>;
     /**
-     * @description Request the public key from the wallet
+     * Request the public key from the wallet
      */
     getPK: () => Promise<string>;
     /**
-     * @description Transform WalletTransferParams into a format compliant with the underlying wallet
+     * Transform WalletTransferParams into a format compliant with the underlying wallet
      */
     mapTransferParamsToWalletParams: (params: () => Promise<WalletTransferParams>) => Promise<any>;
     /**
-     * @description Transform WalletTransferTicketParams into a format compliant with the underlying wallet
+     * Transform WalletTransferTicketParams into a format compliant with the underlying wallet
      */
     mapTransferTicketParamsToWalletParams: (params: () => Promise<WalletTransferTicketParams>) => Promise<any>;
     /**
-     * @description Transform WalletRegisterGlobalConstantParams into a format compliant with the underlying wallet
+     * Transform WalletRegisterGlobalConstantParams into a format compliant with the underlying wallet
      */
     mapRegisterGlobalConstantParamsToWalletParams: (params: () => Promise<WalletRegisterGlobalConstantParams>) => Promise<any>;
     /**
-     * @description Transform WalletStakeParams into a format compliant with the underlying wallet
+     * Transform WalletStakeParams into a format compliant with the underlying wallet
      */
     mapStakeParamsToWalletParams: (params: () => Promise<WalletStakeParams>) => Promise<any>;
     /**
-     * @description Transform WalletUnstakeParams into a format compliant with the underlying wallet
+     * Transform WalletUnstakeParams into a format compliant with the underlying wallet
      */
     mapUnstakeParamsToWalletParams: (params: () => Promise<WalletUnstakeParams>) => Promise<any>;
     /**
-     * @description Transform WalletFinalizeUnstakeParams into a format compliant with the underlying wallet
+     * Transform WalletFinalizeUnstakeParams into a format compliant with the underlying wallet
      */
     mapFinalizeUnstakeParamsToWalletParams: (params: () => Promise<WalletFinalizeUnstakeParams>) => Promise<any>;
     /**
-     * @description Transform WalletOriginateParams into a format compliant with the underlying wallet
+     * Transform WalletOriginateParams into a format compliant with the underlying wallet
      */
     mapOriginateParamsToWalletParams: (params: () => Promise<WalletOriginateParams>) => Promise<any>;
     /**
-     * @description Transform WalletDelegateParams into a format compliant with the underlying wallet
+     * Transform WalletDelegateParams into a format compliant with the underlying wallet
      */
     mapDelegateParamsToWalletParams: (params: () => Promise<WalletDelegateParams>) => Promise<any>;
     /**
-     * @description Transform WalletIncreasePaidStorageParams into a format compliant with the underlying wallet
+     * Transform WalletIncreasePaidStorageParams into a format compliant with the underlying wallet
      */
     mapIncreasePaidStorageWalletParams: (params: () => Promise<WalletIncreasePaidStorageParams>) => Promise<any>;
     /**
-     * @description Request the wallet to send an operation batch
+     * Request the wallet to send an operation batch
      */
     sendOperations: (params: any[]) => Promise<string>;
     /**
-     * @description Request the wallet to sign a payload
+     * Request the wallet to sign a payload
      */
     sign(bytes: string, watermark?: Uint8Array): Promise<string>;
 }

package/dist/types/wallet/operation.d.ts

@@ -5,7 +5,7 @@ import { Receipt } from './receipt';
 import { BlockIdentifier } from '../read-provider/interface';
 export type OperationStatus = 'pending' | 'unknown' | OperationResultStatusEnum;
 /**
- * @description WalletOperation allows to monitor operation inclusion on chains and surface information related to the operation
+ * WalletOperation allows to monitor operation inclusion on chains and surface information related to the operation
  */
 export declare class WalletOperation {
     readonly opHash: string;
@@ -18,15 +18,16 @@ export declare class WalletOperation {
     protected newHead$: Observable<BlockResponse>;
     private confirmed$;
     operationResults(): Promise<OperationContentsAndResult[] | undefined>;
+    protected getInclusionBlock(): Promise<BlockResponse>;
+    private getOperationResultsIfIncluded;
     /**
-     * @description Receipt expose the total amount of tezos token burn and spent on fees
+     * Receipt expose the total amount of tezos token burn and spent on fees
      * The promise returned by receipt will resolve only once the transaction is included
      */
     receipt(): Promise<Receipt>;
     /**
      *
      * @param opHash Operation hash
-     * @param raw Raw operation that was injected
      * @param context Taquito context allowing access to rpc and signer
      * @throws {InvalidOperationHashError}
      */