@aeternity/aepp-sdk4.0.1 • Public • Published
This SDK is in continuos development where things can easily break, especially if you're not an officially released version. We aim to make all our releases as stable as possible, neverless it should not be taken as production-ready.
To catch up with the more edgy state of development please check out the develop branch.
Table of content
1. Install the SDK
Add the latest
@aeternity/aepp-sdk release from npmjs.com to your project using one of these commands
# install using npm...or yarn or pnpmnpm i @aeternity/aepp-sdk
Note: To install a Pre-Release (latest
alpha version) using on the latest Node version, you have to install the package appending the
@next tag reference, or even use the
# symbol and the Repo URL to install a version coming from a specific branch.
# install the @next version of the SDKnpm i @aeternity/aepp-sdk@next# install the #develop version of the SDKnpm i https://github.com/aeternity/aepp-sdk-js#develop
2. Import (a chosen Flavor)
Import the right flavor. For this example with get the
Universal flavor, which contains all the features of the SDK:
3. Create an Account and get some AEs
You can do many more things now, but you'll probably have to start with:
- Create an account using the 💻 CLI
- Give yourself some initial AEs using the 🚰 Faucet Aepp
- Enjoy building Aepps 🤓
Guides & Examples
CLI - Command Line Client
To quickly test all of Aeternity's blockchain features from your Terminal, you can Install and use our NodeJS CLI by running:
npm i -g @aeternity/aepp-clito globally install the CLI
aecli --helpto get a list of possible commands
eg. Create an Account:
aecli account create testWhateverAccountName
For advanced use, to get a deeper understanding of the SDK or to contribute to its development, it is advised to read the Contributing Guidelines section.
We keep our Changelog up to date.
ISC License (ISC) Copyright © 2018 aeternity developers
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.