@snapshot-labs/snapshot.js 0.8.3 → 0.9.1

package/dist/index.d.ts

@@ -80,6 +80,7 @@ declare const _default: {
                 };
                 network: {
                     type: string;
+                    snapshotNetwork: boolean;
                     title: string;
                     minLength: number;
                     maxLength: number;
@@ -116,6 +117,7 @@ declare const _default: {
                                 type: string;
                                 maxLength: number;
                                 title: string;
+                                snapshotNetwork: boolean;
                             };
                             params: {
                                 type: string;
@@ -337,6 +339,7 @@ declare const _default: {
                             };
                             network: {
                                 type: string;
+                                snapshotNetwork: boolean;
                                 title: string;
                                 maxLength: number;
                             };
@@ -554,6 +557,7 @@ declare const _default: {
                             network: {
                                 title: string;
                                 type: string;
+                                snapshotNetwork: boolean;
                             };
                             multisend: {
                                 title: string;

package/dist/schemas/index.d.ts

@@ -76,6 +76,7 @@ declare const _default: {
             };
             network: {
                 type: string;
+                snapshotNetwork: boolean;
                 title: string;
                 minLength: number;
                 maxLength: number;
@@ -112,6 +113,7 @@ declare const _default: {
                             type: string;
                             maxLength: number;
                             title: string;
+                            snapshotNetwork: boolean;
                         };
                         params: {
                             type: string;
@@ -333,6 +335,7 @@ declare const _default: {
                         };
                         network: {
                             type: string;
+                            snapshotNetwork: boolean;
                             title: string;
                             maxLength: number;
                         };
@@ -550,6 +553,7 @@ declare const _default: {
                         network: {
                             title: string;
                             type: string;
+                            snapshotNetwork: boolean;
                         };
                         multisend: {
                             title: string;

package/dist/snapshot.cjs.js

@@ -650,6 +650,7 @@ var definitions = {
 			},
 			network: {
 				type: "string",
+				snapshotNetwork: true,
 				title: "network",
 				minLength: 1,
 				maxLength: 32
@@ -685,7 +686,8 @@ var definitions = {
 						network: {
 							type: "string",
 							maxLength: 12,
-							title: "network"
+							title: "network",
+							snapshotNetwork: true
 						},
 						params: {
 							type: "object",
@@ -941,6 +943,7 @@ var definitions = {
 						},
 						network: {
 							type: "string",
+							snapshotNetwork: true,
 							title: "Network",
 							maxLength: 12
 						}
@@ -1269,7 +1272,8 @@ var definitions$6 = {
 					properties: {
 						network: {
 							title: "Network",
-							type: "string"
+							type: "string",
+							snapshotNetwork: true
 						},
 						multisend: {
 							title: "Multisend contract address",
@@ -3426,11 +3430,17 @@ var SNAPSHOT_SUBGRAPH_URL = delegationSubgraphs;
 var ENS_RESOLVER_ABI = [
     'function text(bytes32 node, string calldata key) external view returns (string memory)'
 ];
+var EMPTY_ADDRESS = '0x0000000000000000000000000000000000000000';
 var scoreApiHeaders = {
     Accept: 'application/json',
     'Content-Type': 'application/json'
 };
-var ajv = new Ajv__default['default']({ allErrors: true, allowUnionTypes: true, $data: true });
+var ajv = new Ajv__default['default']({
+    allErrors: true,
+    allowUnionTypes: true,
+    $data: true,
+    passContext: true
+});
 // @ts-ignore
 addFormats__default['default'](ajv);
 ajv.addFormat('address', {
@@ -3459,6 +3469,24 @@ ajv.addFormat('ethValue', {
         }
     }
 });
+var networksIds = Object.keys(networks);
+var mainnetNetworkIds = Object.keys(networks).filter(function (id) { return !networks[id].testnet; });
+var testnetNetworkIds = Object.keys(networks).filter(function (id) { return networks[id].testnet; });
+ajv.addKeyword({
+    keyword: 'snapshotNetwork',
+    validate: function (schema, data) {
+        // @ts-ignore
+        var snapshotEnv = this.snapshotEnv || 'default';
+        if (snapshotEnv === 'mainnet')
+            return mainnetNetworkIds.includes(data);
+        if (snapshotEnv === 'testnet')
+            return testnetNetworkIds.includes(data);
+        return networksIds.includes(data);
+    },
+    error: {
+        message: 'must be a valid network used by snapshot'
+    }
+});
 // Custom URL format to allow empty string values
 // https://github.com/snapshot-labs/snapshot.js/pull/541/files
 ajv.addFormat('customUrl', {
@@ -3630,10 +3658,30 @@ function getScores(space, strategies, network, addresses, snapshot, scoreApiUrl,
     if (scoreApiUrl === void 0) { scoreApiUrl = 'https://score.snapshot.org'; }
     if (options === void 0) { options = {}; }
     return __awaiter(this, void 0, void 0, function () {
-        var url, params, res, obj, e_3;
+        var invalidAddress, invalidStrategy, url, params, res, obj, e_3;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
+                    if (!Array.isArray(addresses)) {
+                        return [2 /*return*/, inputError('addresses should be an array of addresses')];
+                    }
+                    if (addresses.length === 0) {
+                        return [2 /*return*/, inputError('addresses can not be empty')];
+                    }
+                    invalidAddress = addresses.find(function (address) { return !isValidAddress(address); });
+                    if (invalidAddress) {
+                        return [2 /*return*/, inputError("Invalid address: " + invalidAddress)];
+                    }
+                    if (!isValidNetwork(network)) {
+                        return [2 /*return*/, inputError("Invalid network: " + network)];
+                    }
+                    invalidStrategy = strategies.find(function (strategy) { return strategy.network && !isValidNetwork(strategy.network); });
+                    if (invalidStrategy) {
+                        return [2 /*return*/, inputError("Invalid network (" + invalidStrategy.network + ") in strategy " + invalidStrategy.name)];
+                    }
+                    if (!isValidSnapshot(snapshot, network)) {
+                        return [2 /*return*/, inputError("Snapshot (" + snapshot + ") must be 'latest' or greater than network start block (" + networks[network].start + ")")];
+                    }
                     url = new URL(scoreApiUrl);
                     url.pathname = '/api/scores';
                     scoreApiUrl = url.toString();
@@ -3676,7 +3724,7 @@ function getScores(space, strategies, network, addresses, snapshot, scoreApiUrl,
 }
 function getVp(address, network, strategies, snapshot, space, delegation, options) {
     return __awaiter(this, void 0, void 0, function () {
-        var init, res, json, e_4;
+        var invalidStrategy, init, res, json, e_4;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -3684,6 +3732,19 @@ function getVp(address, network, strategies, snapshot, space, delegation, option
                         options = {};
                     if (!options.url)
                         options.url = 'https://score.snapshot.org';
+                    if (!isValidAddress(address)) {
+                        return [2 /*return*/, inputError("Invalid voter address: " + address)];
+                    }
+                    if (!isValidNetwork(network)) {
+                        return [2 /*return*/, inputError("Invalid network: " + network)];
+                    }
+                    invalidStrategy = strategies.find(function (strategy) { return strategy.network && !isValidNetwork(strategy.network); });
+                    if (invalidStrategy) {
+                        return [2 /*return*/, inputError("Invalid network (" + invalidStrategy.network + ") in strategy " + invalidStrategy.name)];
+                    }
+                    if (!isValidSnapshot(snapshot, network)) {
+                        return [2 /*return*/, inputError("Snapshot (" + snapshot + ") must be 'latest' or greater than network start block (" + networks[network].start + ")")];
+                    }
                     init = {
                         method: 'POST',
                         headers: scoreApiHeaders,
@@ -3731,6 +3792,15 @@ function validate(validation, author, space, network, snapshot, params, options)
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
+                    if (!isValidAddress(author)) {
+                        return [2 /*return*/, inputError("Invalid author: " + author)];
+                    }
+                    if (!isValidNetwork(network)) {
+                        return [2 /*return*/, inputError("Invalid network: " + network)];
+                    }
+                    if (!isValidSnapshot(snapshot, network)) {
+                        return [2 /*return*/, inputError("Snapshot (" + snapshot + ") must be 'latest' or greater than network start block (" + networks[network].start + ")")];
+                    }
                     if (!options)
                         options = {};
                     if (!options.url)
@@ -3774,9 +3844,12 @@ function validate(validation, author, space, network, snapshot, params, options)
         });
     });
 }
-function validateSchema(schema, data) {
+function validateSchema(schema, data, options) {
+    if (options === void 0) { options = {
+        snapshotEnv: 'default'
+    }; }
     var ajvValidate = ajv.compile(schema);
-    var valid = ajvValidate(data);
+    var valid = ajvValidate.call(options, data);
     return valid ? valid : ajvValidate.errors;
 }
 function getEnsTextRecord(ens, record, network, options) {
@@ -3943,6 +4016,19 @@ function getNumberWithOrdinal(n) {
     var s = ['th', 'st', 'nd', 'rd'], v = n % 100;
     return n + (s[(v - 20) % 10] || s[v] || s[0]);
 }
+function isValidNetwork(network) {
+    return !!networks[network];
+}
+function isValidAddress(address$1) {
+    return address.isAddress(address$1) && address$1 !== EMPTY_ADDRESS;
+}
+function isValidSnapshot(snapshot, network) {
+    return (snapshot === 'latest' ||
+        (typeof snapshot === 'number' && snapshot >= networks[network].start));
+}
+function inputError(message) {
+    return Promise.reject(new Error(message));
+}
 var utils = {
     call: call,
     multicall: multicall,

package/dist/snapshot.esm.js

@@ -641,6 +641,7 @@ var definitions = {
 			},
 			network: {
 				type: "string",
+				snapshotNetwork: true,
 				title: "network",
 				minLength: 1,
 				maxLength: 32
@@ -676,7 +677,8 @@ var definitions = {
 						network: {
 							type: "string",
 							maxLength: 12,
-							title: "network"
+							title: "network",
+							snapshotNetwork: true
 						},
 						params: {
 							type: "object",
@@ -932,6 +934,7 @@ var definitions = {
 						},
 						network: {
 							type: "string",
+							snapshotNetwork: true,
 							title: "Network",
 							maxLength: 12
 						}
@@ -1260,7 +1263,8 @@ var definitions$6 = {
 					properties: {
 						network: {
 							title: "Network",
-							type: "string"
+							type: "string",
+							snapshotNetwork: true
 						},
 						multisend: {
 							title: "Multisend contract address",
@@ -3417,11 +3421,17 @@ var SNAPSHOT_SUBGRAPH_URL = delegationSubgraphs;
 var ENS_RESOLVER_ABI = [
     'function text(bytes32 node, string calldata key) external view returns (string memory)'
 ];
+var EMPTY_ADDRESS = '0x0000000000000000000000000000000000000000';
 var scoreApiHeaders = {
     Accept: 'application/json',
     'Content-Type': 'application/json'
 };
-var ajv = new Ajv({ allErrors: true, allowUnionTypes: true, $data: true });
+var ajv = new Ajv({
+    allErrors: true,
+    allowUnionTypes: true,
+    $data: true,
+    passContext: true
+});
 // @ts-ignore
 addFormats(ajv);
 ajv.addFormat('address', {
@@ -3450,6 +3460,24 @@ ajv.addFormat('ethValue', {
         }
     }
 });
+var networksIds = Object.keys(networks);
+var mainnetNetworkIds = Object.keys(networks).filter(function (id) { return !networks[id].testnet; });
+var testnetNetworkIds = Object.keys(networks).filter(function (id) { return networks[id].testnet; });
+ajv.addKeyword({
+    keyword: 'snapshotNetwork',
+    validate: function (schema, data) {
+        // @ts-ignore
+        var snapshotEnv = this.snapshotEnv || 'default';
+        if (snapshotEnv === 'mainnet')
+            return mainnetNetworkIds.includes(data);
+        if (snapshotEnv === 'testnet')
+            return testnetNetworkIds.includes(data);
+        return networksIds.includes(data);
+    },
+    error: {
+        message: 'must be a valid network used by snapshot'
+    }
+});
 // Custom URL format to allow empty string values
 // https://github.com/snapshot-labs/snapshot.js/pull/541/files
 ajv.addFormat('customUrl', {
@@ -3621,10 +3649,30 @@ function getScores(space, strategies, network, addresses, snapshot, scoreApiUrl,
     if (scoreApiUrl === void 0) { scoreApiUrl = 'https://score.snapshot.org'; }
     if (options === void 0) { options = {}; }
     return __awaiter(this, void 0, void 0, function () {
-        var url, params, res, obj, e_3;
+        var invalidAddress, invalidStrategy, url, params, res, obj, e_3;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
+                    if (!Array.isArray(addresses)) {
+                        return [2 /*return*/, inputError('addresses should be an array of addresses')];
+                    }
+                    if (addresses.length === 0) {
+                        return [2 /*return*/, inputError('addresses can not be empty')];
+                    }
+                    invalidAddress = addresses.find(function (address) { return !isValidAddress(address); });
+                    if (invalidAddress) {
+                        return [2 /*return*/, inputError("Invalid address: " + invalidAddress)];
+                    }
+                    if (!isValidNetwork(network)) {
+                        return [2 /*return*/, inputError("Invalid network: " + network)];
+                    }
+                    invalidStrategy = strategies.find(function (strategy) { return strategy.network && !isValidNetwork(strategy.network); });
+                    if (invalidStrategy) {
+                        return [2 /*return*/, inputError("Invalid network (" + invalidStrategy.network + ") in strategy " + invalidStrategy.name)];
+                    }
+                    if (!isValidSnapshot(snapshot, network)) {
+                        return [2 /*return*/, inputError("Snapshot (" + snapshot + ") must be 'latest' or greater than network start block (" + networks[network].start + ")")];
+                    }
                     url = new URL(scoreApiUrl);
                     url.pathname = '/api/scores';
                     scoreApiUrl = url.toString();
@@ -3667,7 +3715,7 @@ function getScores(space, strategies, network, addresses, snapshot, scoreApiUrl,
 }
 function getVp(address, network, strategies, snapshot, space, delegation, options) {
     return __awaiter(this, void 0, void 0, function () {
-        var init, res, json, e_4;
+        var invalidStrategy, init, res, json, e_4;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -3675,6 +3723,19 @@ function getVp(address, network, strategies, snapshot, space, delegation, option
                         options = {};
                     if (!options.url)
                         options.url = 'https://score.snapshot.org';
+                    if (!isValidAddress(address)) {
+                        return [2 /*return*/, inputError("Invalid voter address: " + address)];
+                    }
+                    if (!isValidNetwork(network)) {
+                        return [2 /*return*/, inputError("Invalid network: " + network)];
+                    }
+                    invalidStrategy = strategies.find(function (strategy) { return strategy.network && !isValidNetwork(strategy.network); });
+                    if (invalidStrategy) {
+                        return [2 /*return*/, inputError("Invalid network (" + invalidStrategy.network + ") in strategy " + invalidStrategy.name)];
+                    }
+                    if (!isValidSnapshot(snapshot, network)) {
+                        return [2 /*return*/, inputError("Snapshot (" + snapshot + ") must be 'latest' or greater than network start block (" + networks[network].start + ")")];
+                    }
                     init = {
                         method: 'POST',
                         headers: scoreApiHeaders,
@@ -3722,6 +3783,15 @@ function validate(validation, author, space, network, snapshot, params, options)
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
+                    if (!isValidAddress(author)) {
+                        return [2 /*return*/, inputError("Invalid author: " + author)];
+                    }
+                    if (!isValidNetwork(network)) {
+                        return [2 /*return*/, inputError("Invalid network: " + network)];
+                    }
+                    if (!isValidSnapshot(snapshot, network)) {
+                        return [2 /*return*/, inputError("Snapshot (" + snapshot + ") must be 'latest' or greater than network start block (" + networks[network].start + ")")];
+                    }
                     if (!options)
                         options = {};
                     if (!options.url)
@@ -3765,9 +3835,12 @@ function validate(validation, author, space, network, snapshot, params, options)
         });
     });
 }
-function validateSchema(schema, data) {
+function validateSchema(schema, data, options) {
+    if (options === void 0) { options = {
+        snapshotEnv: 'default'
+    }; }
     var ajvValidate = ajv.compile(schema);
-    var valid = ajvValidate(data);
+    var valid = ajvValidate.call(options, data);
     return valid ? valid : ajvValidate.errors;
 }
 function getEnsTextRecord(ens, record, network, options) {
@@ -3934,6 +4007,19 @@ function getNumberWithOrdinal(n) {
     var s = ['th', 'st', 'nd', 'rd'], v = n % 100;
     return n + (s[(v - 20) % 10] || s[v] || s[0]);
 }
+function isValidNetwork(network) {
+    return !!networks[network];
+}
+function isValidAddress(address) {
+    return isAddress(address) && address !== EMPTY_ADDRESS;
+}
+function isValidSnapshot(snapshot, network) {
+    return (snapshot === 'latest' ||
+        (typeof snapshot === 'number' && snapshot >= networks[network].start));
+}
+function inputError(message) {
+    return Promise.reject(new Error(message));
+}
 var utils = {
     call: call,
     multicall: multicall,