@safe-global/safe-modules-deployments 1.1.0

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './allowance-module';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./allowance-module"), exports);
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -0,0 +1,12 @@
+export interface SingletonDeployment {
+    version: string;
+    abi: any[];
+    networkAddresses: Record<string, string>;
+    contractName: string;
+    released: boolean;
+}
+export interface DeploymentFilter {
+    version?: string;
+    released?: boolean;
+    network?: string;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+import { DeploymentFilter, SingletonDeployment } from './types';
+export declare const findDeployment: (criteria: DeploymentFilter, deployments: SingletonDeployment[]) => SingletonDeployment | undefined;
+export declare const applyFilterDefaults: (filter?: DeploymentFilter | undefined) => DeploymentFilter;

package/dist/utils.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyFilterDefaults = exports.findDeployment = void 0;
+const findDeployment = (criteria, deployments) => deployments.find((deployment) => {
+    if (criteria.version && deployment.version !== criteria.version)
+        return false;
+    if (criteria.released && deployment.released != criteria.released)
+        return false;
+    if (criteria.network && !deployment.networkAddresses[criteria.network])
+        return false;
+    return true;
+});
+exports.findDeployment = findDeployment;
+const applyFilterDefaults = (filter) => {
+    if (!filter)
+        return { released: true };
+    return filter;
+};
+exports.applyFilterDefaults = applyFilterDefaults;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@safe-global/safe-modules-deployments",
+  "version": "1.1.0",
+  "description": "Collection of Safe Modules singleton deployments",
+  "homepage": "https://github.com/safe-global/safe-modules-deployments/",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "test",
+    "build"
+  ],
+  "scripts": {
+    "build": "yarn rimraf dist && tsc",
+    "lint": "eslint --max-warnings 0 .",
+    "prepack": "yarn build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/safe-global/safe-modules-deployments.git"
+  },
+  "keywords": [
+    "Ethereum",
+    "Wallet",
+    "Safe"
+  ],
+  "author": "mikhail@safe.global",
+  "bugs": {
+    "url": "https://github.com/safe-global/safe-modules-deployments/issues"
+  },
+  "devDependencies": {
+    "@types/node": "^14.14.21",
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
+    "eslint": "8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "prettier": "^2.1.2",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.2.4"
+  }
+}

package/src/allowance-module.ts

@@ -0,0 +1,10 @@
+import AllowanceModule010 from './assets/allowance-module/v0.1.0/allowance-module.json';
+import { DeploymentFilter, SingletonDeployment } from './types';
+import { applyFilterDefaults, findDeployment } from './utils';
+
+// The array should be sorted from the latest version to the oldest.
+const ALLOWANCE_MODULE_DEPLOYMENTS: SingletonDeployment[] = [AllowanceModule010];
+
+export const getAllowanceModuleDeployment = (filter?: DeploymentFilter): SingletonDeployment | undefined => {
+  return findDeployment(applyFilterDefaults(filter), ALLOWANCE_MODULE_DEPLOYMENTS);
+};