CLI Commands

General commands

  • elven-tools derive-pem - derives the PEM file from seed phrase (keywords)
  • elven-tools collection-nft-owners - get collection nft owners using the collection ticker (see more)
  • elven-tools distribute-to-owners - Distribute EGLD/ESDT/SFT/MetaESDT to the collection owners. It will take the addresses from nft-collection-owners.json. Se the command above and docs about it here
  • elven-tools deploy nft-minter - deploys the smart contract (by default from the defined tag branch using the devnet, can be configured)
  • elven-tools init-dapp - initialize the Nextjs Minter Dapp in custom directory

nft-minter commands

  • elven-tools nft-minter issue-collection-token [only owner] - issue main collection handle, it costs 0.05 EGLD, and it is a must in the Elrond chain. All NFTs will be under this collection. The cost here is a one-time payment for the whole collection. Provide the name and ticker. You can also provide a separate name for NFTs. You can also opt-out of adding the edition number to the name.
  • elven-tools nft-minter set-roles [only owner] - for now, the command sets the critical role for the collection handle. It is a 'create nft' role.
  • elven-tools nft-minter start-minting [only owner] - by default, after deploying the smart contract, the minting is disabled. You would need to start it
  • elven-tools nft-minter pause-minting [only owner] - you can also pause it at any moment
  • elven-tools nft-minter set-new-price [only owner] - you can set a new price per NFT for the whole collection
  • elven-tools nft-minter giveaway [only owner] - as an owner, you can give some random tokens to other addresses. (see more)
  • elven-tools nft-minter set-drop [only owner] - you can also split the minting into drops. These are 'waves' of minting where you can change prices and promote each one (v1 doesn't include any logic for revealing the CIDs with delay, the revealed NFTs will be sent in every drop). (see more)
  • elven-tools nft-minter unset-drop [only owner] - you can also disable the drop and pause minting
  • elven-tools nft-minter claim-dev-rewards [only owner] - as an owner of the Smart Contract, you can always claim the developer rewards. Read more about them in the Elrond docs. (see more)
  • elven-tools nft-minter change-base-cids [only owner] - you can change base IPFS CIDs only before any NFT was minted. Otherwise, it doesn't make sense to do that.
  • elven-tools nft-minter set-new-tokens-limit-per-address [only owner] - it is possible to change the limits per address which are configured when deploying the Smart Contract
  • elven-tools nft-minter claim-sc-funds [only owner] - this is treated as a fallback for royalties. The Smart Contract will receive the royalties as the creator, so there has to be a way to get them back. In the future the Smart Contract will probably also have dedicated claim functionality to be able to call the marketplace and get the royalties because some of the marketplaces don't send them automatically. (see more)
  • elven-tools nft-minter shuffle - as a user, you can take part and ensure that the minting is random. This transaction will reshuffle the next index to mint. Everyone can run it.
  • elven-tools nft-minter mint - the main mint function, you can mint NFTs using any walletKey.pem file
  • elven-tools nft-minter get-total-tokens-left - the Smart Contract query, returns amount of tokens left
  • elven-tools nft-minter get-provenance-hash - the Smart Contract query returns the provenance hash if provided when deploying
  • elven-tools nft-minter get-drop-tokens-left - the Smart Contract query returns the number of tokens left per drop
  • elven-tools nft-minter get-nft-price - the Smart Contract query, returns the current price
  • elven-tools nft-minter get-nft-token-id - the Smart Contract query, returns the collection token id
  • elven-tools nft-minter get-nft-token-name - the Smart Contract query, returns optional name for each NFT (if not configured NFTs will take the collection name)
  • elven-tools nft-minter get-collection-token-name - the Smart Contract query, returns the collection token name
  • elven-tools nft-minter get-tokens-limit-per-address-total - the Smart Contract query returns the tokens limit per address
  • elven-tools nft-minter get-minted-per-address-total - the Smart Contract query returns the number of tokens minted per one address
  • elven-tools nft-minter get-minted-per-address-per-drop - when the drop is configured, it will return the number of tokens minted per address per drop
  • elven-tools nft-minter get-tokens-limit-per-address-per-drop - when the drop is configured, it will return the total limit of tokens per address per drop
  • elven-tools nft-minter populate-allowlist - the command for preparing the allowlist, you will be able to read it from allowlist.json file or you can provide addresses by hand. There is a limit of 320 addresses per transaction (see more)
  • elven-tools nft-minter enable-allowlist - enable the allowlist, it won't be onsidered unles enabled even when it is filled with addresses,
  • elven-tools nft-minter disable-allowlist - the option to disable the allowlist,
  • elven-tools nft-minter get-allowlist-size - check the size of the allowlist,
  • elven-tools nft-minter is-allowlist-enabled - check if allowlist is currently enabled,
  • elven-tools nft-minter get-allowlist-address-check - check if provided address is included in the allowlist,
  • elven-tools nft-minter is-drop-active - checks if there is an active drop at the moment
  • elven-tools nft-minter clear-allowlist - It will clear the whole allowlist. The best is to keep a max of 1300 addresses in the allowlist at a time. Of course, if only you plan to clear it later. If you keep more and want to clear it, you can reach the gas limit for a transaction. So it would be best to split the allowlist per drop, keep it as small as possible and clear it each time.
  • elven-tools nft-minter remove-allowlist-address - removes a single address from allowlist
  • elven-tools nft-minter is-minting-paused - checks if the minting is paused,
  • elven-tools nft-minter get-total-supply - returns the total supply for the collection,
  • elven-tools nft-minter get-total-supply-of-current-drop - returns the supply of current drop
Contents