JavaScript SDK Documentation

⚠️ Disclaimer

We're doing our best to keep the documentation up to date, but please let us know if you see some out-of-date file. Thanks!


There are three different ways of incorporating aepp-sdk-js into your project, depending on the particular scenario: * ES Modules at es/ (recommended) * Node.js bundle at dist/aepp-sdk.js * Browser bundle at dist/aepp-sdk.browser.js * Browser bundle for using through \<script> tag at dist/aepp-sdk.browser-script.js

Also, please be aware that using require instead of module loader syntax (import) means that the default export automatically becomes exposed as default, which is reflected below in the code examples. This is due to a recent change in [Babel] compilation and fully compliant with the standard.

Flavors / Entry Points

The recommended approach to use aepp-sdk is to import one of the following Ae Factories based on the specific use case:

  • RpcWallet: for Wallet's focused development
  • Contract: for Contract's focused development
  • RpcAepp: for Web Aepp's focused development ⚠️ No Wallet support
  • Aens: for AENs' focused development
  • Oracle: for Oracle's focused development
  • Universal: for Universal development (includes all SDK features)

In order to cater more specific needs, it is recommended to refer to the contributing Docs.

Testing Network

When initialising a client, to test, you can use Aeternity's Test Network URL:

You can use this URL with any release on npmjs. It offers the last stable version of Node, used by all of Aeternity's Dev Tools.