BitGo sdk-coin-xlm

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-xlm.

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

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

import { BitGoAPI } from '@bitgo/sdk-api';
import { Xlm } from '@bitgo/sdk-coin-xlm';

const sdk = new BitGoAPI();

sdk.register('xlm', Xlm.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.

Change Log

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

3.4.4 (2025-06-25)

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

3.4.3 (2025-06-24)

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

3.4.2 (2025-06-18)

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

3.4.1 (2025-06-10)

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

3.4.0 (2025-06-05)

Features

• root: support node 22 (c4ad6af)

3.3.0 (2025-06-02)

Features

• rename audit function naming and signature (1a885ab)
• root: add new audit key baseCoin method (57c1778)

3.2.56 (2025-05-28)

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

3.2.55 (2025-05-22)

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

3.2.54 (2025-05-20)

Bug Fixes

• support memoid along with address for send transaction (6b6d25a)

3.2.53 (2025-05-07)

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

3.2.52 (2025-04-29)

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

3.2.51 (2025-04-25)

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

3.2.50 (2025-04-15)

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

3.2.49 (2025-04-04)

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

3.2.48 (2025-04-02)

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

3.2.47 (2025-03-28)

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

3.2.46 (2025-03-20)

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

3.2.45 (2025-03-18)

Bug Fixes

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

3.2.44 (2025-03-06)

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

3.2.43 (2025-03-04)

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

3.2.42 (2025-02-26)

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

3.2.41 (2025-02-20)

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

3.2.40 (2025-02-19)

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

3.2.39 (2025-02-11)

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

3.2.38 (2025-02-05)

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

3.2.37 (2025-01-28)

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

3.2.36 (2025-01-23)

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

3.2.35 (2025-01-23)

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

3.2.34 (2025-01-20)

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

3.2.33 (2025-01-15)

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

3.2.32 (2025-01-09)

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

3.2.31 (2025-01-03)

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

3.2.30 (2024-12-24)

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

3.2.29 (2024-12-19)

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

3.2.28 (2024-12-17)

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

3.2.27 (2024-12-17)

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

3.2.26 (2024-12-12)

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

3.2.25 (2024-12-11)

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

3.2.24 (2024-12-03)

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

3.2.23 (2024-11-26)

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

3.2.22 (2024-11-21)

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

3.2.21 (2024-11-19)

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

3.2.20 (2024-11-14)

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

3.2.19 (2024-11-08)

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

3.2.18 (2024-11-07)

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

3.2.17 (2024-11-01)

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

3.2.16 (2024-10-22)

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

3.2.15 (2024-10-15)

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

3.2.14 (2024-10-08)

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

3.2.13 (2024-10-04)

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

3.2.12 (2024-09-24)

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

3.2.11 (2024-09-19)

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

3.2.10 (2024-09-16)

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

3.2.9 (2024-09-10)

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

3.2.8 (2024-09-03)

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

3.2.7 (2024-08-29)

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

3.2.6 (2024-08-27)

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

3.2.5 (2024-08-20)

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

3.2.4 (2024-08-13)

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

3.2.3 (2024-08-07)

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

3.2.2 (2024-07-30)

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

3.2.1 (2024-07-24)

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

3.2.0 (2024-07-16)

Bug Fixes

• sdk-coin-xlm: deprecate instead of rename utils to avoid breaking change (f1589d4)

Features

• sdk-coin-xlm: better error handling on keypair creation util (c1abf80)
• sdk-coin-xlm: recover root key support and refactor utils (6bf1367)

3.1.3 (2024-07-04)

Bug Fixes

• sdk-coin-xlm: fix xlm root key tx signing (f0cb64e)

3.1.2 (2024-07-02)

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

3.1.1 (2024-06-27)

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

3.1.0 (2024-06-26)

Features

• sdk-coin-xlm: export keypair (d9acd04)
• sdk-coin-xlm: refactor xlm by adding utils (1044f5f)
• sdk-coin-xlm: root key support for xlm (33de8e5)

3.0.21 (2024-06-21)

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

3.0.20 (2024-06-20)

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

3.0.19 (2024-06-14)

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

3.0.18 (2024-06-11)

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

3.0.17 (2024-06-05)

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

3.0.16 (2024-05-31)

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

3.0.15 (2024-05-28)

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

3.0.14 (2024-05-22)

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

3.0.13 (2024-05-17)

Bug Fixes

• sdk-coin-xlm: xlm recovery fixes (2bbae79)

3.0.12 (2024-05-13)

Bug Fixes

• sdk-coin-xlm: fix returned data from recover function (77b1eba)

3.0.11 (2024-05-08)

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

3.0.10 (2024-05-01)

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

3.0.9 (2024-04-25)

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

3.0.8 (2024-04-24)

Bug Fixes

• superagent upgrade to 9.0 (6e9aa43)

3.0.7 (2024-04-22)

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

3.0.6 (2024-04-17)

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

3.0.5 (2024-04-12)

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

3.0.4 (2024-04-10)

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

3.0.3 (2024-04-09)

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

3.0.2 (2024-04-08)

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

3.0.1 (2024-04-05)

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

3.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

2.25.1 (2024-03-19)

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

2.25.0 (2024-03-11)

Features

• sdk-core: add new supportsDeriveKeyWithSeed flag (c82bc46)

2.24.2 (2024-02-28)

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

2.24.1 (2024-02-22)

Bug Fixes

• sdk-coin-xlm: deprecate eddsa key deriver for xlm (6078fc1)

2.24.0 (2024-02-19)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.22.0 (2024-01-30)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.21.0 (2024-01-26)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.20.0 (2024-01-26)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.19.0 (2024-01-25)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.18.0 (2024-01-22)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.17.0 (2024-01-09)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.16.0 (2024-01-03)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.15.0 (2023-12-18)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.14.0 (2023-12-12)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.13.0 (2023-12-09)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.12.0 (2023-12-05)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.11.0 (2023-11-28)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.10.0 (2023-11-24)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.9.0 (2023-11-17)

Bug Fixes

• sdk-coin-xlm: fix muxed address check in verifyTransaction (50a3640)
• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.8.0 (2023-11-13)

Bug Fixes

• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.7.0 (2023-11-13)

Bug Fixes

• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.6.0 (2023-11-13)

Bug Fixes

• sdk-core: fix issue related to bignumber version (519fe47)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.5.0 (2023-10-20)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.4.0 (2023-10-18)

Features

• sdk-coin-xlm: support token enablement (7e1e5c8)

2.3.11 (2023-09-25)

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

2.3.10 (2023-09-09)

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

2.3.9 (2023-09-09)

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

2.3.8 (2023-09-07)

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

2.3.7 (2023-09-05)

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

2.3.6 (2023-09-01)

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

2.3.5 (2023-08-29)

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

2.3.4 (2023-08-25)

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

2.3.3 (2023-08-24)

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

2.3.2 (2023-08-16)

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

2.3.1 (2023-08-16)

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

2.3.0 (2023-08-04)

Features

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

2.2.0 (2023-07-28)

Features

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

2.1.1 (2023-07-18)

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

2.1.0 (2023-06-21)

Features

• sdk-coin-xlm: adding txHex to explainTransaction params for xlm (1feb544)

2.0.12 (2023-06-14)

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

2.0.11 (2023-06-13)

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

2.0.10 (2023-06-07)

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

2.0.9 (2023-06-05)

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

2.0.8 (2023-05-25)

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

2.0.7 (2023-05-17)

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

2.0.6 (2023-05-10)

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

2.0.5 (2023-05-03)

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

2.0.4 (2023-04-25)

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

2.0.3 (2023-04-20)

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

2.0.2 (2023-04-13)

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

2.0.1 (2023-02-17)

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

2.0.0 (2023-02-16)

Bug Fixes

• sdk-core: mark pub as optional in Keychain interface (7d6012c)

BREAKING CHANGES

• sdk-core: Keychain.pub is now optional

1.2.13 (2023-02-08)

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

1.2.12 (2023-01-30)

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

1.2.11 (2023-01-25)

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

1.2.10 (2022-12-23)

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

1.2.9 (2022-12-20)

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

1.2.8 (2022-12-09)

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

1.2.7 (2022-12-06)

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

1.2.6 (2022-12-01)

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

1.2.5 (2022-11-29)

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

1.2.4 (2022-11-04)

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

1.2.2 (2022-10-27)

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

1.2.1 (2022-10-25)

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

1.2.0 (2022-10-18)

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

1.0.1 (2022-07-19)

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

1.0.1-rc.3 (2022-07-19)

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

1.0.1-rc.2 (2022-07-18)

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

1.0.1-rc.1 (2022-07-15)

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

1.0.1-rc.0 (2022-07-15)

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