Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@bitgo/sdk-coin-algo

BitGo4kMIT2.1.80TypeScript support: included

BitGo SDK coin library for Algorand

readme

BitGo sdk-coin-algo

SDK coins provide a modular approach to a monolithic architecture. This and all BitGoJS SDK coins allow developers to use only the coins needed for a given project.

Installation

All coins are loaded traditionally through the bitgo package. If you are using coins individually, you will be accessing the coin via the @bitgo/sdk-api package.

In your project install both @bitgo/sdk-api and @bitgo/sdk-coin-algo.

npm i @bitgo/sdk-api @bitgo/sdk-coin-algo

Next, you will be able to initialize an instance of "bitgo" through @bitgo/sdk-api instead of via bitgo.

import { BitGoAPI } from '@bitgo/sdk-api';
import { Algo } from '@bitgo/sdk-coin-algo';

const sdk = new BitGoAPI();

sdk.register('algo', Algo.createInstance);

Development

Most of the coin implementations are derived from @bitgo/sdk-core, @bitgo/statics, and coin specific packages. These implementations are used to interact with the BitGo API and BitGo platform services.

You will notice that the basic version of common class extensions have been provided to you and must be resolved before the package build will succeed. Upon initiation of a given SDK coin, you will need to verify that your coin has been included in the root tsconfig.packages.json and that the linting, formatting, and testing succeeds when run both within the coin and from the root of BitGoJS.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

2.1.80 (2025-05-28)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.79 (2025-05-22)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.78 (2025-05-20)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.77 (2025-05-07)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.76 (2025-04-29)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.75 (2025-04-25)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.74 (2025-04-15)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.73 (2025-04-04)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.72 (2025-04-02)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.71 (2025-03-28)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.70 (2025-03-20)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.69 (2025-03-18)

Bug Fixes

  • sdk-core: set default multisig if empty (e2727df)

2.1.68 (2025-03-06)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.67 (2025-03-04)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.66 (2025-02-26)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.65 (2025-02-20)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.64 (2025-02-19)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.63 (2025-02-11)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.62 (2025-02-05)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.61 (2025-01-28)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.60 (2025-01-23)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.59 (2025-01-23)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.58 (2025-01-20)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.57 (2025-01-15)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.56 (2025-01-09)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.55 (2025-01-03)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.54 (2024-12-24)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.53 (2024-12-19)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.52 (2024-12-17)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.51 (2024-12-17)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.50 (2024-12-12)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.49 (2024-12-11)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.48 (2024-12-03)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.47 (2024-11-26)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.46 (2024-11-21)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.45 (2024-11-19)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.44 (2024-11-14)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.43 (2024-11-08)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.42 (2024-11-07)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.41 (2024-11-01)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.40 (2024-10-22)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.39 (2024-10-15)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.38 (2024-10-08)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.37 (2024-10-04)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.36 (2024-09-24)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.35 (2024-09-19)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.34 (2024-09-16)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.33 (2024-09-10)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.32 (2024-09-03)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.31 (2024-08-29)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.30 (2024-08-27)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.29 (2024-08-20)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.28 (2024-08-13)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.27 (2024-08-07)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.26 (2024-07-30)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.25 (2024-07-24)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.24 (2024-07-16)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.23 (2024-07-04)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.22 (2024-07-02)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.21 (2024-06-27)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.20 (2024-06-26)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.19 (2024-06-21)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.18 (2024-06-20)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.17 (2024-06-14)

Bug Fixes

  • sdk-coin-algo: return non-bitgo recovery tx in base64 (c4df3ab)

2.1.16 (2024-06-11)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.15 (2024-06-05)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.14 (2024-05-31)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.13 (2024-05-28)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.12 (2024-05-22)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.11 (2024-05-17)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.10 (2024-05-13)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.9 (2024-05-08)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.8 (2024-05-01)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.7 (2024-04-25)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.6 (2024-04-24)

Bug Fixes

  • superagent upgrade to 9.0 (6e9aa43)

2.1.5 (2024-04-22)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.4 (2024-04-17)

Reverts

  • Revert "feat: protect pass by value when sending data out" (ef1497f)

2.1.3 (2024-04-12)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.2 (2024-04-10)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.1 (2024-04-09)

Note: Version bump only for package @bitgo/sdk-coin-algo

2.1.0 (2024-04-08)

Features

  • protect pass by value when sending data out (8755bdd)

2.0.1 (2024-04-05)

Bug Fixes

  • sdk-coin-algo: fix stellarAddressToAlgoAddress (b44c8fd)

