feat: algo25 package by joe-p · Pull Request #335 · algorandecosystem/algokit-core

joe-p · 2026-02-21T01:05:52Z

Adds the algo25 package which is used to go from mneomic to seed (and vice versa)

Copilot

Pull request overview

Adds a new algokit_algo25 Rust crate (and algokit_algo25_ffi) to support Algorand 25-word mnemonic ↔ seed conversions, along with generated Swift/Android bindings and updates to build/CI tooling to publish the new package.

Changes:

Introduces crates/algokit_algo25 (mnemonic/seed conversion logic + wordlist) and crates/algokit_algo25_ffi (UniFFI exports + error mapping).
Adds new Swift package AlgoKitAlgo25 and Android package algokit_algo25 containing generated UniFFI bindings and build scaffolding.
Updates build tooling (tools/build_pkgs) and CI workflow to include algokit_algo25.

Reviewed changes

Copilot reviewed 22 out of 24 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tools/build_pkgs/src/main.rs	Registers `Algo25` as a buildable package and maps to `algokit_algo25_ffi`.
packages/swift/AlgoKitAlgo25/Tests/AlgoKitAlgo25Tests/AlgoKitAlgo25Tests.swift	Adds Swift test target skeleton for the new package.
packages/swift/AlgoKitAlgo25/Sources/AlgoKitAlgo25/AlgokitAlgo25.swift	Adds generated Swift UniFFI bindings for algo25.
packages/swift/AlgoKitAlgo25/Package.swift	Defines Swift package and binary target for the Algo25 xcframework.
packages/swift/AlgoKitAlgo25/.gitignore	Adds Swift package-specific ignores.
packages/android/algokit_algo25/src/main/kotlin/uniffi/algokit_algo25_ffi/algokit_algo25_ffi.kt	Adds generated Kotlin/JNA UniFFI bindings for algo25.
packages/android/algokit_algo25/settings.gradle.kts	Adds Gradle settings for the new Android module.
packages/android/algokit_algo25/gradlew.bat	Adds Gradle wrapper (Windows) for the new Android module.
packages/android/algokit_algo25/gradlew	Adds Gradle wrapper (POSIX) for the new Android module.
packages/android/algokit_algo25/gradle/wrapper/gradle-wrapper.properties	Configures Gradle wrapper distribution for the new module.
packages/android/algokit_algo25/gradle/wrapper/gradle-wrapper.jar	Adds Gradle wrapper JAR.
packages/android/algokit_algo25/gradle/libs.versions.toml	Adds version catalog for the new Android module.
packages/android/algokit_algo25/gradle.properties	Adds Gradle properties for the new Android module.
packages/android/algokit_algo25/build.gradle.kts	Adds Android library build configuration and deps (incl. JNA).
packages/android/algokit_algo25/README.md	Documents build and test commands for the Android package.
crates/algokit_algo25_ffi/uniffi.toml	Configures UniFFI Swift module name for algo25 FFI.
crates/algokit_algo25_ffi/src/lib.rs	Implements UniFFI-exported API surface and error conversions for algo25.
crates/algokit_algo25_ffi/Cargo.toml	Adds FFI crate manifest, crate types, and UniFFI feature wiring.
crates/algokit_algo25/src/lib.rs	Implements mnemonic/seed conversion logic and unit tests.
crates/algokit_algo25/src/english.rs	Adds English wordlist used for mnemonic encoding/decoding.
crates/algokit_algo25/Cargo.toml	Adds new crate manifest and sha2 dependency.
Cargo.toml	Registers new crates in the workspace members list.
Cargo.lock	Adds resolved dependencies for the new crates.
.github/workflows/ci_cd.yml	Includes `algokit_algo25` in the CI list of FFI-producing crates.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

crates/algokit_algo25/src/lib.rs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

michaeltchuang · 2026-02-21T22:23:37Z

packages/android/algokit_algo25/build.gradle.kts

+}
+
+android {
+  namespace = "com.example.algokit_algo25"


@joe-p is this supposed to be an example package name?

What domain should we use?

What domain should we use?

we are setup on mavencentral for io.github.algorandecosystem so I think our aar structure might be io.github.algorandecosystem:algokit-*

what about using io.github.algorandecosystem.algokit.algo25?

michaeltchuang · 2026-02-21T22:26:04Z

packages/android/algokit_algo25/gradle/libs.versions.toml

+material = { group = "com.google.android.material", name = "material", version.ref = "material" }
+
+# Compose dependencies
+androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "compose-bom" }


@joe-p compose is for Android UI libraries...is this generated from Rust FFI? I think maybe we can remove them if it's not needed. Same with material and appcompat, expresso is UI testing

