Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Attempt Asset merged #1197

Closed
wants to merge 802 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
802 commits
Select commit Hold shift + click to select a range
9870f09
Asset deployment values tests
wojciech-turek Aug 9, 2023
16c79fe
fix: updated contracts
Aug 9, 2023
f82dbd8
Merge branch 'master' into asset-l2-integration
atkinsonholly Aug 9, 2023
fe14acc
add: asset package added to root readme list
atkinsonholly Aug 9, 2023
8ebe273
Merge pull request #1085 from thesandboxgame/task/add-trusted-forward…
atkinsonholly Aug 9, 2023
725c2fc
Merge branch 'master' into asset-l2-integration
atkinsonholly Aug 9, 2023
8ea8af0
Merge pull request #1080 from thesandboxgame/royalties-deployment
atkinsonholly Aug 10, 2023
98eebee
Add base URI test
wojciech-turek Aug 11, 2023
a4ec8b8
Destructure items from the fixture
wojciech-turek Aug 11, 2023
5a52ca8
Add AssetCreate deploy tests
wojciech-turek Aug 11, 2023
7c3eb39
Merge branch 'asset-l2-integration' of https://github.com/thesandboxg…
wojciech-turek Aug 11, 2023
25d32d3
Only allow specific tiers to be revealed in signle tx
wojciech-turek Aug 11, 2023
3cf08ea
Add getter function
wojciech-turek Aug 11, 2023
4b650bb
fix: updated deployment script
Aug 14, 2023
30260d7
fix: added deployment scripts
Aug 14, 2023
520949d
feat: added intregration tests
Aug 14, 2023
dd311af
Fix formatting
wojciech-turek Aug 14, 2023
70de723
Update deployment script
wojciech-turek Aug 14, 2023
9c98cc2
Fix existing tests and add a new one
wojciech-turek Aug 14, 2023
d6a29e6
Remove only
wojciech-turek Aug 14, 2023
88652d6
feat: prepare the asset branch for the new solhint version
adjisb Aug 15, 2023
401de93
Update natspec
wojciech-turek Aug 16, 2023
0ffa0dc
Merge pull request #1095 from thesandboxgame/task/add-intregration-tests
wojciech-turek Aug 16, 2023
1680f04
Format fix
wojciech-turek Aug 16, 2023
867f4ea
Add operator test
wojciech-turek Aug 16, 2023
fd2398c
Merge branch 'asset-l2-integration' of https://github.com/thesandboxg…
wojciech-turek Aug 16, 2023
c88275a
Add blackist tests
wojciech-turek Aug 16, 2023
15877b0
Merge pull request #1088 from thesandboxgame/integration-tests
rishabh0x00 Aug 16, 2023
56b3cd7
Merge pull request #1093 from thesandboxgame/burn-reveal-specific-id
atkinsonholly Aug 17, 2023
28df90c
Add pausable extension to asset reveal and asset create
wojciech-turek Aug 17, 2023
3c46ce2
Update deployment config
wojciech-turek Aug 17, 2023
185fa11
Fix fixture
wojciech-turek Aug 18, 2023
2cf59ab
Fix test
wojciech-turek Aug 18, 2023
98ff08f
Fix rm exclusive block testing
wojciech-turek Aug 18, 2023
e38a1e0
Add missing initialize calls
wojciech-turek Aug 18, 2023
334cec0
Merge pull request #1097 from thesandboxgame/pausable
atkinsonholly Aug 18, 2023
8b6662e
Merge pull request #1096 from thesandboxgame/feat/prepare_asset_for_n…
atkinsonholly Aug 18, 2023
594216d
fix : removed proxyCall function abi
Aug 23, 2023
5025edc
fix : removed proxyCall function
Aug 23, 2023
f5e690c
fix : removed proxyCall documentation
Aug 23, 2023
0b97778
fix : removed proxyCall test
Aug 23, 2023
4ed7ceb
feat : added splitter deployer role
Aug 24, 2023
6e8cf91
fix : updated test fixtures
Aug 24, 2023
2f43790
feat : added test cases
Aug 24, 2023
368c5e5
feat : updated asset deployment setup
Aug 24, 2023
00f4f71
fix : fixed format
Aug 25, 2023
369fd49
fix: updated role hash
Aug 28, 2023
dd585e4
feat : added overflow require check
Aug 24, 2023
34aa81d
fix : fixed format
Aug 25, 2023
759e7ec
feat: added overflow erc20 contract
Aug 28, 2023
67b6b46
feat: added overflow test case
Aug 28, 2023
06e6754
fix : updated visibility of state variable
Aug 25, 2023
9c1fb52
fix : updated contracts
Aug 25, 2023
72a7ff1
fix : updated test cases
Aug 25, 2023
73e054f
fix : fixed format
Aug 25, 2023
3fc158b
feat: added netspec comments
Aug 28, 2023
3ad45de
Override renounce fn
wojciech-turek Sep 5, 2023
fc823e1
Add test for the fn override
wojciech-turek Sep 5, 2023
6045c6a
Update documentation
wojciech-turek Sep 5, 2023
d987684
Add gap variables
wojciech-turek Sep 5, 2023
0eacab7
Update docstrings
wojciech-turek Sep 5, 2023
d65768a
Fix incomplete docstrings
wojciech-turek Sep 5, 2023
84daa21
Align on error messages
wojciech-turek Sep 5, 2023
b94fd02
Index parameters in AssetReveal events
wojciech-turek Sep 5, 2023
c76fcd1
Fix typos
wojciech-turek Sep 5, 2023
37f76fe
Add named returns
wojciech-turek Sep 5, 2023
b75368b
Update tests
wojciech-turek Sep 5, 2023
328f405
no need to index unrevealed tokenId
wojciech-turek Sep 6, 2023
b7ff163
Update tests
wojciech-turek Sep 6, 2023
c936f1d
Fix typo
wojciech-turek Sep 6, 2023
dbeb41c
Count mappings towards used storage slots
wojciech-turek Sep 6, 2023
763ece0
Remove non-null assertion
wojciech-turek Sep 6, 2023
ba42b73
Remove exclusive test
wojciech-turek Sep 6, 2023
cbb67d7
Update Asset contract docstring
wojciech-turek Sep 6, 2023
3926b5a
Add missing space between words
wojciech-turek Sep 6, 2023
d003b1d
Add missing named return and update interface
wojciech-turek Sep 6, 2023
5e17c72
fix: added named return variable in getter function
Sep 7, 2023
aadb8bc
refactor : refactored _setTokenRoyalties
Aug 25, 2023
ecdafd1
feat : added test cases
Aug 25, 2023
aa327fd
fix : fixed format
Aug 25, 2023
c58df98
fix : removed unwanted code
Aug 25, 2023
2dc6f56
fix: udpated test cases titles
Aug 28, 2023
a1a65e9
fix : fixed format
Aug 28, 2023
d6af0f7
fix : updated MultiRoyaltyDistributor contract
Aug 25, 2023
5832638
feat : added test cases
Aug 25, 2023
c1a0c2a
fix : updated test case
Aug 25, 2023
1421b59
fix: updated test cases titles
Aug 28, 2023
4136dd8
fix: updated contracts
Aug 30, 2023
8d397a7
fix: updated test cases
Aug 30, 2023
13fd8e1
refactor : ERC20 transfer call using SafeERC20
Aug 26, 2023
486e6f6
fix : added royaltyBPS into royaltyConfigs
Aug 26, 2023
4725c5f
feat : added test case
Aug 26, 2023
c1decd9
refactor: removed unused code
Aug 30, 2023
9032009
fix: fixed and removed test cases
Aug 30, 2023
0e0ff10
fix : updated docstrings
Aug 26, 2023
7b7ec59
fix: updated doc string
Aug 30, 2023
05fef1d
fix: fixed docstring
Aug 31, 2023
53a6374
fix : added onlyInitializing modifier
Aug 26, 2023
21f766c
feat : added events after sensitive changes
Aug 28, 2023
6d9ddbd
feat : added events in interface
Aug 28, 2023
00771c0
feat : added test cases
Aug 28, 2023
d63f605
refactor : update function structure for event handling
Aug 29, 2023
cdf0039
refactor : _setBaseURI with super call
Aug 30, 2023
9221caf
fix: removed merge markers
Aug 30, 2023
8c77b1c
fix: fixed test cases
Aug 30, 2023
180bc8d
feat : added events after sensitive changes
Aug 28, 2023
06c30ea
feat : added test cases
Aug 28, 2023
377d1a2
feat : added a gap variable
Aug 28, 2023
9770d4b
fix : fixed merge conflict
Aug 31, 2023
d4638b6
Fix the gap length
wojciech-turek Sep 1, 2023
d12d52b
feat : added events after sensitive changes
Aug 28, 2023
c3721c8
fix : updated missing docstring
Aug 28, 2023
f30085d
fix: updated comment format
Aug 31, 2023
30ae019
fix: fixed merge conflict
Sep 7, 2023
f051694
feat : added failing test cases for burn and transfer
Aug 28, 2023
3d13ddd
refactor : variables names
Aug 29, 2023
cdd001e
fix : updated splitter abi
Aug 29, 2023
d80750d
fix : updated test cases
Aug 29, 2023
68f6003
fix: fixed test case
Aug 31, 2023
7068bb6
fix : updated splitter abi
Aug 29, 2023
9d058bf
fix : updated constant format
Aug 29, 2023
a7acda6
refactor : marked RoyaltyDistributor as abstract
Aug 29, 2023
7124016
fix : updated a test case
Aug 29, 2023
075ce61
feat : added events after sensitive changes
Aug 28, 2023
e6fd61f
fix : added '_disableInitializers()' in constructor
Aug 29, 2023
0418b69
fix: fixed merge conflict
Sep 7, 2023
f333356
feat : added events after sensitive changes
Aug 28, 2023
7a790c8
fix : updated missing docstring
Aug 28, 2023
d2c1701
fix : added '_disableInitializers()' in constructor
Aug 29, 2023
7281bcb
fix : updated incomplete docstrings
Aug 29, 2023
d14e82f
fix: removed duplicate constructor
Aug 31, 2023
9f119ea
feat : added events after sensitive changes
Aug 28, 2023
6c6aed4
fix : updated missing docstring
Aug 28, 2023
63be1a8
fix : added named return values
Aug 30, 2023
b28c1f1
refactor : enhance function with named return values
Aug 30, 2023
37c0e45
fix: updated contracts and interfaces
Aug 31, 2023
ffda588
fix: format fixed
Aug 31, 2023
b385c33
return the values directly
wojciech-turek Sep 1, 2023
8ce3733
Shorten revert messages and update tests
wojciech-turek Sep 7, 2023
c82b40a
Formatting fix
wojciech-turek Sep 7, 2023
63a5fe0
feat : added events after sensitive changes
Aug 28, 2023
1532cea
fix : updated missing docstring
Aug 28, 2023
4bd0fa2
refactor : enhance function with named return values
Aug 30, 2023
5595489
return the values directly
wojciech-turek Sep 1, 2023
899aea3
refactor : variables names
Aug 29, 2023
c810488
fix : added '_disableInitializers()' in constructor
Aug 29, 2023
a4749ac
fix : updated incomplete docstrings
Aug 29, 2023
12672d6
fix : added indexed params in events
Aug 30, 2023
6ae72f9
fix: removed duplicate constructor
Aug 31, 2023
85979b2
feat : added events after sensitive changes
Aug 28, 2023
d7b6d5e
fix : updated missing docstring
Aug 28, 2023
de639e8
refactor : enhance function with named return values
Aug 30, 2023
a09b5f3
return the values directly
wojciech-turek Sep 1, 2023
608ded4
fix : added missing parent initializer calls in contract
Aug 30, 2023
19060f8
feat : added events after sensitive changes
Aug 28, 2023
0a7ad20
fix : updated missing docstring
Aug 28, 2023
18a0221
refactor : enhance function with named return values
Aug 30, 2023
ad384de
return the values directly
wojciech-turek Sep 1, 2023
444b4f0
fix : updated functions visibility to external
Aug 30, 2023
301ca73
fix: function visibility
Sep 1, 2023
968f8f3
Fix casing
wojciech-turek Sep 7, 2023
66dd01b
fix: updated function visibility
Sep 8, 2023
3a7921f
feat : added events after sensitive changes
Aug 28, 2023
5aa7c28
fix : updated missing docstring
Aug 28, 2023
a59b101
refactor : enhance function with named return values
Aug 30, 2023
2d6acf2
return the values directly
wojciech-turek Sep 1, 2023
3ccafc5
fix : fixed redundant code
Aug 30, 2023
c61fedf
fix: removed redundent code
Sep 1, 2023
bacfb0b
refactor : enhance function with named return values
Aug 30, 2023
9ddbacc
return the values directly
wojciech-turek Sep 1, 2023
f19841a
refactor : enhance function with named return values
Aug 30, 2023
ccc6408
return the values directly
wojciech-turek Sep 1, 2023
db219fe
fix : fixed typographical errors
Aug 30, 2023
e14cfa4
Fix typographical errors
wojciech-turek Sep 1, 2023
b95984a
refactor : enhance function with named return values
Aug 30, 2023
d5d799a
return the values directly
wojciech-turek Sep 1, 2023
de75a07
refactor : enhance function with named return values
Aug 30, 2023
a822c01
return the values directly
wojciech-turek Sep 1, 2023
bd489c0
refactor : enhance function with named return values
Aug 30, 2023
1eb60f2
return the values directly
wojciech-turek Sep 1, 2023
74cdcd8
refactor : used named return royalBps variable
Aug 30, 2023
26a6a93
fix: added missing function
Sep 1, 2023
920c1e3
fix: format:fix
Sep 1, 2023
129a667
refactor : enhance function with named return values
Aug 30, 2023
b87dbe7
return the values directly
wojciech-turek Sep 1, 2023
925452a
fix: added missing function
Sep 1, 2023
a594e5f
fix : removed unused variables
Aug 30, 2023
2cb5258
fix: fixed format
Sep 7, 2023
80d6ba2
refactor: removed royaltyBps value allocation
Sep 8, 2023
907b8bf
Update the gap size
wojciech-turek Sep 8, 2023
e539e1c
Add num to error message and update tests
wojciech-turek Sep 11, 2023
fdfdd31
Merge pull request #1130 from thesandboxgame/catalyst-audit/N-18-unus…
rishabh0x00 Sep 11, 2023
711d9e0
Merge pull request #1128 from thesandboxgame/catalyst-audit/N-14-typo…
rishabh0x00 Sep 11, 2023
61067e9
Merge pull request #1127 from thesandboxgame/catalyst-audit/N-12-redu…
rishabh0x00 Sep 11, 2023
bf2172b
Merge pull request #1126 from thesandboxgame/catalyst-audit/N-11-publ…
rishabh0x00 Sep 11, 2023
083d8fd
Merge pull request #1125 from thesandboxgame/catalyst-audit/N-10-miss…
rishabh0x00 Sep 11, 2023
943a005
Merge pull request #1124 from thesandboxgame/catalyst-audit/N-09-lack…
rishabh0x00 Sep 11, 2023
1273521
Merge pull request #1123 from thesandboxgame/catalyst-audit/N-08-inco…
rishabh0x00 Sep 11, 2023
15b07e1
Merge pull request #1122 from thesandboxgame/catalyst-audit/N-06-inco…
rishabh0x00 Sep 11, 2023
e3f416e
Merge pull request #1121 from thesandboxgame/catalyst-audit/N-05-disa…
rishabh0x00 Sep 11, 2023
50a12fe
Merge pull request #1120 from thesandboxgame/catalyst-audit/N-04-cont…
rishabh0x00 Sep 11, 2023
494369c
Merge pull request #1119 from thesandboxgame/catalyst-audit/N-03-cons…
rishabh0x00 Sep 11, 2023
65fa9d4
Merge pull request #1118 from thesandboxgame/catalyst-audit/N-02-codi…
rishabh0x00 Sep 11, 2023
63641ab
Merge pull request #1117 from thesandboxgame/catalyst-audit/L-11-the-…
rishabh0x00 Sep 11, 2023
ca28aec
Merge pull request #1115 from thesandboxgame/catalyst-audit/L-10-miss…
rishabh0x00 Sep 11, 2023
dab5fb9
Merge pull request #1114 from thesandboxgame/catalyst-audit/L-09-lack…
rishabh0x00 Sep 11, 2023
c25dea5
Merge pull request #1113 from thesandboxgame/catalyst-audit/L-08-lack…
rishabh0x00 Sep 11, 2023
b719ab3
Merge pull request #1112 from thesandboxgame/catalyst-audit/L-07-init…
rishabh0x00 Sep 11, 2023
b469006
Merge pull request #1111 from thesandboxgame/catalyst-audit/L-06-inco…
rishabh0x00 Sep 11, 2023
e2f46c7
Merge pull request #1109 from thesandboxgame/catalyst-audit/L-05-inco…
rishabh0x00 Sep 11, 2023
3c2a449
Merge pull request #1108 from thesandboxgame/catalyst-audit/L-04-erc2…
rishabh0x00 Sep 11, 2023
db2a337
Merge pull request #1107 from thesandboxgame/catalyst-audit/L-03-depl…
rishabh0x00 Sep 11, 2023
9e8ef0b
Merge pull request #1106 from thesandboxgame/catalyst-audit/L-02-arra…
rishabh0x00 Sep 11, 2023
a55903d
Merge pull request #1105 from thesandboxgame/catalyst-audit/L-01-abst…
rishabh0x00 Sep 11, 2023
6185c70
Merge pull request #1104 from thesandboxgame/catalyst-audit/M-01-miss…
rishabh0x00 Sep 11, 2023
613fb98
Merge pull request #1103 from thesandboxgame/catalyst-audit/H-02-depl…
rishabh0x00 Sep 11, 2023
7ab6837
Merge pull request #1102 from thesandboxgame/catalyst-audit/H-01-crea…
rishabh0x00 Sep 11, 2023
22fd379
New Catalyst contract deployment
wojciech-turek Sep 11, 2023
76bba6f
Redeploy asset create contract
wojciech-turek Sep 12, 2023
e3e9b80
Fix missed typo
wojciech-turek Sep 12, 2023
ea818b6
Merge pull request #1135 from thesandboxgame/asset-audit-M-01
wojciech-turek Sep 15, 2023
28bac74
Merge pull request #1136 from thesandboxgame/asset-audit-L-01
wojciech-turek Sep 15, 2023
15d6e85
Merge pull request #1137 from thesandboxgame/asset-audit-l-02
wojciech-turek Sep 15, 2023
2355570
Merge pull request #1138 from thesandboxgame/asset-audit-l-03
wojciech-turek Sep 15, 2023
7e55db1
Merge pull request #1139 from thesandboxgame/asset-audit-n-01
wojciech-turek Sep 15, 2023
97f7809
Merge pull request #1140 from thesandboxgame/asset-audit-n-02
wojciech-turek Sep 15, 2023
f25c2fa
Merge branch 'asset-l2-integration' of https://github.com/thesandboxg…
wojciech-turek Sep 15, 2023
fc06649
Merge pull request #1141 from thesandboxgame/asset-audit-n-03
wojciech-turek Sep 15, 2023
f63b04d
Merge branch 'asset-l2-integration' into asset-audit-n-04
wojciech-turek Sep 15, 2023
68d046e
Merge branch 'asset-l2-integration' of https://github.com/thesandboxg…
wojciech-turek Sep 15, 2023
f1d17cf
Fix formatting
wojciech-turek Sep 15, 2023
0c1fed4
Fix format and rm bad rule from solhint
wojciech-turek Sep 15, 2023
d3ee638
Merge pull request #1143 from thesandboxgame/asset-audit-n-05
wojciech-turek Sep 15, 2023
e5ef998
Format fix
wojciech-turek Sep 15, 2023
55ebf7a
Merge pull request #1142 from thesandboxgame/asset-audit-n-04
wojciech-turek Sep 15, 2023
f7d7fae
Merge branch 'asset-l2-integration' into asset-audit-tsb-01
wojciech-turek Sep 15, 2023
1ce2167
Merge pull request #1146 from thesandboxgame/new-cat-deployment
wojciech-turek Sep 15, 2023
9eb8a70
Merge pull request #1145 from thesandboxgame/asset-audit-tsb-01
atkinsonholly Sep 18, 2023
f9385b2
Remove apos from revert messages
wojciech-turek Sep 18, 2023
82b1c71
Add backend wallet for testing to deploy setup
wojciech-turek Sep 18, 2023
7ea97bf
Redeploy contracts
wojciech-turek Sep 18, 2023
39c335f
Fix broken tests due to revert statement change
wojciech-turek Sep 18, 2023
530aeb5
Merge pull request #1148 from thesandboxgame/asset-audit-deployment
atkinsonholly Sep 18, 2023
0bebea3
Add initial cat mint script
wojciech-turek Sep 20, 2023
28081c4
Update cat mint receiver and rm square brackets around args
wojciech-turek Sep 20, 2023
934d768
Revert from hardcoded contract address for now
wojciech-turek Sep 20, 2023
d5ce194
Update giveaway contract address
wojciech-turek Sep 21, 2023
557eab0
Merge pull request #1153 from thesandboxgame/catalyst-mint-script
wojciech-turek Sep 22, 2023
c66451d
lock updated
mvanmeerbeck Oct 4, 2023
7dc8061
lock updated
mvanmeerbeck Oct 4, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions .env.example

This file was deleted.

3 changes: 3 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ jobs:

- name: Running tests
run: yarn test:ci
env:
ETH_NODE_URI_POLYGON: ${{ secrets.ETH_NODE_URI_POLYGON }}

coverage:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -72,3 +74,4 @@ jobs:
run: yarn deploy:ci
env:
ETH_NODE_URI_GOERLI: ${{ secrets.ETH_NODE_URI_GOERLI }}
ETH_NODE_URI_POLYGON: ${{ secrets.ETH_NODE_URI_POLYGON }}
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ node_modules/

# yarn 3
.yarn/*
!.yarn/cache
.yarn/cache
!.yarn/patches
!.yarn/plugins
!.yarn/releases
Expand Down
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,16 @@ yarn install
- 📦 This mono-repository contains a suite of smart contract packages.
- ⚖️ The mono-repository is released under [MIT license](./LICENSE). Note, that the packages may contain their own licenses.

| Package | Version | License | Description |
|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|------------------------------------------|
| [`@sandbox-smart-contracts/packages/core`](./packages/core) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/core)](https://www.npmjs.com/package/@sandbox-smart-contracts/core) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🗝️ Core smart contracts (pre 2023) |
| [`@sandbox-smart-contracts/packages/deploy`](./packages/deploy) | N/A | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🚀 Deploy all packages (except core) |
| [`@sandbox-smart-contracts/packages/example-hardhat`](./packages/example-hardhat) | N/A | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 👷 Development template using Hardhat |
| [`@sandbox-smart-contracts/packages/giveaway`](./packages/giveaway) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/giveaway)](https://www.npmjs.com/package/@sandbox-smart-contracts/giveaway) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🎁 Instant Giveaway smart contract claims |
| [`@sandbox-smart-contracts/packages/dependency-metatx`](./packages/dependency-metatx) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/dependency-metatx)](https://www.npmjs.com/package/@sandbox-smart-contracts/giveaway) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🌐 Dependency: ERC2771 handler |
| Package | Version | License | Description |
|---------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`@sandbox-smart-contracts/packages/core`](./packages/core) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/core)](https://www.npmjs.com/package/@sandbox-smart-contracts/core) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🗝️ Core smart contracts (pre 2023) |
| [`@sandbox-smart-contracts/packages/deploy`](./packages/deploy) | N/A | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🚀 Deploy all packages (except core) |
| [`@sandbox-smart-contracts/packages/example-hardhat`](./packages/example-hardhat) | N/A | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 👷 Development template using Hardhat |
| [`@sandbox-smart-contracts/packages/giveaway`](./packages/giveaway) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/giveaway)](https://www.npmjs.com/package/@sandbox-smart-contracts/giveaway) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🎁 Instant Giveaway smart contract claims |
| [`@sandbox-smart-contracts/packages/dependency-metatx`](./packages/dependency-metatx) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/dependency-metatx)](https://www.npmjs.com/package/@sandbox-smart-contracts/dependency-metatx) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🌐 Dependency: ERC2771 handler |
| [`@sandbox-smart-contracts/packages/dependency-royalty-management`](./packages/dependency-royalty-management) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/dependency-royalty-management)](https://www.npmjs.com/package/@sandbox-smart-contracts/royalty-management) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🎨 Dependency: The Sandbox Royalty Implementation in partnership with [Manifold's royalty-registry](https://github.com/manifoldxyz/royalty-registry-solidity/tree/main) |
| [`@sandbox-smart-contracts/packages/dependency-operator-filter`](./packages/dependency-operator-filter) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/dependency-operator-filter)](https://www.npmjs.com/package/@sandbox-smart-contracts/operator-filter) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🤝 Dependency: The Sandbox's implementation for OpenSea's operator filter |
| [`@sandbox-smart-contracts/packages/asset`](./packages/asset) | [![npm](https://img.shields.io/npm/v/@sandbox-smart-contracts/asset)](https://www.npmjs.com/package/@sandbox-smart-contracts/asset) | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html) | 🚗 Asset contract upgrade for L2 deployment featuring tiers, abilities, operator-filter and creator royalties |

## Contributing

Expand Down
16 changes: 16 additions & 0 deletions packages/asset/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
node_modules
.env
coverage
coverage.json
typechain
typechain-types

# Hardhat files
cache
artifacts

# generated docs
generated-markups

# editors
.idea
41 changes: 41 additions & 0 deletions packages/asset/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
const path = require('path');
const tsconfigPath = path.join(__dirname, 'tsconfig.json');
module.exports = {
root: true,
extends: [
'eslint:recommended',
'plugin:mocha/recommended',
'plugin:prettier/recommended',
],
parserOptions: {
ecmaVersion: 2020,
},
plugins: ['mocha'],
env: {
commonjs: true,
node: true,
mocha: true,
},
overrides: [
{
files: ['*.ts'],
parser: '@typescript-eslint/parser',
parserOptions: {
project: [tsconfigPath],
ecmaVersion: 2020,
sourceType: 'module',
},
plugins: ['mocha', '@typescript-eslint'],
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:mocha/recommended',
'plugin:prettier/recommended',
],
rules: {
'@typescript-eslint/no-misused-promises': 'error',
'@typescript-eslint/no-floating-promises': 'error',
},
},
],
};
16 changes: 16 additions & 0 deletions packages/asset/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
node_modules
.env
coverage
coverage.json
typechain
typechain-types

# Hardhat files
cache
artifacts
./artifacts
./cache
./typechain

deploy
deployments
16 changes: 16 additions & 0 deletions packages/asset/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
node_modules
.env
coverage
coverage.json
typechain
typechain-types

# Hardhat files
cache
artifacts

# generated docs
generated-markups

# editors
.idea
15 changes: 15 additions & 0 deletions packages/asset/.prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
module.exports = {
singleQuote: true,
bracketSpacing: false,
plugins: ['prettier-plugin-solidity'],
overrides: [
{
files: '*.sol',
options: {
printWidth: 120,
tabWidth: 4,
singleQuote: false,
},
},
],
};
7 changes: 7 additions & 0 deletions packages/asset/.solcover.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
module.exports = {
mocha: {
grep: '@skip-on-coverage', // Find everything with this tag
invert: true, // Run the grep's inverse set.
},
skipFiles: ['/mock'],
};
14 changes: 14 additions & 0 deletions packages/asset/.solhint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"extends": "solhint:recommended",
"plugins": ["prettier"],
"rules": {
"prettier/prettier": [
"error",
{
"endOfLine": "auto"
}
],
"compiler-version": ["error", "^0.8.0"],
"func-visibility": ["error", {"ignoreConstructors": true}]
}
}
1 change: 1 addition & 0 deletions packages/asset/.solhintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
contracts/mock
71 changes: 71 additions & 0 deletions packages/asset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# <PACKAGE>

The Sandbox Asset package for deploying on Polygon

## Running the project locally

Install dependencies with `yarn`

Testing: Use `yarn test` inside `packages/<package>` to run tests locally inside this package

For testing from root (with workspace feature) use: `yarn workspace @sandbox-smart-contracts/<package> test`

Coverage: Run `yarn coverage`

Formatting: Run `yarn prettier` to check and `yarn prettier:fix` to fix formatting errors

Linting: Run `yarn lint` to check and `yarn lint:fix` to fix static analysis errors

## Package structure and minimum standards

#### A NOTE ON DEPENDENCIES

1. Add whatever dependencies you like inside your package; this template is for hardhat usage. OpenZeppelin contracts
are highly recommended and should be installed as a dev dependency
2. For most Pull Requests there should be minimum changes to `yarn.lock` at root level
3. Changes to root-level dependencies are permissible, however they should not be downgraded
4. Take care to run `yarn` before pushing your changes
5. You shouldn't need to install dotenv since you won't be deploying inside this package (see below)

#### UNIT TESTING

1. Unit tests are to be added in `packages/<package>/test`
2. Coverage must meet minimum requirements for CI to pass
3. `getSigners` return an array of addresses, the first one is the default `deployer` for contracts, under no
circumstances should tests be written as `deployer`
4. It's permissible to create mock contracts at `packages/<package>/contracts/mock` e.g. for third-party contracts
5. Tests must not rely on any deploy scripts from the `deploy` package; your contracts must be deployed inside the test
fixture. See `test/fixtures.ts`

# Deployment

Each package must unit-test the contracts by running everything inside the `hardhat node`. Deployment to "real"
networks, configuration of our environment and integration tests must be done inside the `deploy` package.

The `deploy` package only imports `.sol` files. The idea is to recompile everything inside it and manage the entire
deploy strategy from one place.

1. Your deploy scripts should not be included inside `packages/<package>`: deploy scripts live inside `packages/deploy/`
2. The `deploy` package doesn't use the hardhat config file from the specific package. Instead, it
uses `packages/deploy/hardhat.config.ts`
3. You will need to review `packages/deploy/hardhat.config.ts` and update it as needed for any new namedAccounts you
added to your package
4. When it comes to deploy time, it is preferred to include deploy scripts and end-to-end tests as a separate PR
5. The named accounts inside the `deploy` package must use the "real-life" values
6. Refer to the readme at `packages/deploy` to learn more about importing your package

#### INTEGRATION TESTING

1. End-to-end tests live at `packages/deploy/`
2. You must add end-to-end tests ahead of deploying your package. Importantly, these tests should verify deployment and
initialization configuration

# A NOTE ON MAKING PULL REQUESTS

1. Follow the PR template checklist
2. Your PR will not be approved if the above criteria are not met





Loading
Loading