@leofcoin/chain 1.0.6 → 1.0.9

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

@@ -788,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)
@@ -796,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) {
@@ -840,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};
@@ -909,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])
   }

package/dist/chain.browser.js

@@ -17908,6 +17908,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)
@@ -17916,6 +17921,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) {
@@ -17960,6 +17971,7 @@ class Chain {
 
   /**
    *
+   * @param {String} contract - a contract string (see plugins/deployContract)
    */
   async deployContract(contract, params = []) {
     globalThis.msg = {sender: peernet.id, call: this.call}
@@ -18029,6 +18041,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])
   }

package/dist/chain.js

@@ -788,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)
@@ -796,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) {
@@ -840,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};
@@ -909,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])
   }