@snapshot-labs/snapshot.js 0.10.1 → 0.11.1

package/dist/index.d.ts

@@ -283,10 +283,18 @@ declare const _default: {
                         delay: {
                             type: string;
                             minimum: number;
+                            maximum: number;
+                            errorMessage: {
+                                maximum: string;
+                            };
                         };
                         period: {
                             type: string;
                             minimum: number;
+                            maximum: number;
+                            errorMessage: {
+                                maximum: string;
+                            };
                         };
                         type: {
                             type: string;

package/dist/schemas/index.d.ts

@@ -279,10 +279,18 @@ declare const _default: {
                     delay: {
                         type: string;
                         minimum: number;
+                        maximum: number;
+                        errorMessage: {
+                            maximum: string;
+                        };
                     };
                     period: {
                         type: string;
                         minimum: number;
+                        maximum: number;
+                        errorMessage: {
+                            maximum: string;
+                        };
                     };
                     type: {
                         type: string;

package/dist/snapshot.cjs.js

@@ -9,6 +9,7 @@ var hash = require('@ethersproject/hash');
 var jsonToGraphqlQuery = require('json-to-graphql-query');
 var Ajv = require('ajv');
 var addFormats = require('ajv-formats');
+var addErrors = require('ajv-errors');
 var set = require('lodash.set');
 var providers$1 = require('@ethersproject/providers');
 var bytes = require('@ethersproject/bytes');
@@ -19,6 +20,7 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
 var Ajv__default = /*#__PURE__*/_interopDefaultLegacy(Ajv);
 var addFormats__default = /*#__PURE__*/_interopDefaultLegacy(addFormats);
+var addErrors__default = /*#__PURE__*/_interopDefaultLegacy(addErrors);
 var set__default = /*#__PURE__*/_interopDefaultLegacy(set);
 
 /*! *****************************************************************************
@@ -870,11 +872,19 @@ var definitions = {
 				properties: {
 					delay: {
 						type: "integer",
-						minimum: 0
+						minimum: 0,
+						maximum: 2592000,
+						errorMessage: {
+							maximum: "Delay must be less than 30 days"
+						}
 					},
 					period: {
 						type: "integer",
-						minimum: 0
+						minimum: 0,
+						maximum: 15552000,
+						errorMessage: {
+							maximum: "Delay must be less than 180 days"
+						}
 					},
 					type: {
 						type: "string",
@@ -2990,17 +3000,6 @@ var networks = {
 }
 };
 
-var delegationSubgraphs = {
-	"1": "https://subgrapher.snapshot.org/gateway-arbitrum.network.thegraph.com/api/0f15b42bdeff7a063a4e1757d7e2f99e/subgraphs/id/4YgtogVaqoM8CErHWDK8mKQ825BcVdKB8vBYmb4avAQo",
-	"5": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-goerli",
-	"10": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-optimism",
-	"56": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-binance-smart-chain",
-	"100": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-gnosis-chain",
-	"137": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-polygon",
-	"250": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-fantom",
-	"42161": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-arbitrum"
-};
-
 var SingleChoiceVoting = /** @class */ (function () {
     function SingleChoiceVoting(proposal, votes, strategies, selected) {
         this.proposal = proposal;
@@ -3412,7 +3411,113 @@ var voting = {
     basic: SingleChoiceVoting
 };
 
+var delegationSubgraphs = {
+	"1": "https://subgrapher.snapshot.org/gateway-arbitrum.network.thegraph.com/api/0f15b42bdeff7a063a4e1757d7e2f99e/subgraphs/id/4YgtogVaqoM8CErHWDK8mKQ825BcVdKB8vBYmb4avAQo",
+	"5": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-goerli",
+	"10": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-optimism",
+	"56": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-binance-smart-chain",
+	"100": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-gnosis-chain",
+	"137": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-polygon",
+	"250": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-fantom",
+	"42161": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-arbitrum"
+};
+
 var SNAPSHOT_SUBGRAPH_URL = delegationSubgraphs;
+var PAGE_SIZE = 1000;
+function getDelegatesBySpace(network, space, snapshot, options) {
+    if (snapshot === void 0) { snapshot = 'latest'; }
+    if (options === void 0) { options = {}; }
+    return __awaiter(this, void 0, void 0, function () {
+        var subgraphUrl, pivot, result, spaceIn, newResults;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    subgraphUrl = options.subgraphUrl || SNAPSHOT_SUBGRAPH_URL[network];
+                    if (!subgraphUrl) {
+                        return [2 /*return*/, Promise.reject("Delegation subgraph not available for network " + network)];
+                    }
+                    pivot = 0;
+                    result = new Map();
+                    spaceIn = buildSpaceIn(space);
+                    _a.label = 1;
+                case 1:
+                    return [4 /*yield*/, fetchData({
+                            url: subgraphUrl,
+                            spaces: spaceIn,
+                            pivot: pivot,
+                            snapshot: snapshot
+                        })];
+                case 2:
+                    newResults = _a.sent();
+                    if (checkAllDuplicates(newResults)) {
+                        throw new Error('Unable to paginate delegation');
+                    }
+                    newResults.forEach(function (delegation) {
+                        concatUniqueDelegation(result, delegation);
+                        pivot = delegation.timestamp;
+                    });
+                    if (newResults.length < PAGE_SIZE)
+                        return [3 /*break*/, 3];
+                    return [3 /*break*/, 1];
+                case 3: return [2 /*return*/, __spread(result.values())];
+            }
+        });
+    });
+}
+function checkAllDuplicates(delegations) {
+    return (delegations.length === PAGE_SIZE &&
+        delegations[0].timestamp === delegations[delegations.length - 1].timestamp);
+}
+function delegationKey(delegation) {
+    return delegation.delegator + "-" + delegation.delegate + "-" + delegation.space;
+}
+function concatUniqueDelegation(result, delegation) {
+    var key = delegationKey(delegation);
+    if (!result.has(key)) {
+        result.set(key, delegation);
+    }
+}
+function buildSpaceIn(space) {
+    var spaces = ['', space];
+    if (space.includes('.eth'))
+        spaces.push(space.replace('.eth', ''));
+    return spaces;
+}
+function fetchData(_a) {
+    var url = _a.url, spaces = _a.spaces, pivot = _a.pivot, snapshot = _a.snapshot;
+    return __awaiter(this, void 0, void 0, function () {
+        var params;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    params = {
+                        delegations: {
+                            __args: {
+                                where: {
+                                    space_in: spaces,
+                                    timestamp_gte: pivot
+                                },
+                                first: PAGE_SIZE,
+                                skip: 0,
+                                orderBy: 'timestamp',
+                                orderDirection: 'asc'
+                            },
+                            delegator: true,
+                            space: true,
+                            delegate: true,
+                            timestamp: true
+                        }
+                    };
+                    if (snapshot !== 'latest') {
+                        params.delegations.__args.block = { number: snapshot };
+                    }
+                    return [4 /*yield*/, subgraphRequest(url, params)];
+                case 1: return [2 /*return*/, (_b.sent()).delegations || []];
+            }
+        });
+    });
+}
+
 var ENS_RESOLVER_ABI = [
     'function text(bytes32 node, string calldata key) external view returns (string memory)'
 ];
@@ -3429,6 +3534,7 @@ var ajv = new Ajv__default['default']({
 });
 // @ts-ignore
 addFormats__default['default'](ajv);
+addErrors__default['default'](ajv);
 ajv.addFormat('address', {
     validate: function (value) {
         try {
@@ -3972,58 +4078,6 @@ function getSpaceController(id, network, options) {
         });
     });
 }
-function getDelegatesBySpace(network, space, snapshot, options) {
-    if (snapshot === void 0) { snapshot = 'latest'; }
-    if (options === void 0) { options = {}; }
-    return __awaiter(this, void 0, void 0, function () {
-        var subgraphUrl, spaceIn, PAGE_SIZE, result, page, params, pageResult, pageDelegations;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    subgraphUrl = options.subgraphUrl || SNAPSHOT_SUBGRAPH_URL[network];
-                    if (!subgraphUrl) {
-                        return [2 /*return*/, Promise.reject("Delegation subgraph not available for network " + network)];
-                    }
-                    spaceIn = ['', space];
-                    if (space.includes('.eth'))
-                        spaceIn.push(space.replace('.eth', ''));
-                    PAGE_SIZE = 1000;
-                    result = [];
-                    page = 0;
-                    params = {
-                        delegations: {
-                            __args: {
-                                where: {
-                                    space_in: spaceIn
-                                },
-                                first: PAGE_SIZE,
-                                skip: 0
-                            },
-                            delegator: true,
-                            space: true,
-                            delegate: true
-                        }
-                    };
-                    if (snapshot !== 'latest') {
-                        params.delegations.__args.block = { number: snapshot };
-                    }
-                    _a.label = 1;
-                case 1:
-                    params.delegations.__args.skip = page * PAGE_SIZE;
-                    return [4 /*yield*/, subgraphRequest(subgraphUrl, params)];
-                case 2:
-                    pageResult = _a.sent();
-                    pageDelegations = pageResult.delegations || [];
-                    result = result.concat(pageDelegations);
-                    page++;
-                    if (pageDelegations.length < PAGE_SIZE)
-                        return [3 /*break*/, 3];
-                    return [3 /*break*/, 1];
-                case 3: return [2 /*return*/, result];
-            }
-        });
-    });
-}
 function clone(item) {
     return JSON.parse(JSON.stringify(item));
 }

