# @aeternity/aepp-sdk

> SDK for the æternity blockchain

Latest version **15.0.0** (published 2026-09-07) · ISC license · 0 weekly downloads

## Install

```sh
npm install @aeternity/aepp-sdk
pnpm add @aeternity/aepp-sdk
yarn add @aeternity/aepp-sdk
bun add @aeternity/aepp-sdk
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; large bundle.

## Facts

| | |
|---|---|
| Version | 15.0.0 |
| Published | 2026-09-07 |
| First published | 2018-03-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18.19 |
| Dependencies | 31 |
| Unpacked size | 14 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 255 |
| Maintainers | dincho, thepiwo, davidyuk, marc0olo, aebot, hanssv |
| Keywords | API, aeternity, blockchain, SDK |

## Links

- npm: https://www.npmjs.com/package/@aeternity/aepp-sdk
- Repository: https://github.com/aeternity/aepp-sdk-js
- Homepage: https://sdk.aeternity.io/
- Issues: https://github.com/aeternity/aepp-sdk-js/issues
- npm.io page: https://npm.io/package/@aeternity/aepp-sdk

## Dependencies (31)

- [ws](https://npm.io/package/ws.md) ^8.18.1
- [rlp](https://npm.io/package/rlp.md) ^3.0.0
- [bs58](https://npm.io/package/bs58.md) ^6.0.0
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [events](https://npm.io/package/events.md) ^3.3.0
- [sha.js](https://npm.io/package/sha.js.md) ^2.4.11
- [blakejs](https://npm.io/package/blakejs.md) ^1.2.1
- [process](https://npm.io/package/process.md) ^0.11.10
- [@types/ws](https://npm.io/package/@types/ws.md) ^8.18.1
- [tweetnacl](https://npm.io/package/tweetnacl.md) ^1.0.3
- [websocket](https://npm.io/package/websocket.md) ^1.0.35
- [@types/node](https://npm.io/package/@types/node.md) ^22.15.3
- [json-bigint](https://npm.io/package/json-bigint.md) ^1.0.0
- [@scure/bip39](https://npm.io/package/@scure/bip39.md) ^1.6.0
- [bignumber.js](https://npm.io/package/bignumber.js.md) ^9.3.0
- [canonicalize](https://npm.io/package/canonicalize.md) ^2.1.0
- [@types/sha.js](https://npm.io/package/@types/sha.js.md) ^2.4.4
- [eventemitter3](https://npm.io/package/eventemitter3.md) ^5.0.1
- [isomorphic-ws](https://npm.io/package/isomorphic-ws.md) ^5.0.0
- [tweetnacl-auth](https://npm.io/package/tweetnacl-auth.md) ^1.0.1
- [@types/websocket](https://npm.io/package/@types/websocket.md) ^1.0.10
- [@azure/core-client](https://npm.io/package/@azure/core-client.md) ^1.9.3
- [@types/json-bigint](https://npm.io/package/@types/json-bigint.md) ^1.0.4
- [@metamask/providers](https://npm.io/package/@metamask/providers.md) ^22.1.0
- [webextension-polyfill](https://npm.io/package/webextension-polyfill.md) ^0.12.0
- [@babel/runtime-corejs3](https://npm.io/package/@babel/runtime-corejs3.md) ^7.27.0
- [@ledgerhq/hw-transport](https://npm.io/package/@ledgerhq/hw-transport.md) ^6.31.4
- [@types/readable-stream](https://npm.io/package/@types/readable-stream.md) ^4.0.18
- [@aeternity/aepp-calldata](https://npm.io/package/@aeternity/aepp-calldata.md) ^1.9.1
- [@azure/core-rest-pipeline](https://npm.io/package/@azure/core-rest-pipeline.md) ^1.19.1
- [@types/webextension-polyfill](https://npm.io/package/@types/webextension-polyfill.md) ^0.12.3

## Recent versions

- 15.0.0 (latest) — 2026-09-07
- 13.0.0-beta.0 (beta) — 2023-03-01
- 13.0.0-alpha.1 (alpha) — 2023-01-13
- 14.1.1 — 2026-03-26
- 14.1.0 — 2025-04-29
- 14.0.0 — 2024-10-20
- 13.3.3 — 2024-07-18
- 13.3.2 — 2024-04-22
- 13.3.1 — 2024-04-19
- 13.3.0 — 2024-04-09
- 13.2.2 — 2023-09-21
- 13.2.1 — 2023-07-29
- 13.2.0 — 2023-07-28
- 13.1.0 — 2023-07-07
- 13.0.1 — 2023-04-25
- … 95 more at https://npm.io/package/@aeternity/aepp-sdk/versions

## README

# [æternity](https://aeternity.com)'s JavaScript SDK

[![main action](https://github.com/aeternity/aepp-sdk-js/actions/workflows/main.yml/badge.svg)](https://github.com/aeternity/aepp-sdk-js/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/aeternity/aepp-sdk-js/branch/develop/graph/badge.svg?token=wON6gOciRP)](https://codecov.io/gh/aeternity/aepp-sdk-js)
[![docs](https://github.com/aeternity/aepp-sdk-js/actions/workflows/docs.yml/badge.svg)](https://github.com/aeternity/aepp-sdk-js/actions/workflows/docs.yml)
[![npm](https://img.shields.io/npm/v/@aeternity/aepp-sdk.svg)](https://www.npmjs.com/package/@aeternity/aepp-sdk)
[![npm](https://img.shields.io/npm/l/@aeternity/aepp-sdk.svg)](https://www.npmjs.com/package/@aeternity/aepp-sdk)

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

[æternity]: https://aeternity.com
[æternity node]: https://github.com/aeternity/aeternity
[hosted on GitHub]: https://github.com/aeternity/aepp-sdk-js

## Guides & Examples

Introduction

- [Installation](docs/README.md)
- [Quick Start](docs/quick-start.md)

Usage guides:

- [AENS](docs/guides/aens.md) (æternity naming system)
- [Contracts](docs/guides/contracts.md)
- [Contract Events](docs/guides/contract-events.md)
- [Oracles](docs/guides/oracles.md)
- [PayingForTx](docs/guides/paying-for-tx.md) (Meta-Transactions)
- [Batch Transactions](docs/guides/batch-requests.md)
- [Error Handling](docs/guides/error-handling.md)
- [Low vs High level API](docs/guides/low-vs-high-usage.md)
- [Typed data hashing and signing](docs/guides/typed-data.md)
- [Usage with TypeScript](docs/guides/typescript.md)
- [JWT usage](docs/guides/jwt.md)
- [Transaction options](docs/transaction-options.md)
- [Range of possible address length](docs/guides/address-length.md)
- Wallet Interaction
  - [Connect an æpp to a wallet](docs/guides/connect-aepp-to-wallet.md)
  - [How to build a wallet](docs/guides/build-wallet.md)
  - [Ledger Hardware Wallet](docs/guides/ledger-wallet.md)
  - [Aeternity snap for MetaMask](docs/guides/metamask-snap.md)

There are also [examples](examples/README.md) that you can directly use and play with.

### [API Reference](https://sdk.aeternity.io/v14.1.0/api/)

## CLI - Command Line Interface

To quickly test _all_ of æternity's blockchain features from your terminal, you can install and use the [CLI](https://github.com/aeternity/aepp-cli-js) 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](docs/contrib/README.md) section.

## Changelog

We keep our [Changelog](docs/CHANGELOG.md) up to date.

---
_Source: https://npm.io/package/@aeternity/aepp-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
