npm - @leofcoin/chain - Versions diffs - 1.0.13 → 1.0.16 - Mend

@leofcoin/chain 1.0.13 → 1.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (173) hide show

package/docs/@leofcoin/chain/1.0.13/global.html ADDED Viewed

@@ -0,0 +1,1153 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>
+      Global - Documentation
+  </title>
+  <link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
+  <script>hljs.initHighlightingOnLoad();</script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
+  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+  <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+  <link type="text/css" rel="stylesheet" href="styles/collapse.css">
+  <!-- start Mixpanel -->
+  <script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,
+  0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
+  for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);
+  mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>
+  <!-- end Mixpanel -->
+</head>
+<body>
+  <svg style="display: none;">
+    <defs>
+      <symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
+          <path d="M0 0h24v24H0z" fill="none"/>
+          <path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
+      </symbol>
+    </defs>
+  </svg>
+  <input type="checkbox" id="nav-trigger" class="nav-trigger" />
+  <label for="nav-trigger" class="navicon-button x">
+    <div class="navicon"></div>
+  </label>
+  <label for="nav-trigger" class="overlay"></label>
+  <div class="top-nav-wrapper">
+    <ul>
+      <li >
+        <a href="index.html">
+            <svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
+              <path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
+              <path d="M0 0h24v24H0z" fill="none"/>
+            </svg>
+        </a>
+      </li>
+    </ul>
+  </div>
+  <nav>
+    <h3 class="reference-title">
+      @leofcoin/chain
+    </h3>
+      <h3>
+        Resources
+      </h3>
+        <a href="https://github.com/arteontoken/monorepo/chain">github</a>
+    <h3 id="global-nav">Global</h3><ul><li><a href="global.html#addContract">addContract</a></li><li><a href="global.html#createTransaction">createTransaction</a></li><li><a href="global.html#createTransactionFrom">createTransactionFrom</a></li><li><a href="global.html#deployContract">deployContract</a></li><li><a href="global.html#lookup">lookup</a></li><li><a href="global.html#state">state</a></li></ul>
+  </nav>
+  <div id="main">
+      <h1 class="page-title">
+        Global
+      </h1>
+<section>
+  <header>
+      <h2>
+      </h2>
+  </header>
+  <article>
+    <div class="container-overview">
+<dl class="details">
+</dl>
+    </div>
+        <h3 class="subsection-title">Members</h3>
+<h4 class="name" id="state">
+  <span class="type-signature"></span>state<span class="type-signature"></span>
+</h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+      <ul class="dummy">
+        <li>
+          <a href="standards_token.js.html">standards/token.js</a>, <a href="standards_token.js.html#line47">line 47</a>
+        </li>
+      </ul>
+    </dd>
+</dl>
+      <h3 class="subsection-title">Methods</h3>
+  <span class='name-container'>
+    <a class="link-icon" href="#addContract">
+      <svg height="20" width="20" style="fill: black;">
+        <use xlink:href="#linkIcon"></use>
+      </svg>
+    </a>
+    <h4 class="name" id="addContract">
+      <span class="type-signature">(async) </span>addContract<span class="signature">()</span><span class="type-signature"></span>
+    </h4>
+  </span>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+      <ul class="dummy">
+        <li>
+          <a href="machine.js.html">machine.js</a>, <a href="machine.js.html#line75">line 75</a>
+        </li>
+      </ul>
+    </dd>
+</dl>
+  <span class='name-container'>
+    <a class="link-icon" href="#createTransaction">
+      <svg height="20" width="20" style="fill: black;">
+        <use xlink:href="#linkIcon"></use>
+      </svg>
+    </a>
+    <h4 class="name" id="createTransaction">
+      <span class="type-signature"></span>createTransaction<span class="signature">(to, method, params, nonce)</span><span class="type-signature"></span>
+    </h4>
+  </span>
+  <div class="description">
+    <p>whenever method = createContract params should hold the contract hash</p>
+<p>example: [hash]
+createTransaction('0x0', 'createContract', [hash])</p>
+  </div>
+  <h5>Parameters:</h5>
+<table class="params">
+  <thead>
+    <tr>
+        <th>Name</th>
+      <th>Type</th>
+      <th class="last">Description</th>
+    </tr>
+  </thead>
+  <tbody>
+      <tr>
+          <td class="name"><code>to</code></td>
+        <td class="type">
+    <span class="param-type">
+      String
+    </span>
+        </td>
+        <td class="description last">
+          <p>the contract address for the contract to interact with</p>
+        </td>
+      </tr>
+      <tr>
+          <td class="name"><code>method</code></td>
+        <td class="type">
+    <span class="param-type">
+      String
+    </span>
+        </td>
+        <td class="description last">
+          <p>the method/function to run</p>
+        </td>
+      </tr>
+      <tr>
+          <td class="name"><code>params</code></td>
+        <td class="type">
+    <span class="param-type">
+      Array
+    </span>
+        </td>
+        <td class="description last">
+          <p>array of paramters to apply to the contract method</p>
+        </td>
+      </tr>
+      <tr>
+          <td class="name"><code>nonce</code></td>
+        <td class="type">
+    <span class="param-type">
+      Number
+    </span>
+        </td>
+        <td class="description last">
+          <p>total transaction count [optional]</p>
+        </td>
+      </tr>
+  </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+      <ul class="dummy">
+        <li>
+          <a href="chain.js.html">chain.js</a>, <a href="chain.js.html#line476">line 476</a>
+        </li>
+      </ul>
+    </dd>
+</dl>
+  <span class='name-container'>
+    <a class="link-icon" href="#createTransactionFrom">
+      <svg height="20" width="20" style="fill: black;">
+        <use xlink:href="#linkIcon"></use>
+      </svg>
+    </a>
+    <h4 class="name" id="createTransactionFrom">
+      <span class="type-signature">(async) </span>createTransactionFrom<span class="signature">(from, to, method, params, nonce)</span><span class="type-signature"></span>
+    </h4>
+  </span>
+  <div class="description">
+    <p>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...</p>
+  </div>
+  <h5>Parameters:</h5>
+<table class="params">
+  <thead>
+    <tr>
+        <th>Name</th>
+      <th>Type</th>
+      <th class="last">Description</th>
+    </tr>
+  </thead>
+  <tbody>
+      <tr>
+          <td class="name"><code>from</code></td>
+        <td class="type">
+    <span class="param-type">
+      String
+    </span>
+        </td>
+        <td class="description last">
+          <p>the sender address</p>
+        </td>
+      </tr>
+      <tr>
+          <td class="name"><code>to</code></td>
+        <td class="type">
+    <span class="param-type">
+      String
+    </span>
+        </td>
+        <td class="description last">
+          <p>the contract address for the contract to interact with</p>
+        </td>
+      </tr>
+      <tr>
+          <td class="name"><code>method</code></td>
+        <td class="type">
+    <span class="param-type">
+      String
+    </span>
+        </td>
+        <td class="description last">
+          <p>the method/function to run</p>
+        </td>
+      </tr>
+      <tr>
+          <td class="name"><code>params</code></td>
+        <td class="type">
+    <span class="param-type">
+      Array
+    </span>
+        </td>
+        <td class="description last">
+          <p>array of paramters to apply to the contract method</p>
+        </td>
+      </tr>
+      <tr>
+          <td class="name"><code>nonce</code></td>
+        <td class="type">
+    <span class="param-type">
+      Number
+    </span>
+        </td>
+        <td class="description last">
+          <p>total transaction count [optional]</p>
+        </td>
+      </tr>
+  </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+      <ul class="dummy">
+        <li>
+          <a href="chain.js.html">chain.js</a>, <a href="chain.js.html#line490">line 490</a>
+        </li>
+      </ul>
+    </dd>
+</dl>
+  <span class='name-container'>
+    <a class="link-icon" href="#deployContract">
+      <svg height="20" width="20" style="fill: black;">
+        <use xlink:href="#linkIcon"></use>
+      </svg>
+    </a>
+    <h4 class="name" id="deployContract">
+      <span class="type-signature">(async) </span>deployContract<span class="signature">(contract)</span><span class="type-signature"></span>
+    </h4>
+  </span>
+  <h5>Parameters:</h5>
+<table class="params">
+  <thead>
+    <tr>
+        <th>Name</th>
+      <th>Type</th>
+      <th class="last">Description</th>
+    </tr>
+  </thead>
+  <tbody>
+      <tr>
+          <td class="name"><code>contract</code></td>
+        <td class="type">
+    <span class="param-type">
+      String
+    </span>
+        </td>
+        <td class="description last">
+          <p>a contract string (see plugins/deployContract)</p>
+        </td>
+      </tr>
+  </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+      <ul class="dummy">
+        <li>
+          <a href="chain.js.html">chain.js</a>, <a href="chain.js.html#line535">line 535</a>
+        </li>
+      </ul>
+    </dd>
+</dl>
+  <span class='name-container'>
+    <a class="link-icon" href="#lookup">
+      <svg height="20" width="20" style="fill: black;">
+        <use xlink:href="#linkIcon"></use>
+      </svg>
+    </a>
+    <h4 class="name" id="lookup">
+      <span class="type-signature"></span>lookup<span class="signature">(name)</span><span class="type-signature"> &rarr; {String}</span>
+    </h4>
+  </span>
+  <div class="description">
+    <p>lookup an address for a registered name using the builtin nameService</p>
+  </div>
+  <h5>Parameters:</h5>
+<table class="params">
+  <thead>
+    <tr>
+        <th>Name</th>
+      <th>Type</th>
+      <th class="last">Description</th>
+    </tr>
+  </thead>
+  <tbody>
+      <tr>
+          <td class="name"><code>name</code></td>
+        <td class="type">
+    <span class="param-type">
+      String
+    </span>
+        </td>
+        <td class="description last">
+          <p>contractName</p>
+        </td>
+      </tr>
+  </tbody>
+</table>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+      <ul class="dummy">
+        <li>
+          <a href="chain.js.html">chain.js</a>, <a href="chain.js.html#line612">line 612</a>
+        </li>
+      </ul>
+    </dd>
+</dl>
+  <div class="example-container">
+    <a class="link-icon" href="#lookup-examples">
+      <svg height="20" width="20" style="fill: black;">
+        <use xlink:href="#linkIcon"></use>
+      </svg>
+    </a>
+    <h5 id="lookup-examples">Example</h5>
+  <pre class="prettyprint"><code>chain.lookup('myCoolContractName') // qmqsfddfdgfg...</code></pre>
+  </div>
+  </article>
+</section>
+  </div>
+  <br class="clear">
+  <footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
+  </footer>
+  <script src="scripts/linenumber.js"></script>
+  <script src="scripts/pagelocation.js"></script>
+</body>
+</html>