document erc721 burnScheduledPrefix (#35)

* document erc721 burnScheduledPrefix * Update docs/home/300-react-to-events/2-primitive-catalogue/10-evm/3-ERC721.md --------- Co-authored-by: Sebastien Guillemot <[email protected]>
PaimaStudios · Apr 6, 2024 · 41c005f · 41c005f
1 parent aa7a094
commit 41c005f
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/home/300-react-to-events/2-primitive-catalogue/10-evm/3-ERC721.md b/docs/home/300-react-to-events/2-primitive-catalogue/10-evm/3-ERC721.md
@@ -13,6 +13,8 @@ extensions:
     contractAddress: "0x01...ef"
     startBlockHeight: 7654321
     scheduledPrefix: "newnft"
+    # optional
+    burnScheduledPrefix: "nftburn"
 ```
 
 ### Meaning
@@ -32,6 +34,20 @@ where:
 - `tokenId` is the ID of the newly minted token (in base 10),
 - `mintData` is the string emitted when the NFT was minted for PaimaERC721 NFTs (used for specifying the type of Stateful NFT). For classical ERC721 contracts, it will always be an empty string.
 
+
+**If** `burnScheduledPrefix` is set, burn events are also emitted with the format:
+
+```
+prefix|owner|tokenId
+```
+
+where:
+
+- `prefix` is the value of `burnScheduledPrefix` in the config file.
+- `owner` is the address that burned the token.
+- `tokenId` is the ID of the burned token (in base 10),
+
+
 ### Utility functions
 
 - `getNftOwner`, to fetch the address which owns the NFT with the specified token ID: