æ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
• Typed data hashing and signing
• Usage with TypeScript
• JWT usage
• Transaction options
• Range of possible address length
• Wallet Interaction
  • Connect an æpp to a wallet
  • How to build a wallet
  • Ledger Hardware Wallet
  • Aeternity snap for MetaMask

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

API Reference

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.