@taquito/sapling 14.0.0-beta-RC.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 ECAD Labs Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+# Taquito Sapling package
+
+_Documentation can be found [here](https://tezostaquito.io/docs/next/sapling)_  
+_TypeDoc style documentation is available on-line [here](https://tezostaquito.io/typedoc/modules/_taquito_sapling.html)_
+
+## General Information
+
+Sapling is a protocol allowing to perform private transactions in a decentralized environment. This package allows to read from a sapling state (retrieve the balance and transaction history) and prepare sapling transactions.
+
+## Install
+
+Install the package as follows
+
+```
+npm install @taquito/sapling
+```
+## Usage
+
+**Retrieve a balance in the Sapling shielded pool**
+
+The returned balance is in mutez.
+
+```ts
+import { TezosToolkit, RpcReadAdapter } from '@taquito/taquito';
+import { SaplingToolkit, InMemorySpendingKey } from '@taquito/sapling';
+
+const tezos = new TezosToolkit('https://jakartanet.ecadinfra.com/');
+
+const saplingContract = await tezos.contract.at('KT1UYwMR6Q6LZnwQEi77DSBrAjKT1tEJb245');
+
+const inMemorySpendingKey = await InMemorySpendingKey.fromMnemonic('YOUR_MNEMONIC');
+
+const readProvider = new RpcReadAdapter(tezos.rpc);
+
+const saplingToolkit = new SaplingToolkit(
+    { saplingSigner: inMemorySpendingKey }, 
+    { contractAddress: saplingContract.address, memoSize: 8 }, 
+    readProvider
+)
+
+const txViewer = await saplingToolkit.getSaplingTransactionViewer();
+const initialBalance = await txViewer.getBalance();
+```
+
+**Prepare a shielded transaction**
+
+A shielded transaction allows sending tokens from a Tezos account (tz1, tz2, tz3) to a Sapling address (zet).
+
+```ts
+import { TezosToolkit, RpcReadAdapter } from '@taquito/taquito';
+import { SaplingToolkit, InMemorySpendingKey } from '@taquito/sapling';
+
+const tezos = new TezosToolkit('https://jakartanet.ecadinfra.com/');
+// set up your signer on the TezosToolkit as usual
+const saplingContract = await tezos.contract.at('KT1UYwMR6Q6LZnwQEi77DSBrAjKT1tEJb245');
+
+const inMemorySpendingKey = await InMemorySpendingKey.fromMnemonic('YOUR_MNEMONIC');
+
+const readProvider = new RpcReadAdapter(tezos.rpc);
+
+const saplingToolkit = new SaplingToolkit(
+    { saplingSigner: inMemorySpendingKey }, 
+    { contractAddress: saplingContract.address, memoSize: 8 }, 
+    readProvider
+)
+
+// Fetch a payment address (zet)
+const inMemoryViewingKey = await inMemorySpendingKey.getSaplingViewingKeyProvider();
+const paymentAddress = (await inMemoryViewingKey.getAddress()).address;
+
+// prepare the shielded transaction
+const shieldedTx = await saplingToolkit.prepareShieldedTransaction([{
+    to: paymentAddress,
+    amount: 3,
+    memo: 'test',
+    mutez: false // set to false by default
+}])
+
+// Inject the sapling transaction using the ContractAbstraction
+// The amount MUST be specified in the send method to transfer the 3 tez to the shielded pool
+const op = await saplingContract.methods.default([shieldedTx]).send({ amount: 3 });
+await op.confirmation();
+```
+
+Refer to the website documentation for further examples and information: https://tezostaquito.io/docs/next/sapling
+
+## Additional info
+
+See the top-level project [https://github.com/ecadlabs/taquito](https://github.com/ecadlabs/taquito) for details on reporting issues, contributing and versioning.
+
+## Disclaimer
+
+THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/lib/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_BOUND_DATA = exports.DEFAULT_MEMO = exports.OCK_KEY = exports.KDF_KEY = void 0;
+exports.KDF_KEY = 'KDFSaplingForTezosV1';
+exports.OCK_KEY = 'OCK_keystringderivation_TEZOS';
+exports.DEFAULT_MEMO = '';
+exports.DEFAULT_BOUND_DATA = Buffer.from('', 'hex');
+//# sourceMappingURL=constants.js.map

package/dist/lib/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,sBAAsB,CAAC;AACjC,QAAA,OAAO,GAAG,+BAA+B,CAAC;AAC1C,QAAA,YAAY,GAAG,EAAE,CAAC;AAClB,QAAA,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC"}

package/dist/lib/error.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidParameter = exports.InsufficientBalance = exports.InvalidMemo = exports.TreeConstructionFailure = exports.InvalidMerkleRootError = exports.InvalidSpendingKey = void 0;
+/**
+ *  @category Error
+ *  @description Error indicating that the spending key is invalid
+ */
+class InvalidSpendingKey extends Error {
+    constructor(sk, reason = 'The spending key is invalid') {
+        super(`${reason}: ${sk}`);
+        this.name = 'InvalidSpendingKey';
+    }
+}
+exports.InvalidSpendingKey = InvalidSpendingKey;
+/**
+ *  @category Error
+ *  @description Error that indicates an invalid Merkle root being passed
+ */
+class InvalidMerkleRootError extends Error {
+    constructor(root) {
+        super(`The following Merkle tree is invalid: ${JSON.stringify(root)}`);
+        this.root = root;
+        this.name = 'InvalidMerkleRootError';
+    }
+}
+exports.InvalidMerkleRootError = InvalidMerkleRootError;
+/**
+ *  @category Error
+ *  @description Error that indicates a failure when trying to construct the Merkle tree
+ */
+class TreeConstructionFailure extends Error {
+    constructor(message) {
+        super(message);
+        this.message = message;
+        this.name = 'TreeConstructionFailure';
+    }
+}
+exports.TreeConstructionFailure = TreeConstructionFailure;
+/**
+ *  @category Error
+ *  @description Error indicating that the memo is invalid
+ */
+class InvalidMemo extends Error {
+    constructor(memo, errorDetail) {
+        super(`The memo '${memo}' is invalid. ${errorDetail}`);
+        this.name = 'InvalidMemo';
+    }
+}
+exports.InvalidMemo = InvalidMemo;
+/**
+ *  @category Error
+ *  @description Error indicating that there is not enough balance to prepare the sapling transaction
+ */
+class InsufficientBalance extends Error {
+    constructor(realBalance, amountToSpend) {
+        super(`Unable to spend ${amountToSpend} mutez while the balance is only ${realBalance} mutez.`);
+        this.name = 'InsufficientBalance';
+    }
+}
+exports.InsufficientBalance = InsufficientBalance;
+/**
+ *  @category Error
+ *  @description Error indicating that a parameter is invalid
+ */
+class InvalidParameter extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'InvalidParameter';
+    }
+}
+exports.InvalidParameter = InvalidParameter;
+//# sourceMappingURL=error.js.map

package/dist/lib/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/error.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,MAAa,kBAAmB,SAAQ,KAAK;IAE3C,YAAY,EAAU,EAAE,MAAM,GAAG,6BAA6B;QAC5D,KAAK,CAAC,GAAG,MAAM,KAAK,EAAE,EAAE,CAAC,CAAC;QAFrB,SAAI,GAAG,oBAAoB,CAAC;IAGnC,CAAC;CACF;AALD,gDAKC;AAED;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,KAAK;IAE/C,YAAmB,IAAY;QAC7B,KAAK,CAAC,yCAAyC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QADtD,SAAI,GAAJ,IAAI,CAAQ;QADxB,SAAI,GAAG,wBAAwB,CAAC;IAGvC,CAAC;CACF;AALD,wDAKC;AAED;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,KAAK;IAEhD,YAAmB,OAAe;QAChC,KAAK,CAAC,OAAO,CAAC,CAAC;QADE,YAAO,GAAP,OAAO,CAAQ;QAD3B,SAAI,GAAG,yBAAyB,CAAC;IAGxC,CAAC;CACF;AALD,0DAKC;AAED;;;GAGG;AACH,MAAa,WAAY,SAAQ,KAAK;IAEpC,YAAY,IAAY,EAAE,WAAmB;QAC3C,KAAK,CAAC,aAAa,IAAI,iBAAiB,WAAW,EAAE,CAAC,CAAC;QAFlD,SAAI,GAAG,aAAa,CAAC;IAG5B,CAAC;CACF;AALD,kCAKC;AAED;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,KAAK;IAE5C,YAAY,WAAmB,EAAE,aAAqB;QACpD,KAAK,CAAC,mBAAmB,aAAa,oCAAoC,WAAW,SAAS,CAAC,CAAC;QAF3F,SAAI,GAAG,qBAAqB,CAAC;IAGpC,CAAC;CACF;AALD,kDAKC;AAED;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,KAAK;IAEzC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QAFV,SAAI,GAAG,kBAAkB,CAAC;IAGjC,CAAC;CACF;AALD,4CAKC"}

package/dist/lib/sapling-forger/sapling-forger.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaplingForger = void 0;
+const utils_1 = require("@taquito/utils");
+const bignumber_js_1 = require("bignumber.js");
+class SaplingForger {
+    /**
+     * @description Forge sapling transactions
+     * @param spendDescriptions the list of spend descriptions
+     * @param outputDescriptions the list of output descriptions
+     * @param signature signature hash
+     * @param balance balance of the Sapling contract (input/output difference)
+     * @param root root of the merkle tree
+     * @returns Forged sapling transaction of type Buffer
+     */
+    forgeSaplingTransaction(tx) {
+        const spendBuf = this.forgeSpendDescriptions(tx.inputs);
+        const spend = Buffer.concat([utils_1.toHexBuf(spendBuf.length, 32), spendBuf]);
+        const outputBuf = this.forgeOutputDescriptions(tx.outputs);
+        const output = Buffer.concat([utils_1.toHexBuf(outputBuf.length, 32), outputBuf]);
+        const root = Buffer.from(tx.root, 'hex');
+        return Buffer.concat([
+            spend,
+            output,
+            tx.signature,
+            utils_1.toHexBuf(tx.balance, 64),
+            root,
+            utils_1.toHexBuf(tx.boundData.length, 32),
+            tx.boundData,
+        ]);
+    }
+    /**
+     * @description Forge list of spend descriptions
+     * @param spendDescriptions list of spend descriptions
+     * @returns concatenated forged bytes of type Buffer
+     */
+    forgeSpendDescriptions(spendDescriptions) {
+        const descriptions = [];
+        for (const i of spendDescriptions) {
+            const buff = this.forgeSpendDescription(i);
+            descriptions.push(buff);
+        }
+        return Buffer.concat(descriptions);
+    }
+    forgeSpendDescription(desc) {
+        return Buffer.concat([
+            desc.commitmentValue,
+            desc.nullifier,
+            desc.publicKeyReRandomization,
+            desc.proof,
+            desc.signature,
+        ]);
+    }
+    /**
+     * @description Forge list of output descriptions
+     * @param outputDescriptions list of output descriptions
+     * @returns concatenated forged bytes of type Buffer
+     */
+    forgeOutputDescriptions(outputDescriptions) {
+        const descriptions = [];
+        for (const i of outputDescriptions) {
+            const buff = this.forgeOutputDescription(i);
+            descriptions.push(buff);
+        }
+        return Buffer.concat(descriptions);
+    }
+    forgeOutputDescription(desc) {
+        const ct = desc.ciphertext;
+        return Buffer.concat([
+            desc.commitment,
+            desc.proof,
+            ct.commitmentValue,
+            ct.ephemeralPublicKey,
+            utils_1.toHexBuf(ct.payloadEnc.length, 32),
+            ct.payloadEnc,
+            ct.nonceEnc,
+            ct.payloadOut,
+            ct.nonceOut,
+        ]);
+    }
+    forgeUnsignedTxInput(unsignedSpendDescription) {
+        return Buffer.concat([
+            unsignedSpendDescription.commitmentValue,
+            unsignedSpendDescription.nullifier,
+            unsignedSpendDescription.publicKeyReRandomization,
+            unsignedSpendDescription.proof,
+        ]);
+    }
+    forgeTransactionPlaintext(txPlainText) {
+        const encodedMemo = Buffer.from(utils_1.char2Bytes(txPlainText.memo).padEnd(txPlainText.memoSize, '0'), 'hex');
+        return Buffer.concat([
+            txPlainText.diversifier,
+            utils_1.toHexBuf(new bignumber_js_1.default(txPlainText.amount), 64),
+            txPlainText.randomCommitmentTrapdoor,
+            utils_1.toHexBuf(txPlainText.memoSize, 32),
+            encodedMemo,
+        ]);
+    }
+}
+exports.SaplingForger = SaplingForger;
+//# sourceMappingURL=sapling-forger.js.map

package/dist/lib/sapling-forger/sapling-forger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sapling-forger.js","sourceRoot":"","sources":["../../../src/sapling-forger/sapling-forger.ts"],"names":[],"mappings":";;;AAMA,0CAAsD;AACtD,+CAAqC;AAErC,MAAa,aAAa;IACxB;;;;;;;;OAQG;IACH,uBAAuB,CAAC,EAAsB;QAC5C,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;QACxD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,gBAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;QAEvE,MAAM,SAAS,GAAG,IAAI,CAAC,uBAAuB,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAC3D,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,gBAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;QAE1E,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAEzC,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,KAAK;YACL,MAAM;YACN,EAAE,CAAC,SAAS;YACZ,gBAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC;YACxB,IAAI;YACJ,gBAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;YACjC,EAAE,CAAC,SAAS;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,iBAA4C;QACjE,MAAM,YAAY,GAAG,EAAE,CAAC;QAExB,KAAK,MAAM,CAAC,IAAI,iBAAiB,EAAE;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAC3C,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACrC,CAAC;IAED,qBAAqB,CAAC,IAA6B;QACjD,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,IAAI,CAAC,eAAe;YACpB,IAAI,CAAC,SAAS;YACd,IAAI,CAAC,wBAAwB;YAC7B,IAAI,CAAC,KAAK;YACV,IAAI,CAAC,SAAS;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CAAC,kBAA8C;QACpE,MAAM,YAAY,GAAG,EAAE,CAAC;QAExB,KAAK,MAAM,CAAC,IAAI,kBAAkB,EAAE;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;YAC5C,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACrC,CAAC;IAED,sBAAsB,CAAC,IAA8B;QACnD,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;QAE3B,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,IAAI,CAAC,UAAU;YACf,IAAI,CAAC,KAAK;YACV,EAAE,CAAC,eAAe;YAClB,EAAE,CAAC,kBAAkB;YACrB,gBAAQ,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;YAClC,EAAE,CAAC,UAAU;YACb,EAAE,CAAC,QAAQ;YACX,EAAE,CAAC,UAAU;YACb,EAAE,CAAC,QAAQ;SACZ,CAAC,CAAC;IACL,CAAC;IAED,oBAAoB,CAAC,wBAAoE;QACvF,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,wBAAwB,CAAC,eAAe;YACxC,wBAAwB,CAAC,SAAS;YAClC,wBAAwB,CAAC,wBAAwB;YACjD,wBAAwB,CAAC,KAAK;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,yBAAyB,CAAC,WAAwC;QAChE,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAC7B,kBAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,EAC9D,KAAK,CACN,CAAC;QACF,OAAO,MAAM,CAAC,MAAM,CAAC;YACnB,WAAW,CAAC,WAAW;YACvB,gBAAQ,CAAC,IAAI,sBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YAC/C,WAAW,CAAC,wBAAwB;YACpC,gBAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;YAClC,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;CACF;AA9GD,sCA8GC"}

package/dist/lib/sapling-keys/helpers.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decryptKey = void 0;
+const error_1 = require("../error");
+const typedarray_to_buffer_1 = require("typedarray-to-buffer");
+const nacl_1 = require("@stablelib/nacl");
+const pbkdf2_1 = require("pbkdf2");
+const utils_1 = require("@taquito/utils");
+function decryptKey(spendingKey, password) {
+    const keyArr = utils_1.b58cdecode(spendingKey, utils_1.prefix[utils_1.Prefix.SASK]);
+    // exit first if no password and key is encrypted
+    if (!password && spendingKey.slice(0, 4) !== 'sask') {
+        throw new error_1.InvalidSpendingKey(spendingKey, 'no password Provided to decrypt');
+    }
+    if (password && spendingKey.slice(0, 4) !== 'sask') {
+        const salt = typedarray_to_buffer_1.default(keyArr.slice(0, 8));
+        const encryptedSk = typedarray_to_buffer_1.default(keyArr.slice(8));
+        const encryptionKey = pbkdf2_1.default.pbkdf2Sync(password, salt, 32768, 32, 'sha512');
+        const decrypted = nacl_1.openSecretBox(new Uint8Array(encryptionKey), new Uint8Array(24), new Uint8Array(encryptedSk));
+        if (!decrypted) {
+            throw new error_1.InvalidSpendingKey(spendingKey, 'Encrypted Spending Key or Password Incorrect');
+        }
+        return typedarray_to_buffer_1.default(decrypted);
+    }
+    else {
+        return typedarray_to_buffer_1.default(keyArr);
+    }
+}
+exports.decryptKey = decryptKey;
+//# sourceMappingURL=helpers.js.map

package/dist/lib/sapling-keys/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/sapling-keys/helpers.ts"],"names":[],"mappings":";;;AAAA,oCAA8C;AAC9C,+DAA4C;AAC5C,0CAAgD;AAChD,mCAA4B;AAC5B,0CAA4D;AAE5D,SAAgB,UAAU,CAAC,WAAmB,EAAE,QAAiB;IAC/D,MAAM,MAAM,GAAG,kBAAU,CAAC,WAAW,EAAE,cAAM,CAAC,cAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5D,iDAAiD;IACjD,IAAI,CAAC,QAAQ,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,EAAE;QACnD,MAAM,IAAI,0BAAkB,CAAC,WAAW,EAAE,iCAAiC,CAAC,CAAC;KAC9E;IAED,IAAI,QAAQ,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,EAAE;QAClD,MAAM,IAAI,GAAG,8BAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,WAAW,GAAG,8BAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9C,MAAM,aAAa,GAAG,gBAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;QAC7E,MAAM,SAAS,GAAG,oBAAa,CAC7B,IAAI,UAAU,CAAC,aAAa,CAAC,EAC7B,IAAI,UAAU,CAAC,EAAE,CAAC,EAClB,IAAI,UAAU,CAAC,WAAW,CAAC,CAC5B,CAAC;QACF,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,0BAAkB,CAAC,WAAW,EAAE,8CAA8C,CAAC,CAAC;SAC3F;QAED,OAAO,8BAAQ,CAAC,SAAS,CAAC,CAAC;KAC5B;SAAM;QACL,OAAO,8BAAQ,CAAC,MAAM,CAAC,CAAC;KACzB;AACH,CAAC;AAzBD,gCAyBC"}

package/dist/lib/sapling-keys/in-memory-proving-key.js

@@ -0,0 +1,84 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
+var _provingKey;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InMemoryProvingKey = void 0;
+const sapling = require("@airgap/sapling-wasm");
+const helpers_1 = require("./helpers");
+/**
+ * @description holds the proving key, create proof for spend descriptions
+ * The class can be instantiated from a proving key or a spending key
+ */
+class InMemoryProvingKey {
+    constructor(provingKey) {
+        _provingKey.set(this, void 0);
+        __classPrivateFieldSet(this, _provingKey, Buffer.from(provingKey, 'hex'));
+    }
+    /**
+     * @description Allows to instantiate the InMemoryProvingKey from an encrypted/unencrypted spending key
+     *
+     * @param spendingKey Base58Check-encoded spending key
+     * @param password Optional password to decrypt the spending key
+     * @example
+     * ```
+     * await InMemoryProvingKey.fromSpendingKey('sask27SLmU9herddHz4qFJBLMjWYMbJF8RtS579w9ej9mfCYK7VUdyCJPHK8AzW9zMsopGZEkYeNjAY7Zz1bkM7CGu8eKLzrjBLTMC5wWJDhxiK91ahA29rhDRsHdJDV2u2jFwb2MNUix8JW7sAkAqYVaJpCehTBPgRQ1KqKwqqUaNmuD8kazd4Q8MCWmgbWs21Yuomdqyi9FLigjRp7oY4m5adaVU19Nj1AHvsMY2tePeU2L')
+     * ```
+     *
+     */
+    static fromSpendingKey(spendingKey, password) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const decodedSpendingKey = helpers_1.decryptKey(spendingKey, password);
+            const provingKey = yield sapling.getProofAuthorizingKey(decodedSpendingKey);
+            return new InMemoryProvingKey(provingKey.toString('hex'));
+        });
+    }
+    /**
+     * @description Prepare an unsigned sapling spend description using the proving key
+     *
+     * @param parametersSpendProof.saplingContext The sapling proving context
+     * @param parametersSpendProof.address The address of the input
+     * @param parametersSpendProof.randomCommitmentTrapdoor The randomness of the commitment
+     * @param parametersSpendProof.publicKeyReRandomization The re-randomization of the public key
+     * @param parametersSpendProof.amount The value of the input
+     * @param parametersSpendProof.root The root of the merkle tree
+     * @param parametersSpendProof.witness The path of the commitment in the tree
+     * @param derivationPath tezos current standard 'm/'
+     * @returns The unsinged spend description
+     */
+    prepareSpendDescription(parametersSpendProof) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const spendDescription = yield sapling.prepareSpendDescriptionWithAuthorizingKey(parametersSpendProof.saplingContext, __classPrivateFieldGet(this, _provingKey), parametersSpendProof.address, parametersSpendProof.randomCommitmentTrapdoor, parametersSpendProof.publicKeyReRandomization, parametersSpendProof.amount, parametersSpendProof.root, parametersSpendProof.witness);
+            return {
+                commitmentValue: spendDescription.cv,
+                nullifier: spendDescription.nf,
+                publicKeyReRandomization: spendDescription.rk,
+                rtAnchor: spendDescription.rt,
+                proof: spendDescription.proof,
+            };
+        });
+    }
+}
+exports.InMemoryProvingKey = InMemoryProvingKey;
+_provingKey = new WeakMap();
+//# sourceMappingURL=in-memory-proving-key.js.map

