Sending ABI methods with composer #221

PatrickDinh · 2025-08-04T01:37:24Z

Fixes #

Proposed Changes

- revert some naming (still not completed) - review function logic

PatrickDinh · 2025-08-07T11:13:37Z

crates/algokit_utils/src/transactions/asset_config.rs

@@ -152,3 +152,60 @@ pub struct AssetDestroyParams {
    /// ID of the existing asset to be destroyed.
    pub asset_id: u64,
 }
+
+pub fn build_asset_create(params: &AssetCreateParams, header: TransactionHeader) -> Transaction {


these methods were refactored out of composer.rs

Copilot

Pull Request Overview

This PR implements the ability to send ABI methods using the composer, introducing comprehensive support for application method calls alongside existing raw transaction functionality.

Adds new ApplicationMethodCallParams and related parameter structures for ABI method calls
Implements ABI method argument handling including payments, application calls, transactions, and references
Extends the composer with add_application_method_call functionality to complement existing raw transaction methods

Reviewed Changes

Copilot reviewed 20 out of 21 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
inner_fee_coverage.rs	Refactors test file to use new `ApplicationRawCallParams` instead of deprecated `ApplicationCallParams`
asset_transfer.rs	Minor import reorganization moving asset-related imports to main utils module
application_call.rs	Major addition of comprehensive ABI method call tests and new parameter structures
contract.py	Adds new sandbox contract with various ABI methods for testing complex scenarios
Sandbox.arc56.json	Contract specification file defining the sandbox contract's ABI interface
payment.rs	Adds utility functions `build_payment` and `build_account_close` for transaction construction
mod.rs	Updates module exports to include new transaction parameter types and removes deprecated ones
key_registration.rs	Adds builder functions for different types of key registration transactions

Copilot · 2025-08-07T11:34:50Z

crates/algokit_utils/src/transactions/payment.rs

@@ -26,3 +26,22 @@ pub struct AccountCloseParams {
    /// The address to receive the remaining funds.
    pub close_remainder_to: Address,
 }
+


The new build_payment function lacks documentation. Add a doc comment explaining its purpose, parameters, and return value.

Suggested change

/// Builds a payment transaction that sends ALGO from the sender to the specified receiver.

///

/// # Parameters

/// - `params`: The parameters specifying the receiver and amount to send.

/// - `header`: The transaction header, including sender and other common fields.

///

/// # Returns

/// A `Transaction` representing the payment transaction.

Copilot · 2025-08-07T11:34:50Z

crates/algokit_utils/src/transactions/payment.rs

+        close_remainder_to: None,
+    })
+}
+


The new build_account_close function lacks documentation. Add a doc comment explaining its purpose, parameters, and return value.

Suggested change

/// Builds a payment transaction that closes an account by transferring all remaining funds

/// to the specified `close_remainder_to` address.

///

/// # Parameters

/// - `params`: The parameters specifying the recipient of the remaining funds.

/// - `header`: The transaction header, including the sender's address.

///

/// # Returns

/// A `Transaction` representing the account close operation.

Copilot · 2025-08-07T11:34:50Z

crates/algokit_utils/src/transactions/key_registration.rs

@@ -21,3 +23,51 @@ pub struct OfflineKeyRegistrationParams {
 pub struct NonParticipationKeyRegistrationParams {
    pub common_params: CommonParams,
 }
+


The new build_online_key_registration function lacks documentation. Add a doc comment explaining its purpose, parameters, and return value.

Suggested change

/// Builds an online key registration transaction.

///

/// # Parameters

/// - `params`: Reference to [`OnlineKeyRegistrationParams`] containing the key registration details,

/// such as vote key, selection key, voting period, key dilution, and optional state proof key.

/// - `header`: The [`TransactionHeader`] to use for the transaction.

///

/// # Returns

/// A [`Transaction`] representing an online key registration with the provided parameters.

Copilot · 2025-08-07T11:34:51Z

crates/algokit_utils/src/transactions/key_registration.rs

+        non_participation: None,
+    })
+}
+


The new build_offline_key_registration function lacks documentation. Add a doc comment explaining its purpose, parameters, and return value.

Suggested change

/// Builds an offline key registration transaction.

///

/// # Parameters

/// - `params`: The parameters for the offline key registration, including common transaction fields and optional non-participation flag.

/// - `header`: The transaction header containing metadata such as sender, fee, and validity period.

///

/// # Returns

/// A `Transaction` representing the offline key registration.

Copilot · 2025-08-07T11:34:51Z

crates/algokit_utils/src/transactions/key_registration.rs

+        non_participation: params.non_participation,
+    })
+}
+


The new build_non_participation_key_registration function lacks documentation. Add a doc comment explaining its purpose, parameters, and return value.

