Skip to content

Commit 0e66cc8

Browse files
Merge pull request #49 from DimensionDev/improvement/README
fix readme style, add generate-readme script and add abi check in workflow action
2 parents 4fb028c + 3f6cfbe commit 0e66cc8

11 files changed

+7553
-7507
lines changed
Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1-
name: test
1+
name: Test
22

33
on:
44
push:
5-
branches: [master]
5+
branches:
6+
- master
67
pull_request:
7-
branches: [master]
8+
branches:
9+
- master
810

911
jobs:
1012
test:
1113
runs-on: ubuntu-20.04
1214
steps:
13-
- uses: actions/checkout@v2
15+
- uses: actions/checkout@v3
16+
with:
17+
submodules: 'recursive'
1418
- uses: actions/setup-node@v2
1519
with:
1620
node-version: 15
17-
- run: git submodule init
18-
- run: git submodule update
1921
- run: npm ci
2022
- run: npm run compile
21-
# - run: npm install --no-save ganache-cli
22-
# - run: npx ganache-cli -a 100 &
23+
- run: git diff --exit-code
2324
- run: npm run test:normal
2425
- run: npm run test:erc721

.solhint.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"extends": "solhint:recommended",
3+
"rules": {
4+
"avoid-throw": false,
5+
"compiler-version": [
6+
"error",
7+
"^0.8.0"
8+
],
9+
"avoid-suicide": "error",
10+
"avoid-sha3": "warn"
11+
},
12+
"plugins": [
13+
"prettier"
14+
]
15+
}

README.md

Lines changed: 75 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -40,60 +40,81 @@ npm run deploy:ropsten
4040

4141
## Deployed Contract Address
4242