package/dist/lib/sapling-keys/in-memory-proving-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"in-memory-proving-key.js","sourceRoot":"","sources":["../../../src/sapling-keys/in-memory-proving-key.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAgD;AAEhD,uCAAuC;AAEvC;;;GAGG;AACH,MAAa,kBAAkB;IAG7B,YAAY,UAAkB;QAF9B,8BAAoB;QAGlB,uBAAA,IAAI,eAAe,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,EAAC;IACpD,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAO,eAAe,CAAC,WAAmB,EAAE,QAAiB;;YACjE,MAAM,kBAAkB,GAAG,oBAAU,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAC7D,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;YAC5E,OAAO,IAAI,kBAAkB,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5D,CAAC;KAAA;IAED;;;;;;;;;;;;OAYG;IACG,uBAAuB,CAC3B,oBAA+D;;YAE/D,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,yCAAyC,CAC9E,oBAAoB,CAAC,cAAc,6CAEnC,oBAAoB,CAAC,OAAO,EAC5B,oBAAoB,CAAC,wBAAwB,EAC7C,oBAAoB,CAAC,wBAAwB,EAC7C,oBAAoB,CAAC,MAAM,EAC3B,oBAAoB,CAAC,IAAI,EACzB,oBAAoB,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO;gBACL,eAAe,EAAE,gBAAgB,CAAC,EAAE;gBACpC,SAAS,EAAE,gBAAgB,CAAC,EAAE;gBAC9B,wBAAwB,EAAE,gBAAgB,CAAC,EAAE;gBAC7C,QAAQ,EAAE,gBAAgB,CAAC,EAAE;gBAC7B,KAAK,EAAE,gBAAgB,CAAC,KAAK;aAC9B,CAAC;QACJ,CAAC;KAAA;CACF;AA1DD,gDA0DC"}

