Below you'll find all endpoints with a short description. You can always see the complete code here.
Please check all attributes for each endpoint in the linked code line in the repository. It is all open-source.
You'll find all the endpoints here.
These are the required operations you would need to perform once always when configuring a new collection and Smart Contract. Check the CLI tool to simplify the work required.
init - standard init endpoint, it will be triggered on deployment and upgrade
issueToken - required endpoint for creating a new collection, this is done once. It is a handler for the whole single collection.
setLocalRoles - Set roles. You can choose from four of them. Create and Add quantity roles are required to proceed.
createToken - create SFT tokens with the defined amount, assets, and attributes.
mint - increase the initial supply
burn - decrease the initial supply
claimScFunds - You can claim the funds which are there on the payable Smart Contract. For example, royalties paid by marketplaces. These are only funds that come from outside. The funds from selling are directly sent to the contract owner after each sell.
setNewPrice - You can change the previously set price.
setNewAmountLimitPerAddress - You can change the previously set max token amount with a particular nonce per address
pauseSelling - You can stop selling a token with a particular nonce.
startSelling - You can start selling a token with a particular nonce.
giveaway - You can send some amount of particular SFTs to some addresses. No limits applied here.
buy - buy SFT tokens
getCollectionTokenName - returns collection token name
getCollectionTokenId - returns collection token id
getTokenDisplayName - returns the SFT token display name. Here you need to provide the nonce of the SFT token because there can be more than one. Each can have different supply and attributes
getPrice - returns current price per one token, you also need to provide the nonce of the SFT token
getMaxAmountPerAddress - returns the max amount of tokens to buy by one address. You also need to provide the nonce of the SFT token
isPaused - returns the information about whether the token with a particular nonce can be bought or the selling is paused
getAmountPerAddressTotal - returns the amount of already bought tokens with a particular nonce by a specific address
Check the examples for
You can also check the elven-tools-cli source code, where I also used the MultiversX JS SDK.
Check the examples for