@leofcoin/contracts 0.1.0 → 0.1.2

package/exports/power-token.js

@@ -1,7 +1,205 @@
-import Token from '@leofcoin/standards/token.js'
-
-export default class Power extends Token {
-  constructor(state) {
-    super('Power', 'PWR', 18, state)
-  }
-}
+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);
+    }
+}
+
+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(from, amount) {
+        if (!this.hasRole(msg.sender, 'BURN'))
+            throw new Error('not allowed');
+        this.#totalSupply = this.#totalSupply.sub(amount);
+        this.#decreaseBalance(from, amount);
+    }
+    #beforeTransfer(from, to, amount) {
+        if (!this.#balances[from] || this.#balances[from] < 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' && 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 = 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);
+    }
+}
+
+class Power extends Token {
+    constructor(state) {
+        super('Power', 'PWR', 18, state);
+    }
+}
+
+export { Power as default };

package/exports/types.d.ts

@@ -0,0 +1,2 @@
+import globals from '@leofcoin/global-types';
+export default globals;

package/exports/validators.d.ts

@@ -0,0 +1,16 @@
+import Roles from '@leofcoin/standards/roles.js';
+export default class Validators extends Roles {
+    #private;
+    get state(): any;
+    constructor(tokenAddress: any, state: any);
+    get name(): string;
+    get currency(): any;
+    get validators(): {};
+    get totalValidators(): number;
+    get minimumBalance(): any;
+    changeCurrency(currency: any): void;
+    has(validator: any): boolean;
+    addValidator(validator: address): Promise<void>;
+    removeValidator(validator: any): void;
+    updateValidator(validator: any, active: any): Promise<void>;
+}

package/exports/validators.js

