@leofcoin/standards 0.3.1 → 0.3.3

package/exports/index.d.ts

@@ -1,7 +1,7 @@
-export { default as Meta } from './meta.js';
-export { default as Roles } from './roles.js';
-export { default as Token } from './token.js';
-export { default as TokenReceiver } from './token-receiver.js';
-export { default as PublicVoting } from './voting/public-voting.js';
-export { default as PrivateVoting } from './voting/private-voting.js';
+export { default as Meta, type MetaState } from './meta.js';
+export { default as Roles, type RolesState } from './roles.js';
+export { default as Token, type TokenState } from './token.js';
+export { default as TokenReceiver, type TokenReceiverState } from './token-receiver.js';
+export { default as PublicVoting, type VotingState, type VoteResult, type Vote, type VoteView } from './voting/public-voting.js';
+export { default as PrivateVoting, type PrivateVotingState } from './voting/private-voting.js';
 export * from './helpers.js';

package/exports/interfaces.d.ts

@@ -0,0 +1,47 @@
+export interface MetaState {
+    creator: address;
+    createdAt: bigint;
+}
+export declare interface RolesState extends MetaState {
+    roles: {
+        [index: string]: address[];
+    };
+}
+export declare interface TokenState extends RolesState {
+    holders: bigint;
+    balances: {
+        [address: address]: bigint;
+    };
+    approvals: {
+        [owner: address]: {
+            [operator: address]: bigint;
+        };
+    };
+    totalSupply: bigint;
+}
+export interface VotingState extends MetaState {
+    votes: {
+        [id: string]: Vote;
+    };
+    votingDisabled: boolean;
+    votingDuration: number;
+}
+export interface PrivateVotingState extends VotingState {
+    voters: address[];
+}
+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 VoteView extends Vote {
+    id: string;
+}

package/exports/interfaces.js

@@ -0,0 +1 @@
+

package/exports/meta.d.ts

