@leofcoin/standards 0.1.8 → 0.2.1

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +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": []
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @leofcoin/standards
+
+## 0.2.1
+
+### Patch Changes
+
+- 6073f7d: interface/public-voting -> interfaces/i-public-voting
+
+## 0.2.0
+
+### Minor Changes
+
+- Add voting & tokenReceiver

package/README.md

@@ -1,21 +1,23 @@
 # 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'
+import { Token } from '@leofcoin/standards'
 
 class myCoolToken extends Token {
-  constructor() {
-    super('myCoolToken', 'MCT', 18, state?)
+  constructor(state) {
+    super('myCoolToken', 'MCT', 18, state)
   }
 }
 ```
-

package/exports/public-voting.js

@@ -1,13 +1,11 @@
-import TokenReceiver from './token-receiver.js';
-
 /**
  * allows everybody that has a balance greater or equeal then/to tokenAmountToReceive to vote
  */
-class PublicVoting extends TokenReceiver {
+class PublicVoting {
     #votes;
     #votingDisabled;
-    constructor(tokenToReceive, tokenAmountToReceive, state) {
-        super(tokenToReceive, tokenAmountToReceive, state);
+    #votingDuration = 172800000;
+    constructor(state) {
         if (state) {
             this.#votes = state.votes;
             this.#votingDisabled = state.votingDisabled;
@@ -16,6 +14,9 @@ class PublicVoting extends TokenReceiver {
     get votes() {
         return { ...this.#votes };
     }
+    get votingDuration() {
+        return this.#votingDuration;
+    }
     get votingDisabled() {
         return this.#votingDisabled;
     }
@@ -23,7 +24,7 @@ class PublicVoting extends TokenReceiver {
      *
      */
     get state() {
-        return { ...super.state, votes: this.#votes, votingDisabled: this.#votingDisabled };
+        return { votes: this.#votes, votingDisabled: this.#votingDisabled, votingDuration: this.#votingDuration };
     }
     get inProgress() {
         return Object.entries(this.#votes)
@@ -40,7 +41,7 @@ class PublicVoting extends TokenReceiver {
      * @param {string} method function to run when agree amount is bigger
      */
     createVote(title, description, endTime, method, args = []) {
-        if (!this.canVote(msg.sender))
+        if (!this.#canVote())
             throw new Error(`Not allowed to create a vote`);
         const id = crypto.randomUUID();
         this.#votes[id] = {
@@ -51,8 +52,13 @@ class PublicVoting extends TokenReceiver {
             args
         };
     }
-    canVote(address) {
-        return this.canPay();
+    #canVote() {
+        // @ts-expect-error
+        return this._canVote?.();
+    }
+    #beforeVote() {
+        // @ts-expect-error
+        return this._beforeVote?.();
     }
     #endVoting(voteId) {
         let agree = Object.values(this.#votes[voteId].results).filter((result) => result === 1);
@@ -72,22 +78,22 @@ class PublicVoting extends TokenReceiver {
             this.#endVoting(voteId);
         if (ended)
             throw new Error('voting already ended');
-        if (!this.canVote(msg.sender))
+        if (!this.#canVote())
             throw new Error(`Not allowed to vote`);
-        await msg.staticCall(this.tokenToReceive, 'burn', [this.tokenAmountToReceive]);
+        await this.#beforeVote();
         this.#votes[voteId][msg.sender] = vote;
     }
     #disableVoting() {
         this.#votingDisabled = true;
     }
     disableVoting() {
-        if (!this.canVote(msg.sender))
+        if (!this.#canVote())
             throw new Error('not a allowed');
         else {
-            this.createVote(`disable voting`, `Warning this disables all voting features forever`, new Date().getTime() + 172800000, '#disableVoting', []);
+            this.createVote(`disable voting`, `Warning this disables all voting features forever`, new Date().getTime() + this.#votingDuration, '#disableVoting', []);
         }
     }
-    sync() {
+    _sync() {
         for (const vote of this.inProgress) {
             if (vote.endTime < new Date().getTime())
                 this.#endVoting(vote.id);

package/exports/token-receiver.d.ts

@@ -1,19 +1,47 @@
-export interface TokenReceiverState {
+import { IPublicVoting } from './voting/interfaces/public-voting.js';
+import PublicVoting from './voting/public-voting.js';
+import { VotingState } from './voting/types.js';
+export interface TokenReceiverState extends VotingState {
     tokenToReceive: address;
+    tokenReceiver: address;
     tokenAmountToReceive: typeof BigNumber;
+    voteType: 'burn' | 'transfer';
 }
-export default class TokenReceiver {
+export default class TokenReceiver extends PublicVoting implements IPublicVoting {
     #private;
-    constructor(tokenToReceive: address, tokenAmountToReceive: typeof BigNumber, state: TokenReceiverState);
+    constructor(tokenToReceive: address, tokenAmountToReceive: typeof BigNumber, burns: boolean, state?: TokenReceiverState);
     get tokenToReceive(): string;
     get tokenAmountToReceive(): import("@ethersproject/bignumber").BigNumber;
+    get tokenReceiver(): string;
     get state(): {
+        tokenReceiver: string;
         tokenToReceive: string;
         tokenAmountToReceive: import("@ethersproject/bignumber").BigNumber;
+        voteType: "burn" | "transfer";
+        votes: {
+            [id: string]: import("./voting/types.js").Vote;
+        };
+        votingDisabled: boolean;
+        votingDuration: number;
     };
     /**
      * check if sender can pay
      * @returns {boolean} promise
      */
-    canPay(): Promise<boolean>;
+    _canVote(): Promise<boolean>;
+    _beforeVote(): Promise<any>;
+    /**
+     * check if sender can pay
+     * @returns {boolean} promise
+     */
+    _payTokenToReceive(): Promise<boolean>;
+    /**
+     * check if sender can pay
+     * @returns {boolean} promise
+     */
+    _burnTokenToReceive(): Promise<boolean>;
+    changeVoteType(type: TokenReceiverState['voteType']): Promise<void>;
+    getTokensOut(amount: typeof BigNumber, receiver: address): void;
+    changeTokenAmountToReceive(): void;
+    changeTokenToReceive(): Promise<void>;
 }

package/exports/token-receiver.js

@@ -1,14 +1,24 @@
-class TokenReceiver {
+import PublicVoting from './public-voting.js';
+
+class TokenReceiver extends PublicVoting {
     #tokenToReceive;
     #tokenAmountToReceive;
-    constructor(tokenToReceive, tokenAmountToReceive, state) {
+    #tokenReceiver;
+    #voteType = 'transfer';
+    constructor(tokenToReceive, tokenAmountToReceive, burns, state) {
+        super(state);
         if (state) {
+            this.#tokenReceiver = state.tokenReceiver;
             this.#tokenToReceive = state.tokenToReceive;
             this.#tokenAmountToReceive = BigNumber['from'](state.tokenAmountToReceive);
+            this.#voteType = state.voteType;
         }
         else {
+            this.#tokenReceiver = msg.contract;
             this.#tokenToReceive = tokenToReceive;
             this.#tokenAmountToReceive = BigNumber['from'](tokenAmountToReceive);
+            if (burns)
+                this.#voteType = 'burn';
         }
     }
     get tokenToReceive() {
@@ -17,19 +27,101 @@ class TokenReceiver {
     get tokenAmountToReceive() {
         return this.#tokenAmountToReceive;
     }
+    get tokenReceiver() {
+        return this.#tokenReceiver;
+    }
     get state() {
         return {
+            ...super.state,
+            tokenReceiver: this.#tokenReceiver,
             tokenToReceive: this.#tokenToReceive,
-            tokenAmountToReceive: this.#tokenAmountToReceive
+            tokenAmountToReceive: this.#tokenAmountToReceive,
+            voteType: this.#voteType
         };
     }
+    async #canVote() {
+        const amount = (await msg.staticCall(this.#tokenToReceive, 'balanceOf', [msg.sender]));
+        return amount.gte(this.#tokenAmountToReceive);
+    }
     /**
      * check if sender can pay
      * @returns {boolean} promise
      */
-    async canPay() {
-        const amount = (await msg.staticCall(this.#tokenToReceive, 'balanceOf', [msg.sender]));
-        return amount.gte(this.#tokenAmountToReceive);
+    async _canVote() {
+        return this.#canVote();
+    }
+    async #beforeVote() {
+        if (this.#voteType === 'burn')
+            return msg.staticCall(this.tokenToReceive, 'burn', [this.tokenAmountToReceive]);
+        return msg.staticCall(this.tokenToReceive, 'transfer', [msg.sender, this.tokenReceiver, this.tokenAmountToReceive]);
+    }
+    async _beforeVote() {
+        await this.#beforeVote();
+    }
+    /**
+     * check if sender can pay
+     * @returns {boolean} promise
+     */
+    async _payTokenToReceive() {
+        return msg.staticCall(this.#tokenToReceive, 'transfer', [
+            msg.sender,
+            this.#tokenReceiver,
+            this.#tokenAmountToReceive
+        ]);
+    }
+    /**
+     * check if sender can pay
+     * @returns {boolean} promise
+     */
+    async _burnTokenToReceive() {
+        return msg.staticCall(this.#tokenToReceive, 'burn', [this.#tokenAmountToReceive]);
+    }
+    #changeTokenToReceive(address) {
+        this.#tokenToReceive = address;
+    }
+    #changeTokenAmountToReceive(amount) {
+        this.#tokenAmountToReceive = amount;
+    }
+    #changeVoteType(type) {
+        this.#voteType = type;
+    }
+    #getTokensOut(amount, receiver) {
+        return msg.call(this.#tokenReceiver, 'transfer', [this.#tokenReceiver, receiver, amount]);
+    }
+    async changeVoteType(type) {
+        if (!this.#canVote())
+            throw new Error('not a allowed');
+        if (this.#voteType === 'transfer' && (await this.#balance()).gt(0))
+            throw new Error('get tokens out first or they be lost forever');
+        else {
+            this.createVote(`change the token amount to receive`, `set tokenAmountToReceive`, new Date().getTime() + this.votingDuration, '#changeVoteType', [type]);
+        }
+    }
+    getTokensOut(amount, receiver) {
+        if (!this.#canVote())
+            throw new Error('not a allowed');
+        else {
+            this.createVote(`withdraw all tokens`, `withdraw all tokens to ${receiver}`, new Date().getTime() + this.votingDuration, '#getTokensOut', [amount, receiver]);
+        }
+    }
+    changeTokenAmountToReceive() {
+        if (!this.#canVote())
+            throw new Error('not a allowed');
+        else {
+            this.createVote(`change the token amount to receive`, `set tokenAmountToReceive`, new Date().getTime() + this.votingDuration, '#changeTokenAmountToReceive', []);
+        }
+    }
+    #balance() {
+        return msg.staticCall(this.#tokenToReceive, 'balanceOf', [this.#tokenReceiver]);
+    }
+    async changeTokenToReceive() {
+        if (!this.#canVote())
+            throw new Error('not a allowed');
+        if (!(await this.#balance()).eq(0) && this.#voteType === 'transfer')
+            throw new Error('get tokens out first or they be lost forever');
+        else {
+            this.createVote(`change the token to receive`, `set tokenToReceive to a new address`, new Date().getTime() + this.votingDuration, '#changeTokenToReceive', []);
+        }
     }
 }
 

package/exports/token.d.ts

@@ -26,9 +26,15 @@ export default class Token extends Roles {
     get symbol(): string;
     get holders(): {};
     get balances(): {};
+    get approvals(): {
+        [owner: string]: {
+            [operator: string]: import("@ethersproject/bignumber").BigNumber;
+        };
+    };
     get decimals(): number;
     mint(to: address, amount: BigNumberish): void;
     burn(from: address, amount: BigNumberish): void;
+    balance(): any;
     balanceOf(address: address): BigNumberish;
     setApproval(operator: address, amount: BigNumberish): void;
     approved(owner: address, operator: address, amount: BigNumberish): boolean;

package/exports/token.js

@@ -73,6 +73,9 @@ class Token extends Roles {
     get balances() {
         return { ...this.#balances };
     }
+    get approvals() {
+        return this.#approvals;
+    }
     get decimals() {
         return this.#decimals;
     }
@@ -110,6 +113,9 @@ class Token extends Roles {
         this.#balances[address] = this.#balances[address].sub(amount);
         this.#updateHolders(address, previousBalance);
     }
+    balance() {
+        return this.#balances[msg.sender];
+    }
     balanceOf(address) {
         return this.#balances[address];
     }

package/exports/voting/interfaces/public-voting.d.ts

@@ -0,0 +1,4 @@
+export interface IPublicVoting {
+    _canVote(): Promise<any>;
+    _beforeVote(): Promise<any>;
+}

package/exports/voting/private-voting.d.ts

@@ -1,116 +1,14 @@
-export type VoteResult = 0 | 0.5 | 1;
-export type Vote = {
-    title: string;
-    method: string;
-    args: any[];
-    description: string;
-    endTime: EpochTimeStamp;
-    results?: {
-        [address: address]: VoteResult;
-    };
-    finished?: boolean;
-    enoughVotes?: boolean;
-};
-export type PrivateVotingState = {
-    voters: address[];
-    votes: {
-        [id: string]: Vote;
-    };
-    votingDisabled: boolean;
-};
-export interface VoteView extends Vote {
-    id: string;
+import { VoteResult, VoteView, VotingState } from './types.js';
+export interface PrivateVotingState extends VotingState {
+    voters: any;
 }
 export default class PrivateVoting {
     #private;
     constructor(state: PrivateVotingState);
     get votes(): {
-        [x: string]: Vote;
-    };
-    get voters(): {
-        [x: number]: string;
-        length: number;
-        toString(): string;
-        toLocaleString(): string;
-        pop(): string;
-        push(...items: string[]): number;
-        concat(...items: ConcatArray<string>[]): string[];
-        concat(...items: (string | ConcatArray<string>)[]): string[];
-        join(separator?: string): string;
-        reverse(): string[];
-        shift(): string;
-        slice(start?: number, end?: number): string[];
-        sort(compareFn?: (a: string, b: string) => number): string[];
-        splice(start: number, deleteCount?: number): string[];
-        splice(start: number, deleteCount: number, ...items: string[]): string[];
-        unshift(...items: string[]): number;
-        indexOf(searchElement: string, fromIndex?: number): number;
-        lastIndexOf(searchElement: string, fromIndex?: number): number;
-        every<S extends string>(predicate: (value: string, index: number, array: string[]) => value is S, thisArg?: any): this is S[];
-        every(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean;
-        some(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): boolean;
-        forEach(callbackfn: (value: string, index: number, array: string[]) => void, thisArg?: any): void;
-        map<U>(callbackfn: (value: string, index: number, array: string[]) => U, thisArg?: any): U[];
-        filter<S_1 extends string>(predicate: (value: string, index: number, array: string[]) => value is S_1, thisArg?: any): S_1[];
-        filter(predicate: (value: string, index: number, array: string[]) => unknown, thisArg?: any): string[];
-        reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
-        reduce(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduce<U_1>(callbackfn: (previousValue: U_1, currentValue: string, currentIndex: number, array: string[]) => U_1, initialValue: U_1): U_1;
-        reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string): string;
-        reduceRight(callbackfn: (previousValue: string, currentValue: string, currentIndex: number, array: string[]) => string, initialValue: string): string;
-        reduceRight<U_2>(callbackfn: (previousValue: U_2, currentValue: string, currentIndex: number, array: string[]) => U_2, initialValue: U_2): U_2;
-        find<S_2 extends string>(predicate: (value: string, index: number, obj: string[]) => value is S_2, thisArg?: any): S_2;
-        find(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): string;
-        findIndex(predicate: (value: string, index: number, obj: string[]) => unknown, thisArg?: any): number;
-        fill(value: string, start?: number, end?: number): string[];
-        copyWithin(target: number, start: number, end?: number): string[];
-        entries(): IterableIterator<[number, string]>;
-        keys(): IterableIterator<number>;
-        values(): IterableIterator<string>;
-        includes(searchElement: string, fromIndex?: number): boolean;
-        flatMap<U_3, This = undefined>(callback: (this: This, value: string, index: number, array: string[]) => U_3 | readonly U_3[], thisArg?: This): U_3[];
-        flat<A, D extends number = 1>(this: A, depth?: D): FlatArray<A, D>[];
-        at(index: number): string;
-        [Symbol.iterator](): IterableIterator<string>;
-        [Symbol.unscopables]: {
-            [x: number]: boolean;
-            length?: boolean;
-            toString?: boolean;
-            toLocaleString?: boolean;
-            pop?: boolean;
-            push?: boolean;
-            concat?: boolean;
-            join?: boolean;
-            reverse?: boolean;
-            shift?: boolean;
-            slice?: boolean;
-            sort?: boolean;
-            splice?: boolean;
-            unshift?: boolean;
-            indexOf?: boolean;
-            lastIndexOf?: boolean;
-            every?: boolean;
-            some?: boolean;
-            forEach?: boolean;
-            map?: boolean;
-            filter?: boolean;
-            reduce?: boolean;
-            reduceRight?: boolean;
-            find?: boolean;
-            findIndex?: boolean;
-            fill?: boolean;
-            copyWithin?: boolean;
-            entries?: boolean;
-            keys?: boolean;
-            values?: boolean;
-            includes?: boolean;
-            flatMap?: boolean;
-            flat?: boolean;
-            at?: boolean;
-            [Symbol.iterator]?: boolean;
-            readonly [Symbol.unscopables]?: boolean;
-        };
+        [x: string]: import("./types.js").Vote;
     };
+    get voters(): any;
     get votingDisabled(): boolean;
     /**
      *
@@ -125,7 +23,7 @@ export default class PrivateVoting {
      * @param {string} method function to run when agree amount is bigger
      */
     createVote(title: string, description: string, endTime: EpochTimeStamp, method: string, args?: any[]): void;
-    canVote(address: address): boolean;
+    canVote(address: address): any;
     vote(voteId: string, vote: VoteResult): void;
     disableVoting(): void;
     grantVotingPower(address: address, voteId: string): void;

package/exports/voting/public-voting.d.ts

@@ -1,41 +1,38 @@
-import TokenReceiver, { TokenReceiverState } from '../token-receiver.js';
-export type VoteResult = 0 | 0.5 | 1;
-export type PublicVote = {
-    title: string;
-    method: string;
-    args: any[];
-    description: string;
-    endTime: EpochTimeStamp;
-    results?: {
-        [address: address]: VoteResult;
-    };
-    finished?: boolean;
-    enoughVotes?: boolean;
-};
-export interface PublicVotingState extends TokenReceiverState {
-    votes: {
-        [id: string]: PublicVote;
-    };
-    votingDisabled: boolean;
-}
-export interface VoteView extends PublicVote {
-    id: string;
-}
+import { VotingState, VoteResult } from './types.js';
 /**
  * allows everybody that has a balance greater or equeal then/to tokenAmountToReceive to vote
  */
-export default class PublicVoting extends TokenReceiver {
+export default class PublicVoting {
     #private;
-    constructor(tokenToReceive: address, tokenAmountToReceive: typeof BigNumber, state: PublicVotingState);
+    constructor(state: VotingState);
     get votes(): {
-        [x: string]: PublicVote;
+        [x: string]: import("./types.js").Vote;
     };
+    get votingDuration(): number;
     get votingDisabled(): boolean;
     /**
      *
      */
-    get state(): PublicVotingState;
-    get inProgress(): VoteView[];
+    get state(): {
+        votes: {
+            [id: string]: import("./types.js").Vote;
+        };
+        votingDisabled: boolean;
+        votingDuration: number;
+    };
+    get inProgress(): {
+        id: string;
+        title: string;
+        method: string;
+        args: any[];
+        description: string;
+        endTime: number;
+        results?: {
+            [address: string]: VoteResult;
+        };
+        finished?: boolean;
+        enoughVotes?: boolean;
+    }[];
     /**
      * create vote
      * @param {string} vote
@@ -44,8 +41,7 @@ export default class PublicVoting extends TokenReceiver {
      * @param {string} method function to run when agree amount is bigger
      */
     createVote(title: string, description: string, endTime: EpochTimeStamp, method: string, args?: any[]): void;
-    canVote(address: address): Promise<boolean>;
     vote(voteId: string, vote: VoteResult): Promise<void>;
     disableVoting(): void;
-    sync(): void;
+    _sync(): void;
 }

package/exports/voting/types.d.ts

@@ -0,0 +1,23 @@
+export type VoteResult = 0 | 0.5 | 1;
+export type Vote = {
+    title: string;
+    method: string;
+    args: any[];
+    description: string;
+    endTime: EpochTimeStamp;
+    results?: {
+        [address: string]: VoteResult;
+    };
+    finished?: boolean;
+    enoughVotes?: boolean;
+};
+export interface VotingState {
+    votes: {
+        [id: string]: Vote;
+    };
+    votingDisabled: boolean;
+    votingDuration: number;
+}
+export interface VoteView extends Vote {
+    id: string;
+}

package/package.json

@@ -1,65 +1,71 @@
-{
-  "name": "@leofcoin/standards",
-  "version": "0.1.8",
-  "description": "Contract standards",
-  "type": "module",
-  "exports": {
-    ".": {
-      "import": "./exports/index.js",
-      "types": "./exports/index.d.ts"
-    },
-    "./token": {
-      "import": "./exports/token.js",
-      "types": "./exports/token.d.ts"
-    },
-    "./roles": {
-      "import": "./exports/roles.js",
-      "types": "./exports/roles.d.ts"
-    },
-    "./public-voting": {
-      "import": "./exports/public-voting.js",
-      "types": "./exports/public-voting.d.ts"
-    },
-    "./private-voting": {
-      "import": "./exports/private-voting.js",
-      "types": "./exports/private-voting.d.ts"
-    },
-    "./token-receiver": {
-      "import": "./exports/token-receiver.js",
-      "types": "./exports/token-receiver.d.ts"
-    },
-    "./helpers": {
-      "import": "./exports/helpers.js",
-      "types": "./exports/helpers.d.ts"
-    },
-    "./token.js": "./exports/token.js",
-    "./roles.js": "./exports/roles.js",
-    "./public-voting.js": "./exports/public-voting.js",
-    "./private-voting.js": "./exports/private-voting.js",
-    "./helpers.js": "./exports/helpers.js"
-  },
-  "scripts": {
-    "build": "rollup -c",
-    "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",
-  "devDependencies": {
-    "@leofcoin/global-types": "^1.0.0",
-    "@rollup/plugin-typescript": "^11.0.0",
-    "rollup": "^3.17.1",
-    "tslib": "^2.5.0"
-  },
-  "dependencies": {
-    "@ethersproject/bignumber": "^5.7.0"
-  }
-}
+{
+  "name": "@leofcoin/standards",
+  "version": "0.2.1",
+  "description": "Contract standards",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./exports/index.js",
+      "types": "./exports/index.d.ts"
+    },
+    "./token": {
+      "import": "./exports/token.js",
+      "types": "./exports/token.d.ts"
+    },
+    "./roles": {
+      "import": "./exports/roles.js",
+      "types": "./exports/roles.d.ts"
+    },
+    "./public-voting": {
+      "import": "./exports/public-voting.js",
+      "types": "./exports/public-voting.d.ts"
+    },
+    "./private-voting": {
+      "import": "./exports/private-voting.js",
+      "types": "./exports/private-voting.d.ts"
+    },
+    "./token-receiver": {
+      "import": "./exports/token-receiver.js",
+      "types": "./exports/token-receiver.d.ts"
+    },
+    "./interfaces/i-public-voting": {
+      "import": "./exports/i-public-voting.js",
+      "types": "./exports/i-public-voting.d.ts"
+    },
+    "./helpers": {
+      "import": "./exports/helpers.js",
+      "types": "./exports/helpers.d.ts"
+    },
+    "./token.js": "./exports/token.js",
+    "./roles.js": "./exports/roles.js",
+    "./public-voting.js": "./exports/public-voting.js",
+    "./interfaces/i-public-voting.js": "./exports/i-public-voting.js",
+    "./private-voting.js": "./exports/private-voting.js",
+    "./helpers.js": "./exports/helpers.js"
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "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",
+  "devDependencies": {
+    "@leofcoin/global-types": "^1.0.0",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "rollup": "^4.12.0",
+    "tslib": "^2.5.0"
+  },
+  "dependencies": {
+    "@changesets/cli": "^2.27.1",
+    "@ethersproject/bignumber": "^5.7.0"
+  }
+}

package/rollup.config.js

@@ -1,5 +1,4 @@
 import typescript from '@rollup/plugin-typescript'
-import tsConfig from './tsconfig.json' assert { type: 'json' }
 import { execSync } from 'child_process'
 
 // const templates = (await readdir('./src/templates')).map(path => join('./src/templates', path))
@@ -15,6 +14,7 @@ export default [
       'src/token.ts',
       'src/roles.ts',
       'src/voting/public-voting.ts',
+      'src/voting/interfaces/i-public-voting.ts',
       'src/voting/private-voting.ts',
       'src/helpers.ts',
       'src/token-receiver.ts'
@@ -23,6 +23,6 @@ export default [
       dir: './exports',
       format: 'es'
     },
-    plugins: [typescript(tsConfig)]
+    plugins: [typescript()]
   }
 ]

package/src/token-receiver.ts

@@ -1,17 +1,36 @@
-export interface TokenReceiverState {
+import { IPublicVoting } from './voting/interfaces/i-public-voting.js'
+import PublicVoting from './voting/public-voting.js'
+import { VotingState } from './voting/types.js'
+
+export interface TokenReceiverState extends VotingState {
   tokenToReceive: address
+  tokenReceiver: address
   tokenAmountToReceive: typeof BigNumber
+  voteType: 'burn' | 'transfer'
 }
-export default class TokenReceiver {
+export default class TokenReceiver extends PublicVoting implements IPublicVoting {
   #tokenToReceive: address
   #tokenAmountToReceive: typeof BigNumber
-  constructor(tokenToReceive: address, tokenAmountToReceive: typeof BigNumber, state: TokenReceiverState) {
+  #tokenReceiver: address
+  #voteType: TokenReceiverState['voteType'] = 'transfer'
+
+  constructor(
+    tokenToReceive: address,
+    tokenAmountToReceive: typeof BigNumber,
+    burns: boolean,
+    state?: TokenReceiverState
+  ) {
+    super(state)
     if (state) {
+      this.#tokenReceiver = state.tokenReceiver
       this.#tokenToReceive = state.tokenToReceive
       this.#tokenAmountToReceive = BigNumber['from'](state.tokenAmountToReceive)
+      this.#voteType = state.voteType
     } else {
+      this.#tokenReceiver = msg.contract
       this.#tokenToReceive = tokenToReceive
       this.#tokenAmountToReceive = BigNumber['from'](tokenAmountToReceive)
+      if (burns) this.#voteType = 'burn'
     }
   }
 
@@ -23,19 +42,135 @@ export default class TokenReceiver {
     return this.#tokenAmountToReceive
   }
 
+  get tokenReceiver() {
+    return this.#tokenReceiver
+  }
+
   get state() {
     return {
+      ...super.state,
+      tokenReceiver: this.#tokenReceiver,
       tokenToReceive: this.#tokenToReceive,
-      tokenAmountToReceive: this.#tokenAmountToReceive
+      tokenAmountToReceive: this.#tokenAmountToReceive,
+      voteType: this.#voteType
     }
   }
 
+  async #canVote() {
+    const amount = (await msg.staticCall(this.#tokenToReceive, 'balanceOf', [msg.sender])) as typeof BigNumber
+    return amount.gte(this.#tokenAmountToReceive)
+  }
+
   /**
    * check if sender can pay
    * @returns {boolean} promise
    */
-  async canPay(): Promise<boolean> {
-    const amount = (await msg.staticCall(this.#tokenToReceive, 'balanceOf', [msg.sender])) as typeof BigNumber
-    return amount.gte(this.#tokenAmountToReceive)
+  async _canVote(): Promise<boolean> {
+    return this.#canVote()
+  }
+
+  async #beforeVote(): Promise<any> {
+    if (this.#voteType === 'burn') return msg.staticCall(this.tokenToReceive, 'burn', [this.tokenAmountToReceive])
+    return msg.staticCall(this.tokenToReceive, 'transfer', [msg.sender, this.tokenReceiver, this.tokenAmountToReceive])
+  }
+
+  async _beforeVote(): Promise<any> {
+    await this.#beforeVote()
+  }
+
+  /**
+   * check if sender can pay
+   * @returns {boolean} promise
+   */
+  async _payTokenToReceive(): Promise<boolean> {
+    return msg.staticCall(this.#tokenToReceive, 'transfer', [
+      msg.sender,
+      this.#tokenReceiver,
+      this.#tokenAmountToReceive
+    ])
+  }
+
+  /**
+   * check if sender can pay
+   * @returns {boolean} promise
+   */
+  async _burnTokenToReceive(): Promise<boolean> {
+    return msg.staticCall(this.#tokenToReceive, 'burn', [this.#tokenAmountToReceive])
+  }
+
+  #changeTokenToReceive(address: address) {
+    this.#tokenToReceive = address
+  }
+
+  #changeTokenAmountToReceive(amount: typeof BigNumber) {
+    this.#tokenAmountToReceive = amount
+  }
+
+  #changeVoteType(type: TokenReceiverState['voteType']) {
+    this.#voteType = type
+  }
+
+  #getTokensOut(amount: typeof BigNumber, receiver: address) {
+    return msg.call(this.#tokenReceiver, 'transfer', [this.#tokenReceiver, receiver, amount])
+  }
+
+  async changeVoteType(type: TokenReceiverState['voteType']) {
+    if (!this.#canVote()) throw new Error('not a allowed')
+    if (this.#voteType === 'transfer' && (await this.#balance()).gt(0))
+      throw new Error('get tokens out first or they be lost forever')
+    else {
+      this.createVote(
+        `change the token amount to receive`,
+        `set tokenAmountToReceive`,
+        new Date().getTime() + this.votingDuration,
+        '#changeVoteType',
+        [type]
+      )
+    }
+  }
+
+  getTokensOut(amount: typeof BigNumber, receiver: address) {
+    if (!this.#canVote()) throw new Error('not a allowed')
+    else {
+      this.createVote(
+        `withdraw all tokens`,
+        `withdraw all tokens to ${receiver}`,
+        new Date().getTime() + this.votingDuration,
+        '#getTokensOut',
+        [amount, receiver]
+      )
+    }
+  }
+
+  changeTokenAmountToReceive() {
+    if (!this.#canVote()) throw new Error('not a allowed')
+    else {
+      this.createVote(
+        `change the token amount to receive`,
+        `set tokenAmountToReceive`,
+        new Date().getTime() + this.votingDuration,
+        '#changeTokenAmountToReceive',
+        []
+      )
+    }
+  }
+
+  #balance(): Promise<typeof BigNumber> {
+    return msg.staticCall(this.#tokenToReceive, 'balanceOf', [this.#tokenReceiver])
+  }
+
+  async changeTokenToReceive() {
+    if (!this.#canVote()) throw new Error('not a allowed')
+    if (!(await this.#balance()).eq(0) && this.#voteType === 'transfer')
+      throw new Error('get tokens out first or they be lost forever')
+    else {
+      this.createVote(
+        `change the token to receive`,
+        `set tokenToReceive to a new address`,
+        new Date().getTime() + this.votingDuration,
+        '#changeTokenToReceive',
+        []
+      )
+    }
   }
 }

package/src/token.ts

@@ -90,6 +90,10 @@ export default class Token extends Roles {
     return { ...this.#balances }
   }
 
+  get approvals() {
+    return this.#approvals
+  }
+
   get decimals() {
     return this.#decimals
   }
@@ -132,6 +136,10 @@ export default class Token extends Roles {
     this.#updateHolders(address, previousBalance)
   }
 
+  balance() {
+    return this.#balances[msg.sender]
+  }
+
   balanceOf(address: address): BigNumberish {
     return this.#balances[address]
   }

package/src/voting/interfaces/i-public-voting.ts

@@ -0,0 +1,4 @@
+export interface IPublicVoting {
+  _canVote(): Promise<any>
+  _beforeVote(): Promise<any>
+}

package/src/voting/private-voting.ts

@@ -1,25 +1,7 @@
-export type VoteResult = 0 | 0.5 | 1
-
-export type Vote = {
-  title: string
-  method: string
-  args: any[]
-  description: string
-  endTime: EpochTimeStamp
-  results?: { [address: address]: VoteResult }
-  finished?: boolean
-  enoughVotes?: boolean
-}
+import { VoteResult, VoteView, VotingState } from './types.js'
 
-export type PrivateVotingState = {
-  voters: address[]
-  votes: {
-    [id: string]: Vote
-  }
-  votingDisabled: boolean
-}
-export interface VoteView extends Vote {
-  id: string
+export interface PrivateVotingState extends VotingState {
+  voters
 }
 
 export default class PrivateVoting {

package/src/voting/public-voting.ts

@@ -1,38 +1,14 @@
-import TokenReceiver, { TokenReceiverState } from '../token-receiver.js'
-import PrivateVoting from './private-voting.js'
-
-export type VoteResult = 0 | 0.5 | 1
-
-export type PublicVote = {
-  title: string
-  method: string
-  args: any[]
-  description: string
-  endTime: EpochTimeStamp
-  results?: { [address: address]: VoteResult }
-  finished?: boolean
-  enoughVotes?: boolean
-}
-
-export interface PublicVotingState extends TokenReceiverState {
-  votes: {
-    [id: string]: PublicVote
-  }
-  votingDisabled: boolean
-}
-export interface VoteView extends PublicVote {
-  id: string
-}
+import { VotingState, VoteResult } from './types.js'
 
 /**
  * allows everybody that has a balance greater or equeal then/to tokenAmountToReceive to vote
  */
-export default class PublicVoting extends TokenReceiver {
-  #votes: PublicVotingState['votes']
+export default class PublicVoting {
+  #votes: VotingState['votes']
   #votingDisabled: boolean
+  #votingDuration: number = 172800000
 
-  constructor(tokenToReceive: address, tokenAmountToReceive: typeof BigNumber, state: PublicVotingState) {
-    super(tokenToReceive, tokenAmountToReceive, state)
+  constructor(state: VotingState) {
     if (state) {
       this.#votes = state.votes
       this.#votingDisabled = state.votingDisabled
@@ -43,6 +19,10 @@ export default class PublicVoting extends TokenReceiver {
     return { ...this.#votes }
   }
 
+  get votingDuration() {
+    return this.#votingDuration
+  }
+
   get votingDisabled() {
     return this.#votingDisabled
   }
@@ -50,11 +30,11 @@ export default class PublicVoting extends TokenReceiver {
   /**
    *
    */
-  get state(): PublicVotingState {
-    return { ...super.state, votes: this.#votes, votingDisabled: this.#votingDisabled }
+  get state() {
+    return { votes: this.#votes, votingDisabled: this.#votingDisabled, votingDuration: this.#votingDuration }
   }
 
-  get inProgress(): VoteView[] {
+  get inProgress() {
     return Object.entries(this.#votes)
       .filter(([id, vote]) => !vote.finished)
       .map(([id, vote]) => {
@@ -70,7 +50,7 @@ export default class PublicVoting extends TokenReceiver {
    */
 
   createVote(title: string, description: string, endTime: EpochTimeStamp, method: string, args: any[] = []) {
-    if (!this.canVote(msg.sender)) throw new Error(`Not allowed to create a vote`)
+    if (!this.#canVote()) throw new Error(`Not allowed to create a vote`)
     const id = crypto.randomUUID()
     this.#votes[id] = {
       title,
@@ -81,8 +61,14 @@ export default class PublicVoting extends TokenReceiver {
     }
   }
 
-  canVote(address: address) {
-    return this.canPay()
+  #canVote() {
+    // @ts-expect-error
+    return this._canVote?.()
+  }
+
+  #beforeVote() {
+    // @ts-expect-error
+    return this._beforeVote?.()
   }
 
   #endVoting(voteId) {
@@ -100,8 +86,8 @@ export default class PublicVoting extends TokenReceiver {
     const ended = new Date().getTime() > this.#votes[voteId].endTime
     if (ended && !this.#votes[voteId].finished) this.#endVoting(voteId)
     if (ended) throw new Error('voting already ended')
-    if (!this.canVote(msg.sender)) throw new Error(`Not allowed to vote`)
-    await msg.staticCall(this.tokenToReceive, 'burn', [this.tokenAmountToReceive])
+    if (!this.#canVote()) throw new Error(`Not allowed to vote`)
+    await this.#beforeVote()
     this.#votes[voteId][msg.sender] = vote
   }
 
@@ -110,19 +96,19 @@ export default class PublicVoting extends TokenReceiver {
   }
 
   disableVoting() {
-    if (!this.canVote(msg.sender)) throw new Error('not a allowed')
+    if (!this.#canVote()) throw new Error('not a allowed')
     else {
       this.createVote(
         `disable voting`,
         `Warning this disables all voting features forever`,
-        new Date().getTime() + 172800000,
+        new Date().getTime() + this.#votingDuration,
         '#disableVoting',
         []
       )
     }
   }
 
-  sync() {
+  _sync() {
     for (const vote of this.inProgress) {
       if (vote.endTime < new Date().getTime()) this.#endVoting(vote.id)
     }

package/src/voting/types.ts

@@ -0,0 +1,24 @@
+export type VoteResult = 0 | 0.5 | 1
+
+export type Vote = {
+  title: string
+  method: string
+  args: any[]
+  description: string
+  endTime: EpochTimeStamp
+  results?: { [address: string]: VoteResult }
+  finished?: boolean
+  enoughVotes?: boolean
+}
+
+export interface VotingState {
+  votes: {
+    [id: string]: Vote
+  }
+  votingDisabled: boolean
+  votingDuration: number
+}
+
+export interface VoteView extends Vote {
+  id: string
+}

package/test/public-voting.js

@@ -0,0 +1,6 @@
+import Voting from './../exports/public-voting.js'
+
+const voting = new Voting('0x0', '1000')
+
+console.log(voting)
+console.log(voting.votingDuration)