-
Notifications
You must be signed in to change notification settings - Fork 11
5 Work In Progress : Cookbook
This section covers some basic usecases. Thoses code snippets allow you to discover the differents way to use/interact with a feature, some options or best practices and provides crusty informations. If you are looking for full exemple instead of short code snippets, you rather look at our Ternoa-js dApp and gitHub repo. Depending of the community requests and feebacks, we will implement more of thoses cookbook exemples and make them available for everyone below.
batchTxHex or batchAllTxHex functions can be implemented into the execution process of a transaction. Both transactions do the same and expect the same parameters. The difference is that with the "batch" one, our transactions will be executed until one fails and at that point it will not continue to the next batched transaction. With "batchAll" it will first try to do them all and if any one fails it will revered the successful ones and the state of the chain will not change. The general rule of thumb is to always use the batchAll transaction.
batchTx or batchAllTx functions also exist and return both the tx hash but not in hex format. They both work exactly the same.
As an exemple, this can be usefull if you want to create a large amount of NFT : Instead of creating all the NFTs one by one, it's recommended, in cases where more than one operation needs to be done, to group them all and to executed them as one transaction. This allows you to save on transaction fees and most importantly to save on time.
In this exemple we are going to run the batchAllTxHex but because we want the process to stop and revert in case of error and an hex format as result, but batchTxHex, batchTx or batchAllTx could be used with the exact same code below.
export const nftsBatchMintingHex = async (nftMetadata, quantity) => {
// nftMetaData represents here the offChain datas of the NFT.
// quantity is the number of NFT to be minted
try{
...
// First we create the NFT
const nftTx = await createNftTx(nftMetadata, 0, undefined, false)
// Second we add all the NFT in an Array
const nftsTxs = new Array(Number(quantity)).fill(nftTx)
// We batch the transaction with the batchAllTxHex function
return await batchAllTxHex(nftsTxs)
...
}catch(error){
console.log(error)
}
}In this exemple, we show a way to check if the batch is completed or interupted. Keep in mind that BatchTx Extrinsic is considered as successfull even when interrupted. It does not mean that all tx are validated: the chain provide the ExtrinsicSuccess event anyway. A good practice would be to monitor BatchCompleted and check with our findEvent function if a BatchInterrupted Event has been thrown within the Batch. If a BatchCompleted event is available, it means that the batch has not been interrupted. Otherwise, the batch has been interrupted at some point. Check the event list.
export const batchTx = async () => {
try {
...
// we asume the API is initialized and the Keyring has been recovered.
// We create a first tx and get the hash : a collection without limit
const signableCollection = await createCollectionTx("BatchCollectionTestings", undefined)
// We create a second tx with a wrong parameter to interupt the batch : a collection id that does not exist in the chain for now
const signableNFT = await createNftTx("create NFT with wrong collection Id to interupte batch", 0, 1000, false)
// We batch both hash in an array []
const signableBatchTx = await batchTxHex([signableCollection, signableNFT])
// We sign and submit the tx to get the event list
const batchedEvents = await submitTxBlocking(signableBatchTx, WaitUntil.BlockInclusion, keyring)
// We check if the event list has a BatchCompletedEvent
const isBatchCompleted = batchedEvents.findEvents(BatchCompletedEvent)
// if the event list is equal to 0 (not BatchCompletedEvent), we provide the BatchInterruptedEvent with the error detail.
if (isBatchCompleted.length <= 0) {
return batchedEvents.findEvents(BatchInterruptedEvent)
}
// We return the full event list if it contains a BatchCompletedEvent
return batchedEvents
} catch (err) {
console.log(err)
}
}
// The expected output:
//[
// BatchInterruptedEvent {
// raw: Type(2) [Map] {
// ...
// },
// type: 'utility.BatchInterrupted',
// section: 'utility',
// method: 'BatchInterrupted',
// index: 1, // index of the interupted item.
// dispatchError: { ... },
// errorType: 'CollectionNotFound',
// details: 'No Collection was found with that NFT id.'
// }
]IPFS is one fo the solution we recommand to upload the NFT metadatas and to provide them as the offchainDatas of your feature. The full IPFS Upload will be soon added to the ternoa-js SDK. For now, we invite you to look at this github discussions or to this dApp exemple we used for a workshop before.
A little reminder to the expected formats :
- title: Title of the NFT - string
- description: Description of the NFT - string
- image: IPFS hash of the NFT's asset - string
- properties: An object containing NFT's properties and at least a Media object - object
- media: An object containing NFT's asset properties - object (see below)
media - object:
- hash : IPFS hash of the NFT asset - string
- type: Type of media (file format) - string
- size: size of the encrypted media - string
- banner_image: IPFS hash of the collection's banner image - string
- name: Name of the collection - string
- description: Description of the collection - string
- profile_image: IPFS hash of the avatar/profile image assigned to the collection - string
- name: Name of the marketplace - string
- logo_uri: Logo URI of the marketplace - string
- walletConnect / polkadot extension sign