package/dist/snapshot.esm.js

@@ -7,6 +7,7 @@ import { _TypedDataEncoder, namehash, ensNormalize } from '@ethersproject/hash';
 import { jsonToGraphQLQuery } from 'json-to-graphql-query';
 import Ajv from 'ajv';
 import addFormats from 'ajv-formats';
+import addErrors from 'ajv-errors';
 import set from 'lodash.set';
 import { StaticJsonRpcProvider } from '@ethersproject/providers';
 import { hexlify, arrayify } from '@ethersproject/bytes';
@@ -861,11 +862,19 @@ var definitions = {
 				properties: {
 					delay: {
 						type: "integer",
-						minimum: 0
+						minimum: 0,
+						maximum: 2592000,
+						errorMessage: {
+							maximum: "Delay must be less than 30 days"
+						}
 					},
 					period: {
 						type: "integer",
-						minimum: 0
+						minimum: 0,
+						maximum: 15552000,
+						errorMessage: {
+							maximum: "Delay must be less than 180 days"
+						}
 					},
 					type: {
 						type: "string",
@@ -2981,17 +2990,6 @@ var networks = {
 }
 };
 
-var delegationSubgraphs = {
-	"1": "https://subgrapher.snapshot.org/gateway-arbitrum.network.thegraph.com/api/0f15b42bdeff7a063a4e1757d7e2f99e/subgraphs/id/4YgtogVaqoM8CErHWDK8mKQ825BcVdKB8vBYmb4avAQo",
-	"5": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-goerli",
-	"10": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-optimism",
-	"56": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-binance-smart-chain",
-	"100": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-gnosis-chain",
-	"137": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-polygon",
-	"250": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-fantom",
-	"42161": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-arbitrum"
-};
-
 var SingleChoiceVoting = /** @class */ (function () {
     function SingleChoiceVoting(proposal, votes, strategies, selected) {
         this.proposal = proposal;
@@ -3403,7 +3401,113 @@ var voting = {
     basic: SingleChoiceVoting
 };
 
+var delegationSubgraphs = {
+	"1": "https://subgrapher.snapshot.org/gateway-arbitrum.network.thegraph.com/api/0f15b42bdeff7a063a4e1757d7e2f99e/subgraphs/id/4YgtogVaqoM8CErHWDK8mKQ825BcVdKB8vBYmb4avAQo",
+	"5": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-goerli",
+	"10": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-optimism",
+	"56": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-binance-smart-chain",
+	"100": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-gnosis-chain",
+	"137": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-polygon",
+	"250": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-fantom",
+	"42161": "https://subgrapher.snapshot.org/api.thegraph.com/subgraphs/name/snapshot-labs/snapshot-arbitrum"
+};
+
 var SNAPSHOT_SUBGRAPH_URL = delegationSubgraphs;
+var PAGE_SIZE = 1000;
+function getDelegatesBySpace(network, space, snapshot, options) {
+    if (snapshot === void 0) { snapshot = 'latest'; }
+    if (options === void 0) { options = {}; }
+    return __awaiter(this, void 0, void 0, function () {
+        var subgraphUrl, pivot, result, spaceIn, newResults;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    subgraphUrl = options.subgraphUrl || SNAPSHOT_SUBGRAPH_URL[network];
+                    if (!subgraphUrl) {
+                        return [2 /*return*/, Promise.reject("Delegation subgraph not available for network " + network)];
+                    }
+                    pivot = 0;
+                    result = new Map();
+                    spaceIn = buildSpaceIn(space);
+                    _a.label = 1;
+                case 1:
+                    return [4 /*yield*/, fetchData({
+                            url: subgraphUrl,
+                            spaces: spaceIn,
+                            pivot: pivot,
+                            snapshot: snapshot
+                        })];
+                case 2:
+                    newResults = _a.sent();
+                    if (checkAllDuplicates(newResults)) {
+                        throw new Error('Unable to paginate delegation');
+                    }
+                    newResults.forEach(function (delegation) {
+                        concatUniqueDelegation(result, delegation);
+                        pivot = delegation.timestamp;
+                    });
+                    if (newResults.length < PAGE_SIZE)
+                        return [3 /*break*/, 3];
+                    return [3 /*break*/, 1];
+                case 3: return [2 /*return*/, __spread(result.values())];
+            }
+        });
+    });
+}
+function checkAllDuplicates(delegations) {
+    return (delegations.length === PAGE_SIZE &&
+        delegations[0].timestamp === delegations[delegations.length - 1].timestamp);
+}
+function delegationKey(delegation) {
+    return delegation.delegator + "-" + delegation.delegate + "-" + delegation.space;
+}
+function concatUniqueDelegation(result, delegation) {
+    var key = delegationKey(delegation);
+    if (!result.has(key)) {
+        result.set(key, delegation);
+    }
+}
+function buildSpaceIn(space) {
+    var spaces = ['', space];
+    if (space.includes('.eth'))
+        spaces.push(space.replace('.eth', ''));
+    return spaces;
+}
+function fetchData(_a) {
+    var url = _a.url, spaces = _a.spaces, pivot = _a.pivot, snapshot = _a.snapshot;
+    return __awaiter(this, void 0, void 0, function () {
+        var params;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    params = {
+                        delegations: {
+                            __args: {
+                                where: {
+                                    space_in: spaces,
+                                    timestamp_gte: pivot
+                                },
+                                first: PAGE_SIZE,
+                                skip: 0,
+                                orderBy: 'timestamp',
+                                orderDirection: 'asc'
+                            },
+                            delegator: true,
+                            space: true,
+                            delegate: true,
+                            timestamp: true
+                        }
+                    };
+                    if (snapshot !== 'latest') {
+                        params.delegations.__args.block = { number: snapshot };
+                    }
+                    return [4 /*yield*/, subgraphRequest(url, params)];
+                case 1: return [2 /*return*/, (_b.sent()).delegations || []];
+            }
+        });
+    });
+}
+
 var ENS_RESOLVER_ABI = [
     'function text(bytes32 node, string calldata key) external view returns (string memory)'
 ];
