Skip to content

Commit 5666070

Browse files
neilcampbellneilcampbell
authored
Merge pull request #106 from algorandfoundation/fix/id-raw-naming
fix: correct id raw naming to match encode raw convention
2 parents 8ef1434 + 9e3c3e1 commit 5666070

File tree

27 files changed

+903
-92
lines changed

27 files changed

+903
-92
lines changed

‎crates/algokit_transact/src/test_utils/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ impl AddressMother {
121121
pub struct TransactionTestData {
122122
pub transaction: Transaction,
123123
pub id: String,
124-
pub raw_id: Byte32,
124+
pub id_raw: Byte32,
125125
pub unsigned_bytes: Vec<u8>,
126126
pub signing_private_key: Byte32,
127127
pub signed_bytes: Vec<u8>,
@@ -131,7 +131,7 @@ impl TransactionTestData {
131131
pub fn new(transaction: Transaction, signing_private_key: Byte32) -> Self {
132132
let signing_key: SigningKey = SigningKey::from_bytes(&signing_private_key);
133133
let id = transaction.id().unwrap();
134-
let raw_id: [u8; HASH_BYTES_LENGTH] = transaction.raw_id().unwrap();
134+
let id_raw: [u8; HASH_BYTES_LENGTH] = transaction.id_raw().unwrap();
135135
let unsigned_bytes = transaction.encode().unwrap();
136136
let signature = signing_key.sign(&unsigned_bytes);
137137
let signed_txn = SignedTransaction {
@@ -143,7 +143,7 @@ impl TransactionTestData {
143143
Self {
144144
transaction,
145145
id,
146-
raw_id,
146+
id_raw,
147147
unsigned_bytes,
148148
signing_private_key,
149149
signed_bytes,
@@ -228,7 +228,7 @@ mod tests {
228228
String::from("TZM3P4ZL4DLIEZ3WOEP67MQ6JITTO4D3NJN3RCA5YDBC3V4LA5LA")
229229
);
230230
assert_eq!(
231-
data.raw_id,
231+
data.id_raw,
232232
[
233233
158, 89, 183, 243, 43, 224, 214, 130, 103, 118, 113, 31, 239, 178, 30, 74, 39, 55,
234234
112, 123, 106, 91, 184, 136, 29, 192, 194, 45, 215, 139, 7, 86
@@ -278,7 +278,7 @@ mod tests {
278278
String::from("JIDBHDPLBASULQZFI4EY5FJWR6VQRMPPFSGYBKE2XKW65N3UQJXA")
279279
);
280280
assert_eq!(
281-
data.raw_id,
281+
data.id_raw,
282282
[
283283
74, 6, 19, 141, 235, 8, 37, 69, 195, 37, 71, 9, 142, 149, 54, 143, 171, 8, 177,
284284
239, 44, 141, 128, 168, 154, 186, 173, 238, 183, 116, 130, 110

‎crates/algokit_transact/src/tests.rs

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -90,25 +90,11 @@ fn test_address() {
9090
}
9191

9292
#[test]
93-
fn test_pay_transaction_raw_id() {
94-
let expected_tx_id = [
93+
fn test_pay_transaction_id() {
94+
let expected_tx_id_raw = [
9595
35, 93, 0, 170, 96, 221, 1, 74, 119, 147, 131, 116, 7, 31, 225, 40, 215, 47, 44, 120, 128,
9696
245, 41, 65, 116, 255, 147, 64, 90, 80, 147, 223,
9797
];
98-
99-
let tx_builder = TransactionMother::payment_with_note();
100-
let payment_tx = tx_builder.build().unwrap();
101-
let signed_tx = SignedTransaction {
102-
transaction: payment_tx.clone(),
103-
signature: [0; ALGORAND_SIGNATURE_BYTE_LENGTH],
104-
};
105-
106-
assert_eq!(payment_tx.raw_id().unwrap(), expected_tx_id);
107-
assert_eq!(signed_tx.raw_id().unwrap(), expected_tx_id);
108-
}
109-
110-
#[test]
111-
fn test_pay_transaction_id() {
11298
let expected_tx_id = "ENOQBKTA3UAUU54TQN2AOH7BFDLS6LDYQD2SSQLU76JUAWSQSPPQ";
11399

114100
let tx_builder = TransactionMother::payment_with_note();
@@ -119,7 +105,9 @@ fn test_pay_transaction_id() {
119105
};
120106

121107
assert_eq!(payment_tx.id().unwrap(), expected_tx_id);
108+
assert_eq!(payment_tx.id_raw().unwrap(), expected_tx_id_raw);
122109
assert_eq!(signed_tx.id().unwrap(), expected_tx_id);
110+
assert_eq!(signed_tx.id_raw().unwrap(), expected_tx_id_raw);
123111
}
124112

125113
#[test]

‎crates/algokit_transact/src/traits.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ pub trait TransactionId: AlgorandMsgpack {
115115
///
116116
/// # Returns
117117
/// The transaction ID as a 32-byte array or an AlgoKitTransactError if encoding fails.
118-
fn raw_id(&self) -> Result<[u8; HASH_BYTES_LENGTH], AlgoKitTransactError> {
118+
fn id_raw(&self) -> Result<[u8; HASH_BYTES_LENGTH], AlgoKitTransactError> {
119119
let mut hasher = Sha512_256::new();
120120
hasher.update(self.encode()?);
121121

@@ -132,7 +132,7 @@ pub trait TransactionId: AlgorandMsgpack {
132132
/// # Returns
133133
/// The base32-encoded transaction ID string or an AlgoKitTransactError if ID calculation fails.
134134
fn id(&self) -> Result<String, AlgoKitTransactError> {
135-
let hash = self.raw_id()?;
135+
let hash = self.id_raw()?;
136136

137137
Ok(base32::encode(
138138
base32::Alphabet::Rfc4648 { padding: false },

‎crates/algokit_transact/src/transactions/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ impl TransactionId for SignedTransaction {
131131
///
132132
/// # Returns
133133
/// The transaction ID as a byte array or an error if generation fails.
134-
fn raw_id(&self) -> Result<[u8; HASH_BYTES_LENGTH], AlgoKitTransactError> {
135-
self.transaction.raw_id()
134+
fn id_raw(&self) -> Result<[u8; HASH_BYTES_LENGTH], AlgoKitTransactError> {
135+
self.transaction.id_raw()
136136
}
137137
}
138138

‎crates/algokit_transact_ffi/build.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ fn generate_test_data() {
1818
unsigned_bytes: Vec<u8>,
1919
signed_bytes: Vec<u8>,
2020
id: String,
21-
raw_id: [u8; HASH_BYTES_LENGTH],
21+
id_raw: [u8; HASH_BYTES_LENGTH],
2222
}
2323

2424
test_utils::TestDataMother::export(
@@ -29,7 +29,7 @@ fn generate_test_data() {
2929
unsigned_bytes: d.unsigned_bytes.clone(),
3030
signed_bytes: d.signed_bytes.clone(),
3131
id: d.id.clone(),
32-
raw_id: d.raw_id,
32+
id_raw: d.id_raw,
3333
}),
3434
);
3535
}

‎crates/algokit_transact_ffi/src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -462,10 +462,10 @@ pub fn address_from_string(address: &str) -> Result<Address, AlgoKitTransactErro
462462

463463
/// Get the raw 32-byte transaction ID for a transaction.
464464
#[ffi_func]
465-
pub fn get_transaction_raw_id(tx: &Transaction) -> Result<Vec<u8>, AlgoKitTransactError> {
465+
pub fn get_transaction_id_raw(tx: &Transaction) -> Result<Vec<u8>, AlgoKitTransactError> {
466466
let tx_internal: algokit_transact::Transaction = tx.clone().try_into()?;
467-
let raw_id = tx_internal.raw_id()?;
468-
Ok(raw_id.to_vec())
467+
let id_raw = tx_internal.id_raw()?;
468+
Ok(id_raw.to_vec())
469469
}
470470

471471
/// Get the base32 transaction ID string for a transaction.
@@ -550,9 +550,9 @@ mod tests {
550550
let tx_ffi = data.transaction.try_into().unwrap();
551551

552552
let actual_id = get_transaction_id(&tx_ffi).unwrap();
553-
let actual_raw_id = get_transaction_raw_id(&tx_ffi).unwrap();
553+
let actual_id_raw = get_transaction_id_raw(&tx_ffi).unwrap();
554554

555555
assert_eq!(actual_id, data.id);
556-
assert_eq!(actual_raw_id, data.raw_id);
556+
assert_eq!(actual_id_raw, data.id_raw);
557557
}
558558
}

‎crates/algokit_transact_ffi/test_data.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"optInAssetTransfer": {
33
"id": "JIDBHDPLBASULQZFI4EY5FJWR6VQRMPPFSGYBKE2XKW65N3UQJXA",
4-
"rawId": [
4+
"idRaw": [
55
74,
66
6,
77
19,
@@ -624,7 +624,7 @@
624624
},
625625
"simplePayment": {
626626
"id": "TZM3P4ZL4DLIEZ3WOEP67MQ6JITTO4D3NJN3RCA5YDBC3V4LA5LA",
627-
"rawId": [
627+
"idRaw": [
628628
158,
629629
89,
630630
183,

‎packages/python/algokit_transact/tests/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
class TransactionTestData:
1717
transaction: Transaction
1818
id: str
19-
raw_id: bytes
19+
id_raw: bytes
2020
unsigned_bytes: bytes
2121
signed_bytes: bytes
2222
signing_private_key: SigningKey

‎packages/python/algokit_transact/tests/test_payment.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
address_from_string,
1212
address_from_pub_key,
1313
get_transaction_id,
14-
get_transaction_raw_id,
14+
get_transaction_id_raw,
1515
)
1616
from nacl.signing import SigningKey
1717

@@ -97,4 +97,4 @@ def test_get_transaction_id():
9797
"""A transaction id can be obtained from a transaction"""
9898

9999
assert get_transaction_id(simple_payment.transaction) == simple_payment.id
100-
assert get_transaction_raw_id(simple_payment.transaction) == simple_payment.raw_id
100+
assert get_transaction_id_raw(simple_payment.transaction) == simple_payment.id_raw

‎packages/swift/AlgoKitTransact/Frameworks/algokit_transact.xcframework/Info.plist

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,19 @@
66
<array>
77
<dict>
88
<key>BinaryPath</key>
9-
<string>libalgokit_transact_ffi-catalyst.a</string>
9+
<string>libalgokit_transact_ffi.a</string>
1010
<key>HeadersPath</key>
1111
<string>Headers</string>
1212
<key>LibraryIdentifier</key>
13-
<string>ios-arm64_x86_64-maccatalyst</string>
13+
<string>ios-arm64</string>
1414
<key>LibraryPath</key>
15-
<string>libalgokit_transact_ffi-catalyst.a</string>
15+
<string>libalgokit_transact_ffi.a</string>
1616
<key>SupportedArchitectures</key>
1717
<array>
1818
<string>arm64</string>
19-
<string>x86_64</string>
2019
</array>
2120
<key>SupportedPlatform</key>
2221
<string>ios</string>
23-
<key>SupportedPlatformVariant</key>
24-
<string>maccatalyst</string>
2522
</dict>
2623
<dict>
2724
<key>BinaryPath</key>
@@ -42,19 +39,22 @@
4239
</dict>
4340
<dict>
4441
<key>BinaryPath</key>
45-
<string>libalgokit_transact_ffi.a</string>
42+
<string>libalgokit_transact_ffi-catalyst.a</string>
4643
<key>HeadersPath</key>
4744
<string>Headers</string>
4845
<key>LibraryIdentifier</key>
49-
<string>ios-arm64</string>
46+
<string>ios-arm64_x86_64-maccatalyst</string>
5047
<key>LibraryPath</key>
51-
<string>libalgokit_transact_ffi.a</string>
48+
<string>libalgokit_transact_ffi-catalyst.a</string>
5249
<key>SupportedArchitectures</key>
5350
<array>
5451
<string>arm64</string>
52+
<string>x86_64</string>
5553
</array>
5654
<key>SupportedPlatform</key>
5755
<string>ios</string>
56+
<key>SupportedPlatformVariant</key>
57+
<string>maccatalyst</string>
5858
</dict>
5959
<dict>
6060
<key>BinaryPath</key>

0 commit comments

Comments
 (0)