@nexusmutual/sdk 0.4.13 → 0.4.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -3
- package/package.json +7 -2
package/README.md
CHANGED
|
@@ -12,9 +12,7 @@ This package only exports CommonJS modules. You can import it like this:
|
|
|
12
12
|
|
|
13
13
|
```js
|
|
14
14
|
// Usage with ES6 modules
|
|
15
|
-
import products from '@nexusmutual/sdk
|
|
16
|
-
import productTypes from '@nexusmutual/sdk/product-types'
|
|
17
|
-
// logos?
|
|
15
|
+
import { products, productTypes } from '@nexusmutual/sdk'
|
|
18
16
|
```
|
|
19
17
|
|
|
20
18
|
## Nexus Mutual contract addresses and abis
|
|
@@ -30,3 +28,30 @@ Logos should meet the following criteria:
|
|
|
30
28
|
- svg format, with 1:1 ratio
|
|
31
29
|
- no fixed width or height
|
|
32
30
|
- the image should reach the edge of the viewbox
|
|
31
|
+
|
|
32
|
+
## Development
|
|
33
|
+
|
|
34
|
+
### Install dependencies
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
npm ci
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Install husky
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx husky install
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
to activate **husky** in project
|
|
47
|
+
|
|
48
|
+
### ENV variables setup
|
|
49
|
+
|
|
50
|
+
Copy the `.env.example` file into `.env` and populate with the required values.
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### Build locally
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
npm build
|
|
57
|
+
```
|
package/package.json
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nexusmutual/sdk",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.14",
|
|
4
4
|
"description": "Nexus Mutual SDK",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "node scripts/build.js",
|
|
7
7
|
"lint": "eslint --max-warnings 0 .",
|
|
8
8
|
"lint:fix": "npm run lint -- --fix",
|
|
9
|
+
"format": "prettier --loglevel silent --check 'src/**/*.{js,jsx,ts,tsx}'",
|
|
10
|
+
"format:fix": "prettier --loglevel silent --write 'src/**/*.{js,jsx,ts,tsx}'",
|
|
9
11
|
"test": "jest",
|
|
10
12
|
"test:watch": "jest --watch",
|
|
11
13
|
"list:products": "node scripts/list-products.js",
|
|
@@ -38,6 +40,8 @@
|
|
|
38
40
|
"svgo": "^3.0.2"
|
|
39
41
|
},
|
|
40
42
|
"devDependencies": {
|
|
43
|
+
"@commitlint/cli": "13.2.1",
|
|
44
|
+
"@commitlint/config-conventional": "13.2.0",
|
|
41
45
|
"@types/jest": "^29.5.5",
|
|
42
46
|
"@typescript-eslint/eslint-plugin": "^7.5.0",
|
|
43
47
|
"@typescript-eslint/parser": "^7.5.0",
|
|
@@ -54,7 +58,8 @@
|
|
|
54
58
|
"eslint-plugin-promise": "^6.1.1",
|
|
55
59
|
"eslint-plugin-standard": "^5.0.0",
|
|
56
60
|
"ethers": "^5.7.2",
|
|
57
|
-
"husky": "
|
|
61
|
+
"husky": "9.0.11",
|
|
62
|
+
"is-ci": "3.0.1",
|
|
58
63
|
"jest": "^29.7.0",
|
|
59
64
|
"jest-mock-axios": "^4.7.3",
|
|
60
65
|
"node-fetch": "^2.6.9",
|