@safe-global/safe-modules-deployments 1.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2018 Safe Ecosystem Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+# Safe Modules Deployments
+
+[![npm version](https://badge.fury.io/js/%40safe-global%2Fsafe-modules-deployments.svg)](https://badge.fury.io/js/%40safe-global%2Fsafe-modules-deployments)
+
+This contract contains a collection of deployments of audited contracts from the [Safe modules repository](https://github.com/safe-global/safe-modules).
+
+For each deployment the address on the different networks and the abi files are available. To get an overview of the available versions check the available [json assets](./src/assets/).
+
+To add additional deployments please follow the [deployment steps in the module folder in the Safe modules repository](https://github.com/safe-global/safe-modules).
+
+## Install
+
+- npm - `npm i @safe-global/safe-modules-deployments`
+- yarn - `yarn add @safe-global/safe-modules-deployments`
+
+## Usage
+
+It is possible to directly use the json files in the [assets folder](./src/assets/) that contain the addresses and abi definitions.
+
+An alternative is to use the JavaScript library methods to query the correct deployment. The library supports different methods to get the deployment of a specific contract.
+
+Each of the method takes an optional `DeploymentFilter` as a parameter.
+
+```ts
+interface DeploymentFilter {
+  version?: string;
+  released?: boolean; // Defaults to true if no filter is specified
+  network?: string; // Chain id of the network
+}
+```
+
+The method will return a `SingletonDeployment` object or `undefined` if no deployment was found for the specified filter.
+
+```ts
+interface SingletonDeployment {
+  version: string;
+  abi: any[];
+  networkAddresses: Record<string, string>; // Address of the contract by network
+  contractName: string;
+  released: boolean; // A released version was audited and has a running bug bounty
+}
+```
+
+- Allowance Module
+
+```ts
+const allowanceModule = getAllowanceModuleDeployment();
+
+// Returns latest contract version, even if not finally released yet
+const allowanceModuleNightly = getAllowanceModuleDeployment({ released: undefined });
+
+// Returns released contract version for specific network
+const allowanceModuleGörli = getAllowanceModuleDeployment({ network: '5' });
+
+// Returns released contract version for specific version
+const allowanceModule010 = getAllowanceModuleDeployment({ version: '0.1.0' });
+```
+
+## Notes
+
+A list of network information can be found at [chainid.network](https://chainid.network/)
+
+## License
+
+This library is released under MIT.

package/dist/allowance-module.d.ts

@@ -0,0 +1,2 @@
+import { DeploymentFilter, SingletonDeployment } from './types';
+export declare const getAllowanceModuleDeployment: (filter?: DeploymentFilter | undefined) => SingletonDeployment | undefined;

package/dist/allowance-module.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllowanceModuleDeployment = void 0;
+const allowance_module_json_1 = __importDefault(require("./assets/allowance-module/v0.1.0/allowance-module.json"));
+const utils_1 = require("./utils");
+// The array should be sorted from the latest version to the oldest.
+const ALLOWANCE_MODULE_DEPLOYMENTS = [allowance_module_json_1.default];
+const getAllowanceModuleDeployment = (filter) => {
+    return (0, utils_1.findDeployment)((0, utils_1.applyFilterDefaults)(filter), ALLOWANCE_MODULE_DEPLOYMENTS);
+};
+exports.getAllowanceModuleDeployment = getAllowanceModuleDeployment;