2.0.0 (2024-03-28)

Features

  • root: deprecate node 16 (d3ec624)

BREAKING CHANGES

  • root: Node 16 is no longer supported in bitgojs. TICKET: WP-1100

1.28.1 (2024-03-19)

Bug Fixes

  • sdk-coin-algo: replace fee with feeInfo for algo unsigned sweep (1c4d6f0)

1.28.0 (2024-03-11)

Bug Fixes

  • sdk-coin-algo: return extra fields for unsigned sweep recovery (e85d303)

Features

  • sdk-coin-algo: add tx broadcast support for algo (fcfd9d8)
  • sdk-core: add new supportsDeriveKeyWithSeed flag (c82bc46)

1.27.1 (2024-02-28)

Bug Fixes

  • sdk-coin-algo: fix firstRound value for algo wrw (9f040d8)

1.27.0 (2024-02-22)

Features

  • sdk-coin-algo: add wrw support for algo (da00d83)
  • sdk-coin-algo: implement algo root key creation (6541032)

1.26.0 (2024-02-19)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.24.0 (2024-01-30)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.23.0 (2024-01-26)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.22.0 (2024-01-26)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.21.0 (2024-01-25)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.20.0 (2024-01-22)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.19.0 (2024-01-09)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.18.0 (2024-01-03)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.17.0 (2023-12-18)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.16.0 (2023-12-12)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.15.0 (2023-12-09)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.14.0 (2023-12-05)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.13.0 (2023-11-28)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.12.0 (2023-11-24)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.11.0 (2023-11-17)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.10.0 (2023-11-13)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.9.0 (2023-11-13)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.8.0 (2023-11-13)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.7.0 (2023-10-20)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.6.0 (2023-10-18)

Features

  • sdk-coin-algo: support for token enablement (af718c9)

1.5.11 (2023-09-25)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.10 (2023-09-09)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.9 (2023-09-09)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.8 (2023-09-07)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.7 (2023-09-05)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.6 (2023-09-01)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.5 (2023-08-29)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.4 (2023-08-25)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.3 (2023-08-24)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.2 (2023-08-16)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.1 (2023-08-16)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.5.0 (2023-08-04)

Features

  • root: add node 18 to engines and CI (9cc6a70)
  • root: remove node 14 from engines (6ec47cb)

1.4.0 (2023-07-28)

Features

  • root: add node 18 to engines and CI (9cc6a70)
  • root: remove node 14 from engines (6ec47cb)

1.3.28 (2023-07-18)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.27 (2023-06-21)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.26 (2023-06-14)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.25 (2023-06-13)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.24 (2023-06-07)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.23 (2023-06-05)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.22 (2023-05-25)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.21 (2023-05-17)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.20 (2023-05-10)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.19 (2023-05-03)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.18 (2023-04-25)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.17 (2023-04-20)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.16 (2023-04-13)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.15 (2023-02-17)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.14 (2023-02-16)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.13 (2023-02-08)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.12 (2023-01-30)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.11 (2023-01-25)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.10 (2022-12-23)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.9 (2022-12-20)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.8 (2022-12-09)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.7 (2022-12-06)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.6 (2022-12-01)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.5 (2022-11-29)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.4 (2022-11-04)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.2 (2022-10-27)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.1 (2022-10-25)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.3.0 (2022-10-18)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0 (2022-07-19)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.16 (2022-07-19)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.15 (2022-07-18)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.14 (2022-07-15)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.13 (2022-07-15)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.12 (2022-07-14)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.11 (2022-07-12)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.10 (2022-07-11)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.9 (2022-07-07)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.8 (2022-07-05)

Reverts

  • Revert "Revert "feat(bitgo): change the names from algo tokens"" (ea9a761)

1.1.0-rc.7 (2022-07-01)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.6 (2022-06-30)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.5 (2022-06-30)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.4 (2022-06-29)

Reverts

  • Revert "feat(bitgo): change the names from algo tokens" (81e794b)

1.1.0-rc.3 (2022-06-29)

Reverts

  • Revert "feat(bitgo): change the names from algo tokens" (81e794b)

1.1.0-rc.2 (2022-06-27)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.1 (2022-06-23)

Note: Version bump only for package @bitgo/sdk-coin-algo

1.1.0-rc.0 (2022-06-22)

Features

  • bitgo: change the names from algo tokens (8925d4e)

1.0.1-rc.0 (2022-06-21)

Note: Version bump only for package @bitgo/sdk-coin-algo