feat(transact): keyreg txn support #163

joe-p · 2025-06-18T14:11:53Z

TODO

Wait for feat: Add support for application call transactions #165 and adopt that testing strategy in this PR
Implement validity checking once we decide on how we want to do that

Summary

Entirely written by claude. Haven't yet reviewed anything, but wanted to commit and PR first so we can all see what it's first shot looked like.

Explored codebase structure - Understood the existing transaction types (Payment, AssetTransfer) and how they're implemented
Researched KeyReg transaction fields - Found comprehensive documentation about Algorand KeyReg transaction fields from official sources
Implemented KeyReg transaction type - Added complete support including:
- KeyRegistrationTransactionFields struct with all required fields:
- vote_key (32-byte root participation public key)
- selection_key (32-byte VRF public key)
- state_proof_key (64-byte state proof key)
- vote_first (first valid round)
- vote_last (last valid round)
- vote_key_dilution (key dilution parameter)
- non_participation (optional non-participating flag)
  - Builder pattern support via KeyRegistrationTransactionBuilder
  - Integration with Transaction enum using the correct serde tag "keyreg"
  - FFI support in the algokit_transact_ffi crate
Comprehensive tests covering:
- Creating online key registration transactions
- Updating (offline key registration transactions)
- Deleting (non-participating key registration)
- Calling in transaction groups with other transaction types
- Encoding/decoding round-trip tests
- Transaction ID generation
- Fee calculation
- Online/offline detection

Key Features Implemented:

Online Registration: Full support for registering accounts online for consensus participation with all required participation keys
Offline Registration: Support for taking accounts offline (empty participation key fields)
Non-Participating: Support for marking accounts as non-reward earning
Canonical Fields: Used exact field names and types from Algorand documentation (votekey, selkey, sprfkey, votefst, votelst, votekd, nonpart)
Proper Serialization: Uses MessagePack with correct field naming and optional field handling
Transaction Grouping: KeyReg transactions can be grouped with other transaction types
Builder Pattern: Consistent with existing transaction builders for easy construction

The implementation follows the existing patterns in the codebase and includes comprehensive tests as requested. The KeyReg transaction type is now fully functional and ready to use in applications that need to manage Algorand account
participation in consensus.

joe-p · 2025-06-23T17:16:06Z

crates/algokit_transact/src/transactions/mod.rs

@@ -116,6 +121,12 @@ impl AssetTransferTransactionBuilder {
    }
 }