Suggested change

/// Builds a key registration transaction that marks the account as non-participating.

///

/// # Parameters

/// - `_params`: Reference to `NonParticipationKeyRegistrationParams` containing common transaction parameters.

/// - `header`: The transaction header to use for the transaction.

///

/// # Returns

/// A `Transaction` representing a non-participation key registration.

aorumbayev · 2025-08-07T11:49:02Z

crates/algokit_utils/src/transactions/asset_config.rs

+    })
+}
+
+pub fn build_asset_reconfigure(


was there a reason we initially defined this as reconfigure instead of configure? We don't have term reconfigure on utils py or ts

for the utils layer, we wanted to add some abstraction on top of asset configure, therefore, we have build_asset_create, build_asset_reconfigure, and build_asset_destroy. The different is small, for example, the create method doesn't need asset ID because it's always 0.

In utils-ts/py we call it asset_config. Based on the previous decision to align to utils-ts/py naming wherever possible, we should rename this as part of the stabilisation.

crates/algokit_utils/src/transactions/composer.rs

crates/algokit_utils/src/transactions/application_call.rs

crates/algokit_utils/src/transactions/composer.rs

crates/algokit_abi/src/arc56_contract.rs

neilcampbell · 2025-08-08T04:42:51Z

crates/algokit_utils/src/transactions/application_call.rs

+}
+
+#[derive(Debug, Clone)]
+pub enum ProcessedApplicationMethodCallArg {


thought: When we add default value support, I wonder if we'd be able to process the resolution of the default value at add time? Probably the main thing to the consider is that you can use a readonly ABI method call as a default value, so it'd mean a simulate call when performing a transaction add.

that's something need to keep in mind. We might need to think it through a bit because that means the add will become an async method.

Yep we'd need to colour those functions. Good reason not to do it there.
Another optimisation we can apply when processing at build, is sending a single simulate for all default method args in the group.

crates/algokit_utils/src/transactions/application_call.rs

crates/algokit_utils/src/transactions/asset_transfer.rs

crates/algokit_utils/src/transactions/composer.rs

neilcampbell · 2025-08-08T13:20:50Z

crates/algokit_utils/src/transactions/application_call.rs

+    abi_values: &[ABIValue],
+) -> Result<Vec<Vec<u8>>, ComposerError> {
+    // Encode first 13 arguments individually
+    let the_first_abi_types = &abi_types[..ARGS_TUPLE_PACKING_THRESHOLD];


Suggested change

let the_first_abi_types = &abi_types[..ARGS_TUPLE_PACKING_THRESHOLD];

let the_first_13_abi_types = &abi_types[..ARGS_TUPLE_PACKING_THRESHOLD];

To match name of values.

neilcampbell · 2025-08-08T13:33:11Z

crates/algokit_utils/src/transactions/composer.rs

+        method: &ABIMethod,
+    ) -> Option<Result<ABIReturn, ComposerError>> {
+        // Check if method has return type
+        method.returns.as_ref()?;


Suggested change

method.returns.as_ref()?;

let return_type = method.returns.as_ref()?;

Then you can remove the let return_type = method.returns.as_ref().unwrap(); // Safe unwrap since we checked above later on. Without the assignment, the code threw me a little.

neilcampbell · 2025-08-08T13:33:26Z

crates/algokit_utils/src/transactions/composer.rs

+
+        // Extract the return value bytes (skip the prefix)
+        let return_bytes = &last_log[ABI_RETURN_PREFIX.len()..];
+        let return_type = method.returns.as_ref().unwrap(); // Safe unwrap since we checked above


Suggested change

let return_type = method.returns.as_ref().unwrap(); // Safe unwrap since we checked above

aorumbayev and others added 30 commits July 25, 2025 12:03

chore: wip

10f29b7

chore: wip

683b039

wip - refactor:

c76b78f

- revert some naming (still not completed) - review function logic

refactor: naming

60362ee

wip: remove temp struct

0d33cc3

wip - refactor - move app call

8c0da6a

refactor - standardise names

a88d43b

refactor - rename composer add_x methods

e1a1016

fix logic for populate_foreign_arrays

25e9679

small refactor

0903d26

wip - nested method call

ae3a952

refactor

55e711f

mooore refactor

d84d66b

huge refactor, move builder methods out of composer

98ae116

fix method call args + encode

f635a41

wip - simple test

0a57b7f

wip - decode return value

e9a8418

test verify return value

cdf5e7b

wip - simple app factory

9ac1dd9

wip - tests

e08c284

tests pass with the app deployed from app spec file

de65e38

introduce ARC56Contract type for life quality

2db5c64

test add method

8e555a4

review and delete api_application_call

3255bc4

clean up

f664ead

more tests

0491a6d

more test

2d1c4fb

wip - fix and test txn arg in method call

461d924

fix logic for nested method call

621dd5e

test nested txns

4456c1a

PatrickDinh added 3 commits August 7, 2025 16:15

docs and fix

bec43c0

rename

1d8182f

remove claude.md

7fbd881

PatrickDinh commented Aug 7, 2025

View reviewed changes

PatrickDinh marked this pull request as ready for review August 7, 2025 11:33

Copilot AI review requested due to automatic review settings August 7, 2025 11:33

review

d6da98e

Copilot AI reviewed Aug 7, 2025

View reviewed changes

PatrickDinh changed the title ~~DRAFT - sending ABI methods with composer~~ Sending ABI methods with composer Aug 7, 2025

aorumbayev reviewed Aug 7, 2025

View reviewed changes

crates/algokit_utils/src/transactions/application_call.rs Outdated Show resolved Hide resolved

aorumbayev reviewed Aug 7, 2025

View reviewed changes

crates/algokit_utils/src/transactions/composer.rs Outdated Show resolved Hide resolved

PatrickDinh added 5 commits August 8, 2025 09:42

Merge tag 'python/algokit_transact@1.0.0-alpha.38' into feat/app-client

0753228

rename add_raw_call methods to follow convention

1263065

rename

ca3d6aa

refactor to avoid clone

d269bd8

small refactor

c14f443

neilcampbell reviewed Aug 8, 2025

View reviewed changes

PatrickDinh added 2 commits August 8, 2025 14:21

wip - review

2cff425

big rename

2b61c2f

neilcampbell reviewed Aug 8, 2025

View reviewed changes

chore: remove BuildTransactionResult abstraction

07b09a8

neilcampbell reviewed Aug 8, 2025

View reviewed changes

crates/algokit_utils/src/transactions/composer.rs Outdated Show resolved Hide resolved

PatrickDinh added 3 commits August 8, 2025 21:25

wip PR feedback

d1cfd3b

PR feedback

b2e9c76

PR feedback: fix the type for ABIReturn

bc75675

neilcampbell reviewed Aug 8, 2025

View reviewed changes

joe-p self-requested a review August 8, 2025 18:24

+/// Builds a payment transaction that sends ALGO from the sender to the specified receiver.
+///
+/// # Parameters
+/// - `params`: The parameters specifying the receiver and amount to send.
+/// - `header`: The transaction header, including sender and other common fields.
+///
+/// # Returns
+/// A `Transaction` representing the payment transaction.

+/// Builds a payment transaction that closes an account by transferring all remaining funds
+/// to the specified `close_remainder_to` address.
+///
+/// # Parameters
+/// - `params`: The parameters specifying the recipient of the remaining funds.
+/// - `header`: The transaction header, including the sender's address.
+///
+/// # Returns
+/// A `Transaction` representing the account close operation.

+/// Builds an online key registration transaction.
+///
+/// # Parameters
+/// - `params`: Reference to [`OnlineKeyRegistrationParams`] containing the key registration details,
+///   such as vote key, selection key, voting period, key dilution, and optional state proof key.
+/// - `header`: The [`TransactionHeader`] to use for the transaction.
+///
+/// # Returns
+/// A [`Transaction`] representing an online key registration with the provided parameters.

+/// Builds an offline key registration transaction.
+///
+/// # Parameters
+/// - `params`: The parameters for the offline key registration, including common transaction fields and optional non-participation flag.
+/// - `header`: The transaction header containing metadata such as sender, fee, and validity period.
+///
+/// # Returns
+/// A `Transaction` representing the offline key registration.

+/// Builds a key registration transaction that marks the account as non-participating.
+///
+/// # Parameters
+/// - `_params`: Reference to `NonParticipationKeyRegistrationParams` containing common transaction parameters.
+/// - `header`: The transaction header to use for the transaction.
+///
+/// # Returns
+/// A `Transaction` representing a non-participation key registration.

	let the_first_abi_types = &abi_types[..ARGS_TUPLE_PACKING_THRESHOLD];
	let the_first_13_abi_types = &abi_types[..ARGS_TUPLE_PACKING_THRESHOLD];

	method.returns.as_ref()?;
	let return_type = method.returns.as_ref()?;

Sending ABI methods with composer #221

Are you sure you want to change the base?

Sending ABI methods with composer #221

Conversation

PatrickDinh commented Aug 4, 2025

Proposed Changes

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!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neilcampbell Aug 8, 2025 • 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neilcampbell Aug 8, 2025 • 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!

Uh oh!

neilcampbell Aug 8, 2025 •

edited

Loading

neilcampbell Aug 8, 2025 •

edited

Loading