@@ -3420,6 +3524,7 @@ var ajv = new Ajv({
 });
 // @ts-ignore
 addFormats(ajv);
+addErrors(ajv);
 ajv.addFormat('address', {
     validate: function (value) {
         try {
@@ -3963,58 +4068,6 @@ function getSpaceController(id, network, options) {
         });
     });
 }
-function getDelegatesBySpace(network, space, snapshot, options) {
-    if (snapshot === void 0) { snapshot = 'latest'; }
-    if (options === void 0) { options = {}; }
-    return __awaiter(this, void 0, void 0, function () {
-        var subgraphUrl, spaceIn, PAGE_SIZE, result, page, params, pageResult, pageDelegations;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    subgraphUrl = options.subgraphUrl || SNAPSHOT_SUBGRAPH_URL[network];
-                    if (!subgraphUrl) {
-                        return [2 /*return*/, Promise.reject("Delegation subgraph not available for network " + network)];
-                    }
-                    spaceIn = ['', space];
-                    if (space.includes('.eth'))
-                        spaceIn.push(space.replace('.eth', ''));
-                    PAGE_SIZE = 1000;
-                    result = [];
-                    page = 0;
-                    params = {
-                        delegations: {
-                            __args: {
-                                where: {
-                                    space_in: spaceIn
-                                },
-                                first: PAGE_SIZE,
-                                skip: 0
-                            },
-                            delegator: true,
-                            space: true,
-                            delegate: true
-                        }
-                    };
-                    if (snapshot !== 'latest') {
-                        params.delegations.__args.block = { number: snapshot };
-                    }
-                    _a.label = 1;
-                case 1:
-                    params.delegations.__args.skip = page * PAGE_SIZE;
-                    return [4 /*yield*/, subgraphRequest(subgraphUrl, params)];
-                case 2:
-                    pageResult = _a.sent();
-                    pageDelegations = pageResult.delegations || [];
-                    result = result.concat(pageDelegations);
-                    page++;
-                    if (pageDelegations.length < PAGE_SIZE)
-                        return [3 /*break*/, 3];
-                    return [3 /*break*/, 1];
-                case 3: return [2 /*return*/, result];
-            }
-        });
-    });
-}
 function clone(item) {
     return JSON.parse(JSON.stringify(item));
 }