æternity's JavaScript SDK

JavaScript SDK for the revolutionary æternity blockchain, targeting the æternity node implementation. The aepp-sdk is hosted on GitHub.

Guides & Examples

Introduction

• Installation
• Quick Start

Usage guides:

• AENS (æternity naming system)
• Contracts
• Contract Events
• Oracles
• PayingForTx (Meta-Transactions)
• Batch Transactions
• Error Handling
• Low vs High level API
• Wallet Interaction
  • Connect an æpp to a wallet
  • How to build a wallet

There are also examples that you can directly use and play with.

CLI - Command Line Interface

To quickly test all of æternity's blockchain features from your terminal, you can install and use the CLI by running:

1. npm i -g @aeternity/aepp-cli to globally install the CLI
2. aecli --help to get a list of possible commands

Contributing

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.

Changelog

We keep our Changelog up to date.

License

ISC License (ISC) Copyright © 2024 æternity 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.