Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 8, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a00ec6
feat(utils): Adds key registration support
aorumbayev Jul 8, 2025
a1a6792
chore: pr feedback tweaks
neilcampbell Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions crates/algokit_utils/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ pub use testing::{
pub use transactions::{
ApplicationCallParams, ApplicationCreateParams, ApplicationDeleteParams,
ApplicationUpdateParams, AssetCreateParams, AssetDestroyParams, AssetReconfigureParams,
CommonParams, Composer, ComposerError, ComposerTxn, EmptySigner, PaymentParams, TxnSigner,
TxnSignerGetter,
CommonParams, Composer, ComposerError, ComposerTxn, EmptySigner,
NonParticipationKeyRegistrationParams, OfflineKeyRegistrationParams,
OnlineKeyRegistrationParams, PaymentParams, TxnSigner, TxnSignerGetter,
};
219 changes: 84 additions & 135 deletions crates/algokit_utils/src/transactions/composer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,25 @@ use algod_client::{
models::{PendingTransactionResponse, TransactionParams},
};
use algokit_transact::{
Address, AlgorandMsgpack, AssetConfigTransactionFields, FeeParams, OnApplicationComplete,
PaymentTransactionFields, SignedTransaction, Transaction, TransactionHeader, Transactions,
Address, AlgorandMsgpack, AssetConfigTransactionFields, FeeParams,
KeyRegistrationTransactionFields, OnApplicationComplete, PaymentTransactionFields,
SignedTransaction, Transaction, TransactionHeader, Transactions,
};
use derive_more::Debug;
use std::sync::Arc;

use crate::genesis_id_is_localnet;

use super::application_call::{
ApplicationCallParams, ApplicationCreateParams, ApplicationDeleteParams,
ApplicationUpdateParams,
};
use super::asset_config::{AssetCreateParams, AssetDestroyParams, AssetReconfigureParams};
use super::common::{CommonParams, DefaultSignerGetter, TxnSigner, TxnSignerGetter};
use crate::clients::network_client::genesis_id_is_localnet;
use super::key_registration::{
NonParticipationKeyRegistrationParams, OfflineKeyRegistrationParams,
OnlineKeyRegistrationParams,
};

#[derive(Debug, thiserror::Error)]
pub enum ComposerError {
Expand Down Expand Up @@ -102,6 +108,9 @@ pub enum ComposerTxn {
ApplicationCreate(ApplicationCreateParams),
ApplicationUpdate(ApplicationUpdateParams),
ApplicationDelete(ApplicationDeleteParams),
OnlineKeyRegistration(OnlineKeyRegistrationParams),
OfflineKeyRegistration(OfflineKeyRegistrationParams),
NonParticipationKeyRegistration(NonParticipationKeyRegistrationParams),
}

impl ComposerTxn {
Expand Down Expand Up @@ -139,6 +148,15 @@ impl ComposerTxn {
ComposerTxn::ApplicationDelete(app_delete_params) => {
app_delete_params.common_params.clone()
}
ComposerTxn::OnlineKeyRegistration(online_key_reg_params) => {
online_key_reg_params.common_params.clone()
}
ComposerTxn::OfflineKeyRegistration(offline_key_reg_params) => {
offline_key_reg_params.common_params.clone()
}
ComposerTxn::NonParticipationKeyRegistration(non_participation_params) => {
non_participation_params.common_params.clone()
}
_ => CommonParams::default(),
}
}
Expand Down Expand Up @@ -168,6 +186,10 @@ impl Composer {
self.built_group.as_ref()
}

pub fn signed_group(&self) -> Option<&Vec<SignedTransaction>> {
self.signed_group.as_ref()
}

#[cfg(feature = "default_http_client")]
pub fn testnet() -> Self {
Composer {
Expand Down Expand Up @@ -240,6 +262,29 @@ impl Composer {
self.push(ComposerTxn::AssetDestroy(asset_destroy_params))
}

pub fn add_online_key_registration(
&mut self,
online_key_reg_params: OnlineKeyRegistrationParams,
) -> Result<(), String> {
self.push(ComposerTxn::OnlineKeyRegistration(online_key_reg_params))
}

pub fn add_offline_key_registration(
&mut self,
offline_key_reg_params: OfflineKeyRegistrationParams,
) -> Result<(), String> {
self.push(ComposerTxn::OfflineKeyRegistration(offline_key_reg_params))
}

pub fn add_non_participation_key_registration(
&mut self,
non_participation_params: NonParticipationKeyRegistrationParams,
) -> Result<(), String> {
self.push(ComposerTxn::NonParticipationKeyRegistration(
non_participation_params,
))
}

pub fn add_application_call(
&mut self,
app_call_params: ApplicationCallParams,
Expand Down Expand Up @@ -519,6 +564,42 @@ impl Composer {
},
)
}
ComposerTxn::OnlineKeyRegistration(online_key_reg_params) => {
Transaction::KeyRegistration(KeyRegistrationTransactionFields {
header,
vote_key: Some(online_key_reg_params.vote_key),
selection_key: Some(online_key_reg_params.selection_key),
vote_first: Some(online_key_reg_params.vote_first),
vote_last: Some(online_key_reg_params.vote_last),
vote_key_dilution: Some(online_key_reg_params.vote_key_dilution),
state_proof_key: online_key_reg_params.state_proof_key,
non_participation: None,
})
}
ComposerTxn::OfflineKeyRegistration(offline_key_reg_params) => {
Transaction::KeyRegistration(KeyRegistrationTransactionFields {
header,
vote_key: None,
selection_key: None,
vote_first: None,
vote_last: None,
vote_key_dilution: None,
state_proof_key: None,
non_participation: offline_key_reg_params.non_participation,
})
}
ComposerTxn::NonParticipationKeyRegistration(_) => {
Transaction::KeyRegistration(KeyRegistrationTransactionFields {
header,
vote_key: None,
selection_key: None,
vote_first: None,
vote_last: None,
vote_key_dilution: None,
state_proof_key: None,
non_participation: Some(true),
})
}
};

if calculate_fee {
Expand Down Expand Up @@ -744,138 +825,6 @@ mod tests {
assert!(composer.add_payment(payment_params).is_ok());
}

#[tokio::test]
async fn test_build_payment() {
let mut composer = Composer::testnet();
let payment_params = PaymentParams {
common_params: CommonParams {
sender: AddressMother::address(),
signer: None,
rekey_to: None,
note: None,
lease: None,
static_fee: None,
extra_fee: None,
max_fee: None,
validity_window: None,
first_valid_round: None,
last_valid_round: None,
},
receiver: AddressMother::address(),
amount: 1000,
close_remainder_to: None,
};
composer.add_payment(payment_params).unwrap();

let result = composer.build().await;
assert!(result.is_ok());

let built_group = composer.built_group().unwrap();
assert_eq!(built_group.len(), 1);
}

#[tokio::test]
async fn test_build_asset_transfer() {
let mut composer = Composer::testnet();
let asset_transfer_params = AssetTransferParams {
common_params: CommonParams {
sender: AddressMother::address(),
signer: None,
rekey_to: None,
note: None,
lease: None,
static_fee: None,
extra_fee: None,
max_fee: None,
validity_window: None,
first_valid_round: None,
last_valid_round: None,
},
asset_id: 12345,
amount: 1000,
receiver: AddressMother::address(),
};
assert!(composer.add_asset_transfer(asset_transfer_params).is_ok());
assert!(composer.build().await.is_ok());
assert!(composer.built_group().is_some());
}

#[tokio::test]
async fn test_build_asset_opt_in() {
let mut composer = Composer::testnet();
let asset_opt_in_params = AssetOptInParams {
common_params: CommonParams {
sender: AddressMother::address(),
signer: None,
rekey_to: None,
note: None,
lease: None,
static_fee: None,
extra_fee: None,
max_fee: None,
validity_window: None,
first_valid_round: None,
last_valid_round: None,
},
asset_id: 12345,
};
assert!(composer.add_asset_opt_in(asset_opt_in_params).is_ok());
assert!(composer.build().await.is_ok());
assert!(composer.built_group().is_some());
}

#[tokio::test]
async fn test_build_asset_opt_out() {
let mut composer = Composer::testnet();
let asset_opt_out_params = AssetOptOutParams {
common_params: CommonParams {
sender: AddressMother::address(),
signer: None,
rekey_to: None,
note: None,
lease: None,
static_fee: None,
extra_fee: None,
max_fee: None,
validity_window: None,
first_valid_round: None,
last_valid_round: None,
},
asset_id: 12345,
close_remainder_to: Some(AddressMother::neil()),
};
assert!(composer.add_asset_opt_out(asset_opt_out_params).is_ok());
assert!(composer.build().await.is_ok());
assert!(composer.built_group().is_some());
}

#[tokio::test]
async fn test_build_asset_clawback() {
let mut composer = Composer::testnet();
let asset_clawback_params = AssetClawbackParams {
common_params: CommonParams {
sender: AddressMother::address(),
signer: None,
rekey_to: None,
note: None,
lease: None,
static_fee: None,
extra_fee: None,
max_fee: None,
validity_window: None,
first_valid_round: None,
last_valid_round: None,
},
asset_id: 12345,
amount: 1000,
receiver: AddressMother::address(),
clawback_target: AddressMother::neil(),
};
assert!(composer.add_asset_clawback(asset_clawback_params).is_ok());
assert!(composer.build().await.is_ok());
assert!(composer.built_group().is_some());
}

#[tokio::test]
async fn test_gather_signatures() {
let mut composer = Composer::new(AlgodClient::testnet(), Some(Arc::new(EmptySigner {})));
Expand Down
23 changes: 23 additions & 0 deletions crates/algokit_utils/src/transactions/key_registration.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
use super::common::CommonParams;

#[derive(Debug, Clone)]
pub struct OnlineKeyRegistrationParams {
pub common_params: CommonParams,
pub vote_key: [u8; 32],
pub selection_key: [u8; 32],
pub vote_first: u64,
pub vote_last: u64,
pub vote_key_dilution: u64,
pub state_proof_key: Option<[u8; 64]>,
}

#[derive(Debug, Clone)]
pub struct OfflineKeyRegistrationParams {
pub common_params: CommonParams,
pub non_participation: Option<bool>,
}

#[derive(Debug, Clone)]
pub struct NonParticipationKeyRegistrationParams {
pub common_params: CommonParams,
}
5 changes: 5 additions & 0 deletions crates/algokit_utils/src/transactions/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ pub mod application_call;
pub mod asset_config;
pub mod common;
pub mod composer;
pub mod key_registration;

// Re-export commonly used transaction types
pub use application_call::{
Expand All @@ -11,3 +12,7 @@ pub use application_call::{
pub use asset_config::{AssetCreateParams, AssetDestroyParams, AssetReconfigureParams};
pub use common::{CommonParams, DefaultSignerGetter, EmptySigner, TxnSigner, TxnSignerGetter};
pub use composer::{Composer, ComposerError, ComposerTxn, PaymentParams};
pub use key_registration::{
NonParticipationKeyRegistrationParams, OfflineKeyRegistrationParams,
OnlineKeyRegistrationParams,
};
Loading