@leofcoin/standards 0.2.2 → 0.2.4

package/.changeset/config.json

@@ -1,11 +1,11 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": true,
-  "fixed": [],
-  "linked": [],
-  "access": "public",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": true,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/exports/contract-creator.d.ts

@@ -0,0 +1,10 @@
+export type ContractCreatorState = {
+    contractCreator: address;
+};
+export default class ContractCreator {
+    #private;
+    constructor(state: ContractCreatorState);
+    get _contractCreator(): string;
+    get state(): ContractCreatorState;
+    get _isContractCreator(): boolean;
+}

package/exports/contract-creator.js

@@ -0,0 +1,20 @@
+class ContractCreator {
+    #creator;
+    constructor(state) {
+        if (state)
+            this.#creator = state.contractCreator;
+        else
+            this.#creator = msg.sender;
+    }
+    get _contractCreator() {
+        return this.#creator;
+    }
+    get state() {
+        return { contractCreator: this.#creator };
+    }
+    get _isContractCreator() {
+        return msg.sender === this.#creator;
+    }
+}
+
+export { ContractCreator as default };

package/exports/index.js

@@ -4,3 +4,4 @@ export { default as TokenReceiver } from './token-receiver.js';
 export { default as PublicVoting } from './public-voting.js';
 export { default as PrivateVoting } from './private-voting.js';
 export { restoreApprovals, restoreBalances } from './helpers.js';
+import './contract-creator.js';

package/exports/roles.d.ts

@@ -1,12 +1,16 @@
-export default class Roles {
-    #private;
-    constructor(roles: {
+import ContractCreator, { ContractCreatorState } from './contract-creator.js';
+export interface RolesState extends ContractCreatorState {
+    roles: {
         [index: string]: address[];
-    });
+    };
+}
+export default class Roles extends ContractCreator {
+    #private;
+    constructor(state: any);
     /**
      *
      */
-    get state(): {};
+    get state(): RolesState;
     get roles(): {};
     /**
      * @param {address} address

package/exports/roles.js

@@ -1,4 +1,6 @@
-class Roles {
+import ContractCreator from './contract-creator.js';
+
+class Roles extends ContractCreator {
     /**
      * Object => Array
      */
@@ -7,14 +9,15 @@ class Roles {
         MINT: [],
         BURN: []
     };
-    constructor(roles) {
+    constructor(state) {
+        super(state);
         // 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 };
+        if (state.roles) {
+            if (state.roles instanceof Object) {
+                this.#roles = { ...state.roles, ...this.#roles };
             }
             else {
                 throw new TypeError(`expected roles to be an object`);
@@ -29,7 +32,7 @@ class Roles {
      *
      */
     get state() {
-        return { roles: this.roles };
+        return { ...super.state, roles: this.roles };
     }
     get roles() {
         return { ...this.#roles };

package/exports/token-receiver.d.ts

@@ -40,6 +40,7 @@ export default class TokenReceiver extends PublicVoting implements IPublicVoting
      * @returns {boolean} promise
      */
     _burnTokenToReceive(): Promise<boolean>;
+    _canPay(): Promise<any>;
     changeVoteType(type: TokenReceiverState['voteType']): Promise<void>;
     getTokensOut(amount: typeof BigNumber, receiver: address): void;
     changeTokenAmountToReceive(): void;

package/exports/token-receiver.js

@@ -76,6 +76,10 @@ class TokenReceiver extends PublicVoting {
     async _burnTokenToReceive() {
         return msg.staticCall(this.#tokenToReceive, 'burn', [this.#tokenAmountToReceive]);
     }
+    async _canPay() {
+        const amount = await msg.call(this.#tokenToReceive, 'balance', []);
+        return amount.gte(this.tokenAmountToReceive);
+    }
     #changeTokenToReceive(address) {
         this.#tokenToReceive = address;
     }

package/exports/token.js

@@ -1,5 +1,6 @@
 import { restoreBalances, restoreApprovals } from './helpers.js';
 import Roles from './roles.js';
+import './contract-creator.js';
 
 class Token extends Roles {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leofcoin/standards",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Contract standards",
   "type": "module",
   "exports": {
@@ -24,6 +24,10 @@
       "import": "./exports/private-voting.js",
       "types": "./exports/private-voting.d.ts"
     },
+    "./contract-creator": {
+      "import": "./exports/contract-creator.js",
+      "types": "./exports/contract-creator.d.ts"
+    },
     "./token-receiver": {
       "import": "./exports/token-receiver.js",
       "types": "./exports/token-receiver.d.ts"
@@ -39,6 +43,7 @@
     "./roles.js": "./exports/roles.js",
     "./public-voting.js": "./exports/public-voting.js",
     "./private-voting.js": "./exports/private-voting.js",
+    "./contract-creator.js": "./exports/contract-creator.js",
     "./helpers.js": "./exports/helpers.js"
   },
   "scripts": {

package/rollup.config.js

@@ -16,6 +16,7 @@ export default [
       'src/voting/public-voting.ts',
       'src/voting/private-voting.ts',
       'src/helpers.ts',
+      'src/contract-creator.ts',
       'src/token-receiver.ts'
     ],
     output: {

package/src/contract-creator.ts

@@ -0,0 +1,24 @@
+export type ContractCreatorState = {
+  contractCreator: address
+}
+
+export default class ContractCreator {
+  #creator: address
+
+  constructor(state: ContractCreatorState) {
+    if (state) this.#creator = state.contractCreator
+    else this.#creator = msg.sender
+  }
+
+  get _contractCreator() {
+    return this.#creator
+  }
+
+  get state(): ContractCreatorState {
+    return { contractCreator: this.#creator }
+  }
+
+  get _isContractCreator() {
+    return msg.sender === this.#creator
+  }
+}

package/src/roles.ts

@@ -1,4 +1,10 @@
-export default class Roles {
+import ContractCreator, { ContractCreatorState } from './contract-creator.js'
+
+export interface RolesState extends ContractCreatorState {
+  roles: { [index: string]: address[] }
+}
+
+export default class Roles extends ContractCreator {
   /**
    * Object => Array
    */
@@ -8,14 +14,15 @@ export default class Roles {
     BURN: []
   }
 
-  constructor(roles: { [index: string]: address[] }) {
+  constructor(state) {
+    super(state)
     // 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 }
+    if (state.roles) {
+      if (state.roles instanceof Object) {
+        this.#roles = { ...state.roles, ...this.#roles }
       } else {
         throw new TypeError(`expected roles to be an object`)
       }
@@ -28,8 +35,8 @@ export default class Roles {
   /**
    *
    */
-  get state(): {} {
-    return { roles: this.roles }
+  get state(): RolesState {
+    return { ...super.state, roles: this.roles }
   }
 
   get roles(): {} {

package/src/token-receiver.ts

@@ -98,6 +98,11 @@ export default class TokenReceiver extends PublicVoting implements IPublicVoting
     return msg.staticCall(this.#tokenToReceive, 'burn', [this.#tokenAmountToReceive])
   }
 
+  async _canPay() {
+    const amount = await msg.call(this.#tokenToReceive, 'balance', [])
+    return amount.gte(this.tokenAmountToReceive)
+  }
+
   #changeTokenToReceive(address: address) {
     this.#tokenToReceive = address
   }