package/dist/lib/sapling-keys/in-memory-spending-key.js

@@ -0,0 +1,146 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
+var _spendingKeyBuf, _saplingViewingKey;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InMemorySpendingKey = void 0;
+const error_1 = require("../error");
+const in_memory_viewing_key_1 = require("./in-memory-viewing-key");
+const sapling = require("@airgap/sapling-wasm");
+const utils_1 = require("@taquito/utils");
+const bip39 = require("bip39");
+const helpers_1 = require("./helpers");
+/**
+ * @description holds the spending key, create proof and signature for spend descriptions
+ * can instantiate from mnemonic word list or decrypt a encrypted spending key
+ * with access to instantiate a InMemoryViewingKey
+ */
+class InMemorySpendingKey {
+    /**
+     *
+     * @param spendingKey unencrypted sask... or encrypted MMXj...
+     * @param password required for MMXj encrypted keys
+     */
+    constructor(spendingKey, password) {
+        _spendingKeyBuf.set(this, void 0);
+        _saplingViewingKey.set(this, void 0);
+        __classPrivateFieldSet(this, _spendingKeyBuf, helpers_1.decryptKey(spendingKey, password));
+    }
+    /**
+     *
+     * @param mnemonic string of words
+     * @param derivationPath tezos current standard 'm/'
+     * @returns InMemorySpendingKey class instantiated
+     */
+    static fromMnemonic(mnemonic, derivationPath = 'm/') {
+        return __awaiter(this, void 0, void 0, function* () {
+            // no password passed here. password provided only changes from sask -> MMXj
+            const fullSeed = yield bip39.mnemonicToSeed(mnemonic);
+            const first32 = fullSeed.slice(0, 32);
+            const second32 = fullSeed.slice(32);
+            // reduce seed bytes must be 32 bytes reflecting both halves
+            const seed = Buffer.from(first32.map((byte, index) => byte ^ second32[index]));
+            const spendingKeyArr = new Uint8Array(yield sapling.getExtendedSpendingKey(seed, derivationPath));
+            const spendingKey = utils_1.b58cencode(spendingKeyArr, utils_1.prefix[utils_1.Prefix.SASK]);
+            if (utils_1.ValidationResult.VALID !== 3) {
+                throw new error_1.InvalidSpendingKey(spendingKey);
+            }
+            return new InMemorySpendingKey(spendingKey);
+        });
+    }
+    /**
+     *
+     * @returns InMemoryViewingKey instantiated class
+     */
+    getSaplingViewingKeyProvider() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let viewingKey;
+            if (!__classPrivateFieldGet(this, _saplingViewingKey)) {
+                viewingKey = yield sapling.getExtendedFullViewingKeyFromSpendingKey(__classPrivateFieldGet(this, _spendingKeyBuf));
+                __classPrivateFieldSet(this, _saplingViewingKey, new in_memory_viewing_key_1.InMemoryViewingKey(viewingKey.toString('hex')));
+            }
+            return __classPrivateFieldGet(this, _saplingViewingKey);
+        });
+    }
+    /**
+     * @description Prepare an unsigned sapling spend description using the spending key
+     * @param parametersSpendProof.saplingContext The sapling proving context
+     * @param parametersSpendProof.address The address of the input
+     * @param parametersSpendProof.randomCommitmentTrapdoor The randomness of the commitment
+     * @param parametersSpendProof.publicKeyReRandomization The re-randomization of the public key
+     * @param parametersSpendProof.amount The value of the input
+     * @param parametersSpendProof.root The root of the merkle tree
+     * @param parametersSpendProof.witness The path of the commitment in the tree
+     * @param derivationPath tezos current standard 'm/'
+     * @returns The unsigned spend description
+     */
+    prepareSpendDescription(parametersSpendProof) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const spendDescription = yield sapling.prepareSpendDescriptionWithSpendingKey(parametersSpendProof.saplingContext, __classPrivateFieldGet(this, _spendingKeyBuf), parametersSpendProof.address, parametersSpendProof.randomCommitmentTrapdoor, parametersSpendProof.publicKeyReRandomization, parametersSpendProof.amount, parametersSpendProof.root, parametersSpendProof.witness);
+            return {
+                commitmentValue: spendDescription.cv,
+                nullifier: spendDescription.nf,
+                publicKeyReRandomization: spendDescription.rk,
+                rtAnchor: spendDescription.rt,
+                proof: spendDescription.proof,
+            };
+        });
+    }
+    /**
+     * @description Sign a sapling spend description
+     * @param parametersSpendSig.publicKeyReRandomization The re-randomization of the public key
+     * @param parametersSpendSig.unsignedSpendDescription The unsigned Spend description
+     * @param parametersSpendSig.hash The data to be signed
+     * @returns The signed spend description
+     */
+    signSpendDescription(parametersSpendSig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const signedSpendDescription = yield sapling.signSpendDescription({
+                cv: parametersSpendSig.unsignedSpendDescription.commitmentValue,
+                rt: parametersSpendSig.unsignedSpendDescription.rtAnchor,
+                nf: parametersSpendSig.unsignedSpendDescription.nullifier,
+                rk: parametersSpendSig.unsignedSpendDescription.publicKeyReRandomization,
+                proof: parametersSpendSig.unsignedSpendDescription.proof,
+            }, __classPrivateFieldGet(this, _spendingKeyBuf), parametersSpendSig.publicKeyReRandomization, parametersSpendSig.hash);
+            return {
+                commitmentValue: signedSpendDescription.cv,
+                nullifier: signedSpendDescription.nf,
+                publicKeyReRandomization: signedSpendDescription.rk,
+                proof: signedSpendDescription.proof,
+                signature: signedSpendDescription.spendAuthSig,
+            };
+        });
+    }
+    /**
+     * @description Return a proof authorizing key from the configured spending key
+     */
+    getProvingKey() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const provingKey = yield sapling.getProofAuthorizingKey(__classPrivateFieldGet(this, _spendingKeyBuf));
+            return provingKey.toString('hex');
+        });
+    }
+}
+exports.InMemorySpendingKey = InMemorySpendingKey;
+_spendingKeyBuf = new WeakMap(), _saplingViewingKey = new WeakMap();
+//# sourceMappingURL=in-memory-spending-key.js.map

