suidouble 1.0.5 → 1.6.0-2

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
@@ -294,20 +299,21 @@ Don't forget to test transactions sending real money on devnet/testnet first!
 
 ##### composing transaction block yourself
 
-If you need more flexebility, there's always an option to construct the transaction block yourself:
+If you need more flexebility, there's always an option to construct the transaction yourself:
 
 ```javascript
-const { TransactionBlock, Transactions } = require('suidobule'); // this exposes classes from the "@mysten/sui.js", so you don't have to import them separately
+const { Transaction, txInput } = require('suidobule'); // this exposes classes from the "@mysten/sui.js", so you don't have to import them separately
 
-const txb = new TransactionBlock();
-txb.moveCall({
+const tx = new Transaction();
+tx.moveCall({
     target: `package_id::module_id::method_name`,
     arguments: [
-        txb.pure(contract.arg('u256', something)),
-        txb.object(someid),
+        txInput(tx, 'u256', some_value),
+        txInput(tx, 'vector<bool>', some_array),
+        tx.object('0xc060006111016b8a020ad5b33834984a437aaa7d3c74c18e09a95d48aceab08c'), // object ids are ok t
     ],
 });
-const moveCallResult = await contract.moveCall('suidouble_chat', 'post_pay', {tx: txb});
+const moveCallResult = await contract.moveCall('suidouble_chat', 'post_pay', {tx: tx});
 ```
 
 

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,
@@ -16,4 +17,6 @@ module.exports = {
     Transaction: Transaction,
     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);

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) {

package/lib/SuiPackage.js

@@ -452,8 +452,8 @@ class SuiPackage extends SuiObject {
 
         const authorizeUpgradeArguments = [
             cap,
-            tx.pure(this.arg('u8', UpgradePolicyCOMPATIBLE)), 
-            tx.pure(this.arg('vector<u8>', this._builtDigest)),
+            this._suiMaster.utils.txInput(tx, 'u8', UpgradePolicyCOMPATIBLE), 
+            this._suiMaster.utils.txInput(tx, 'vector<u8>', this._builtDigest), 
         ];
 
         const ticket = tx.moveCall({

package/lib/SuiPackageModule.js

@@ -166,6 +166,11 @@ class SuiPackageModule extends SuiCommonMethods {
                     const txCoinToSend = await suiCoin.coinOfAmountToTxCoin(tx, ownerAddress, param[0].amount);
 
                     callArgs.push(tx.makeMoveVec({ type: suiCoin.coinObjectType, elements: [txCoinToSend]}));
+                } else if (typeof param === 'string' && param.indexOf('0x') === 0) {
+                    callArgs.push(tx.object(param));
+                } else if (param && param.Pure && param.Pure.bytes) {
+                    // already Pure
+                    callArgs.push(this._suiMaster.utils.txInput(tx, param));
                 } else {
                     callArgs.push(tx.pure(param));
                 }

package/lib/SuiUtils.js

@@ -1,13 +1,32 @@
 const SuiCommonMethods = require('./SuiCommonMethods.js');
-const { Inputs } = require('@mysten/sui/transactions');
+const { Inputs, Transaction, Argument } = require('@mysten/sui/transactions');
 const { bcs } = require('@mysten/sui/bcs');
+const { fromB64 } = require('@mysten/bcs');
 const { SuiClient, getFullnodeUrl, SuiHTTPTransport } = require('@mysten/sui/client');
 const { normalizeSuiAddress } = require('@mysten/sui/utils');
 
 const WebSocketClient = require('websocket').w3cwebsocket;
 
+/** Helpful methods using in different places of suidouble */
 class SuiUtils extends SuiCommonMethods {
 
+    /**
+     * 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 {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(SuiUtils.pureInputToBytes(typeOrInput));
+        } else {
+            return tx.pure(SuiUtils.pureInputToBytes(SuiUtils.pureInput(typeOrInput, value)));
+        }
+    }
+
     /**
      * Returns and Inputs.Pure for a given type
      *   to be used as moveCall parameters
@@ -19,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 
@@ -58,24 +71,34 @@ class SuiUtils extends SuiCommonMethods {
         }
     }
 
+    /**
+     * Convert sui's PureInput into bcs serialized bytes
+     * @param {Inputs.Pure} pureInput 
+     */
+    static pureInputToBytes(pureInput) {
+        return fromB64(pureInput.Pure.bytes);
+    }
+
     /**
      * 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,11 +1,11 @@
 {
   "name": "suidouble",
-  "version": "1.0.5",
+  "version": "1.6.0-2",
   "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": {
-    "test": "tap -j=1 ./test/*.test.js",
-    "coverage": "tap -j=1 ./test/*.test.js"
+    "test": "tap -j1 -t120 ./test/*.test.js",
+    "coverage": "tap -j1 -t120 ./test/*.test.js"
   },
   "keywords": [
     "sui",
@@ -21,22 +21,17 @@
   "author": "Jeka Kiselyov <jeka911@gmail.com> (https://github.com/jeka-kiselyov)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@mysten/sui": "1.0.5",
+    "@mysten/sui": "^1.6.0",
     "@wallet-standard/core": "^1.0.3",
     "websocket": "^1.0.35"
   },
   "devDependencies": {
-    "tap": "^16.3.4"
+    "tap": "^21.0.1"
   },
   "browser": {
     "child_process": false,
     "fs": false,
     "path": false
   },
-  "tap": {
-    "branches": 90,
-    "lines": 90,
-    "functions": 90,
-    "statements": 90
-  }
+  "tap": {}
 }

package/test/coins.test.js

@@ -89,7 +89,7 @@ test('getting coin objects for a transaction', async t => {
 
     const tx = new Transaction();
     const coinInput = await suiCoin.coinOfAmountToTxCoin(tx, suiMaster.address, suiMaster.MIST_PER_SUI); // pick 1 SUI
-    tx.transferObjects([coinInput], tx.pure('0x1d20dcdb2bca4f508ea9613994683eb4e76e9c4ed371169677c1be02aaf0b12a')); // send it anywhere
+    tx.transferObjects([coinInput], '0x1d20dcdb2bca4f508ea9613994683eb4e76e9c4ed371169677c1be02aaf0b12a'); // send it anywhere
 
     const result = await suiMaster.signAndExecuteTransaction({
         transaction: tx,

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