Table of contents

• 1. Installation
• 2. Documentation
• 3. Development
  • 3.1. Requirements
  • 3.2. Setup
  • 3.3. Running In Development Mode
• 4. Testing
  • 4.1. Requirements
  • 4.1. Running Tests
• 5. Appendix
  • 5.1. Useful Commands
• 6. How To Contribute
• 7. License

📦 1. Installation

• Using npm:

npm install @jumpdefi/airdrop-tool

• Using yarn:

yarn add @jumpdefi/airdrop-tool

📚 2. Documentation

For full documentation, please see here.

Back to top ^

🛠 3. Development

3.1. Requirements

• Install Node v20.9.0+

Back to top ^

3.2. Setup

Install the dependencies:

$ npm install

Back to top ^

3.3. Running In Development Mode

• To run the CLI in development mode, simply run the npm script:

$ npm start -- --help

⚠️ NOTE: In order to not conflict with npm's arguments, you must use the -- between start and CLI flags.

Back to top ^

🧪 4. Testing

4.1. Requirements

• Install Docker
• Install Docker Compose v2.5.0+

Back to top ^

4.2. Running Tests

The test script begins by building and starting a local Near network using the credentials in .near. Once this has started, the tests are run against this local validator node.

⚠️ NOTE: As the local network contains one validator node, all blocks are handled by this validator.

Within this local network, account IDs will fave the suffix of .test.near, i.e. myaccount.test.near.

The main account (.test.near), whose credentials are stored at ./test/credentials, can be used as a faucet or to deploy contracts.

Back to top ^

📑 5. Appendix

5.1. Useful Commands

| Command | Description | |----------------------|------------------------------------------------------------------------------------| | npm run build | Builds the source code into the dist/ directory. | | npm run docs:build | Builds the documentation into the .docusaurus/ directory. | | npm run docs:serve | Serves the built documentation from the .docusaurus/ directory. | | npm run docs:start | Builds and runs the documentation in a development environment with hot reloading. | | npm run lint | Runs the linter on .js and .ts files. | | npm run prettier | Runs the prettier on .js and .ts files. | | npm start | Runs the CLI in development mode. | | npm test | Spins up a local Near node and runs tests against it. |

Back to top ^

👏 6. How To Contribute

Please read the Contributing Guide to learn about the development process.

Back to top ^

📄 7. License

Please refer to the LICENSE file.

Back to top ^