Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dk1a/solecslib
ERC1155 and ERC721 Systems that use components to store data
https://github.com/dk1a/solecslib
erc1155 erc721 mud solecs solidity
Last synced: 3 months ago
JSON representation
ERC1155 and ERC721 Systems that use components to store data
- Host: GitHub
- URL: https://github.com/dk1a/solecslib
- Owner: dk1a
- Created: 2022-11-04T12:26:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-20T12:26:17.000Z (over 1 year ago)
- Last Synced: 2024-10-14T01:25:38.230Z (4 months ago)
- Topics: erc1155, erc721, mud, solecs, solidity
- Language: Solidity
- Homepage:
- Size: 659 KB
- Stars: 22
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# solecslib
ERC1155 and ERC721 Subsystems that use components to store data
Experimental additions to [@latticexyz/solecs](https://github.com/latticexyz/mud/tree/main/packages/solecs)
See [mud.dev](https://mud.dev/) first for context on solecs and what a System is.
A Subsystem is a System that inherits OwnableWritable instead of Ownable.
Call `Subsystem.authorizeWriter(systemAddress)` to allow a System to execute a Subsystem.
### Development
Install dependencies via node
```bash
yarn install
```
Run tests via both forge and hardhat
```bash
yarn test
```
[Forge](https://book.getfoundry.sh/forge/writing-tests) is used for tests internally. Except ERC tests are entirely taken from [@solidstate/spec](https://github.com/solidstate-network/solidstate-solidity/tree/master/spec), which is why hardhat is also used.
----------
## Tokens
### ERC1155, ERC721
They have similar contracts with shared suffixes:
- VData - Virtual data abstraction, like an internal interface
- Internal - ERC internals, inherits VData
- Logic - ERC public+internal methods, inherits Internal. This is a full ERC implementation, lacking only a data provider.
- DataComponents - data provider (only simple setters/getters), inherits VData.
- ERC__Subsystem - Logic + DataComponents + Subsystem + constructor + default execute implementation.
#### ERC1155BaseSubsystem, ERC721BaseSubsystem
Full ERC1155/721 and Subsystem implementation, with a default execute and sub-executes (mint,burn,transfer all share 1 contract). Its components may be read by anyone without even awareness of ERC1155/721, but writes must always go through ERC__BaseSubsystem (this is mostly because of events, only 1 contract should emit them).
#### Notes on VData and Logic
Data and Logic separation isn't really necessary, but this was an interesting use case for it. For example by having *Logic + DataStorage + constructor* you could get an ordinary ERC1155/721 implementation (where DataStorage implements VData but just uses normal contract storage). And imo keeping components away from Logic makes it easier to compare to @solidstate/contracts (I tried to keep it very similar, and even reuse tests via @solidstate/spec).
#### Forwarder systems, like OperatorApprovalSystem
These exist as an optional addition to ERC__BaseSubsystem. They are pure-ECS wrappers for transfers and approvals. I'm not sure they're useful.
----------
## FromPrototype
Instantiates prototypes, ensures a reverse mapping.
`instanceContext` is encoded with `protoEntity` to get instanced entity in `newInstance` and other methods.
[ScopedValueFromPrototype](contracts/scoped-value/ScopedValueFromPrototype.sol) has an example.
----------
## ScopedValue, ScopedValueFromPrototype
FromPrototype-wrapped version is likely more useful.
Interact with batches (identified by scope) of entity values, or individual entity values.
Scope is for doing batched read/increase/decrease without looping through everything.
Value is any kind of entity to counter mapping.
[ScopedValueFromPrototypeTest](contracts/test/scoped-value/ScopedValueFromPrototype.t.sol) has an example.
----------