Implemented v0.3.0-rc3 changes

.gitignore

@@ -3,4 +3,4 @@ node_modules
 package-lock.json
 .DS_Store
 **/tsconfig.tsbuildinfo
-**/*.js.map
+**/*.js.map

docs/source/conf.py

@@ -15,9 +15,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'v0.3.0-rc2'
+version = u'v0.3.0-rc3'
 # The full version, including alpha/beta/rc tags.
-release = u'v0.3.0-rc2'
+release = u'v0.3.0-rc3'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/constants.rst

@@ -18,7 +18,7 @@ js-moi-sdk package.
 
     console.log(moi.VERSION)
 
-    >> 0.3.0-rc2
+    >> 0.3.0-rc3
 
 MOI Derivation Path
 -------------------

docs/source/hierarchical-deterministic-wallet.rst

@@ -44,169 +44,125 @@ The ``Keystore`` interface represents a keystore object. It has the following pr
 
 Wallet
 ------
+
 A class representing a Hierarchical Deterministic Wallet that can sign interactions and manage accounts.
 
 .. code-block:: javascript
 
     // Example
-    const provider = new JsonRpcProvider("http://localhost:1600");
-    const wallet = new Wallet(provider);
+    const mnemonic = "hollow appear story text start mask salt social child ...";
 
-Methods
-~~~~~~~
+    const wallet = await Wallet.fromMnemonic(mnemonic);
 
-.. autofunction:: Wallet#load
 
-.. code-block:: javascript
+Creating Instances
+======================
 
-    // Example
-    const privateKey = Buffer.from("...")
-    wallet.load(privateKey, "secp256k1")
+- Create a wallet instance from private key
 
-.. autofunction:: Wallet#isInitialized
+    .. code-block:: javascript
 
-.. code-block:: javascript
+        const privateKey = "0x...";
 
-    // Example
-    const isInitialized = wallet.isInitialized();
-    console.log(isInitialized)
-
-    >> true
-
-.. autofunction:: Wallet#createRandom
+        const wallet = new Wallet(privateKey, CURVE.SECP256K1);
+
+-  Create a wallet instance from a mnemonic
 
-.. code-block:: javascript
+    .. code-block:: javascript
 
-    // Example
-    await wallet.createRandom();
+        const mnemonic = "hollow appear story text start mask salt social child ...";
 
-.. autofunction:: Wallet#generateKeystore
+        const wallet = await Wallet.fromMnemonic(mnemonic);
 
-.. code-block:: javascript
+- Create a wallet instance from JSON keystore
 
-    // Example
-    const keystore = await wallet.generateKeystore("CZ%90$DI");
-    console.log(keystore);
+    .. code-block:: javascript
 