43-
### HappyRedPacket
44-
45-
| Chain | Address |
46-
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
47-
| Mainnet | [0xaBBe1101](https://etherscan.io/address/0xaBBe1101FD8fa5847c452A6D70C8655532B03C33) |
48-
| Ropsten | [0x0722507c](https://ropsten.etherscan.io/address/0x0722507c3b776A6B205946592016e358B0D34c3F) |
49-
| BSC | [0x0ca42C17](https://bscscan.com/address/0x0ca42C178e14c618c81B8438043F27d9D38145f6) |
50-
| Matic | [0x93e0b87A](https://polygonscan.com/address/0x93e0b87A0aD0C991dc1B5176ddCD850c9a78aabb) |
51-
| Rinkeby-Arbitrum | [0x4A77E797](https://rinkeby-explorer.arbitrum.io/address/0x4A77E797031257db72F7D2C3Ec08a4FAc5c8CfE9) |
52-
| Arbitrum | [0x83D6b366](https://explorer.arbitrum.io/address/0x83D6b366f21e413f214EB077D5378478e71a5eD2) |
53-
| xDai | [0x54a0A221](https://blockscout.com/xdai/mainnet/address/0x54a0A221C25Fc0a347EC929cFC5db0be17fA2a2B/transactions) |
54-
| Goerli | [0x8bF6b979](https://goerli.etherscan.io/address/0x8bF6b979286970860Adc75dc621cf1969b0bE66C) |
55-
| Fantom | [0x578a7Fee](https://ftmscan.com/address/0x578a7Fee5f0D8CEc7d00578Bf37374C5b95C4b98) |
56-
| Avalanche | [0xF9F7C149](https://snowtrace.io/address/0xF9F7C1496c21bC0180f4B64daBE0754ebFc8A8c0) |
57-
| Celo | [0xab7b1be4](https://explorer.celo.org/address/0xab7b1be4233a04e5c43a810e75657eced8e5463b/transactions) |
58-
| Kovan-optimistic | [0x68EDbfA3](https://kovan-optimistic.etherscan.io/address/0x68EDbfA3E564C987FaaAB54f4FD1E7567D4151Dd) |
59-
| Optimistic | [0x981be454](https://optimistic.etherscan.io/address/0x981be454a930479d92C91a0092D204b64845A5D6) |
60-
| Aurora | [0x19f179D7](https://explorer.mainnet.aurora.dev/address/0x19f179D7e0D7d9F9d5386afFF64271D98A91615B/transactions) |
61-
| Fuse | [0x561c5f3a](https://explorer.fuse.io/address/0x561c5f3a19871ecb1273D6D8eCc276BeEDa5c8b4/transactions) |
62-
| Boba | [0x578a7Fee](https://blockexplorer.boba.network/address/0x578a7Fee5f0D8CEc7d00578Bf37374C5b95C4b98/transactions) |
63-
| Moonriver | [0x578a7Fee](https://moonriver.moonscan.io/address/0x578a7Fee5f0D8CEc7d00578Bf37374C5b95C4b98) |
64-
| CFX eSpace | [0x96c7d011](https://evm.confluxscan.io/address/0x96c7d011cdfd467f551605f0f5fce279f86f4186) |
65-
| CFX eSpace-test | [0x913975af](https://evmtestnet.confluxscan.io/address/0x913975af2bb8a6be4100d7dc5e9765b77f6a5d6c) |
66-
| Harmony | [0xAb7B1bE4](https://explorer.harmony.one/address/0xab7b1be4233a04e5c43a810e75657eced8e5463b) |
67-
| Harmony-test | [0x96c7D011](https://explorer.pops.one/address/0x96c7d011cdfd467f551605f0f5fce279f86f4186) |
68-
| Metis | [0x2cf91AD8](https://andromeda-explorer.metis.io/address/0x2cf91AD8C175305EBe6970Bd8f81231585EFbd77/transactions) |
69-
| Metis-test | [0xAb7B1bE4](https://stardust-explorer.metis.io/address/0xAb7B1bE4233A04e5C43a810E75657ECED8E5463B/transactions) |
70-
71-
### HappyRedPacket_ERC721
72-
73-
| Chain | Address |
74-
| ---------------- | ----------------------------------------------------------------------------------------------------------------- |
75-
| Mainnet | [0x8d285739](https://etherscan.io/address/0x8d285739523FC2Ac8eC9c9C229ee863C8C9bF8C8) |
76-
| Ropsten | [0x8fF42e93](https://ropsten.etherscan.io/address/0x8fF42e93C19E44763FD1cD07b9E04d13bA07AD3f) |
77-
| BSC | [0xf8968e1F](https://bscscan.com/address/0xf8968e1Fcf1440Be5Cec7Bb495bcee79753d5E06) |
78-
| Matic | [0xf6Dc0427](https://polygonscan.com/address/0xf6Dc042717EF4C097348bE00f4BaE688dcaDD4eA) |
79-
| Arbitrum | [0x561c5f3a](https://explorer.arbitrum.io/address/0x561c5f3a19871ecb1273D6D8eCc276BeEDa5c8b4) |
80-
| xDai | [0x561c5f3a](https://blockscout.com/xdai/mainnet/address/0x561c5f3a19871ecb1273D6D8eCc276BeEDa5c8b4/transactions) |
81-
| Goerli | [0x0a04e23f](https://goerli.etherscan.io/address/0x0a04e23f95E9DB2Fe4C31252548F663fFe3AAe4d) |
82-
| Fantom | [0xF9F7C149](https://ftmscan.com/address/0xF9F7C1496c21bC0180f4B64daBE0754ebFc8A8c0) |
83-
| Avalanche | [0x96c7D011](https://snowtrace.io/address/0x96c7D011cdFD467f551605f0f5Fce279F86F4186) |
84-
| Celo | [0x96c7D011](https://explorer.celo.org/address/0x96c7D011cdFD467f551605f0f5Fce279F86F4186/transactions) |
85-
| Kovan-optimistic | [0x556F63d7](https://kovan-optimistic.etherscan.io/address/0x556F63d7467c729034585C3e50e54e582222b491) |
86-
| Optimistic | [0x02Ea0720](https://optimistic.etherscan.io/address/0x02Ea0720254F7fa4eca7d09A1b9C783F1020EbEF) |
87-
| Aurora | [0x05ee315E](https://explorer.mainnet.aurora.dev/address/0x05ee315E407C21a594f807D61d6CC11306D1F149/transactions) |
88-
| Fuse | [0x066804d9](https://explorer.fuse.io/address/0x066804d9123bF2609Ed4A4a40b1177a9c5a9Ed51/transactions) |
89-
| Boba | [0xF9F7C149](https://blockexplorer.boba.network/address/0xF9F7C1496c21bC0180f4B64daBE0754ebFc8A8c0/transactions) |
90-
| Moonriver | [0xF9F7C149](https://moonriver.moonscan.io/address/0xF9F7C1496c21bC0180f4B64daBE0754ebFc8A8c0) |
91-
| CFX eSpace | [0x5b966f3a](https://evm.confluxscan.io/address/0x5b966f3a32db9c180843bcb40267a66b73e4f022) |
92-
| CFX eSpace-test | [0x71834a3f](https://evmtestnet.confluxscan.io/address/0x71834a3fdea3e70f14a93ed85c6be70925d0cad9) |
93-
| Harmony | [0x83D6b366](https://explorer.harmony.one/address/0x83d6b366f21e413f214eb077d5378478e71a5ed2) |
94-
| Harmony-test | [0x981be454](https://explorer.pops.one/address/0x981be454a930479d92c91a0092d204b64845a5d6) |
95-
| Metis | [0x81246335](https://andromeda-explorer.metis.io/address/0x812463356F58fc8194645A1838ee6C52D8ca2D26/transactions) |
96-
| Metis-test | [0x2cf91AD8](https://stardust-explorer.metis.io/address/0x2cf91AD8C175305EBe6970Bd8f81231585EFbd77/transactions) |
43+
<!-- begin RedPacket -->
44+
45+
| Chain | HappyRedPacket | HappyRedPacket_ERC721 |
46+
| ---------------- | :---------------------------------: | :------------------------------------: |
47+
| Mainnet | [`0xaBBe1101`][rp-mainnet] | [`0x8d285739`][rp721-mainnet] |
48+
| Ropsten | [`0x0722507c`][rp-ropsten] | [`0x8fF42e93`][rp721-ropsten] |
49+
| BSC | [`0x0ca42C17`][rp-bsc] | [`0xf8968e1F`][rp721-bsc] |
50+
| Matic | [`0x93e0b87A`][rp-matic] | [`0xf6Dc0427`][rp721-matic] |
51+
| Rinkeby_arbitrum | [`0x4A77E797`][rp-rinkeby_arbitrum] | |
52+
| Arbitrum | [`0x83D6b366`][rp-arbitrum] | [`0x561c5f3a`][rp721-arbitrum] |
53+
| xDai | [`0x54a0A221`][rp-xdai] | [`0x561c5f3a`][rp721-xdai] |
54+
| Goerli | [`0x8bF6b979`][rp-goerli] | [`0x0a04e23f`][rp721-goerli] |
55+
| Fantom | [`0x578a7Fee`][rp-fantom] | [`0xF9F7C149`][rp721-fantom] |
56+
| Avalanche | [`0xF9F7C149`][rp-avalanche] | [`0x96c7D011`][rp721-avalanche] |
57+
| Celo | [`0xab7b1be4`][rp-celo] | [`0x96c7D011`][rp721-celo] |
58+
| Kovan_optimistic | [`0x68EDbfA3`][rp-kovan_optimistic] | [`0x556F63d7`][rp721-kovan_optimistic] |
59+
| Optimistic | [`0x981be454`][rp-optimistic] | [`0x02Ea0720`][rp721-optimistic] |
60+
| Aurora | [`0x19f179D7`][rp-aurora] | [`0x05ee315E`][rp721-aurora] |
61+
| Fuse | [`0x561c5f3a`][rp-fuse] | [`0x066804d9`][rp721-fuse] |
62+
| Boba | [`0x578a7Fee`][rp-boba] | [`0xF9F7C149`][rp721-boba] |
63+
| Moonriver | [`0x578a7Fee`][rp-moonriver] | [`0xF9F7C149`][rp721-moonriver] |
64+
| Conflux | [`0x96c7d011`][rp-conflux] | [`0x5b966f3a`][rp721-conflux] |
65+
| Conflux_test | [`0x913975af`][rp-conflux_test] | [`0x71834a3f`][rp721-conflux_test] |
66+
| Harmony | [`0xab7b1be4`][rp-harmony] | [`0x83d6b366`][rp721-harmony] |
67+
| Harmony_test | [`0x96c7d011`][rp-harmony_test] | [`0x981be454`][rp721-harmony_test] |
68+
| Metis | [`0x2cf91AD8`][rp-metis] | [`0x81246335`][rp721-metis] |
69+
| Metis_test | [`0xAb7B1bE4`][rp-metis_test] | [`0x2cf91AD8`][rp721-metis_test] |
70+
71+
[rp-mainnet]: https://etherscan.io/address/0xaBBe1101FD8fa5847c452A6D70C8655532B03C33
72+
[rp-ropsten]: https://ropsten.etherscan.io/address/0x0722507c3b776A6B205946592016e358B0D34c3F
73+
[rp-bsc]: https://bscscan.com/address/0x0ca42C178e14c618c81B8438043F27d9D38145f6
74+
[rp-matic]: https://polygonscan.com/address/0x93e0b87A0aD0C991dc1B5176ddCD850c9a78aabb
75+
[rp-rinkeby_arbitrum]: https://rinkeby-explorer.arbitrum.io/address/0x4A77E797031257db72F7D2C3Ec08a4FAc5c8CfE9
76+
[rp-arbitrum]: https://explorer.arbitrum.io/address/0x83D6b366f21e413f214EB077D5378478e71a5eD2
77+
[rp-xdai]: https://blockscout.com/xdai/mainnet/address/0x54a0A221C25Fc0a347EC929cFC5db0be17fA2a2B
78+
[rp-goerli]: https://goerli.etherscan.io/address/0x8bF6b979286970860Adc75dc621cf1969b0bE66C
79+
[rp-fantom]: https://ftmscan.com/address/0x578a7Fee5f0D8CEc7d00578Bf37374C5b95C4b98
80+
[rp-avalanche]: https://snowtrace.io/address/0xF9F7C1496c21bC0180f4B64daBE0754ebFc8A8c0
81+
[rp-celo]: https://explorer.celo.org/address/0xab7b1be4233a04e5c43a810e75657eced8e5463b
82+
[rp-kovan_optimistic]: https://kovan-optimistic.etherscan.io/address/0x68EDbfA3E564C987FaaAB54f4FD1E7567D4151Dd
83+
[rp-optimistic]: https://optimistic.etherscan.io/address/0x981be454a930479d92C91a0092D204b64845A5D6
84+
[rp-aurora]: https://explorer.mainnet.aurora.dev/address/0x19f179D7e0D7d9F9d5386afFF64271D98A91615B
85+
[rp-fuse]: https://explorer.fuse.io/address/0x561c5f3a19871ecb1273D6D8eCc276BeEDa5c8b4
86+
[rp-boba]: https://blockexplorer.boba.network/address/0x578a7Fee5f0D8CEc7d00578Bf37374C5b95C4b98
87+
[rp-moonriver]: https://moonriver.moonscan.io/address/0x578a7Fee5f0D8CEc7d00578Bf37374C5b95C4b98
88+
[rp-conflux]: https://evm.confluxscan.io/address/0x96c7d011cdfd467f551605f0f5fce279f86f4186
89+
[rp-conflux_test]: https://evmtestnet.confluxscan.io/address/0x913975af2bb8a6be4100d7dc5e9765b77f6a5d6c
90+
[rp-harmony]: https://explorer.harmony.one/address/0xab7b1be4233a04e5c43a810e75657eced8e5463b
91+
[rp-harmony_test]: https://explorer.pops.one/address/0x96c7d011cdfd467f551605f0f5fce279f86f4186
92+
[rp-metis]: https://andromeda-explorer.metis.io/address/0x2cf91AD8C175305EBe6970Bd8f81231585EFbd77
93+
[rp-metis_test]: https://stardust-explorer.metis.io/address/0xAb7B1bE4233A04e5C43a810E75657ECED8E5463B
94+
[rp721-mainnet]: https://etherscan.io/address/0x8d285739523FC2Ac8eC9c9C229ee863C8C9bF8C8
95+
[rp721-ropsten]: https://ropsten.etherscan.io/address/0x8fF42e93C19E44763FD1cD07b9E04d13bA07AD3f
96+
[rp721-bsc]: https://bscscan.com/address/0xf8968e1Fcf1440Be5Cec7Bb495bcee79753d5E06
97+
[rp721-matic]: https://polygonscan.com/address/0xf6Dc042717EF4C097348bE00f4BaE688dcaDD4eA
98+
[rp721-arbitrum]: https://explorer.arbitrum.io/address/0x561c5f3a19871ecb1273D6D8eCc276BeEDa5c8b4
99+
[rp721-xdai]: https://blockscout.com/xdai/mainnet/address/0x561c5f3a19871ecb1273D6D8eCc276BeEDa5c8b4
100+
[rp721-goerli]: https://goerli.etherscan.io/address/0x0a04e23f95E9DB2Fe4C31252548F663fFe3AAe4d
101+
[rp721-fantom]: https://ftmscan.com/address/0xF9F7C1496c21bC0180f4B64daBE0754ebFc8A8c0
102+
[rp721-avalanche]: https://snowtrace.io/address/0x96c7D011cdFD467f551605f0f5Fce279F86F4186
103+
[rp721-celo]: https://explorer.celo.org/address/0x96c7D011cdFD467f551605f0f5Fce279F86F4186
104+
[rp721-kovan_optimistic]: https://kovan-optimistic.etherscan.io/address/0x556F63d7467c729034585C3e50e54e582222b491
105+
[rp721-optimistic]: https://optimistic.etherscan.io/address/0x02Ea0720254F7fa4eca7d09A1b9C783F1020EbEF
106+
[rp721-aurora]: https://explorer.mainnet.aurora.dev/address/0x05ee315E407C21a594f807D61d6CC11306D1F149
107+
[rp721-fuse]: https://explorer.fuse.io/address/0x066804d9123bF2609Ed4A4a40b1177a9c5a9Ed51
108+
[rp721-boba]: https://blockexplorer.boba.network/address/0xF9F7C1496c21bC0180f4B64daBE0754ebFc8A8c0
109+
[rp721-moonriver]: https://moonriver.moonscan.io/address/0xF9F7C1496c21bC0180f4B64daBE0754ebFc8A8c0
110+
[rp721-conflux]: https://evm.confluxscan.io/address/0x5b966f3a32db9c180843bcb40267a66b73e4f022
111+
[rp721-conflux_test]: https://evmtestnet.confluxscan.io/address/0x71834a3fdea3e70f14a93ed85c6be70925d0cad9
112+
[rp721-harmony]: https://explorer.harmony.one/address/0x83d6b366f21e413f214eb077d5378478e71a5ed2
113+
[rp721-harmony_test]: https://explorer.pops.one/address/0x981be454a930479d92c91a0092d204b64845a5d6
114+
[rp721-metis]: https://andromeda-explorer.metis.io/address/0x812463356F58fc8194645A1838ee6C52D8ca2D26
115+
[rp721-metis_test]: https://stardust-explorer.metis.io/address/0x2cf91AD8C175305EBe6970Bd8f81231585EFbd77
116+
117+
<!-- end RedPacket -->
97118

98119
## Test report
99120

0 commit comments

Comments
 (0)