package/dist/lib/sapling-keys/in-memory-spending-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"in-memory-spending-key.js","sourceRoot":"","sources":["../../../src/sapling-keys/in-memory-spending-key.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oCAA8C;AAC9C,mEAA6D;AAC7D,gDAAgD;AAChD,0CAA8E;AAC9E,+BAA+B;AAO/B,uCAAuC;AAEvC;;;;GAIG;AACH,MAAa,mBAAmB;IAG9B;;;;OAIG;IACH,YAAY,WAAmB,EAAE,QAAiB;QAPlD,kCAAwB;QACxB,qCAAmD;QAOjD,uBAAA,IAAI,mBAAmB,oBAAU,CAAC,WAAW,EAAE,QAAQ,CAAC,EAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAO,YAAY,CAAC,QAAgB,EAAE,cAAc,GAAG,IAAI;;YAC/D,4EAA4E;YAC5E,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YAEtD,MAAM,OAAO,GAAW,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9C,MAAM,QAAQ,GAAW,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC5C,4DAA4D;YAC5D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAE/E,MAAM,cAAc,GAAG,IAAI,UAAU,CACnC,MAAM,OAAO,CAAC,sBAAsB,CAAC,IAAI,EAAE,cAAc,CAAC,CAC3D,CAAC;YAEF,MAAM,WAAW,GAAG,kBAAU,CAAC,cAAc,EAAE,cAAM,CAAC,cAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAEpE,IAAI,wBAAgB,CAAC,KAAK,KAAK,CAAC,EAAE;gBAChC,MAAM,IAAI,0BAAkB,CAAC,WAAW,CAAC,CAAC;aAC3C;YAED,OAAO,IAAI,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC;KAAA;IAED;;;OAGG;IACG,4BAA4B;;YAChC,IAAI,UAAkB,CAAC;YACvB,IAAI,iDAAwB,EAAE;gBAC5B,UAAU,GAAG,MAAM,OAAO,CAAC,wCAAwC,+CAAsB,CAAC;gBAC1F,uBAAA,IAAI,sBAAsB,IAAI,0CAAkB,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAC;aAC9E;YAED,wDAA+B;QACjC,CAAC;KAAA;IAED;;;;;;;;;;;OAWG;IACG,uBAAuB,CAC3B,oBAA0C;;YAE1C,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,sCAAsC,CAC3E,oBAAoB,CAAC,cAAc,iDAEnC,oBAAoB,CAAC,OAAO,EAC5B,oBAAoB,CAAC,wBAAwB,EAC7C,oBAAoB,CAAC,wBAAwB,EAC7C,oBAAoB,CAAC,MAAM,EAC3B,oBAAoB,CAAC,IAAI,EACzB,oBAAoB,CAAC,OAAO,CAC7B,CAAC;YACF,OAAO;gBACL,eAAe,EAAE,gBAAgB,CAAC,EAAE;gBACpC,SAAS,EAAE,gBAAgB,CAAC,EAAE;gBAC9B,wBAAwB,EAAE,gBAAgB,CAAC,EAAE;gBAC7C,QAAQ,EAAE,gBAAgB,CAAC,EAAE;gBAC7B,KAAK,EAAE,gBAAgB,CAAC,KAAK;aAC9B,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;OAMG;IACG,oBAAoB,CACxB,kBAAsC;;YAEtC,MAAM,sBAAsB,GAAG,MAAM,OAAO,CAAC,oBAAoB,CAC/D;gBACE,EAAE,EAAE,kBAAkB,CAAC,wBAAwB,CAAC,eAAe;gBAC/D,EAAE,EAAE,kBAAkB,CAAC,wBAAwB,CAAC,QAAQ;gBACxD,EAAE,EAAE,kBAAkB,CAAC,wBAAwB,CAAC,SAAS;gBACzD,EAAE,EAAE,kBAAkB,CAAC,wBAAwB,CAAC,wBAAwB;gBACxE,KAAK,EAAE,kBAAkB,CAAC,wBAAwB,CAAC,KAAK;aACzD,iDAED,kBAAkB,CAAC,wBAAwB,EAC3C,kBAAkB,CAAC,IAAI,CACxB,CAAC;YACF,OAAO;gBACL,eAAe,EAAE,sBAAsB,CAAC,EAAE;gBAC1C,SAAS,EAAE,sBAAsB,CAAC,EAAE;gBACpC,wBAAwB,EAAE,sBAAsB,CAAC,EAAE;gBACnD,KAAK,EAAE,sBAAsB,CAAC,KAAK;gBACnC,SAAS,EAAE,sBAAsB,CAAC,YAAY;aAC/C,CAAC;QACJ,CAAC;KAAA;IAED;;OAEG;IACG,aAAa;;YACjB,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,sBAAsB,+CAAsB,CAAC;YAC9E,OAAO,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC;KAAA;CACF;AA9HD,kDA8HC"}