Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 4.68 KB

README.md

File metadata and controls

85 lines (54 loc) · 4.68 KB
Raw

Elven Tools CLI

What is it?

The CLI tool helps to:

  • deploy the NFT and SFT minter smart contracts on the MultiversX blockchain
  • setup and interact with the NFT and SFT minter smart contracts on the MultiversX blockchain
  • provides a couple of helper tools for getting the data from API (NFTs)
    • get collection owners => docs
    • filter and export the data
    • distribute EGLD, ESDT, SFT and Meta ESDT to the NFT owners of a collection => docs

For now it is designed to deploy contracts:

Be aware that smart contracts doesn't have any audits. They has complete functionality for the first versions, but they still needs some improvements. Test them first on the devnet/testnet.

You can use elven-tools-dapp as your frontend dapp for minting process! (NextJS based app with all 4 auth providers included, and React hooks for interaction) (Learn more about it here: How to start with the Dapp) For now, by default it supports only NFT smart contract, but it will handle both in the future.

Tracking the progress

How does it work?

The Elven Tools CLI is a Node.js command line tool. Your machine must have Node.js installed.

General how to:

  • npm install elven-tools -g - install elven-tools cli tool
  • elven-tools --version or elven-tools -v - check current version
  • elven-tools --help or elven-tools -h - for getting the commands on the root level
  • elven-tools nft-minter --help or elven-tools nft-minter -h - for getting all the commands for the subcommand

You can also use it with npx directly. For example:

  • npx elven-tools@latest deploy nft-minter

Steps for deploying and interacting with the Smart Contract:

Check out the TL;DR and longer description here: Jump start

Check out possible workflows

For NFT: Examples of how you can configure your Smart Contract in a couple of scenarios and how to use the CLI to do this faster and more efficient: www.elven.tools/docs/elven-tools-workflows.html

All Commands

For all commands, check out the docs: www.elven.tools/docs/cli-commands.html

Custom configuration options

For all configuration options check out the docs: www.elven.tools/docs/cli-introduction.html#custom-configuration-options

Most common recipes

Here are ready-to-use recipes and more information on real-life use cases: Elven Tools Recipes

You may also like

  • Buildo.dev - Buildo.dev is a MultiversX app that helps with blockchain interactions, like issuing tokens and querying smart contracts.
  • elven.js - simplified wrapper over JS sdk-core, designed to work as a plug-n-play solution for browser based use cases. No build steps and frameworks, just one file to rule it all! Check usage examples!
  • useElven - React hooks for MultiversX
  • NFT Art Maker - generates images and metadata files and packs them into CAR files, all from provided PNG layers.
  • Buildo Begins - CLI toolset for interacting with the MultiversX blockchain, APIs and smart contracts
  • Export collection owners to CSV

Issues and ideas

Please post issues and ideas here.

Contact

License

MIT