Guides

Intro

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:

• @aeternity/aepp-sdk/es/ae/wallet: for Wallet's focused development
• @aeternity/aepp-sdk/es/ae/contract: for Contract's focused development
• @aeternity/aepp-sdk/es/ae/aepp: for Web Aepp's focused development ⚠️ No Wallet support
• @aeternity/aepp-sdk/es/ae/aens: for AENs' focused development
• @aeternity/aepp-sdk/es/ae/oracle: for Oracle's focused development
• @aeternity/aepp-sdk/es/ae/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 Networks

When initialising a client, to test, you can use Aeternity's Test Nework URLs:

Testnet (https://sdk-testnet.aepps.com)

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

Guides

Import SDK

• Browser
  • Import SDK bundle with <script> tag
  • Import SDK ES Modules (enabling Tree-Shaking)
  • Import SDK in VueJS
• NodeJS Environment
  • Import SDK in NodeJS

SDK basics

• SDK usage Understanding low vs high level

Contract Usage

• Contract ACI
• AENS usage

Examples

Check out our Examples for more.