@venusprotocol/governance-contracts 0.0.1 → 1.0.0-dev.1
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 +73 -0
- package/package.json +39 -33
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# governance-contracts
|
|
2
|
+
|
|
3
|
+
### Compound Fork Commit
|
|
4
|
+
|
|
5
|
+
https://github.com/compound-finance/compound-protocol/tree/a3214f67b73310d547e00fc578e8355911c9d376
|
|
6
|
+
|
|
7
|
+
### Prerequisites
|
|
8
|
+
|
|
9
|
+
- NodeJS - 12.x
|
|
10
|
+
|
|
11
|
+
- Solc - v0.8.13 (https://github.com/ethereum/solidity/releases/tag/v0.8.13)
|
|
12
|
+
|
|
13
|
+
### Installing
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
npm install
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Run Tests
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
npx hardhat test
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Hardhat Commands
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
npx hardhat accounts
|
|
34
|
+
|
|
35
|
+
npx hardhat compile
|
|
36
|
+
|
|
37
|
+
npx hardhat clean
|
|
38
|
+
|
|
39
|
+
npx hardhat test
|
|
40
|
+
|
|
41
|
+
npx hardhat node
|
|
42
|
+
|
|
43
|
+
npx hardhat help
|
|
44
|
+
|
|
45
|
+
REPORT_GAS=true npx hardhat test
|
|
46
|
+
|
|
47
|
+
npx hardhat coverage
|
|
48
|
+
|
|
49
|
+
TS_NODE_FILES=true npx ts-node scripts/deploy.ts
|
|
50
|
+
|
|
51
|
+
npx eslint '**/*.{js,ts}'
|
|
52
|
+
|
|
53
|
+
npx eslint '**/*.{js,ts}' --fix
|
|
54
|
+
|
|
55
|
+
npx prettier '**/*.{json,sol,md}' --check
|
|
56
|
+
|
|
57
|
+
npx prettier '**/*.{json,sol,md}' --write
|
|
58
|
+
|
|
59
|
+
npx solhint 'contracts/**/*.sol'
|
|
60
|
+
|
|
61
|
+
npx solhint 'contracts/**/*.sol' --fix
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
MNEMONIC="<>" BSC_API_KEY="<>" npx hardhat run ./script/hardhat/deploy.ts --network testnet
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Documentation
|
|
70
|
+
|
|
71
|
+
Documentation is autogenerated using [solidity-docgen](https://github.com/OpenZeppelin/solidity-docgen).
|
|
72
|
+
|
|
73
|
+
They can be generated by running `yarn docgen`
|
package/package.json
CHANGED
|
@@ -1,8 +1,45 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@venusprotocol/governance-contracts",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "0.0.1",
|
|
4
|
+
"version": "1.0.0-dev.1",
|
|
5
5
|
"author": "",
|
|
6
|
+
"files": [
|
|
7
|
+
"/contracts"
|
|
8
|
+
],
|
|
9
|
+
"keywords": [
|
|
10
|
+
"blockchain",
|
|
11
|
+
"ethers",
|
|
12
|
+
"ethereum",
|
|
13
|
+
"hardhat",
|
|
14
|
+
"smart-contracts",
|
|
15
|
+
"solidity",
|
|
16
|
+
"template",
|
|
17
|
+
"typescript",
|
|
18
|
+
"typechain"
|
|
19
|
+
],
|
|
20
|
+
"exports": {
|
|
21
|
+
"deploy": "./dist/deploy",
|
|
22
|
+
"artifacts": "./artifacts",
|
|
23
|
+
"contracts": "./contracts",
|
|
24
|
+
"deployments": "./deployments"
|
|
25
|
+
},
|
|
26
|
+
"packageManager": "yarn@3.2.0",
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"access": "public"
|
|
29
|
+
},
|
|
30
|
+
"scripts": {
|
|
31
|
+
"compile": "hardhat compile",
|
|
32
|
+
"test": "hardhat test",
|
|
33
|
+
"build": "rm -rf dist && tsc --declaration && hardhat compile",
|
|
34
|
+
"publish:dist": "yarn build && cd dist && yarn publish --access public",
|
|
35
|
+
"lint": "yarn lint:ts && yarn lint:sol && yarn prettier:check",
|
|
36
|
+
"lint:ts": "eslint --ignore-path ./.eslintignore --ext .js,.ts .",
|
|
37
|
+
"lint:sol": "solhint \"contracts/**/*.sol\"",
|
|
38
|
+
"lint:sol:fix": "prettier --write \"contracts/**/*.sol\"",
|
|
39
|
+
"prettier": "prettier --write \"**/*.{js,json,md,ts,yaml,yml,sol}\"",
|
|
40
|
+
"prettier:check": "prettier --check \"**/*.{js,json,md,ts,yaml,yml,sol}\"",
|
|
41
|
+
"docgen": "hardhat docgen"
|
|
42
|
+
},
|
|
6
43
|
"devDependencies": {
|
|
7
44
|
"@commitlint/cli": "^17.4.4",
|
|
8
45
|
"@commitlint/config-conventional": "^17.4.4",
|
|
@@ -28,7 +65,7 @@
|
|
|
28
65
|
"@types/chai": "^4.3.4",
|
|
29
66
|
"@types/fs-extra": "^9.0.13",
|
|
30
67
|
"@types/mocha": "^10.0.0",
|
|
31
|
-
"@types/node": "^18.
|
|
68
|
+
"@types/node": "^18.16.3",
|
|
32
69
|
"@typescript-eslint/eslint-plugin": "^5.44.0",
|
|
33
70
|
"@typescript-eslint/parser": "^5.44.0",
|
|
34
71
|
"@venusprotocol/venus-protocol": "0.4.1",
|
|
@@ -65,36 +102,5 @@
|
|
|
65
102
|
"tsconfig-paths": "^4.1.2",
|
|
66
103
|
"typechain": "^8.1.1",
|
|
67
104
|
"typescript": "^4.9.3"
|
|
68
|
-
},
|
|
69
|
-
"files": [
|
|
70
|
-
"/contracts"
|
|
71
|
-
],
|
|
72
|
-
"keywords": [
|
|
73
|
-
"blockchain",
|
|
74
|
-
"ethers",
|
|
75
|
-
"ethereum",
|
|
76
|
-
"hardhat",
|
|
77
|
-
"smart-contracts",
|
|
78
|
-
"solidity",
|
|
79
|
-
"template",
|
|
80
|
-
"typescript",
|
|
81
|
-
"typechain"
|
|
82
|
-
],
|
|
83
|
-
"packageManager": "yarn@3.2.1",
|
|
84
|
-
"publishConfig": {
|
|
85
|
-
"access": "public"
|
|
86
|
-
},
|
|
87
|
-
"scripts": {
|
|
88
|
-
"compile": "hardhat compile",
|
|
89
|
-
"test": "hardhat test",
|
|
90
|
-
"build": "rm -rf dist && tsc --declaration && hardhat compile && cp -r ./{package.json,yarn.lock,artifacts,contracts} dist/",
|
|
91
|
-
"publish:dist": "yarn build && cd dist && yarn publish --access public",
|
|
92
|
-
"lint": "yarn lint:ts && yarn lint:sol && yarn prettier:check",
|
|
93
|
-
"lint:ts": "eslint --config ./.eslintrc.yaml --ignore-path ./.eslintignore --ext .js,.ts .",
|
|
94
|
-
"lint:sol": "solhint \"contracts/**/*.sol\"",
|
|
95
|
-
"lint:sol:fix": "prettier --write \"contracts/**/*.sol\"",
|
|
96
|
-
"prettier": "prettier --config ./.prettierrc.yaml --write \"**/*.{js,json,md,ts,yaml,yml,sol}\"",
|
|
97
|
-
"prettier:check": "prettier --check --config ./.prettierrc.yaml \"**/*.{js,json,md,ts,yaml,yml,sol}\"",
|
|
98
|
-
"docgen": "hardhat docgen"
|
|
99
105
|
}
|
|
100
106
|
}
|