@nexusmutual/deployments - npm Package Compare versions

Comparing version 2.3.0 to 2.4.0-rc0

package.json

 {
   "name": "@nexusmutual/deployments",
-  "version": "2.3.0",
+  "version": "2.4.0-rc0",
   "description": "Nexus Mutual deployed contract addresses and abis",
@@ -5,0 +5,0 @@ "typings": "./dist/index.d.ts",

README.md

@@ -7,52 +7,68 @@ # Nexus Mutual Deployment
 
-### CommonJS
+### Variables
 
-```javascript
-  // import everything in one go
-  const deployments = require('@nexusmutual/deployments');
-  console.log(`NXM Token address: ${deployments.addresses.NXMToken}`);
+`addresses`:
+Contains addresses of all contracts.
 
-  // import addresses only
-  const addresses = require('@nexusmutual/deployments/addresses');
+Example:
 
-  // import abis only
-  const abis = require('@nexusmutual/deployments/abis');
+```typescript
+import { addresses } from '@nexusmutual/deployments';
 
-  // import a specific abi
-  const coverAbi = require('@nexusmutual/deployments/abis/Cover');
+console.log(addresses.Assessment); // Outputs: 0x0E801D84Fa9...
+```
 
-  // Create a contract instance
-  const ethers = require('ethers');
+`abis`:
+A map which contains abi definitions for all contracts.
 
-  const provider = new ethers.providers.JsonRpcProvider(PROVIDER_URL);
-  const coverContract = new ethers.Contract(addresses.Cover, coverAbi, provider);
+Example:
 
-  const stakingPoolAddress = await coverContract.stakingPool(2);
-  console.log(`Staking pool #2 is at: ${stakingPoolAddress}`);
+```typescript
+import { abis } from '@nexusmutual/deployments';
+
+console.log(abis.Assessment); // Outputs: [{ inputs: [{ internalType: "ad...
 ```
 
-### ESM
+You can also import them in a treeshakable manner:
 
-```javascript
-  // import everything in one go
-  import deployments from '@nexusmutual/deployments';
-  console.log(`NXM Token address (import all): ${deployments.addresses.NXMToken}`);
+```typescript
+import { Assessment as AssessmentAbi } from '@nexusmutual/deployments';
 
-  // import addresses only
-  import addresses from '@nexusmutual/deployments/addresses';
-  console.log(`NXM Token address (import addresses): ${addresses.NXMToken}`);
+console.log(AssessmentAbi); // Outputs: [{ inputs: [{ internalType: "ad...
+```
 
-  // import abis only
-  import abis from '@nexusmutual/deployments/abis';
-  console.log(`Contract list: ${Object.keys(abis).join(', ')}`);
+### Exported ABIs
 
-  // import a specific abi and create a contract instance
-  import ethers from 'ethers';
-  import coverAbi from '@nexusmutual/deployments/abis/Cover';
+The addresses and ABIs are also exported as `addresses.json` and `abis/*.json` for convenience. These files are located in the `dist/data` folder. You can reference them directly in `node_modules` as follows:
 
-  const provider = new ethers.providers.JsonRpcProvider(PROVIDER_URL);
-  const coverContract = new ethers.Contract(addresses.Cover, coverAbi, provider);
+```
+node_modules/@nexusmutual/deployments/dist/data/addresses.json
+```
 
-  const stakingPoolAddress = await coverContract.stakingPool(2);
-  console.log(`Staking pool #2 is at: ${stakingPoolAddress}`);
+or
+
 ```
+node_modules/@nexusmutual/deployments/dist/data/abis/Assessment.json
+```
+
+## Building the Package
+
+Run build script:
+
+```shell
+npm run build:deployments
+```
+
+This script will generate abis and typings for contracts defined by `contractList` in the `build.js` file using Hardhat. The script will also auto update the `package.json` version.
+
+## Deploying locally
+
+The script requires two environment variables to run:
+
+```
+# These can be found in .env.sample
+ADDRESSES_FILE=./deployments/src/addresses.json
+ABI_DIR=./deployments/generated/abis
+```
+
+These variables specify the output location of the generated addresses and ABIs. On these default locations they will be picked up by the build, which can be useful for local development in combination with `npm link`. See the [local development docs](https://www.notion.so/nxmcommunity/Local-development-95f84f09cbfb4b90bcdcba52e1d2fa90?pvs=4) for more details.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3675069

increased by19.42%

Number of package files

43

increased by377.78%

Lines of code

91025

increased by38.73%

Number of lines in readme file

74

increased by27.59%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes