You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,12 @@
10
10
The library consists of modules and utilities that are built with a help of [Openzeppelin Contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) (4.9.5) and **go far beyond mediocre solidity**.
11
11
12
12
- Implementation of [**Contracts Registry**](https://eips.ethereum.org/EIPS/eip-6224) pattern
13
-
- Versatile **RBAC** and **MultiOwnable**smart contracts
13
+
- Versatile access control smart contracts (Merkle whitelists, RBAC)
14
14
- Enhanced and simplified [**Diamond**](https://eips.ethereum.org/EIPS/eip-2535) pattern
15
-
- Heap based priority queue library
16
-
- Memory data structures (Vector)
17
-
- Optimized [**Incremental Merkle Tree**](https://github.com/runtimeverification/deposit-contract-verification/blob/master/deposit-contract-verification.pdf) data structure
18
-
- Novel **ReturnDataProxy** contract
19
-
- Lightweight **SBT** implementation
20
-
- Flexible UniswapV2 and UniswapV3 oracles
15
+
- Advanced data structures (**Vector**, **PriorityQueue**)
The latest stable version is always in the `master` branch.
32
30
31
+
### Documentation
32
+
33
+
Check out the project's [documentation](https://docs.solarity.dev) with broad explanations and usage examples of every module. Full `natspec` guides are also available in the source code.
34
+
33
35
## Usage
34
36
35
-
You will find the smart contracts in the `/contracts` directory. Feel free to play around and check the source code, it is rather descriptive.
37
+
You will find the smart contracts in the `/contracts` directory. Feel free to play around and check the project's structure.
36
38
37
39
Once the [npm package](https://www.npmjs.com/package/@solarity/solidity-lib) is installed, one can use the library just like that:
38
40
@@ -49,6 +51,10 @@ contract ContractsRegistry is OwnableContractsRegistry {
49
51
> [!IMPORTANT]
50
52
> It is important to use the library as it is shipped and not copy-paste the code from untrusted sources.
51
53
54
+
## Contribution
55
+
56
+
We are open to any mind-blowing ideas! Please take a look at our [contribution guidelines](https://docs.solarity.dev/docs/getting-started/contribution/how-to-contribute) to get involved.
0 commit comments