@snapshot-labs/snapshot.js 0.11.38 → 0.12.0-beta.1

package/dist/src/sign/types.d.ts

@@ -0,0 +1,227 @@
+export interface Space {
+    from?: string;
+    space: string;
+    timestamp?: number;
+    settings: string;
+}
+export type ProposalType = 'single-choice' | 'approval' | 'quadratic' | 'ranked-choice' | 'weighted' | 'basic';
+export interface Proposal {
+    from?: string;
+    space: string;
+    timestamp?: number;
+    type: ProposalType;
+    title: string;
+    body: string;
+    discussion: string;
+    choices: string[];
+    start: number;
+    end: number;
+    snapshot: number;
+    plugins: string;
+    app?: string;
+}
+export interface UpdateProposal {
+    proposal: string;
+    from?: string;
+    space: string;
+    timestamp?: number;
+    type: ProposalType;
+    title: string;
+    body: string;
+    discussion: string;
+    choices: string[];
+    plugins: string;
+}
+export interface FlagProposal {
+    from?: string;
+    space: string;
+    proposal: string;
+    timestamp?: number;
+}
+export interface CancelProposal {
+    from?: string;
+    space: string;
+    timestamp?: number;
+    proposal: string;
+}
+export interface Vote {
+    from?: string;
+    space: string;
+    timestamp?: number;
+    proposal: string;
+    type: ProposalType;
+    choice: number | number[] | string | {
+        [key: string]: number;
+    };
+    privacy?: string;
+    reason?: string;
+    app?: string;
+    metadata?: string;
+}
+export interface Follow {
+    from?: string;
+    network?: string;
+    space: string;
+    timestamp?: number;
+}
+export interface Unfollow {
+    from?: string;
+    network?: string;
+    space: string;
+    timestamp?: number;
+}
+export interface Subscribe {
+    from?: string;
+    space: string;
+    timestamp?: number;
+}
+export interface Unsubscribe {
+    from?: string;
+    space: string;
+    timestamp?: number;
+}
+export interface Profile {
+    from?: string;
+    timestamp?: number;
+    profile: string;
+}
+export interface Statement {
+    from?: string;
+    timestamp?: number;
+    space: string;
+    about: string;
+    statement: string;
+    discourse?: string;
+    status?: string;
+    network?: string;
+}
+export interface Alias {
+    from?: string;
+    alias: string;
+    timestamp?: number;
+}
+export interface DeleteSpace {
+    from?: string;
+    space: string;
+    timestamp?: number;
+}
+export declare const spaceTypes: {
+    Space: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const proposalTypes: {
+    Proposal: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const updateProposalTypes: {
+    UpdateProposal: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const flagProposalTypes: {
+    FlagProposal: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const cancelProposalTypes: {
+    CancelProposal: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const cancelProposal2Types: {
+    CancelProposal: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const voteTypes: {
+    Vote: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const voteArrayTypes: {
+    Vote: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const voteStringTypes: {
+    Vote: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const vote2Types: {
+    Vote: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const voteArray2Types: {
+    Vote: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const voteString2Types: {
+    Vote: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const followTypes: {
+    Follow: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const unfollowTypes: {
+    Unfollow: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const subscribeTypes: {
+    Subscribe: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const unsubscribeTypes: {
+    Unsubscribe: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const profileTypes: {
+    Profile: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const statementTypes: {
+    Statement: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const aliasTypes: {
+    Alias: {
+        name: string;
+        type: string;
+    }[];
+};
+export declare const deleteSpaceType: {
+    DeleteSpace: {
+        name: string;
+        type: string;
+    }[];
+};

package/dist/src/utils/blockfinder.d.ts

@@ -0,0 +1 @@
+export declare function getSnapshots(network: any, snapshot: any, provider: any, networks: any, options?: any): Promise<any>;

package/dist/src/utils/delegation.d.ts

@@ -0,0 +1,18 @@
+export declare const SNAPSHOT_SUBGRAPH_URL: {
+    "1": string;
+    "10": string;
+    "56": string;
+    "100": string;
+    "137": string;
+    "250": string;
+    "42161": string;
+    "11155111": string;
+};
+type Delegation = {
+    delegator: string;
+    delegate: string;
+    space: string;
+    timestamp: number;
+};
+export default function getDelegatesBySpace(network: string, space: string, snapshot?: string | number, options?: any): Promise<Delegation[]>;
+export {};

package/dist/src/utils/multicaller.d.ts

@@ -0,0 +1,12 @@
+import { StaticJsonRpcProvider } from '@ethersproject/providers';
+export default class Multicaller {
+    network: string;
+    provider: StaticJsonRpcProvider;
+    abi: any[];
+    options: any;
+    calls: any[];
+    paths: any[];
+    constructor(network: string, provider: StaticJsonRpcProvider, abi: any[], options?: any);
+    call(path: any, address: any, fn: any, params?: any): Multicaller;
+    execute(from?: any): Promise<any>;
+}

package/dist/src/utils/provider.d.ts

@@ -0,0 +1,5 @@
+export type ProviderOptions = {
+    broviderUrl?: string;
+};
+export default function getProvider(network: any, { broviderUrl }?: ProviderOptions): any;
+export declare function getBatchedProvider(network: any, { broviderUrl }?: ProviderOptions): any;

package/dist/src/utils/web3.d.ts

@@ -0,0 +1,2 @@
+export declare function signMessage(web3: any, msg: any, address: any): Promise<any>;
+export declare function getBlockNumber(provider: any): Promise<number>;

package/dist/src/utils.d.ts

@@ -0,0 +1,91 @@
+import Multicaller from './utils/multicaller';
+import { getSnapshots } from './utils/blockfinder';
+import getProvider from './utils/provider';
+import { signMessage, getBlockNumber } from './utils/web3';
+import { getHash, verify } from './verify';
+import getDelegatesBySpace, { SNAPSHOT_SUBGRAPH_URL } from './utils/delegation';
+interface Options {
+    url?: string;
+    headers?: any;
+}
+interface Strategy {
+    name: string;
+    network?: string;
+    params: any;
+}
+export declare function call(provider: any, abi: any[], call: any[], options?: any): Promise<any>;
+export declare function multicall(network: string, provider: any, abi: any[], calls: any[], options?: any): Promise<any>;
+export declare function subgraphRequest(url: string, query: any, options?: any): Promise<any>;
+export declare function getUrl(uri: any, gateway?: string): any;
+export declare function getJSON(uri: any, options?: any): Promise<any>;
+export declare function ipfsGet(gateway: string, ipfsHash: string, protocolType?: string): Promise<any>;
+export declare function sendTransaction(web3: any, contractAddress: string, abi: any[], action: string, params: any[], overrides?: {}): Promise<any>;
+export declare function getScores(space: string, strategies: Strategy[], network: string, addresses: string[], snapshot?: number | string, scoreApiUrl?: string, options?: any): Promise<any>;
+export declare function getVp(address: string, network: string, strategies: Strategy[], snapshot: number | 'latest', space: string, delegation: boolean, options?: Options): Promise<any>;
+export declare function validate(validation: string, author: string, space: string, network: string, snapshot: number | 'latest', params: any, options?: Options): Promise<any>;
+interface validateSchemaOptions {
+    snapshotEnv?: string;
+    spaceType?: string;
+}
+export declare function validateSchema(schema: any, data: any, options?: validateSchemaOptions): true | import("ajv").ErrorObject<string, Record<string, any>, unknown>[] | null | undefined;
+export declare function getEnsTextRecord(ens: string, record: string, network?: string, options?: any): Promise<any>;
+export declare function getSpaceUri(id: string, network?: string, options?: any): Promise<string | null>;
+export declare function getEnsOwner(ens: string, network?: string, options?: any): Promise<string | null>;
+export declare function getSpaceController(id: string, network?: string, options?: any): Promise<string | null>;
+export declare function clone(item: any): any;
+export declare function sleep(time: any): Promise<unknown>;
+export declare function getNumberWithOrdinal(n: any): string;
+export declare function isStarknetAddress(address: string): boolean;
+export declare function isEvmAddress(address: string): boolean;
+export declare function getFormattedAddress(address: string, format?: string[]): string;
+export { getDelegatesBySpace, SNAPSHOT_SUBGRAPH_URL };
+declare const _default: {
+    call: typeof call;
+    multicall: typeof multicall;
+    subgraphRequest: typeof subgraphRequest;
+    ipfsGet: typeof ipfsGet;
+    getUrl: typeof getUrl;
+    getJSON: typeof getJSON;
+    sendTransaction: typeof sendTransaction;
+    getScores: typeof getScores;
+    getVp: typeof getVp;
+    validateSchema: typeof validateSchema;
+    getEnsTextRecord: typeof getEnsTextRecord;
+    getSpaceUri: typeof getSpaceUri;
+    getEnsOwner: typeof getEnsOwner;
+    getSpaceController: typeof getSpaceController;
+    getDelegatesBySpace: typeof getDelegatesBySpace;
+    clone: typeof clone;
+    sleep: typeof sleep;
+    getNumberWithOrdinal: typeof getNumberWithOrdinal;
+    voting: {
+        'single-choice': typeof import("./voting/singleChoice").default;
+        approval: typeof import("./voting/approval").default;
+        quadratic: typeof import("./voting/quadratic").default;
+        'ranked-choice': typeof import("./voting/rankedChoice").default;
+        weighted: typeof import("./voting/weighted").default;
+        basic: typeof import("./voting/singleChoice").default;
+    };
+    getProvider: typeof getProvider;
+    signMessage: typeof signMessage;
+    getBlockNumber: typeof getBlockNumber;
+    Multicaller: typeof Multicaller;
+    getSnapshots: typeof getSnapshots;
+    getHash: typeof getHash;
+    verify: typeof verify;
+    validate: typeof validate;
+    isStarknetAddress: typeof isStarknetAddress;
+    isEvmAddress: typeof isEvmAddress;
+    getFormattedAddress: typeof getFormattedAddress;
+    SNAPSHOT_SUBGRAPH_URL: {
+        "1": string;
+        "10": string;
+        "56": string;
+        "100": string;
+        "137": string;
+        "250": string;
+        "42161": string;
+        "11155111": string;
+    };
+};
+export default _default;

package/dist/src/verify/evm.d.ts

@@ -0,0 +1,4 @@
+import { type ProviderOptions } from '../utils/provider';
+import type { SignaturePayload } from '.';
+export declare function getHash(data: SignaturePayload): string;
+export default function verify(address: string, sig: string, data: SignaturePayload, network?: string, options?: ProviderOptions): Promise<boolean>;

package/dist/src/verify/evm.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/verify/index.d.ts

@@ -0,0 +1,11 @@
+import type { StarkNetType } from 'starknet';
+import type { TypedDataField } from '@ethersproject/abstract-signer';
+import type { ProviderOptions } from '../utils/provider';
+export type SignaturePayload = {
+    domain: Record<string, string>;
+    types: Record<string, StarkNetType[] | TypedDataField[]>;
+    primaryType?: string;
+    message: Record<string, any>;
+};
+export declare function getHash(data: SignaturePayload, address?: string): string;
+export declare function verify(address: string, sig: string | string[], data: SignaturePayload, network?: string, options?: ProviderOptions): Promise<boolean>;

package/dist/src/verify/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/verify/starknet.d.ts

@@ -0,0 +1,6 @@
+import type { SignaturePayload } from '.';
+import type { ProviderOptions } from '../utils/provider';
+export type NetworkType = 'SN_MAIN' | 'SN_SEPOLIA';
+export declare function isStarknetMessage(data: SignaturePayload): boolean;
+export declare function getHash(data: SignaturePayload, address: string): string;
+export default function verify(address: string, sig: string[], data: SignaturePayload, network?: NetworkType, options?: ProviderOptions): Promise<boolean>;

package/dist/src/verify/starknet.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/voting/approval.d.ts

@@ -0,0 +1,22 @@
+import { ApprovalVote, Strategy } from './types';
+export default class ApprovalVoting {
+    proposal: {
+        choices: string[];
+    };
+    votes: ApprovalVote[];
+    strategies: Strategy[];
+    selected: number[];
+    constructor(proposal: {
+        choices: string[];
+    }, votes: ApprovalVote[], strategies: Strategy[], selected: number[]);
+    static isValidChoice(voteChoice: number[], proposalChoices: string[]): boolean;
+    getValidVotes(): {
+        choice: number[];
+        balance: number;
+        scores: number[];
+    }[];
+    getScores(): number[];
+    getScoresByStrategy(): number[][];
+    getScoresTotal(): number;
+    getChoiceString(): string;
+}

package/dist/src/voting/index.d.ts

@@ -0,0 +1,14 @@
+import singleChoice from './singleChoice';
+import approval from './approval';
+import quadratic from './quadratic';
+import rankedChoice from './rankedChoice';
+import weighted from './weighted';
+declare const _default: {
+    'single-choice': typeof singleChoice;
+    approval: typeof approval;
+    quadratic: typeof quadratic;
+    'ranked-choice': typeof rankedChoice;
+    weighted: typeof weighted;
+    basic: typeof singleChoice;
+};
+export default _default;

package/dist/src/voting/quadratic.d.ts

@@ -0,0 +1,20 @@
+import { QuadraticVote, QuadraticChoice, Strategy } from './types';
+export declare function calcPercentageOfSum(part: number, wholeArray: number[]): number;
+export declare function calcSqrt(percentageWeight: number, votingPower: number): number;
+export default class QuadraticVoting {
+    proposal: {
+        choices: string[];
+    };
+    votes: QuadraticVote[];
+    strategies: Strategy[];
+    selected: QuadraticChoice;
+    constructor(proposal: {
+        choices: string[];
+    }, votes: QuadraticVote[], strategies: Strategy[], selected: QuadraticChoice);
+    static isValidChoice(voteChoice: QuadraticChoice, proposalChoices: string[]): boolean;
+    getValidVotes(): QuadraticVote[];
+    getScores(): number[];
+    getScoresByStrategy(): number[][];
+    getScoresTotal(): number;
+    getChoiceString(): string;
+}

package/dist/src/voting/rankedChoice.d.ts

@@ -0,0 +1,18 @@
+import { RankedChoiceVote, Strategy } from './types';
+export default class RankedChoiceVoting {
+    proposal: {
+        choices: string[];
+    };
+    votes: RankedChoiceVote[];
+    strategies: Strategy[];
+    selected: number[];
+    constructor(proposal: {
+        choices: string[];
+    }, votes: RankedChoiceVote[], strategies: Strategy[], selected: number[]);
+    static isValidChoice(voteChoice: number[], proposalChoices: string[]): boolean;
+    getValidVotes(): RankedChoiceVote[];
+    getScores(): number[];
+    getScoresByStrategy(): number[][];
+    getScoresTotal(): number;
+    getChoiceString(): string;
+}

package/dist/src/voting/singleChoice.d.ts

@@ -0,0 +1,18 @@
+import { SingleChoiceVote, Strategy } from './types';
+export default class SingleChoiceVoting {
+    proposal: {
+        choices: string[];
+    };
+    votes: SingleChoiceVote[];
+    strategies: Strategy[];
+    selected: number;
+    constructor(proposal: {
+        choices: string[];
+    }, votes: SingleChoiceVote[], strategies: Strategy[], selected: number);
+    static isValidChoice(voteChoice: number, proposalChoices: string[]): boolean;
+    getValidVotes(): SingleChoiceVote[];
+    getScores(): number[];
+    getScoresByStrategy(): number[][];
+    getScoresTotal(): number;
+    getChoiceString(): string;
+}

package/dist/src/voting/types.d.ts

@@ -0,0 +1,35 @@
+export interface Strategy {
+    name: string;
+    network: string;
+    params: Record<string, unknown>;
+}
+export interface SingleChoiceVote {
+    choice: number;
+    balance: number;
+    scores: number[];
+}
+export interface ApprovalVote {
+    choice: number[];
+    balance: number;
+    scores: number[];
+}
+export interface RankedChoiceVote {
+    choice: number[];
+    balance: number;
+    scores: number[];
+}
+export interface QuadraticChoice {
+    [key: string]: number;
+}
+export interface QuadraticVote {
+    choice: QuadraticChoice;
+    balance: number;
+    scores: number[];
+}
+export interface WeightedVote {
+    choice: {
+        [key: string]: number;
+    };
+    balance: number;
+    scores: number[];
+}

package/dist/src/voting/weighted.d.ts

@@ -0,0 +1,26 @@
+import { WeightedVote, Strategy } from './types';
+export declare function percentageOfTotal(i: any, values: any, total: any): number;
+export declare function weightedPower(i: any, choice: any, balance: any): number;
+export default class WeightedVoting {
+    proposal: {
+        choices: string[];
+    };
+    votes: WeightedVote[];
+    strategies: Strategy[];
+    selected: {
+        [key: string]: number;
+    };
+    constructor(proposal: {
+        choices: string[];
+    }, votes: WeightedVote[], strategies: Strategy[], selected: {
+        [key: string]: number;
+    });
+    static isValidChoice(voteChoice: {
+        [key: string]: number;
+    }, proposalChoices: string[]): boolean;
+    getValidVotes(): WeightedVote[];
+    getScores(): number[];
+    getScoresByStrategy(): number[][];
+    getScoresTotal(): number;
+    getChoiceString(): string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snapshot-labs/snapshot.js",
-  "version": "0.11.38",
+  "version": "0.12.0-beta.1",
   "repository": "snapshot-labs/snapshot.js",
   "license": "MIT",
   "main": "dist/snapshot.cjs.js",
@@ -22,7 +22,8 @@
     "ajv-formats": "^2.1.1",
     "cross-fetch": "^3.1.6",
     "json-to-graphql-query": "^2.2.4",
-    "lodash.set": "^4.3.2"
+    "lodash.set": "^4.3.2",
+    "starknet": "^5.24.3"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^18.1.0",
@@ -45,7 +46,7 @@
     "rollup-plugin-terser": "^7.0.0",
     "rollup-plugin-typescript2": "^0.27.0",
     "ts-node": "^10.9.2",
-    "typescript": "^3.8.3",
+    "typescript": "^5",
     "vitest": "^0.33.0"
   },
   "scripts": {
@@ -55,6 +56,7 @@
     "test:once": "vitest run",
     "dev": "rollup -c -w",
     "lint": "eslint . --ext .ts --fix",
+    "typecheck": "tsc --noEmit",
     "prepublishOnly": "yarn build"
   },
   "engines": {

package/src/sign/hashedTypes.json

@@ -55,5 +55,9 @@
   "daaf0ff7d3e2ec189cf851228c386c7a4c432076d0ed197864916dd3f656531c": "subscribe",
   "f542edb6f9fe79d0b85554667991352be2fcca85df3dd3c6a6f451d189c7c25d": "unsubscribe",
   "6f6cdd15a1e9e6c4ee544231c4fa7b6c7e5183bc2b37fa4bd1a695f458348ab7": "delete-space",
-  "1aad7825b991457fca04aae48a2a49d815ada524e10316af0da5522ea48b3df6": "alias"
+  "1aad7825b991457fca04aae48a2a49d815ada524e10316af0da5522ea48b3df6": "alias",
+  "8ea9074bff3a30cb61f4f0f0f142c9335c6be828feba0571a45de3f1fd0319c0": "alias",
+  "42f8858a21d4aa232721cb97074851e729829ea362b88bb21f3879899663b586": "follow",
+  "2bb75450e28b06f259ea764cd669de6bde0ba70ce729b0ff05ab9df56e0ff21d": "unfollow",
+  "2ffbebcbd22ef48fd2f4a1182ff1feda7795b57689bd6f0dd73c89e925e7fefb": "profile"
 }

package/src/utils/dist/provider.js

@@ -0,0 +1,47 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+exports.__esModule = true;
+exports.getBatchedProvider = void 0;
+var providers_1 = require("@ethersproject/providers");
+var networks_json_1 = require("../networks.json");
+var providers = {};
+function getProvider(network, type) {
+    var _a;
+    if (type === void 0) { type = 'archive'; }
+    var url = networks_json_1["default"][network].rpc[0];
+    if (type === 'light' && ((_a = networks_json_1["default"][network].light) === null || _a === void 0 ? void 0 : _a.length))
+        url = networks_json_1["default"][network].light[0];
+    var connectionInfo = typeof url === 'object'
+        ? __assign(__assign({}, url), { timeout: 25000 }) : { url: url, timeout: 25000 };
+    if (!providers[network] || !providers[network][type]) {
+        providers[network] = __assign({}, providers[network]);
+        providers[network][type] = new providers_1.StaticJsonRpcProvider(connectionInfo);
+    }
+    return providers[network][type];
+}
+exports["default"] = getProvider;
+function getBatchedProvider(network, type) {
+    var _a;
+    if (type === void 0) { type = 'archive'; }
+    var url = networks_json_1["default"][network].rpc[0];
+    if (type === 'light' && ((_a = networks_json_1["default"][network].light) === null || _a === void 0 ? void 0 : _a.length))
+        url = networks_json_1["default"][network].light[0];
+    var connectionInfo = typeof url === 'object'
+        ? __assign(__assign({}, url), { timeout: 25000 }) : { url: url, timeout: 25000 };
+    if (!providers[network] || !providers[network][type]) {
+        providers[network] = __assign({}, providers[network]);
+        providers[network][type] = new providers_1.JsonRpcBatchProvider(connectionInfo);
+    }
+    return providers[network][type];
+}
+exports.getBatchedProvider = getBatchedProvider;