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

@leofcoin/chain 1.0.13 → 1.0.14

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 (77) hide show

package/docs/@leofcoin/chain/1.0.13/standards_roles.js.html ADDED Viewed

@@ -0,0 +1,188 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>
+      standards/roles.js - 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">
+        standards/roles.js
+      </h1>
+<section>
+  <article>
+    <pre class="prettyprint source linenums"><code>export default class Roles {
+  /**
+   * Object => Array
+   */
+  #roles = {
+    'OWNER': [],
+    'MINT': [],
+    'BURN': []
+  }
+  constructor(roles) {
+    // allow devs to set their own roles but always keep the default ones included
+    // also allows roles to be loaded from the stateStore
+    // carefull when includin gthe roles make sure to add the owner
+    // since no roles are granted by default when using custom roles
+    if (roles) {
+      if (roles instanceof Object) {
+       this.#roles = {...roles, ...this.#roles}
+      } else {
+       throw new Error(`expected roles to be an object`)
+      }
+    } else {
+      // no roles given so default to the msg sender
+      this.#grantRole(msg.sender, 'OWNER')
+    }
+  }
+  get state() {
+    return { roles: this.roles }
+  }
+  get roles() {
+    return {...this.#roles}
+  }
+  hasRole(address, role) {
+    return this.#roles[role] ? this.#roles[role].indexOf(address) !== -1 : false
+  }
+  #grantRole(address, role) {
+    if (this.hasRole(address, role)) throw new Error(`${role} role already granted for ${address}`)
+    this.#roles[role].push(address)
+  }
+  #revokeRole(address, role) {
+    if (!this.hasRole(address, role)) throw new Error(`${role} role already revoked for ${address}`)
+    if (role === 'OWNER' &amp;&amp; this.#roles[role].length === 1) throw new Error(`atleast one owner is needed!`)
+    this.#roles[role].splice(this.#roles[role].indexOf(address))
+  }
+  grantRole(address, role) {
+    if (!this.hasRole(address, 'OWNER')) throw new Error('Not allowed')
+    this.#grantRole(address, role)
+  }
+  revokeRole(address, role) {
+    if (!this.hasRole(address, 'OWNER')) throw new Error('Not allowed')
+    this.#revokeRole(address, role)
+  }
+}
+</code></pre>
+  </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>

package/docs/@leofcoin/chain/1.0.13/standards_token.js.html ADDED Viewed

@@ -0,0 +1,260 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>
+      standards/token.js - 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">
+        standards/token.js
+      </h1>
+<section>
+  <article>
+    <pre class="prettyprint source linenums"><code>import Roles from './roles.js'
+export default class Token extends Roles {
+  /**
+   * string
+   */
+  #name
+  /**
+   * String
+   */
+  #symbol
+  /**
+   * uint
+   */
+  #holders = 0
+  /**
+   * Object => Object => uint
+   */
+  #balances = {}
+  /**
+   * Object => Object => uint
+   */
+  #approvals = {}
+  #decimals = 18
+  #totalSupply = BigNumber.from(0)
+    // this.#privateField2 = 1
+  constructor(name, symbol, decimals = 18, state) {
+    if (!name) throw new Error(`name undefined`)
+    if (!symbol) throw new Error(`symbol undefined`)
+    super(state?.roles)
+    this.#name = name
+    this.#symbol = symbol
+    this.#decimals = decimals
+  }
+  // enables snapshotting
+  // needs dev attention so nothing breaks after snapshot happens
+  // iow everything that is not static needs to be included in the stateObject
+  /**
+   * @return {Object} {holders, balances, ...}
+   */
+  get state() {
+    return {
+      ...super.state,
+      holders: this.holders,
+      balances: this.balances,
+      approvals: { ...this.#approvals },
+      totalSupply: this.totalSupply
+    }
+  }
+  get totalSupply() {
+    return this.#totalSupply
+  }
+  get name() {
+    return this.#name
+  }
+  get symbol() {
+    return this.#symbol
+  }
+  get holders() {
+    return this.#holders
+  }
+  get balances() {
+    return {...this.#balances}
+  }
+  mint(to, amount) {
+    if (!this.hasRole(msg.sender, 'MINT')) throw new Error('not allowed')
+    this.#totalSupply = this.#totalSupply.add(amount)
+    this.#increaseBalance(to, amount)
+  }
+  burn(to, amount) {
+    if (!this.hasRole(msg.sender, 'BURN')) throw new Error('not allowed')
+    this.#totalSupply = this.#totalSupply.sub(amount)
+    this.#decreaseBalance(to, amount)
+  }
+  #beforeTransfer(from, to, amount) {
+    if (!this.#balances[from] || this.#balances[from] &lt; amount) throw new Error('amount exceeds balance')
+  }
+  #updateHolders(address, previousBalance) {
+    if (this.#balances[address].toHexString() === '0x00') this.#holders -= 1
+    else if (this.#balances[address].toHexString() !== '0x00' &amp;&amp; previousBalance.toHexString() === '0x00') this.#holders += 1
+  }
+  #increaseBalance(address, amount) {
+    if (!this.#balances[address]) this.#balances[address] = BigNumber.from(0)
+    const previousBalance = this.#balances[address]
+    this.#balances[address] = this.#balances[address].add(amount)
+    this.#updateHolders(address, previousBalance)
+  }
+  #decreaseBalance(address, amount) {
+    const previousBalance = this.#balances[address]
+    this.#balances[address] = this.#balances[address].sub(amount)
+    this.#updateHolders(address, previousBalance)
+  }
+  balanceOf(address) {
+    return this.#balances[address]
+  }
+  setApproval(operator, amount) {
+    const owner = globalThis.msg.sender
+    if (!this.#approvals[owner]) this.#approvals[owner] = {}
+    this.#approvals[owner][operator] = amount
+  }
+  approved(owner, operator, amount) {
+    return this.#approvals[owner][operator] === amount
+  }
+  transfer(from, to, amount) {
+    // TODO: is BigNumber?
+    amount = BigNumber.from(amount)
+    this.#beforeTransfer(from, to, amount)
+    this.#decreaseBalance(from, amount)
+    this.#increaseBalance(to, amount)
+  }
+}
+</code></pre>
+  </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>

package/docs/@leofcoin/chain/1.0.13/styles/collapse.css ADDED Viewed

@@ -0,0 +1,27 @@
+@media only screen and (min-width: 681px) {
+  nav > ul > li:hover .methods,
+  .active .methods {
+    display: block;
+  }
+  .methods {
+    display: none;
+  }
+  nav > ul > li {
+    padding: 20px 0;
+  }
+  nav > ul > li > a {
+    padding: 0;
+  }
+  nav > ul > li.active a {
+    margin-bottom: 10px;
+  }
+  nav > ul > li:hover > a,
+  nav > ul > li.active > a {
+    margin-bottom: 15px;
+  }
+}