@taquito/taquito 19.2.1-beta.2 → 20.0.0-beta.1

package/dist/lib/wallet/wallet.js

@@ -21,9 +21,7 @@ class WalletOperationBatch {
         this.operations = [];
     }
     /**
-     *
      * @description Add a transaction operation to the batch
-     *
      * @param params Transfer operation parameter
      */
     withTransfer(params) {
@@ -35,9 +33,7 @@ class WalletOperationBatch {
         return this;
     }
     /**
-     *
      * @description Add a contract call to the batch
-     *
      * @param params Call a contract method
      * @param options Generic operation parameters
      */
@@ -45,9 +41,7 @@ class WalletOperationBatch {
         return this.withTransfer(params.toTransferParams(options));
     }
     /**
-     *
      * @description Add a delegation operation to the batch
-     *
      * @param params Delegation operation parameter
      */
     withDelegation(params) {
@@ -60,9 +54,7 @@ class WalletOperationBatch {
         return this;
     }
     /**
-     *
      * @description Add an origination operation to the batch
-     *
      * @param params Origination operation parameter
      */
     withOrigination(params) {
@@ -70,9 +62,7 @@ class WalletOperationBatch {
         return this;
     }
     /**
-     *
      * @description Add an IncreasePaidStorage operation to the batch
-     *
      * @param param IncreasePaidStorage operation parameter
      */
     withIncreasePaidStorage(params) {
@@ -102,9 +92,7 @@ class WalletOperationBatch {
         });
     }
     /**
-     *
      * @description Add a group operation to the batch. Operation will be applied in the order they are in the params array
-     *
      * @param params Operations parameter
      * @throws {@link InvalidOperationKindError}
      */
@@ -130,9 +118,7 @@ class WalletOperationBatch {
         return this;
     }
     /**
-     *
      * @description Submit batch operation to wallet
-     *
      */
     send() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -160,7 +146,6 @@ class Wallet {
     }
     /**
      * @description Retrieve the PKH of the account that is currently in use by the wallet
-     *
      * @param option Option to use while fetching the PKH.
      * If forceRefetch is specified the wallet provider implementation will refetch the PKH from the wallet
      */
@@ -174,7 +159,6 @@ class Wallet {
     }
     /**
      * @description Retrieve the PK of the account that is currently in use by the wallet
-     *
      * @param option Option to use while fetching the PK.
      * If forceRefetch is specified the wallet provider implementation will refetch the PK from the wallet
      */
@@ -187,11 +171,8 @@ class Wallet {
         });
     }
     /**
-     *
      * @description Originate a new contract according to the script in parameters.
-     *
-     * @returns An operation handle with the result from the rpc node
-     *
+     * @returns a OriginationWalletOperation promise object when followed by .send()
      * @param originateParams Originate operation parameter
      */
     originate(params) {
@@ -202,11 +183,8 @@ class Wallet {
         }));
     }
     /**
-     *
      * @description Set the delegate for a contract.
-     *
-     * @returns An operation handle with the result from the rpc node
-     *
+     * @returns a WalletDelegateParams promise object when followed by .send()
      * @param delegateParams operation parameter
      */
     setDelegate(params) {
@@ -222,11 +200,8 @@ class Wallet {
         }));
     }
     /**
-     *
      * @description failing_noop operation that is guaranteed to fail. DISCLAIMER: Not all wallets support signing failing_noop operations.
-     *
      * @returns Signature for a failing_noop
-     *
      * @param params operation parameter
      */
     signFailingNoop(params) {
@@ -257,11 +232,8 @@ class Wallet {
         });
     }
     /**
-     *
      * @description Register the current address as delegate.
-     *
-     * @returns An operation handle with the result from the rpc node
-     *
+     * @returns a DelegationWalletOperation promise object when followed by .send()
      */
     registerDelegate() {
         return this.walletCommand(() => __awaiter(this, void 0, void 0, function* () {
@@ -274,11 +246,8 @@ class Wallet {
         }));
     }
     /**
-     *
      * @description Transfer tezos tokens from current address to a specific address or call a smart contract.
-     *
-     * @returns A wallet command from which we can send the operation to the wallet
-     *
+     * @returns a TransactionWalletOperation promise object when followed by .send()
      * @param params operation parameter
      */
     transfer(params) {
@@ -293,12 +262,83 @@ class Wallet {
         }));
     }
     /**
-     *
-     * @description
-     *
-     * @returns
-     *
-     * @param params
+     * @description Stake a given amount for the source address
+     * @returns a TransactionWalletOperation promise object when followed by .send()
+     * @param Stake pseudo-operation parameter
+     */
+    stake(params) {
+        return this.walletCommand(() => __awaiter(this, void 0, void 0, function* () {
+            const mappedParams = yield this.walletProvider.mapStakeParamsToWalletParams(() => __awaiter(this, void 0, void 0, function* () {
+                const source = yield this.pkh();
+                if (!params.to) {
+                    params.to = source;
+                }
+                if (params.to !== source) {
+                    throw new core_1.InvalidStakingAddressError(params.to);
+                }
+                params.parameter = { entrypoint: 'stake', value: { prim: 'Unit' } };
+                return params;
+            }));
+            const opHash = yield this.walletProvider.sendOperations([mappedParams]);
+            return this.context.operationFactory.createTransactionOperation(opHash);
+        }));
+    }
+    /**
+     * @description Unstake the given amount. If "everything" is given as amount, unstakes everything from the staking balance.
+     * Unstaked tez remains frozen for a set amount of cycles (the slashing period) after the operation. Once this period is over,
+     * the operation "finalize unstake" must be called for the funds to appear in the liquid balance.
+     * @returns a TransactionWalletOperation promise object when followed by .send()
+     * @param Unstake pseudo-operation parameter
+     */
+    unstake(params) {
+        return this.walletCommand(() => __awaiter(this, void 0, void 0, function* () {
+            const mappedParams = yield this.walletProvider.mapUnstakeParamsToWalletParams(() => __awaiter(this, void 0, void 0, function* () {
+                const source = yield this.pkh();
+                if (!params.to) {
+                    params.to = source;
+                }
+                if (params.to !== source) {
+                    throw new core_1.InvalidStakingAddressError(params.to);
+                }
+                params.parameter = { entrypoint: 'unstake', value: { prim: 'Unit' } };
+                return params;
+            }));
+            const opHash = yield this.walletProvider.sendOperations([mappedParams]);
+            return yield this.context.operationFactory.createTransactionOperation(opHash);
+        }));
+    }
+    /**
+     * @description Transfer all the finalizable unstaked funds of the source to their liquid balance
+     * @returns a TransactionWalletOperation promise object when followed by .send()
+     * @param Finalize_unstake pseudo-operation parameter
+     */
+    finalizeUnstake(params) {
+        return this.walletCommand(() => __awaiter(this, void 0, void 0, function* () {
+            const mappedParams = yield this.walletProvider.mapFinalizeUnstakeParamsToWalletParams(() => __awaiter(this, void 0, void 0, function* () {
+                const source = yield this.pkh();
+                if (!params.to) {
+                    params.to = source;
+                }
+                if (params.to !== source) {
+                    throw new core_1.InvalidStakingAddressError(params.to);
+                }
+                if (!params.amount) {
+                    params.amount = 0;
+                }
+                if (params.amount !== 0) {
+                    throw new core_1.InvalidFinalizeUnstakeAmountError('Amount must be 0 to finalize unstake.');
+                }
+                params.parameter = { entrypoint: 'finalize_unstake', value: { prim: 'Unit' } };
+                return params;
+            }));
+            const opHash = yield this.walletProvider.sendOperations([mappedParams]);
+            return yield this.context.operationFactory.createTransactionOperation(opHash);
+        }));
+    }
+    /**
+     * @description Increase the paid storage of a smart contract.
+     * @returns a IncreasePaidStorageWalletOperation promise object when followed by .send()
+     * @param params operation parameter
      */
     increasePaidStorage(params) {
         const destinationValidation = (0, utils_1.validateAddress)(params.destination);
@@ -312,11 +352,8 @@ class Wallet {
         }));
     }
     /**
-     *
      * @description Create a batch of operation
-     *
      * @returns A batch object from which we can add more operation or send a command to the wallet to execute the batch
-     *
      * @param params List of operation to initialize the batch with
      */
     batch(params) {
@@ -327,10 +364,8 @@ class Wallet {
         return batch;
     }
     /**
-     *
      * @description Create an smart contract abstraction for the address specified. Calling entrypoints with the returned
      * smart contract abstraction will leverage the wallet provider to make smart contract calls
-     *
      * @param address Smart contract address
      * @throws {@link InvalidContractAddressError} If the contract address is not valid
      */