# @xlabs-libs/wallet-aggregator-algorand

> Implements the base abstractions for the [Algorand](https://www.algorand.com/) blockchain.

Latest version **0.0.1-alpha.28** (published 2024-08-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @xlabs-libs/wallet-aggregator-algorand
pnpm add @xlabs-libs/wallet-aggregator-algorand
yarn add @xlabs-libs/wallet-aggregator-algorand
bun add @xlabs-libs/wallet-aggregator-algorand
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1-alpha.28 |
| Published | 2024-08-23 |
| First published | 2023-01-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 128.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Maintainers | sebastianscatularo, yuliferna, mpicco, mpicco-randlabs |

## Links

- npm: https://www.npmjs.com/package/@xlabs-libs/wallet-aggregator-algorand
- Repository: https://github.com/XLabs/wallet-aggregator-sdk.git#master
- Homepage: https://github.com/XLabs/wallet-aggregator-sdk/tree/master#readme
- Issues: https://github.com/XLabs/wallet-aggregator-sdk/issues
- npm.io page: https://npm.io/package/@xlabs-libs/wallet-aggregator-algorand

## Dependencies (9)

- [algosdk](https://npm.io/package/algosdk.md) ^1.24.0
- [@perawallet/connect](https://npm.io/package/@perawallet/connect.md) ^1.3.3
- [@ledgerhq/hw-transport](https://npm.io/package/@ledgerhq/hw-transport.md) ^6.28.1
- [@blockshake/defly-connect](https://npm.io/package/@blockshake/defly-connect.md) ^1.1.1
- [@ledgerhq/hw-app-algorand](https://npm.io/package/@ledgerhq/hw-app-algorand.md) ^6.27.12
- [@ledgerhq/hw-transport-webhid](https://npm.io/package/@ledgerhq/hw-transport-webhid.md) ^6.27.12
- [@ledgerhq/hw-transport-webusb](https://npm.io/package/@ledgerhq/hw-transport-webusb.md) ^6.27.12
- [@ledgerhq/hw-transport-web-ble](https://npm.io/package/@ledgerhq/hw-transport-web-ble.md) ^6.27.12
- [@xlabs-libs/wallet-aggregator-core](https://npm.io/package/@xlabs-libs/wallet-aggregator-core.md) ^0.0.1-alpha.21

## Recent versions

- 0.0.1-alpha.28 (latest) — 2024-08-23
- 0.0.1-alpha.27 — 2023-10-04
- 0.0.1-alpha.26 — 2023-09-20
- 0.0.1-alpha.25 — 2023-08-30
- 0.0.1-alpha.24 — 2023-08-30
- 0.0.1-alpha.23 — 2023-07-20
- 0.0.1-alpha.22 — 2023-07-19
- 0.0.1-alpha.21 — 2023-07-19
- 0.0.1-alpha.20 — 2023-07-18
- 0.0.1-alpha.19 — 2023-07-18
- 0.0.1-alpha.18 — 2023-07-17
- 0.0.1-alpha.17 — 2023-07-10
- 0.0.1-alpha.16 — 2023-06-23
- 0.0.1-alpha.15 — 2023-04-20
- 0.0.1-alpha.14 — 2023-03-10
- … 13 more at https://npm.io/package/@xlabs-libs/wallet-aggregator-algorand/versions

## README

## Wallet Aggregator - Algorand

Implements the base abstractions for the [Algorand](https://www.algorand.com/) blockchain.

Wallets implemented so far:

| Wallet       | Link                   |
| ------------ | ---------------------- |
| Pera Wallet  | https://perawallet.app |
| Defly Wallet | https://defly.app      |
| Ledger       | https://ledger.com     |

### Usage

The base Algorand wallet configuration allows setting the algorand node and indexer url and credentials, as well as setting a default account. Each wallet has also its own config options.

Example:

```ts
import { PeraWallet } from "@xlabs-libs/wallet-aggregator-algorand";

const pera = new PeraWallet({
  node: {
    url: "https://algo.node.io",
    token: "a_token",
  },
  peraOptions: {
    chainId: 416002,
  },
});
```

### Note on Transaction signing

The Algorand wallet transaction signing interface complies with the [ARC-0001](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0001.md). While the base cases are supported by all wallets, some of them might implement the ARC only partially (e.g: they don't support signing multisig transactions). Some features can be implemented at adapter level (i.e. in the concrete wallet classes, like skipping transaction with empty `signers` in the ledger HW wallet), but do not expect all functionalities to be there.

---
_Source: https://npm.io/package/@xlabs-libs/wallet-aggregator-algorand · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._