This is probably leftover from when we created that first example app, so it's probably safe to remove

Removed in 782b1ae. Let me know if there's anything I missed (or shouldn't have removed)

PhearZero

Looks good overall, checksum seems valid and the explicit check for 25 words was a nice touch!

PhearZero · 2026-02-21T23:43:04Z

crates/algokit_algo25/src/lib.rs

+}
+
+/// Takes a master derivation key and returns the corresponding mnemonic.
+pub fn master_derivation_key_to_mnemonic(mdk: &[u8]) -> Result<String, MnemonicError> {


Is it just for consistent naming or is this something to be added later? I remember the sdk has a derivation function similar to kmd, I'm guessing this is a stub

These functions are here to align with TS/Py which in turn are aligned with algosdk: https://github.com/algorand/js-algorand-sdk//blob/da8f2e6cd616e9430f8bb8d56bb9d25dffe1b98a/src/mnemonic/mnemonic.ts#L164-L181

I assume they exist because the master key and an ed25519 key are different things technically even though they use the same algorithm

Ahh that's interesting. I wouldn't have expected that, yea it must be a naming decision. I'm guessing KMD does the same

michaeltchuang · 2026-02-21T23:58:17Z

crates/algokit_algo25/src/lib.rs

+}
+
+/// Takes a mnemonic and returns the corresponding master derivation key.
+pub fn mnemonic_to_master_derivation_key(


is master_derivation_key only used for hd too? and not algo25?

i needed a way to get Algo25 public key from mnemonic and thought this was it, but AI was saying it's not the right function, but for BIP39 seed

See this comment: #335 (comment)

I'll be adding HD support in the next PR

See this comment: #335 (comment)

I'll be adding HD support in the next PR

oh ok

one question then...i thought this crate was only algo25 based off name (e.g. crates/algokit_algo25/src/lib.rs...)...will you rename if it includes HD functions too (e.g. crates/algokit_account/src/lib.rs...)? or will hd be it's own crate (e.g. crates/algokit_hd/src/lib.rs...)?

Good question... maybe we rename this package to algokit_recovery and it'll have functions for both HD and algo25 mnemonics?

Good question... maybe we rename this package to algokit_recovery and it'll have functions for both HD and algo25 mnemonics?

i think algokit_account might be better since if you add the random function...it'll have create account functionality in a way too. Or algokit_wallet / algokit_address? Solana has Seed Vault, maybe algokit_seed could work too?

then algokit_accountdetail or algokit_accountinfo can have balance, rekey flag, ASAs...or anything beyond account keys/addresses? what do you think? or maybe ASA becomes it's own crate...i'm open-minded

joe-p added 4 commits February 20, 2026 19:42

feat: algokit algo25

836b48c

feat: algokit_algo25 ffi with swift

15ddb2f

feat: algokit algo25 aar

17cc7d4

chore: replace crypto with algo25

aa66f99

joe-p marked this pull request as ready for review February 21, 2026 11:40

joe-p requested a review from lempira as a code owner February 21, 2026 11:40

Copilot AI review requested due to automatic review settings February 21, 2026 11:40

Copilot started reviewing on behalf of joe-p February 21, 2026 11:41 View session

Copilot AI reviewed Feb 21, 2026

View reviewed changes

crates/algokit_algo25/src/lib.rs Outdated Show resolved Hide resolved

joe-p and others added 2 commits February 21, 2026 07:12

fix: expect exactly 25 words

cddb647

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

test: fix broken test

ff245e1

michaeltchuang requested a review from PhearZero February 21, 2026 21:28

michaeltchuang reviewed Feb 21, 2026

View reviewed changes

PhearZero approved these changes Feb 21, 2026

View reviewed changes

michaeltchuang reviewed Feb 21, 2026

View reviewed changes

joe-p added 4 commits February 21, 2026 19:16

feat: ed25519_public_key_from_seed

6d02094

build: remove compose deps

782b1ae

feat: random_bytes

7e4a76a

ci: attempt to autodetect ios sim udid

60a660f

Conversation

joe-p commented Feb 21, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

michaeltchuang Feb 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michaeltchuang Feb 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PhearZero left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michaeltchuang Feb 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michaeltchuang Feb 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

michaeltchuang Feb 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

michaeltchuang Feb 21, 2026 •

edited

Loading

michaeltchuang Feb 22, 2026 •

edited

Loading

michaeltchuang Feb 21, 2026 •

edited

Loading

michaeltchuang Feb 22, 2026 •

edited

Loading

michaeltchuang Feb 22, 2026 •

edited

Loading