suidouble 1.6.0 → 1.11.0

package/README.md

@@ -46,13 +46,18 @@ Main class to interact with blockchain is SuiMaster:
 const { SuiMaster } = require('suidouble');
 ```
 
-You can initialize it directly, if you have keypair, secret phrase and can use it in code (so on node.js side - server side or CLI apps):
+You can initialize it directly, if you have keypair, secret phrase, or privateKey and can use it in code (so on node.js side - server side or CLI apps):
 ```javascript
 const suiMaster = new SuiMaster({
     keypair: Ed25519Keypair || Secp256r1Keypair || Secp256k1Keypair,
     debug: true,    // echo testing messages to console
     client: 'test', // 'test', 'dev', 'local', 'main' or instance of this lib's SuiLocalTestValidator
 });
+const suiMaster = new SuiMaster({
+    debug: false,
+    privateKey: 'suiprivkey1qpwly9xrfsv50mqug706s40l58klez5q6mpchq4f5ldzktjyr4x7yhj9lf2',
+    client: 'dev', 
+});
 const suiMaster = new SuiMaster({
     debug: false,
     phrase: 'thrive mean two thrive mean two thrive mean two thrive mean two', // secret phrase to generate keypair

package/index.js

@@ -5,6 +5,7 @@ const SuiObject = require('./lib/SuiObject.js');
 const SuiUtils = require('./lib/SuiUtils.js');
 const SuiLocalTestValidator = require('./lib/SuiLocalTestValidator.js');
 const { Transaction, Commands } = require('@mysten/sui/transactions');
+const { bcs } = require('@mysten/sui/bcs');
 
 module.exports = {
     SuiMaster,
@@ -17,4 +18,5 @@ module.exports = {
     Commands: Commands,
     SuiUtils: SuiUtils,
     txInput: SuiUtils.txInput,
+    bcs,
 };

package/lib/SuiCoin.js

@@ -1,6 +1,5 @@
-const { Commands, Transaction } = require('@mysten/sui/transactions');
+const { Commands, Transaction, TransactionObjectArgument } = require('@mysten/sui/transactions');
 const { bcs } = require('@mysten/sui/bcs');
-// console.log(bcs);
 
 
 const safeList = {
@@ -25,7 +24,15 @@ const safeList = {
     },
 };
 
+/** Coin metadata object */
 class SuiCoin {
+
+    /**
+     * SuiCoin constructor
+     * @param {Object} params - Initialization parameters
+     * @param {string} params.coinType - sui object type for a coin, without Coin<...>, only the inside type
+     * @param {SuiCoins} params.suiCoins - instance of SuiCoins
+     */
     constructor(params = {}) {
         this._coinType = params.coinType;
         this._suiCoins = params.suiCoins;
@@ -214,11 +221,11 @@ class SuiCoin {
     /**
      * Returns TransactionObjectArgument with Coin of amount to be used in tranasctions
      * 
-     * @param {import('@mysten/sui/transactions').Transaction} txb - Native SUI SDK Transaction
+     * @param {Transaction} txb - Native SUI SDK Transaction
      * @param {string} owner - address of the owner
      * @param {BigInt|string} amount - amount of coin. BigIng or String to be normalized via Coin decimals, "0.05" for 0.05 sui
      * @param {boolean} addEmptyCoins - attach coins == 0 to the list
-     * @returns {import('@mysten/sui/transactions').TransactionObjectArgument}
+     * @returns {TransactionObjectArgument}
      */
     async coinOfAmountToTxCoin(txb, owner, amount, addEmptyCoins = false) {
         const normalizedAmount = await this.lazyNormalizeAmount(amount);
@@ -237,14 +244,14 @@ class SuiCoin {
                 return coinInput;
             } else {
                 // some other coin
-                const coinInput = txb.add(Commands.SplitCoins(txb.object(coinIds[0]), [txb.pure(expectedAmountAsBigInt)]));
+                const coinInput = txb.add(Commands.SplitCoins(txb.object(coinIds[0]), [txb.pure.u64(expectedAmountAsBigInt)]));
                 return coinInput;
             }
         } else {
             // few coin objects to merge
             const coinIdToMergeIn = coinIds.shift();
             txb.add(Commands.MergeCoins(txb.object(coinIdToMergeIn), coinIds.map((id)=>{return txb.object(id);})));
-            const coinInputSplet = txb.add(Commands.SplitCoins(txb.object(coinIdToMergeIn), [txb.pure(expectedAmountAsBigInt)]));
+            const coinInputSplet = txb.add(Commands.SplitCoins(txb.object(coinIdToMergeIn), [txb.pure.u64(expectedAmountAsBigInt)]));
 
             return coinInputSplet;
         }

package/lib/SuiMaster.js

@@ -14,6 +14,7 @@ const { Secp256r1Keypair } = require('@mysten/sui/keypairs/secp256r1');
 const { Secp256k1Keypair } = require('@mysten/sui/keypairs/secp256k1');
 const { requestSuiFromFaucetV0, getFaucetHost } = require('@mysten/sui/faucet');
 const { Transaction, Commands } = require('@mysten/sui/transactions');
+const { decodeSuiPrivateKey } = require('@mysten/sui/cryptography');
 
 
 class SuiMaster extends SuiCommonMethods {
@@ -36,6 +37,17 @@ class SuiMaster extends SuiCommonMethods {
             }
         } else if (params.keypair) {
             this._keypair = params.keypair;
+        } else if (params.privateKey) {
+            const parsed = decodeSuiPrivateKey(params.privateKey);
+            if (parsed && parsed.schema) {
+                if (parsed.schema === 'ED25519') {
+                    this._keypair = Ed25519Keypair.fromSecretKey(parsed.secretKey);
+                } else if (parsed.schema == 'Secp256k1') {
+                    this._keypair = Secp256k1Keypair.fromSecretKey(parsed.secretKey);
+                } else if (parsed.schema == 'Secp256r1') {
+                    this._keypair = Secp256r1Keypair.fromSecretKey(parsed.secretKey);                    
+                }
+            }
         } else if (params.phrase) {
             if (params.keypairAlgo && (''+params.keypairAlgo).toLowerCase() == 'secp256r1') {
                 if (!params.accountIndex) {
@@ -229,12 +241,28 @@ class SuiMaster extends SuiCommonMethods {
     }
 
     async signAndExecuteTransaction(params) {
+        let txResults = null;
         if (this._keypair) {
             params.signer = this._keypair;
-            return this._client.signAndExecuteTransaction(params);
+            txResults = await this._client.signAndExecuteTransaction(params);
         } else if (this._signer) {
-            return this._signer.signAndExecuteTransaction(params);
+            txResults = await this._signer.signAndExecuteTransaction(params);
         }
+
+        try {
+            if (params && params.requestType && params.requestType == 'WaitForLocalExecution') {
+                const detailedResults =  await this.client.waitForTransaction({
+                    digest: txResults.digest,
+                    options: (params.options || {}),
+                });
+    
+                return detailedResults;
+            }
+        } catch (e) {
+            this.log(e);
+        }
+
+        return txResults;
     }
 
   async requestSuiFromFaucet() {

package/lib/SuiPackage.js

@@ -394,9 +394,9 @@ class SuiPackage extends SuiObject {
         }
     }
 
-    async publish() {
+    async publish(params = {}) {
         if (!this._isBuilt) {
-            await this.build();
+            await this.build(params);
         }
         if (this.address) {
             throw new Error('already published. Maybe you need to upgrade() it?');
@@ -422,6 +422,13 @@ class SuiPackage extends SuiObject {
             },
         });
 
+        // const suiTransaction = new this._suiMaster.SuiTransaction({
+        //         suiMaster: this._suiMaster,
+        //         debug: this._debug,
+        //         data: result,
+        //     });
+        // await suiTransaction.waitForTransaction();
+
         const success = await this.storeInfoFromPublishResult(result);
 
         if (success) {
@@ -431,11 +438,11 @@ class SuiPackage extends SuiObject {
         return this.address;
     }
 
-    async upgrade() {
+    async upgrade(params = {}) {
         await this.checkOnChainIfNeeded();
 
         if (!this._isBuilt) {
-            await this.build();
+            await this.build(params);
         }
 
         this.log('upgrading package...');
@@ -473,7 +480,7 @@ class SuiPackage extends SuiObject {
             arguments: [cap, receipt],
         });
 
-        console.log(tx);
+        // console.log(tx);
 
         const result = await this._suiMaster.signAndExecuteTransaction({
             transaction: tx,
@@ -496,7 +503,7 @@ class SuiPackage extends SuiObject {
      * Build a Move project using `sui move build`
      * @returns Boolean true on success
      */
-    async build() {
+    async build(params = {}) {
         this.log('builing a package...');
 
         const path = this._path;
@@ -505,7 +512,11 @@ class SuiPackage extends SuiObject {
             throw new Error('Cant build a package with no path defined');
         }
 
-        const buildResult = await SuiCliCommands.exec(`sui move build --dump-bytecode-as-base64 --path ${path}`);
+        let command = `sui move build --dump-bytecode-as-base64 --path ${path}`;
+        if (params.withUnpublishedDependencies) {
+            command = `sui move build --with-unpublished-dependencies --dump-bytecode-as-base64 --path ${path}`;
+        }
+        const buildResult = await SuiCliCommands.exec(command);
         const { modules, dependencies, digest } = JSON.parse(buildResult);
 
         this._builtModules = modules;

package/lib/SuiPackageModule.js

@@ -196,12 +196,12 @@ class SuiPackageModule extends SuiCommonMethods {
                 showDisplay: true,
             },
         });
+
         const suiTransaction = new this._suiMaster.SuiTransaction({
                 suiMaster: this._suiMaster,
                 debug: this._debug,
                 data: result,
             });
-
         const status = suiTransaction.status;
 
         const listCreated = [];

package/lib/SuiUtils.js

@@ -7,22 +7,23 @@ const { normalizeSuiAddress } = require('@mysten/sui/utils');
 
 const WebSocketClient = require('websocket').w3cwebsocket;
 
+/** Helpful methods using in different places of suidouble */
 class SuiUtils extends SuiCommonMethods {
 
     /**
-     * Attacha the parameter input into transaction, to be used for moveCall
+     * Attach the parameter input into transaction, to be used for moveCall
      * accepts an Inputs.Pure (result of .pureInput) or type + value directly
      * 
      * @param {Transaction} tx 
-     * @param {Inputs.Pure | String} typeOrInput 
-     * @param {any | undefined} value 
+     * @param {string | Inputs.Pure} typeOrInput 
+     * @param {?Argument} value 
      * @returns Argument
      */
     static txInput(tx, typeOrInput, value = null) {
         if (typeOrInput && typeOrInput.Pure && typeOrInput.Pure.bytes) {
-            return tx.pure(this.pureInputToBytes(typeOrInput));
+            return tx.pure(SuiUtils.pureInputToBytes(typeOrInput));
         } else {
-            return tx.pure(this.pureInputToBytes(this.pureInput(typeOrInput, value)));
+            return tx.pure(SuiUtils.pureInputToBytes(SuiUtils.pureInput(typeOrInput, value)));
         }
     }
 
@@ -37,13 +38,7 @@ class SuiUtils extends SuiCommonMethods {
      *         SuiUtils.pureInput('string', 'metadata')
      *     ]);
      * 
-     *  or:
-     *   wrapped in tx.pure if you are going to construct tx yourself:
-     *    const tx = new Transaction();
-     *    tx.moveCall({ target: `x.x.x`, arguments: [
-     *         tx.pure(SuiUtils.pureInput('u8',22)),
-     *         tx.pure(SuiUtils.pureInput('string','test')),
-     *      ] });
+     * if you are going to construct tx yourself, you'd better use SuiUtils.txInput static method
      * 
      * @param {string} type 
      * @param {value} value 
@@ -87,21 +82,23 @@ class SuiUtils extends SuiCommonMethods {
     /**
      * Wrapper for sui's utils normalizeSuiAddress
      * Perform the following operations:
+     * <pre>
      * 1. Make the address lower case
      * 2. Prepend `0x` if the string does not start with `0x`.
      * 3. Add more zeros if the length of the address(excluding `0x`) is less than `SUI_ADDRESS_LENGTH`
+     * </pre>
      *
      * @param {string} address 
      * @returns string
      */
-    normalizeSuiAddress(address) {
+    static normalizeSuiAddress(address) {
         return normalizeSuiAddress(address);
     }
 
     /**
      * As SUI removed websocket dependency for a node, we'll have it here as constructor wrapper
      *   returning native WebSocket in browser and websocket's w3cwebsocket in node
-     * @returns 
+     * @returns WebSocketClient
      */
     static WebSocketConstructor() {
         return WebSocketClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suidouble",
-  "version": "1.6.0",
+  "version": "1.11.0",
   "description": "Set of provider, package and object classes for javascript representation of Sui Move smart contracts. Use same code for publishing, upgrading, integration testing, interaction with smart contracts and integration in browser web3 dapps",
   "main": "index.js",
   "scripts": {
@@ -21,7 +21,7 @@
   "author": "Jeka Kiselyov <jeka911@gmail.com> (https://github.com/jeka-kiselyov)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@mysten/sui": "^1.6.0",
+    "@mysten/sui": "^1.11.0",
     "@wallet-standard/core": "^1.0.3",
     "websocket": "^1.0.35"
   },
@@ -33,6 +33,5 @@
     "fs": false,
     "path": false
   },
-  "tap": {
-  }
+  "tap": {}
 }

package/test/sui_master_basic.test.js

@@ -39,6 +39,15 @@ test('pseudo-random keypairs generation works ok', async t => {
     t.equal(`${suiMasterAsAdminAnother.address}`, `${suiMasterAsAdmin.address}`, 'same string should generate same pseudo-random');
 });
 
+test('keypair generation with privateKey works ok', async t => {
+    const privateKey = 'suiprivkey1qpwly9xrfsv50mqug706s40l58klez5q6mpchq4f5ldzktjyr4x7yhj9lf2'; 
+    const suiMaster = new SuiMaster({client: 'test', privateKey: privateKey});
+    await suiMaster.initialize();
+
+    t.equal(`${suiMaster.address}`, `0x4d07e4a382dcb69288a8a4589e8fc0534378dad76b75565fda0c1e9ada45b7d1`, 'by privateKey generated ok');
+});
+
+
 test('keypair generation with seed phrase works ok', async t => {
     // Ed25519
     const phrase = 'seek weekend run rival noodle dog alone mosquito decide hover aerobic fiction'; // 0x2bfe9c35ca9400c42e24e4b424cbd2dfb51bcb7c2487e1b4694ff53d8ca00262