Skip to content

Commit

Permalink
added contribute section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
0xPilou committed Sep 29, 2023
1 parent 0f01b31 commit 6f5b955
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# <img src="ab-logo.png" alt="anotherblock" height="40px" align="left"> anotherblock platform contracts

## collaboration workflow
## contribution workflow

### branches

Expand Down Expand Up @@ -160,3 +160,23 @@ deploy standalone royalty contract for specific publisher
```sh
forge script script/base/deploy-royalty.s.sol:DeployRoyalty --rpc-url base --sig "run(address)" <publisherAddress> --broadcast --verify
```

## contribute

### creating new NFT minting mechanism

in order for anyone to create new minting mechanism NFT contract compatible with anotherblock self-service platform, the contract must comply with below requirements :

1. the new contract shall inherit the abstract contract [ERC721AB](src/token/ERC721/ERC721AB.sol)

2. the new contract state shall include two constants, `IMPLEMENTATION_VERSION` & `IMPLEMENTATION_TYPE`

3. the new contract shall include a function `initDrop` calling the internal function `_initDrop` and contain a minimum set of parameters :

- amount of share per token
- amount of genesis token to be minted
- recipient address of the genesis token(s)
- currency used to pay-out royalties
- base URI

4. the new contract shall include a custom mint function (see [ERC721ABLE](src/token//ERC721/ERC721ABLE.sol) for reference)

0 comments on commit 6f5b955

Please sign in to comment.