+impl KeyRegistrationTransactionBuilder {


I noticed we have all the builders defined here. Probably makes sense to move them into their respective files?

Yeah good call.

joe-p · 2025-06-23T17:18:06Z

crates/algokit_transact/src/transactions/key_registration.rs

+    pub non_participation: Option<bool>,
+}
+
+impl KeyRegistrationTransactionFields {


I like this approach. Perhaps we have a ValidTransaction trait that has a valid function with a default implementation that does checks on the header and the calls a valid_for_type function that is called internally to do specific checks.

As an example (untested, may have errors):

trait ValidTransaction { fn valid_for_type(&self) Result<(), String>; fn valid(&self) Result<(), String> { // Do checks on the header fields self.valid_for_type() } } impl ValidTransaction for KeyRegistrationTransaction { fn is_valid_for_type(&self) Result<(), String> { self.valid_offline()? self.valid_online() } }

@PatrickDinh Has done up an implementation of this in his PR https://github.com/algorandfoundation/algokit-core/pull/161/files
The naming is slightly different (trait Validate with validate) and there isn't any header validation as the header type mostly prevents invalid data being set, however that can be added like you have above very easily.

@neilcampbell added trait Validate impl, ready for re review

crates/algokit_transact/src/transactions/key_registration.rs

PatrickDinh

oops, I approved by mistake.

crates/algokit_transact_ffi/src/lib.rs

neilcampbell

@joe-p Shout once you've updated based on the new conventions and we'll review.

neilcampbell · 2025-06-27T02:56:12Z

crates/algokit_transact/src/transactions/key_registration.rs

+    pub non_participation: Option<bool>,
+}
+
+impl KeyRegistrationTransactionFields {


@PatrickDinh Has done up an implementation of this in his PR https://github.com/algorandfoundation/algokit-core/pull/161/files
The naming is slightly different (trait Validate with validate) and there isn't any header validation as the header type mostly prevents invalid data being set, however that can be added like you have above very easily.

Entirely written by claude

also generated by claude, not yet reviewed

Copilot

Pull Request Overview

This PR adds full support for Algorand key registration transactions across TypeScript, Python, Rust core, and FFI layers, including serialization, builder patterns, validation, and tests for online, offline, and non-participating modes.

Added TypeScript tests and JSON parsing updates for key registration.
Extended Python test data loader and examples for key registration.
Introduced FFI-safe key registration types and updated test plans.
Implemented core Rust KeyRegistrationTransactionFields, builder, validation, and polytest coverage.

Reviewed Changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/typescript/algokit_transact/tests/key_registration.test.ts	New TS tests for key registration transactions
packages/typescript/algokit_transact/tests/common.ts	Reviver update to convert numeric fields to BigInt
packages/python/algokit_transact/tests/test_key_registration.py	Python example/tests for key registration
packages/python/algokit_transact/tests/init.py	Extended test data loader for key registration
crates/algokit_transact_ffi/src/transactions/keyreg.rs	FFI struct and conversions for key registration
crates/algokit_transact_ffi/polytest.toml	Added key registration suite to test plan
crates/algokit_transact/src/transactions/key_registration.rs	Core Rust implementation and validation logic

packages/python/algokit_transact/tests/__init__.py

packages/typescript/algokit_transact/__tests__/key_registration.test.ts

- Adds validation for key registration transactions to ensure that online key registration transactions have all required participation key fields. - Introduces validation to ensure vote_first is less than vote_last. - Prevents setting the non_participation flag for online key registration transactions. - Improves error reporting for key registration validation failures.

neilcampbell · 2025-07-04T13:42:17Z

crates/algokit_transact/src/test_utils/mod.rs

@@ -156,6 +159,31 @@ impl TransactionMother {
            .receiver(AddressMother::neil())
            .to_owned()
    }
+


For asset config and app call we split these out into a seperate file. Are you able update to use the same pattern?

neilcampbell · 2025-07-04T13:44:45Z

crates/algokit_transact/src/test_utils/mod.rs

@@ -156,6 +159,31 @@ impl TransactionMother {
            .receiver(AddressMother::neil())
            .to_owned()
    }
+
+    pub fn online_key_registration() -> KeyRegistrationTransactionBuilder {
+        KeyRegistrationTransactionBuilder::default()


It'd be great to use real data from testnet if you can, that way it's easy to verify that the transaction id matches correctly. App call has an example of this and also adds a lora link comment for reference.

neilcampbell · 2025-07-04T13:48:58Z

crates/algokit_transact/src/tests.rs

@@ -410,3 +410,171 @@ fn test_signed_transaction_group_encoding() {
        assert_eq!(decoded_signed_tx, signed_grouped_tx);
    }
 }
+
+#[test]


The tests should be in transactions/key_registration.rs file. You can follow how both app call and asset config does it. Additionally some convenience functions have been extracted to help with testing the encoding, which you can take a look at asset config and app call.

neilcampbell · 2025-07-04T13:55:55Z

crates/algokit_transact/src/transactions/key_registration.rs

+
+    /// Mark account as non-reward earning.
+    #[serde(rename = "nonpart")]
+    #[serde(skip_serializing_if = "Option::is_none")]


Might be worth confirming if serialization should be skipped when value is false as well?

neilcampbell · 2025-07-04T14:00:02Z

crates/algokit_transact/src/transactions/key_registration.rs

+}
+
+impl Validate for KeyRegistrationTransactionFields {
+    fn validate(&self) -> Result<(), Vec<String>> {


Can we use the same patterns used in asset config, so that they inherit the same conventions and messaging.
Also given is_online, is_offline, is_non_participating functions exists, we should probably use those to determine how to validate.

Also asset config uses a different approach which doesn't include is_online etc. I think we should probably keep consistent.

neilcampbell · 2025-07-04T14:06:16Z

crates/algokit_transact_ffi/src/transactions/keyreg.rs

@@ -0,0 +1,89 @@
+//! FFI-safe key registration transaction types for AlgoKit Core.


Suggested change

//! FFI-safe key registration transaction types for AlgoKit Core.

//! Represents a key registration transaction.

neilcampbell · 2025-07-04T14:30:46Z

crates/algokit_transact/src/test_utils/mod.rs

+            .to_owned()
+    }
+
+    pub fn non_participating_key_registration() -> KeyRegistrationTransactionBuilder {


Should we align all terminology to non_participation? There is a few places to update.

Suggested change

pub fn non_participating_key_registration() -> KeyRegistrationTransactionBuilder {

pub fn non_participation_key_registration() -> KeyRegistrationTransactionBuilder {

neilcampbell · 2025-07-05T14:00:03Z

crates/algokit_transact/src/transactions/key_registration.rs

+}
+
+impl Validate for KeyRegistrationTransactionFields {
+    fn validate(&self) -> Result<(), Vec<String>> {


Also asset config uses a different approach which doesn't include is_online etc. I think we should probably keep consistent.

Copilot AI review requested due to automatic review settings June 18, 2025 14:11

This comment was marked as outdated.

Sign in to view

joe-p force-pushed the feat/keyreg branch from b3c6930 to e47d523 Compare June 23, 2025 16:54

joe-p commented Jun 23, 2025

View reviewed changes

PatrickDinh approved these changes Jun 27, 2025

View reviewed changes

PatrickDinh reviewed Jun 27, 2025

View reviewed changes

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

neilcampbell reviewed Jun 27, 2025

View reviewed changes

joe-p added 5 commits July 3, 2025 09:53

feat(transact): keyreg txn support

8290b6d

Entirely written by claude

test(transact): keyreg tests

40f67e3

also generated by claude, not yet reviewed

chore(transact): split out keyreg into transactions mod

7520a31

chore: rm unused import

4010e85

feat(transact): is_non_participating

3f6cd25

aorumbayev force-pushed the feat/keyreg branch from 44147a5 to 1d3948a Compare July 3, 2025 10:59

aorumbayev requested review from PatrickDinh, neilcampbell and Copilot July 3, 2025 10:59

Copilot AI reviewed Jul 3, 2025

View reviewed changes

packages/python/algokit_transact/tests/__init__.py Outdated Show resolved Hide resolved

packages/typescript/algokit_transact/__tests__/key_registration.test.ts Outdated Show resolved Hide resolved

aorumbayev force-pushed the feat/keyreg branch from 1d3948a to 2fd6516 Compare July 3, 2025 11:26

aorumbayev force-pushed the feat/keyreg branch from 2fd6516 to f1dd5c3 Compare July 3, 2025 11:35

aorumbayev mentioned this pull request Jul 4, 2025

feat(utils): Adds key registration support to utils crate #189

Open

neilcampbell reviewed Jul 4, 2025

View reviewed changes

neilcampbell reviewed Jul 5, 2025

View reviewed changes

		@@ -0,0 +1,89 @@
		//! FFI-safe key registration transaction types for AlgoKit Core.

	//! FFI-safe key registration transaction types for AlgoKit Core.
	//! Represents a key registration transaction.

	pub fn non_participating_key_registration() -> KeyRegistrationTransactionBuilder {
	pub fn non_participation_key_registration() -> KeyRegistrationTransactionBuilder {

feat(transact): keyreg txn support #163

Are you sure you want to change the base?

feat(transact): keyreg txn support #163

Conversation

joe-p commented Jun 18, 2025 • edited by aorumbayev Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO

Summary

Uh oh!

This comment was marked as outdated.

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

PatrickDinh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

neilcampbell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

joe-p commented Jun 18, 2025 •

edited by aorumbayev

Loading