suidouble 1.38.0 → 1.45.0

package/lib/SuiCommonMethods.js

@@ -1,4 +1,5 @@
 
+
 class CustomEvent extends Event {
 	#detail;
 

package/lib/SuiLocalTestValidator.js

@@ -47,6 +47,12 @@ export default class SuiLocalTestValidator extends SuiCommonMethods {
         return this._active;
     }
 
+    /**
+     * Launch a localnet sui and wait for it to become available to accept transactions.
+     * Don't forget to .stop() it after usage.
+     * 
+     * @returns {SuiLocalTestValidator}
+     */
     static async launch(params = {}) {
         if (SuiLocalTestValidator.__instance) {
             return await SuiLocalTestValidator.__instance.launch();
@@ -56,6 +62,9 @@ export default class SuiLocalTestValidator extends SuiCommonMethods {
         return await SuiLocalTestValidator.__instance.launch();
     }
 
+    /**
+     * Stop the local sui node 
+     */
     static async stop() {
         if (SuiLocalTestValidator.__instance) {
             return await SuiLocalTestValidator.__instance.stop();
@@ -81,6 +90,11 @@ export default class SuiLocalTestValidator extends SuiCommonMethods {
         return portIsThere;
     }
 
+    /**
+     * Launch a local sui node and wait for it to become available to accept transactions.
+     * 
+     * @returns {SuiLocalTestValidator}
+     */
     async launch() {
         if (this._active) {
             return this;

package/lib/SuiMaster.js

@@ -21,19 +21,38 @@ import { decodeSuiPrivateKey  } from '@mysten/sui/cryptography';
 
 /**
  * @typedef {import("@mysten/sui/client").SuiClient} SuiClient
+ * @typedef {import("@mysten/sui/cryptography").Signer} SuiSigner
+ * @typedef {import("@mysten/sui/cryptography").Keypair} SuiKeypair
+ * @typedef {import("@mysten/sui/client").SuiTransactionBlockResponse} SuiTransactionBlockResponse
  */
 
 export default class SuiMaster extends SuiCommonMethods {
-    constructor(params = {}) {
+    /**
+     * SuiMaster constructor
+     * @param {Object} params - Initialization parameters
+     * @param {?SuiSigner} params.signer - instance of Sui SDK Signer (like Keypair)
+     * @param {?SuiKeypair} params.keypair - instance of Sui SDK Keypair
+     * @param {?string} param.privateKey - private key in Sui format, starting with "suiprivkey1"
+     * @param {?boolean} param.debug - enable debug mode
+     * @param {?string} param.phrase - mnemonic phrase to derive keypair from
+     * @param {?string} param.keypairAlgo - keypair algorithm to use with mnemonic phrase. One of 'ed25519' (default), 'secp256k1', 'secp256r1'
+     * @param {?number} param.accountIndex - index of account to derive from mnemonic phrase. Default is 0
+     * @param {?string} param.as - pseudo-random address generation seed string
+     * @param {?SuiClient|string} params.client - instance of SuiClient or chain name to make SuiClient connected to it (like 'local', 'devnet', 'testnet', 'mainnet')
+     */
+    constructor(params) {
         super(params);
         
         // quick value to differenciate instances (if there're few) in logs
         SuiMaster.instancesCount++;
         this._instanceN = SuiMaster.instancesCount;
 
+        /** @type {SuiSigner} */
         this._signer = null;
+        /** @type {SuiKeypair} */
         this._keypair = null;
 
+        /** @type {string} */
         this._address = null;
 
         if (params.signer) {
@@ -53,6 +72,14 @@ export default class SuiMaster extends SuiCommonMethods {
                 } else if (parsed.schema == 'Secp256r1') {
                     this._keypair = Secp256r1Keypair.fromSecretKey(parsed.secretKey);                    
                 }
+            } else if (parsed && parsed.scheme) {
+                if (parsed.scheme === 'ED25519') {
+                    this._keypair = Ed25519Keypair.fromSecretKey(parsed.secretKey);
+                } else if (parsed.scheme == 'Secp256k1') {
+                    this._keypair = Secp256k1Keypair.fromSecretKey(parsed.secretKey);
+                } else if (parsed.scheme == 'Secp256r1') {
+                    this._keypair = Secp256r1Keypair.fromSecretKey(parsed.secretKey);                    
+                }
             }
         } else if (params.phrase) {
             if (params.keypairAlgo && (''+params.keypairAlgo).toLowerCase() == 'secp256r1') {
@@ -72,7 +99,6 @@ export default class SuiMaster extends SuiCommonMethods {
                     this._keypair = Secp256k1Keypair.deriveKeypair(params.phrase, derivePath);
                 }
             } else {
-                // default is Ed25519{
                 // default is Ed25519
 
                 if (!params.accountIndex) {
@@ -95,6 +121,7 @@ export default class SuiMaster extends SuiCommonMethods {
 
         /** @type {SuiClient} */
         this._client = SuiUtils.normalizeClient(params.client);
+        /** @type {string} */
         this._providerName = this._client ? this._client.providerName : null;
 
         if (!this._client) {
@@ -108,8 +135,10 @@ export default class SuiMaster extends SuiCommonMethods {
             suiMaster: this,
         });
 
+        /** @type {boolean} */
         this._initialized = false;
 
+        /** @type {Object.<string, SuiPackage>} */
         this._packages = {};
 
         /** @type {SuiCoins} */
@@ -214,11 +243,31 @@ export default class SuiMaster extends SuiCommonMethods {
         return this._signer;
     }
 
+    /**
+     * Attach a smart contract package to this SuiMaster instance.
+     * 
+     * @param {Object} params - Configuration parameters
+     * @param {?string} [params.path] - Local filesystem path to the Move package source code
+     * @param {?string} [params.id] - ID or address of the Move package on the Sui blockchain
+     * @param {?Array.<string>|string} [params.modules] - List of modules in the package to look on chain in the UpgradeCap owned by current address
+     * 
+     * @returns {SuiPackage}
+     */
     package(params = {}) {
         return this.addPackage(params);
     }
 
-    addPackage(params = {}) {
+    /**
+     * Attach a smart contract package to this SuiMaster instance.
+     * 
+     * @param {Object} params - Configuration parameters
+     * @param {?string} [params.path] - Local filesystem path to the Move package source code
+     * @param {?string} [params.id] - ID or address of the Move package on the Sui blockchain
+     * @param {?Array.<string>|string} [params.modules] - List of modules in the package to look on chain in the UpgradeCap owned by current address
+     * 
+     * @returns {SuiPackage}
+     */
+    addPackage(params) {
         if (params.id && this._packages[params.id]) {
             return this._packages[params.id];
         }
@@ -249,13 +298,10 @@ export default class SuiMaster extends SuiCommonMethods {
 
         this._initialized = true;
 
-        // this._keypair = sui.Ed25519Keypair.deriveKeypair(this._phrase);
         if (!this._signer && this._keypair) { // we may optionally go without signer, to work in read-only mode
             this._signer = this._keypair;//
         }
 
-        // const publicKey = this._keypair.getPublicKey();
-        // this._address = publicKey.toSuiAddress();
         if (this._signer) {
             if (this._signer.toSuiAddress) {
                 this._address = this._signer.toSuiAddress();    // after Sui's refactor Keypair's method
@@ -325,6 +371,7 @@ export default class SuiMaster extends SuiCommonMethods {
             params.account = { address: this._address };
         }
 
+        /** @type {SuiTransactionBlockResponse} */ 
         let txResults = null;
         if (this._keypair) {
             params.signer = this._keypair;

package/lib/SuiObject.js

@@ -2,17 +2,33 @@ import SuiCommonMethods from './SuiCommonMethods.js';
 import SuiPaginatedResponse from './SuiPaginatedResponse.js';
 import { normalizeSuiAddress } from './SuiUtils.js';
 
+/**
+ * @typedef {import("./SuiMaster.js").default} SuiMaster
+ */
+
 export default class SuiObject extends SuiCommonMethods {
+    /**
+     * Sui Object representation
+     *
+     * @param {Object} params - parameters
+     * @param {SuiMaster} params.suiMaster - instance of SuiMaster
+     * @param {?string} [params.id] - ID or address on the sui blockchain
+     */
     constructor(params = {}) {
         super(params);
 
+        /** @type {SuiMaster} */
         this._suiMaster = params.suiMaster;
         if (!this._suiMaster) {
             throw new Error('suiMaster is requried for suiPackage');
         }
 
+        /** @type {string} */
         this._id = params.id || null;
         this._version = params.version || null;
+
+
+        /** @type {string} */
         this._type = params.type || null;
 
         this._fields = {};          //  on-chain fields on the object

package/lib/SuiPackage.js

@@ -5,7 +5,21 @@ import SuiPaginatedResponse from './SuiPaginatedResponse.js';
 import { Transaction } from '@mysten/sui/transactions';
 import { normalizeSuiAddress } from './SuiUtils.js';
 
+/**
+ * @typedef {import("./SuiMaster.js").default} SuiMaster
+ */
+
 export default class SuiPackage extends SuiObject {
+    /**
+     * Smart Contract Package on Sui blockchain
+     *
+     * @param {Object} params - Configuration parameters
+     * @param {SuiMaster} params.suiMaster - instance of SuiMaster
+     * @param {?string} [params.path] - Local filesystem path to the Move package source code
+     * @param {?string} [params.id] - ID or address of the Move package on the Sui blockchain
+     * @param {?Array.<string>|string} [params.modules] - List of modules in the package to look on chain in the UpgradeCap owned by current address
+     * @param {boolean} [params.debug] - Enable debug mode
+     */
     constructor(params = {}) {
         super(params);
 
@@ -13,8 +27,12 @@ export default class SuiPackage extends SuiObject {
         // this._id
         // this._suiMaster
 
+
+        /** @type {?string} */
         this._path = params.path;
+        /** @type {?string} */
         this._id = params.id || null;
+        /** @type {?Array.<string>|string} */
         this._expectedModules = params.modules || null;
 
         this._isPublished = false;
@@ -28,6 +46,7 @@ export default class SuiPackage extends SuiObject {
         this._builtDependencies = null;
         this._builtDigest = null;
 
+        /** @type {Object.<string, SuiPackageModule>} */
         this._modules = {
 
         };

package/lib/SuiPackageModule.js

@@ -246,13 +246,6 @@ export default class SuiPackageModule extends SuiCommonMethods {
         }
 
         return suiTransaction;
-
-        // return {
-        //     created: listCreated,
-        //     mutated: listMutated,
-        //     deleted: listDeleted,
-        //     status: status,
-        // };
     }
 
     async getOwnedObjects(params = {}) {

package/lib/SuiPaginatedResponse.js

@@ -24,7 +24,7 @@ export default class SuiPaginatedResponse extends SuiCommonMethods {
     /**
      * Simple itterator to go over all list of items, not caring about pagination/cursors etc. It fetches next page when needed
      * Optional maxLimit second parameter to stop when reached count
-     * @param {Function taking single argument of item} callbackFunc 
+     * @param {function} callbackFunc 
      * @param {Number} maxLimit 
      */
     async forEach(callbackFunc, maxLimit = null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suidouble",
-  "version": "1.38.0",
+  "version": "1.45.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",
   "type": "module",
@@ -22,8 +22,8 @@
   "author": "suidouble (https://github.com/suidouble)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@mysten/bcs": "^1.8.0",
-    "@mysten/sui": "^1.38.0",
+    "@mysten/bcs": "^1.9.2",
+    "@mysten/sui": "^1.45.0",
     "@polymedia/coinmeta": "^0.0.17",
     "@scure/bip39": "^1.6.0",
     "@wallet-standard/core": "^1.1.1",