@@ -1,4 +1,7 @@
-import { MetaState } from './types.js';
+export interface MetaState {
+    creator: address;
+    createdAt: bigint;
+}
 export default class Meta {
     #private;
     constructor(state?: MetaState);

package/exports/roles.d.ts

@@ -1,5 +1,9 @@
-import Meta from './meta.js';
-import { RolesState } from './types.js';
+import Meta, { MetaState } from './meta.js';
+export interface RolesState extends MetaState {
+    roles: {
+        [index: string]: address[];
+    };
+}
 export default class Roles extends Meta {
     #private;
     constructor(state?: RolesState);

package/exports/token-receiver.d.ts

@@ -1,6 +1,5 @@
 import { IPublicVoting } from './voting/interfaces/i-public-voting.js';
-import PublicVoting from './voting/public-voting.js';
-import { VotingState } from './voting/types.js';
+import PublicVoting, { VotingState } from './voting/public-voting.js';
 export interface TokenReceiverState extends VotingState {
     tokenToReceive: address;
     tokenReceiver: address;
@@ -19,7 +18,7 @@ export default class TokenReceiver extends PublicVoting implements IPublicVoting
         tokenAmountToReceive: bigint;
         voteType: "burn" | "transfer";
         votes: {
-            [id: string]: import("./voting/types.js").Vote;
+            [id: string]: import("./voting/public-voting.js").Vote;
         };
         votingDisabled: boolean;
         votingDuration: number;

package/exports/token.d.ts

@@ -1,5 +1,16 @@
-import Roles from './roles.js';
-import { TokenState } from './types.js';
+import Roles, { RolesState } from './roles.js';
+export interface TokenState extends RolesState {
+    holders: bigint;
+    balances: {
+        [address: address]: bigint;
+    };
+    approvals: {
+        [owner: address]: {
+            [operator: address]: bigint;
+        };
+    };
+    totalSupply: bigint;
+}
 export default class Token extends Roles {
     #private;
     constructor(name: string, symbol: string, decimals?: number, state?: TokenState);

package/exports/types.d.ts

@@ -19,3 +19,29 @@ export declare interface TokenState extends RolesState {
     };
     totalSupply: bigint;
 }
+export interface VotingState extends MetaState {
+    votes: {
+        [id: string]: Vote;
+    };
+    votingDisabled: boolean;
+    votingDuration: number;
+}
+export interface PrivateVotingState extends VotingState {
+    voters: address[];
+}
+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 VoteView extends Vote {
+    id: string;
+}

package/exports/types.js

@@ -0,0 +1 @@
+

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

@@ -1,10 +1,35 @@
-import Meta from '../meta.js';
-import { PrivateVotingState, VoteResult, VoteView } from './types.js';
+import Meta, { MetaState } from '../meta.js';
+export interface VotingState extends MetaState {
+    votes: {
+        [id: string]: Vote;
+    };
+    votingDisabled: boolean;
+    votingDuration: number;
+}
+export interface PrivateVotingState extends VotingState {
+    voters: address[];
+}
+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 VoteView extends Vote {
+    id: string;
+}
 export default class PrivateVoting extends Meta {
     #private;
     constructor(state: PrivateVotingState);
     get votes(): {
-        [id: string]: import("./types.js").Vote;
+        [id: string]: Vote;
     };
     get voters(): {
         [n: number]: string;

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

@@ -1,5 +1,27 @@
-import Meta from '../meta.js';
-import { VotingState, VoteResult } from './types.js';
+import Meta, { MetaState } from '../meta.js';
+export interface VotingState extends MetaState {
+    votes: {
+        [id: string]: Vote;
+    };
+    votingDisabled: boolean;
+    votingDuration: number;
+}
+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 VoteView extends Vote {
+    id: string;
+}
 /**
  * allows everybody that has a balance greater or equal to tokenAmountToReceive to vote
  */
@@ -7,7 +29,7 @@ export default class PublicVoting extends Meta {
     #private;
     constructor(state: VotingState);
     get votes(): {
-        [id: string]: import("./types.js").Vote;
+        [id: string]: Vote;
     };
     get votingDuration(): number;
     get votingDisabled(): boolean;
@@ -16,7 +38,7 @@ export default class PublicVoting extends Meta {
      */
     get state(): {
         votes: {
-            [id: string]: import("./types.js").Vote;
+            [id: string]: Vote;
         };
         votingDisabled: boolean;
         votingDuration: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leofcoin/standards",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Contract standards",
   "type": "module",
   "exports": {
@@ -8,40 +8,98 @@
       "import": "./exports/index.js",
       "types": "./exports/index.d.ts"
     },
-    "./token": {
-      "import": "./exports/token.js",
-      "types": "./exports/token.d.ts"
+    "./helpers": {
+      "import": "./exports/helpers.js",
+      "types": "./exports/helpers.d.ts"
     },
-    "./roles": {
-      "import": "./exports/roles.js",
-      "types": "./exports/roles.d.ts"
+    "./helpers.js": {
+      "import": "./exports/helpers.js",
+      "types": "./exports/helpers.d.ts"
     },
-    "./public-voting": {
-      "import": "./exports/public-voting.js",
-      "types": "./exports/public-voting.d.ts"
+    "./i-public-voting": {
+      "import": "./exports/i-public-voting.js",
+      "types": "./exports/voting/interfaces/i-public-voting.d.ts"
+    },
+    "./i-public-voting.js": {
+      "import": "./exports/i-public-voting.js",
+      "types": "./exports/voting/interfaces/i-public-voting.d.ts"
+    },
+    "./index.js": {
+      "import": "./exports/index.js",
+      "types": "./exports/index.d.ts"
+    },
+    "./interfaces": {
+      "import": "./exports/interfaces.js",
+      "types": "./exports/interfaces.d.ts"
+    },
+    "./interfaces.js": {
+      "import": "./exports/interfaces.js",
+      "types": "./exports/interfaces.d.ts"
+    },
+    "./meta": {
+      "import": "./exports/meta.js",
+      "types": "./exports/meta.d.ts"
+    },
+    "./meta.js": {
+      "import": "./exports/meta.js",
+      "types": "./exports/meta.d.ts"
     },
     "./private-voting": {
       "import": "./exports/private-voting.js",
-      "types": "./exports/private-voting.d.ts"
+      "types": "./exports/voting/private-voting.d.ts"
+    },
+    "./private-voting.js": {
+      "import": "./exports/private-voting.js",
+      "types": "./exports/voting/private-voting.d.ts"
+    },
+    "./public-voting": {
+      "import": "./exports/public-voting.js",
+      "types": "./exports/voting/interfaces/public-voting.d.ts"
+    },
+    "./public-voting.js": {
+      "import": "./exports/public-voting.js",
+      "types": "./exports/voting/interfaces/public-voting.d.ts"
+    },
+    "./roles": {
+      "import": "./exports/roles.js",
+      "types": "./exports/roles.d.ts"
+    },
+    "./roles.js": {
+      "import": "./exports/roles.js",
+      "types": "./exports/roles.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"
+    "./token-receiver.js": {
+      "import": "./exports/token-receiver.js",
+      "types": "./exports/token-receiver.d.ts"
     },
-    "./helpers": {
-      "import": "./exports/helpers.js",
-      "types": "./exports/helpers.d.ts"
+    "./token": {
+      "import": "./exports/token.js",
+      "types": "./exports/token.d.ts"
+    },
+    "./token.js": {
+      "import": "./exports/token.js",
+      "types": "./exports/token.d.ts"
+    },
+    "./types": {
+      "import": "./exports/types.js",
+      "types": "./exports/voting/types.d.ts"
+    },
+    "./types.js": {
+      "import": "./exports/types.js",
+      "types": "./exports/voting/types.d.ts"
+    },
+    "./voting": {
+      "import": "./exports/voting.js",
+      "types": "./exports/voting.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"
+    "./voting.js": {
+      "import": "./exports/voting.js",
+      "types": "./exports/voting.d.ts"
+    }
   },
   "scripts": {
     "build": "rollup -c",
@@ -62,6 +120,7 @@
     "@leofcoin/global-types": "^1.0.2",
     "@rollup/plugin-typescript": "^12.3.0",
     "rollup": "^4.54.0",
+    "rollup-plugin-auto-exports": "^1.1.1",
     "tslib": "^2.8.1"
   }
 }

package/rollup.config.js

@@ -1,5 +1,6 @@
 import typescript from '@rollup/plugin-typescript'
 import { execSync } from 'child_process'
+import autoExports from 'rollup-plugin-auto-exports'
 
 // const templates = (await readdir('./src/templates')).map(path => join('./src/templates', path))
 const clean = () => {
@@ -17,12 +18,24 @@ export default [
       'src/voting/interfaces/i-public-voting.ts',
       'src/voting/private-voting.ts',
       'src/helpers.ts',
-      'src/token-receiver.ts'
+      'src/token-receiver.ts',
+      'src/interfaces.ts'
     ],
     output: {
       dir: './exports',
       format: 'es'
     },
-    plugins: [typescript()]
+    plugins: [
+      typescript(),
+      autoExports({
+        exportsDir: 'exports',
+        defaultExports: {
+          '.': {
+            import: 'exports/index.js',
+            types: 'exports/index.d.ts'
+          }
+        }
+      })
+    ]
   }
 ]

package/src/index.ts

@@ -1,8 +1,19 @@
-export { default as Meta } from './meta.js'
-export { default as Roles } from './roles.js'
-export { default as Token } from './token.js'
-export { default as TokenReceiver } from './token-receiver.js'
-export { default as PublicVoting } from './voting/public-voting.js'
-export { default as PrivateVoting } from './voting/private-voting.js'
-
+export { default as Meta, type MetaState } from './meta.js'
+export { default as Roles, type RolesState } from './roles.js'
+export { default as Token, type TokenState } from './token.js'
+export {
+  default as TokenReceiver,
+  type TokenReceiverState
+} from './token-receiver.js'
+export {
+  default as PublicVoting,
+  type VotingState,
+  type VoteResult,
+  type Vote,
+  type VoteView
+} from './voting/public-voting.js'
+export {
+  default as PrivateVoting,
+  type PrivateVotingState
+} from './voting/private-voting.js'
 export * from './helpers.js'

package/src/{voting/types.ts → interfaces.ts}

@@ -1,4 +1,18 @@
-import { MetaState } from '../types.js'
+export interface MetaState {
+  creator: address
+  createdAt: bigint
+}
+
+export declare interface RolesState extends MetaState {
+  roles: { [index: string]: address[] }
+}
+
+export declare interface TokenState extends RolesState {
+  holders: bigint
+  balances: { [address: address]: bigint }
+  approvals: { [owner: address]: { [operator: address]: bigint } }
+  totalSupply: bigint
+}
 
 export interface VotingState extends MetaState {
   votes: {

package/src/meta.ts

@@ -1,4 +1,7 @@
-import { MetaState } from './types.js'
+export interface MetaState {
+  creator: address
+  createdAt: bigint
+}
 
 export default class Meta {
   #creator: address

package/src/roles.ts

@@ -1,5 +1,8 @@
-import Meta from './meta.js'
-import { RolesState } from './types.js'
+import Meta, { MetaState } from './meta.js'
+
+export interface RolesState extends MetaState {
+  roles: { [index: string]: address[] }
+}
 
 export default class Roles extends Meta {
   /**

package/src/token-receiver.ts

@@ -1,6 +1,5 @@
 import { IPublicVoting } from './voting/interfaces/i-public-voting.js'
-import PublicVoting from './voting/public-voting.js'
-import { VotingState } from './voting/types.js'
+import PublicVoting, { VotingState } from './voting/public-voting.js'
 
 export interface TokenReceiverState extends VotingState {
   tokenToReceive: address

package/src/token.ts

@@ -1,6 +1,12 @@
 import { restoreApprovals, restoreBalances } from './helpers.js'
-import Roles from './roles.js'
-import { TokenState } from './types.js'
+import Roles, { RolesState } from './roles.js'
+
+export interface TokenState extends RolesState {
+  holders: bigint
+  balances: { [address: address]: bigint }
+  approvals: { [owner: address]: { [operator: address]: bigint } }
+  totalSupply: bigint
+}
 
 export default class Token extends Roles {
   /**

package/src/voting/private-voting.ts

@@ -1,10 +1,33 @@
-import Meta from '../meta.js'
-import {
-  PrivateVotingState,
-  VoteResult,
-  VoteView,
-  VotingState
-} from './types.js'
+import Meta, { MetaState } from '../meta.js'
+
+export interface VotingState extends MetaState {
+  votes: {
+    [id: string]: Vote
+  }
+  votingDisabled: boolean
+  votingDuration: number
+}
+
+export interface PrivateVotingState extends VotingState {
+  voters: address[]
+}
+
+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 VoteView extends Vote {
+  id: string
+}
 
 export default class PrivateVoting extends Meta {
   #voters: PrivateVotingState['voters']

package/src/voting/public-voting.ts

@@ -1,5 +1,29 @@
-import Meta from '../meta.js'
-import { VotingState, VoteResult } from './types.js'
+import Meta, { MetaState } from '../meta.js'
+
+export interface VotingState extends MetaState {
+  votes: {
+    [id: string]: Vote
+  }
+  votingDisabled: boolean
+  votingDuration: number
+}
+
+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 VoteView extends Vote {
+  id: string
+}
 
 /**
  * allows everybody that has a balance greater or equal to tokenAmountToReceive to vote

package/src/types.ts

@@ -1,15 +0,0 @@
-export interface MetaState {
-  creator: address
-  createdAt: bigint
-}
-
-export declare interface RolesState extends MetaState {
-  roles: { [index: string]: address[] }
-}
-
-export declare interface TokenState extends RolesState {
-  holders: bigint
-  balances: { [address: address]: bigint }
-  approvals: { [owner: address]: { [operator: address]: bigint } }
-  totalSupply: bigint
-}