| 1 | # Guides
|
| 2 |
|
| 3 | ## Intro
|
| 4 | There are three different ways of incorporating aepp-sdk-js into your project, depending on the particular scenario:
|
| 5 | * ES Modules at `es/` (recommended)
|
| 6 | * Node.js bundle at `dist/aepp-sdk.js`
|
| 7 | * Browser bundle at `dist/aepp-sdk.browser.js`
|
| 8 | * Browser bundle for using through \<script\> tag at `dist/aepp-sdk.browser-script.js`
|
| 9 |
|
| 10 | Also, please be aware that using `require` instead of module loader syntax
|
| 11 | (`import`) means that the default export automatically becomes exposed as
|
| 12 | `default`, which is reflected below in the code examples. This is due to a
|
| 13 | recent change in [Babel] compilation and fully compliant with the standard.
|
| 14 |
|
| 15 | ### Flavors / Entry Points
|
| 16 |
|
| 17 | The recommended approach to use aepp-sdk is to import one of the following _Ae
|
| 18 | Factories_ based on the specific use case:
|
| 19 |
|
| 20 | * [@aeternity/aepp-sdk/es/ae/wallet](api/ae/wallet.md): for **Wallet**'s focused development
|
| 21 | * [@aeternity/aepp-sdk/es/ae/contract](api/ae/contract.md): for **Contract**'s focused development
|
| 22 | * [@aeternity/aepp-sdk/es/ae/aepp](api/ae/aepp.md): for **Web Aepp**'s focused development ⚠️ **_No Wallet support_**
|
| 23 | * [@aeternity/aepp-sdk/es/ae/aens](api/ae/aens.md): for **AENs**' focused development
|
| 24 | * [@aeternity/aepp-sdk/es/ae/oracle](api/ae/oracle.md): for **Oracle**'s focused development
|
| 25 | * [@aeternity/aepp-sdk/es/ae/universal](api/ae/universal.md): for **Universal** development (includes all SDK features)
|
| 26 |
|
| 27 | In order to cater more specific needs, it is recommended to refer to the
|
| 28 | [contributing Docs](contrib/README.md).
|
| 29 |
|
| 30 | ### Testing Networks
|
| 31 | When initialising a client, to test, you can use Aeternity's Test Nework URLs:
|
| 32 |
|
| 33 | ### Testnet (https://sdk-testnet.aepps.com)
|
| 34 | You can use this URL with any releasee on [npmjs](https://www.npmjs.com/package/@aeternity/aepp-sdk). It offers the last stable version of [Node](https://github.com/aeternity/aeternity), used by all of of Aeternity's Dev Tools.
|
| 35 |
|
| 36 | ## Guides
|
| 37 | ### Import SDK
|
| 38 | - Browser
|
| 39 | - [Import SDK bundle with **`<script>`** tag](guides/import-script-tag.md)
|
| 40 | - [Import SDK **ES Modules** (enabling Tree-Shaking)](guides/import-tree-shaking.md)
|
| 41 | - [Import SDK in **VueJS**](guides/import-vuejs.md)
|
| 42 | - NodeJS Environment
|
| 43 | - [Import SDK in **NodeJS**](guides/import-nodejs.md)
|
| 44 |
|
| 45 | ### SDK basics
|
| 46 | - [**SDK usage** Understanding low vs high level](guides/low-vs-high-usage.md)
|
| 47 |
|
| 48 | ### Contract Usage
|
| 49 | - [Contract ACI](guides/contract-aci-usage.md)
|
| 50 | - [Contract Events](guides/contract-events.md)
|
| 51 | - [AENS delegation signature](guides/delegate-signature-to-contract.md)
|
| 52 | - [AENS usage](guides/aens-usage.md)
|
| 53 |
|
| 54 | ### New Wallet/Aepp API
|
| 55 | - [How to build Wallet app/extension](guides/how-to-build-an-wallet-app-or-extension.md)
|
| 56 | - [How to build Aepp](guides/how-to-build-aepp-using-new-wallet-api.md)
|
| 57 |
|
| 58 | ## Examples
|
| 59 | Check out our [Examples](../examples/README.md) for more.
|