-    // Output
-    /*
-        {
+        const keystore = `{
             "cipher": "aes-128-ctr",
             "ciphertext": "...",
             "cipherparams": {
                 "IV": "..."
             },
             "kdf": "scrypt",
             "kdfparams": {
-                ...
+                "n": 4096,
+                "r": 8,
+                "p": 1,
+                "dklen": 32,
+                "salt": "..."
             },
             "mac": "..."
-        }
-    */
+        }`;
+        const password = "YOUR_PASSWORD_HERE";
 
-.. autofunction:: Wallet#fromMnemonic
+        const wallet = await Wallet.fromKeystore(keystore, password);
 
-.. code-block:: javascript
-
-    // Example
-    const mnemonic = "hollow appear story text start mask salt social child ...";
-    const path = "m/44'/7567'/0'/0/1";
-    await wallet.fromMnemonic(mnemonic, path);
+- Create a wallet instance from a random mnemonic
 
-.. autofunction:: Wallet#fromKeystore
+    .. code-block:: javascript
 
-.. code-block:: javascript
+        const wallet = await Wallet.createRandom();
 
-    // Example
-    const keystore = {
-        "cipher": "aes-128-ctr",
-        "ciphertext": "...",
-        "cipherparams": {
-            "IV": "..."
-        },
-        "kdf": "scrypt",
-        "kdfparams": {
-            ...
-        },
-        "mac": "..."
-    }
-    wallet.fromKeystore(keystore, "CZ%90$DI");
+Properties
+======================
 
-.. autofunction:: Wallet#mnemonic
+- ``address`` - ``readonly`` ``string`` : The address of the wallet.
 
 .. code-block:: javascript
 
-    // Example
-    const mnemonic = wallet.mnemonic();
-    console.log(mnemonic);
-
-    >> hollow appear story text start mask salt social child ...
+    console.log(wallet.address);
+    >> "0x87925..."
 
-.. autofunction:: Wallet#privateKey
+- ``publicKey`` - ``readonly`` ``string``: The public key of the wallet.
 
 .. code-block:: javascript
 
-    // Example
-    const privateKey = wallet.privateKey();
-    console.log(privateKey);
+    console.log(wallet.publicKey);
+    >> "038792..."
 
-    >> 084384...
-
-.. autofunction:: Wallet#publicKey
+- ``privateKey`` - ``readonly`` ``string``: The private key of the wallet. 
 
 .. code-block:: javascript
 
-    // Example
-    const publicKey = wallet.publicKey();
-    console.log(publicKey);
-
-    >> 038792...
+    console.log(wallet.privateKey);
+    >> "0x87925..."
 
-.. autofunction:: Wallet#curve
+- ``mnemonic`` - ``readonly`` ``string``: The mnemonic of the wallet.
 
 .. code-block:: javascript
 
-    // Example
-    const curve = wallet.curve();
-    console.log(curve);
-
-    >> secp256k1
+    console.log(wallet.mnemonic);
+    >> "hollow appear story text start mask salt social child ..."
 
-.. autofunction:: Wallet#getAddress
+- ``curve`` - ``readonly`` ``string``: The curve of the wallet.
 
 .. code-block:: javascript
 
-    // Example
-    const address = wallet.getAddress();
-    console.log(address);
+    console.log(wallet.curve);
+    >> "secp256k1"
 
-    >> 0x87925...
 
-.. autofunction:: Wallet#connect
+Methods
+======================
 
-.. code-block:: javascript
+.. autofunction:: Wallet#sign
 
-    // Example
-    const provider = new VoyageProvider("babylon");
-    wallet.connect(provider);
 
-.. autofunction:: Wallet#sign
+**Example**
 
 .. code-block:: javascript
 
-    // Example
-    const message = "Hello, MOI";
-    const sigAlgo = wallet.signingAlgorithms["ecdsa_secp256k1"];
-    const signature = wallet.sign(Buffer.from(message), sigAlgo);
-    console.log(signature);
+  const message = "Hello, MOI";
+  const algo = wallet.signingAlgorithms["ecdsa_secp256k1"];
 
-    >> 0146304402201546497d46ed2ad7b1b77d1cdf383a28d988197bcad268be7163ebdf2f70645002207768e4225951c02a488713caf32d76ed8ea0bf3d7706128c59ee01788aac726402
+  const signature = wallet.sign(Buffer.from(message), algo);
+  >> "0146304402201546497d46ed2ad7b1b77d1cdf383a28d988197bcad268be7163ebdf2f70645002207768e4225951c02a488713caf32d76ed8ea0bf3d7706128c59ee..."
 
 .. autofunction:: Wallet#signInteraction
 
 .. code-block:: javascript
 
-    // Example
     const address = "0x870ad6c5150ea8c0355316974873313004c6b9425a855a06fff16f408b0e0a8b";
     const interaction = {
         type: IxType.ASSET_CREATE,
@@ -224,10 +180,22 @@ Methods
     const signedIxn = wallet.signInteraction(interaction, sigAlgo);
     console.log(signedIxn)
 
-    // Ouptut
+    // Output
     /*
         {
             ix_args:'0e9f0203131696049608900c900c930ca30cb60c03870ad6c5150ea8c0355316974873313004c6b9425a855a06fff16f408b0e0a8b0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001c80e7f063363636161604d4f49130d41',
             signature: '01463044022059e8e9839a02d2a0b2585e2267400826f91e575eb27cb89485d2deab697c5a34022020d71b2d3caa8c0b003849a2cb4effdbfd32028357db335549a75c82dd329f8902'
         }
     */
+
+.. autofunction:: Wallet#generateKeystore
+
+.. autofunction:: Wallet.fromMnemonic
+
+.. autofunction:: Wallet.fromMnemonicSync
+
+.. autofunction:: Wallet.fromKeystore
+
+.. autofunction:: Wallet.createRandom
+
+.. autofunction:: Wallet.createRandomSync

docs/source/logic.rst

@@ -128,9 +128,10 @@ applications on the MOI network.
     // Example
     const initWallet = async () => {
         const mnemonic = "mother clarify push liquid ordinary social track ...";
+        const wallet = await Wallet.fromMnemonic(mnemonic);
         const provider = new JsonRpcProvider("http://localhost:1600/");
-        const wallet = new Wallet(provider);
-        await wallet.fromMnemonic(mnemonic);
+        wallet.connect(provider);
+
         return wallet;
     }
 
@@ -220,16 +221,27 @@ Functions
     // Example
     const initWallet = async () => {
         const mnemonic = "mother clarify push liquid ordinary social track ...";
+        const wallet = await Wallet.fromMnemonic(mnemonic);
         const provider = new JsonRpcProvider("http://localhost:1600/");
-        const wallet = new Wallet(provider);
-        await wallet.fromMnemonic(mnemonic);
+
+        wallet.connect(provider);
+
         return wallet;
     }
 
     const logicId = "0x0800007d70c34ed6ec4384c75d469894052647a078b33ac0f08db0d3751c1fce29a49a";
     const wallet = await initWallet();
     const logicDriver = await getLogicDriver(logicId, wallet);
 
+.. warning::
+    When the logic driver is initialized with a provider,
+    any attempt to execute a mutating routine will trigger the SDK to
+    raise an exception. The error message associated with this exception
+    will state: **"Mutating routine calls require a signer to be initialized"**.
+    Developers should ensure they should pass signer instance while
+    doing mutating routine calls to avoid encountering this exception.
+
+
 Usage
 ~~~~~
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "moi",
-  "version": "0.3.0-rc2",
+  "version": "0.3.0-rc3",
   "description": "JavaScript library to interact with MOI Protocol via RPC API",
   "private": true,
   "main": "packages/js-moi/dist/index.js",

packages/js-moi-bip39/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-moi-bip39",
-  "version": "0.3.0-rc2",
+  "version": "0.3.0-rc3",
   "description": "Bitcoin BIP39 package for deterministic key generation using mnemonic code",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,10 +24,10 @@
   "author": "Sarva Labs Inc. & MOI Protocol Developers",
   "license": "Apache-2.0 OR MIT",
   "dependencies": {
-    "js-moi-hdnode": "^0.3.0-rc2",
-    "js-moi-signer": "^0.3.0-rc2",
-    "js-moi-constants": "^0.3.0-rc2",
-    "js-moi-utils": "^0.3.0-rc2",
+    "js-moi-hdnode": "^0.3.0-rc3",
+    "js-moi-signer": "^0.3.0-rc3",
+    "js-moi-constants": "^0.3.0-rc3",
+    "js-moi-utils": "^0.3.0-rc3",
     "buffer": "^6.0.3",
     "@noble/hashes": "^1.1.5"
   }

packages/js-moi-constants/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.3.0-rc2";
+export declare const VERSION = "0.3.0-rc3";

packages/js-moi-constants/dist/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "0.3.0-rc2";
+exports.VERSION = "0.3.0-rc3";

packages/js-moi-constants/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-moi-constants",
-  "version": "0.3.0-rc2",
+  "version": "0.3.0-rc3",
   "description": "Collection of constant variables used in js-moi-sdk",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

packages/js-moi-constants/src/version.ts

@@ -1 +1 @@
-export const VERSION = "0.3.0-rc2";
+export const VERSION = "0.3.0-rc3";

packages/js-moi-hdnode/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-moi-hdnode",
-  "version": "0.3.0-rc2",
+  "version": "0.3.0-rc3",
   "description": "BIP32 HD Node for cryptocurrency key management.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,7 +23,7 @@
   "author": "Sarva Labs Inc. & MOI Protocol Developers",
   "license": "Apache-2.0 OR MIT",
   "dependencies": {
-    "js-moi-utils": "^0.3.0-rc2",
+    "js-moi-utils": "^0.3.0-rc3",
     "buffer": "^6.0.3",
     "hdkey": "^2.1.0",
     "assert": "^2.0.0",