@leofcoin/standards 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ArteonToken
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# standards
+> Contract standards
+
+standards used in leofcoin chain kinda like erc20's but the native coin included
+
+## install
+```sh
+npm i @leofcoin/standards
+```
+
+## usage
+```js
+import {Token} from '@leofcoin/standards'
+
+class myCoolToken extends Token {
+  constructor() {
+    super('myCoolToken', 'MCT', 18, state?)
+  }
+}
+```
+

package/exports/roles.js

@@ -0,0 +1,83 @@
+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 including the roles make sure to add the owner
+    // because no roles are granted by default when using custom roles
+    if (roles) {
+      if (roles instanceof Object) {
+       this.#roles = {...roles, ...this.#roles}
+      } else {
+       throw new TypeError(`expected roles to be an object`)
+      }
+    } else {
+      // no roles given so fallback to default to the msg sender
+      this.#grantRole(msg.sender, 'OWNER')
+    }
+  }
+
+  /**
+   *
+   */
+  get state() {
+    return { roles: this.roles }
+  }
+
+  get roles() {
+    return {...this.#roles}
+  }
+  /**
+   * @param {address} address 
+   * @param {string} role 
+   * @returns true | false
+   */
+  hasRole(address, role) {
+    return this.#roles[role] ? this.#roles[role].includes(address) : false
+  }
+
+  /**
+   * @private
+   * @param {address} address address to grant the role to
+   * @param {string} role role to give
+   */
+  #grantRole(address, role) {
+    if (this.hasRole(address, role)) throw new Error(`${role} role already granted for ${address}`)
+
+    this.#roles[role].push(address)
+  }
+
+  /**
+   * remove role for address
+   * @private
+   * @param {address} address address to revoke role from
+   * @param {string} role role to evoke
+   */
+  #revokeRole(address, role) {
+    if (!this.hasRole(address, role)) throw new Error(`${role} role already revoked for ${address}`)
+    if (role === 'OWNER' && 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)
+  }
+}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@leofcoin/standards",
+  "version": "0.1.0",
+  "description": "Contract standards",
+  "exports": {
+    "token": "./exports/token.js",
+    "roles": "./exports/roles.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ArteonToken/standards.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ArteonToken/standards/issues"
+  },
+  "homepage": "https://github.com/ArteonToken/standards#readme"
+}