@@ -1,129 +1,197 @@
-import Roles from '@lefocoin/standards/roles.js'
-
-export default class Validators extends Roles {
-  /**
-   * string
-   */
-  #name = 'ArtOnlineValidators'
-  /**
-   * uint
-   */
-  #totalValidators = 0
-
-  #activeValidators = 0
-  /**
-   * Object => string(address) => Object
-   */
-  #validators = {}
-
-  #currency
-
-  #minimumBalance
-
-  get state() {
-    return {
-      ...super.state,
-      minimumBalance: this.#minimumBalance,
-      currency: this.#currency,
-      totalValidators: this.#totalValidators,
-      activeValidators: this.#activeValidators,
-      validators: this.#validators
-    }
-  }
-
-  constructor(tokenAddress, state) {
-    super(state?.roles)
-    if (state) {
-      this.#minimumBalance = state.minimumBalance
-      this.#currency = state.currency
-
-      this.#totalValidators = state.totalValidators
-      this.#activeValidators = state.activeValidators
-      this.#validators = state.validators
-    } else {
-      this.#minimumBalance = 50_000
-      this.#currency = tokenAddress
-
-      this.#totalValidators += 1
-      this.#activeValidators += 1
-      this.#validators[msg.sender] = {
-        firstSeen: Date.now(),
-        lastSeen: Date.now(),
-        active: true
-      }
-    }
-
-  }
-
-  get name() {
-    return this.#name
-  }
-
-  get currency() {
-    return this.#currency
-  }
-
-  get validators() {
-    return {...this.#validators}
-  }
-
-  get totalValidators() {
-    return this.#totalValidators
-  }
-
-  get minimumBalance() {
-    return this.#minimumBalance
-  }
-
-  changeCurrency(currency) {
-    if (!this.hasRole(msg.sender, 'OWNER')) throw new Error('not an owner')
-    this.#currency = currency
-  }
-
-  has(validator) {
-    return Boolean(this.#validators[validator] !== undefined)
-  }
-
-  #isAllowed(address) {
-    if (msg.sender !== address && !this.hasRole(msg.sender, 'OWNER')) throw new Error('sender is not the validator or owner')
-    return true
-  }
-
-  async addValidator(validator) {
-    this.#isAllowed(validator)
-    if (this.has(validator)) throw new Error('already a validator')
-    
-    const balance = await msg.staticCall(this.currency, 'balanceOf', [validator])
-
-    if (balance < this.minimumBalance) throw new Error(`balance to low! got: ${balance} need: ${this.#minimumBalance}`)
-
-    this.#totalValidators += 1
-    this.#activeValidators += 1
-    this.#validators[validator] = {
-      firstSeen: Date.now(),
-      lastSeen: Date.now(),
-      active: true
-    }
-  }
-
-  removeValidator(validator) {
-    this.#isAllowed(validator)
-    if (!this.has(validator)) throw new Error('validator not found')
-    
-    this.#totalValidators -= 1
-    if (this.#validators[validator].active) this.#activeValidators -= 1
-    delete this.#validators[validator]
-  }
-
-  async updateValidator(validator, active) {
-    this.#isAllowed(validator)
-    if (!this.has(validator)) throw new Error('validator not found')
-    const balance = await msg.staticCall(this.currency, 'balanceOf', [validator])
-    if (balance < this.minimumBalance && active) throw new Error(`balance to low! got: ${balance} need: ${this.#minimumBalance}`)
-    if (this.#validators[validator].active === active) throw new Error(`already ${active ? 'activated' : 'deactivated'}`)
-    if (active) this.#activeValidators += 1
-    else this.#activeValidators -= 1
-    /** minimum balance always needs to be met */
-    this.#validators[validator].active = active
-  }
-}
+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);
+    }
+}
+
+class Validators extends Roles {
+    /**
+     * string
+     */
+    #name = 'ArtOnlineValidators';
+    /**
+     * uint
+     */
+    #totalValidators = 0;
+    #activeValidators = 0;
+    /**
+     * Object => string(address) => Object
+     */
+    #validators = {};
+    #currency;
+    #minimumBalance;
+    get state() {
+        return {
+            ...super.state,
+            minimumBalance: this.#minimumBalance,
+            currency: this.#currency,
+            totalValidators: this.#totalValidators,
+            activeValidators: this.#activeValidators,
+            validators: this.#validators
+        };
+    }
+    constructor(tokenAddress, state) {
+        super(state?.roles);
+        if (state) {
+            this.#minimumBalance = state.minimumBalance;
+            this.#currency = state.currency;
+            this.#totalValidators = state.totalValidators;
+            this.#activeValidators = state.activeValidators;
+            this.#validators = state.validators;
+        }
+        else {
+            this.#minimumBalance = 50000;
+            this.#currency = tokenAddress;
+            this.#totalValidators += 1;
+            this.#activeValidators += 1;
+            this.#validators[msg.sender] = {
+                firstSeen: Date.now(),
+                lastSeen: Date.now(),
+                active: true
+            };
+        }
+    }
+    get name() {
+        return this.#name;
+    }
+    get currency() {
+        return this.#currency;
+    }
+    get validators() {
+        return { ...this.#validators };
+    }
+    get totalValidators() {
+        return this.#totalValidators;
+    }
+    get minimumBalance() {
+        return this.#minimumBalance;
+    }
+    changeCurrency(currency) {
+        if (!this.hasRole(msg.sender, 'OWNER'))
+            throw new Error('not an owner');
+        this.#currency = currency;
+    }
+    has(validator) {
+        return Boolean(this.#validators[validator] !== undefined);
+    }
+    #isAllowed(address) {
+        if (msg.sender !== address && !this.hasRole(msg.sender, 'OWNER'))
+            throw new Error('sender is not the validator or owner');
+        return true;
+    }
+    async addValidator(validator) {
+        this.#isAllowed(validator);
+        if (this.has(validator))
+            throw new Error('already a validator');
+        const balance = await msg.staticCall(this.currency, 'balanceOf', [validator]);
+        if (balance < this.minimumBalance)
+            throw new Error(`balance to low! got: ${balance} need: ${this.#minimumBalance}`);
+        this.#totalValidators += 1;
+        this.#activeValidators += 1;
+        this.#validators[validator] = {
+            firstSeen: Date.now(),
+            lastSeen: Date.now(),
+            active: true
+        };
+    }
+    removeValidator(validator) {
+        this.#isAllowed(validator);
+        if (!this.has(validator))
+            throw new Error('validator not found');
+        this.#totalValidators -= 1;
+        if (this.#validators[validator].active)
+            this.#activeValidators -= 1;
+        delete this.#validators[validator];
+    }
+    async updateValidator(validator, active) {
+        this.#isAllowed(validator);
+        if (!this.has(validator))
+            throw new Error('validator not found');
+        const balance = await msg.staticCall(this.currency, 'balanceOf', [validator]);
+        if (balance < this.minimumBalance && active)
+            throw new Error(`balance to low! got: ${balance} need: ${this.#minimumBalance}`);
+        if (this.#validators[validator].active === active)
+            throw new Error(`already ${active ? 'activated' : 'deactivated'}`);
+        if (active)
+            this.#activeValidators += 1;
+        else
+            this.#activeValidators -= 1;
+        /** minimum balance always needs to be met */
+        this.#validators[validator].active = active;
+    }
+}
+
+export { Validators as default };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@leofcoin/contracts",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "",
+  "type": "module",
   "exports": {
     "./factory": "./exports/factory.js",
     "./name-token": "./exports/name-token.js",
@@ -10,6 +11,7 @@
     "./validators": "./exports/validators.js"
   },
   "scripts": {
+    "build": "rollup -c",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -24,6 +26,13 @@
   },
   "homepage": "https://github.com/leofcoin/contracts#readme",
   "dependencies": {
-    "@leofcoin/standards": "^0.1.1"
+    "@leofcoin/global-types": "^1.0.0",
+    "@leofcoin/standards": "^0.1.2"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "rollup": "^3.17.2",
+    "tslib": "^2.5.0"
   }
 }

package/rollup.config.js

@@ -0,0 +1,67 @@
+import typescript from '@rollup/plugin-typescript'
+import tsConfig from './tsconfig.json' assert { type: 'json'}
+
+import resolve from '@rollup/plugin-node-resolve'
+
+
+export default [{
+  input: './src/factory.ts',
+  output: {
+    dir: './exports',
+    format: 'es'
+  },
+  plugins: [
+    resolve({
+      mainFields: ['exports']
+    }),
+    typescript(tsConfig)
+  ]
+}, {
+  input: './src/name-service.ts',
+  output: {
+    dir: './exports',
+    format: 'es'
+  },
+  plugins: [
+    resolve({
+      mainFields: ['exports']
+    }),
+    typescript(tsConfig)
+  ]
+}, {
+  input: './src/native-token.ts',
+  output: {
+    dir: './exports',
+    format: 'es'
+  },
+  plugins: [
+    resolve({
+      mainFields: ['exports']
+    }),
+    typescript(tsConfig)
+  ]
+}, {
+  input: './src/power-token.ts',
+  output: {
+    dir: './exports',
+    format: 'es'
+  },
+  plugins: [
+    resolve({
+      mainFields: ['exports']
+    }),
+    typescript(tsConfig)
+  ]
+}, {
+  input: './src/validators.ts',
+  output: {
+    dir: './exports',
+    format: 'es'
+  },
+  plugins: [
+    resolve({
+      mainFields: ['exports']
+    }),
+    typescript(tsConfig)
+  ]
+}]