@leofcoin/chain 1.0.5 → 1.0.8

package/.jsdoc.json

@@ -0,0 +1,29 @@
+{
+    "tags": {
+      "allowUnknownTags": true,
+      "dictionaries": ["jsdoc"]
+    },
+    "source": {
+      "include": ["src", "package.json", "README.md"],
+      "includePattern": ".js$",
+      "excludePattern": "(node_modules/|docs)"
+    },
+    "plugins": [
+      "plugins/markdown"
+    ],
+    "templates": {
+        "referenceTitle": "@leofcoin/chain",
+        "disableSort": false,
+        "collapse": true,
+        "resources": {
+          "github": "https://github.com/arteontoken/monorepo/chain"
+        }
+    },
+    "opts": {
+        "destination": "./docs/",
+        "encoding": "utf8",
+        "private": true,
+        "recurse": true,
+        "template": "./node_modules/jsdoc-template"
+    }
+}

package/chain.js

@@ -2,7 +2,6 @@
 
 var bignumber = require('@ethersproject/bignumber');
 var units = require('@ethersproject/units');
-var chalk = require('chalk');
 require('vm');
 var protons = require('protons');
 var codecFormatInterface = require('@leofcoin/codec-format-interface');
@@ -10,17 +9,8 @@ require('@vandeurenglenn/base58');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
-var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
 var protons__default = /*#__PURE__*/_interopDefaultLegacy(protons);
 
-// import { promisify } from 'util'
-
-const info = text => console.log(chalk__default["default"].blueBright(text));
-
-const subinfo = text => console.log(chalk__default["default"].magentaBright(text));
-// export const write = promisify(writeFile)
-// export const read = promisify(readFile)
-
 var proto$4 = `
 message ContractMessage {
   required string creator = 1;
@@ -266,8 +256,8 @@ console.log(e);
       globalThis.msg = this.#createMessage(contractMessage.decoded.creator);
       // globalThis.msg = {sender: contractMessage.decoded.creator}
       this.#contracts[contractMessage.hash] = new Contract(...params);
-      info(`loaded contract: ${contractMessage.hash}`);
-      subinfo(`size: ${Math.round((contractMessage.encoded.length / 1024) * 100) / 100} kb`);
+      debug(`loaded contract: ${contractMessage.hash}`);
+      debug(`size: ${Math.round((contractMessage.encoded.length / 1024) * 100) / 100} kb`);
     } catch (e) {
       console.log(e);
       console.warn(`removing contract ${contractMessage.hash}`);
@@ -485,7 +475,7 @@ class Chain {
       console.log(this.#blocks);
       let blocksSynced = localIndex > 0 ? localIndex - index : index;
       blocksSynced += 1;
-      info(`synced ${blocksSynced} ${blocksSynced > 1 ? 'blocks' : 'block'}`);
+      debug(`synced ${blocksSynced} ${blocksSynced > 1 ? 'blocks' : 'block'}`);
 
       this.#blocks.length;
       (this.#blocks.length) - blocksSynced;
@@ -599,7 +589,7 @@ class Chain {
     this.#lastBlock = {hash: blockMessage.hash, ...blockMessage.decoded};
     await blockStore.put(blockMessage.hash, blockMessage.encoded);
     await chainStore.put('lastBlock', new TextEncoder().encode(blockMessage.hash));
-    info(`added block: ${blockMessage.hash}`);
+    debug(`added block: ${blockMessage.hash}`);
     let promises = [];
     let contracts = [];
     for (let transaction of blockMessage.decoded.transactions) {
@@ -798,6 +788,11 @@ class Chain {
    *
    * example: [hash]
    * createTransaction('0x0', 'createContract', [hash])
+   *
+   * @param {String} to - the contract address for the contract to interact with
+   * @param {String} method - the method/function to run
+   * @param {Array} params - array of paramters to apply to the contract method
+   * @param {Number} nonce - total transaction count [optional]
    */
   createTransaction(to, method, params, nonce) {
     return this.createTransactionFrom(peernet.id, to, method, params, nonce)
@@ -806,6 +801,12 @@ class Chain {
    * every tx done is trough contracts so no need for amount
    * data is undefined when nothing is returned
    * error is thrown on error so undefined data doesn't mean there is an error...
+   *
+   * @param {String} from - the sender address
+   * @param {String} to - the contract address for the contract to interact with
+   * @param {String} method - the method/function to run
+   * @param {Array} params - array of paramters to apply to the contract method
+   * @param {Number} nonce - total transaction count [optional]
    */
   async createTransactionFrom(from, to, method, params, nonce) {
     if (nonce === undefined) {
@@ -850,6 +851,7 @@ class Chain {
 
   /**
    *
+   * @param {String} contract - a contract string (see plugins/deployContract)
    */
   async deployContract(contract, params = []) {
     globalThis.msg = {sender: peernet.id, call: this.call};
@@ -919,6 +921,15 @@ class Chain {
     return this.#machine.deleteAll()
   }
 
+  /**
+   * lookup an address for a registered name using the builtin nameService
+   * @check nameService
+   *
+   * @param {String} - contractName
+   * @returns {String} - address
+   *
+   * @example chain.lookup('myCoolContractName') // qmqsfddfdgfg...
+   */
   lookup(name) {
     return this.call(lib.nameService, 'lookup', [name])
   }