1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
//! Base transactions.
pub mod export;
pub mod fx;
pub mod import;
pub mod vertex;
use crate::{codec, errors::Result, hash, ids, key, txs};
use serde::{Deserialize, Serialize};
/// Base transaction.
///
/// The VM flow checker adds "fee_amount" and "output" amounts to the "produced",
/// and "input" amounts to the "consumed". The check fails with "errInsufficientFunds",
/// if the "produced" amount ("fee" + "outputs") is greater than the "consumed" ("inputs").
///
/// ref. <https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/avm#Tx>
/// ref. <https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/avm#BaseTx>
/// ref. <https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/avm#UnsignedTx>
/// ref. <https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#FlowChecker>
#[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Clone, Default)]
pub struct Tx {
/// The transaction ID is empty for unsigned tx
/// as long as "avax.BaseTx.Metadata" is "None".
/// Once Metadata is updated with signing and "Tx.Initialize",
/// Tx.ID() is non-empty.
pub base_tx: txs::Tx,
pub fx_creds: Vec<fx::Credential>,
}
impl Tx {
pub fn new(base_tx: txs::Tx) -> Self {
Self {
base_tx,
..Self::default()
}
}
/// Returns the transaction ID.
/// Only non-empty if the embedded metadata is updated
/// with the signing process.
pub fn tx_id(&self) -> ids::Id {
if self.base_tx.metadata.is_some() {
let m = self.base_tx.metadata.clone().unwrap();
m.id
} else {
ids::Id::default()
}
}
pub fn type_name() -> String {
"avm.BaseTx".to_string()
}
pub fn type_id() -> u32 {
*(codec::X_TYPES.get(&Self::type_name()).unwrap()) as u32
}
/// ref. <https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/avm/txs#Tx.SignSECP256K1Fx>
/// ref. <https://pkg.go.dev/github.com/ava-labs/avalanchego/utils/crypto#PrivateKeyED25519.SignHash>
pub async fn sign<T: key::secp256k1::SignOnly>(&mut self, signers: Vec<Vec<T>>) -> Result<()> {
// marshal "unsigned tx" with the codec version
let type_id = Self::type_id();
let packer = self.base_tx.pack(codec::VERSION, type_id)?;
// "avalanchego" marshals the whole struct again for signed bytes
// even when the underlying "unsigned_tx" is already once marshaled
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/avm/txs#Tx.SignSECP256K1Fx
//
// reuse the underlying packer to avoid marshaling the unsigned tx twice
// just marshal the next fields in the struct and pack them all together
// in the existing packer
let tx_bytes_with_no_signature = packer.take_bytes();
packer.set_bytes(&tx_bytes_with_no_signature);
// compute sha256 for marshaled "unsigned tx" bytes
// IMPORTANT: take the hash only for the type "avm.Tx" unsigned tx
// not other fields -- only hash "avm.Tx.UnsignedTx" but not "avm.Tx.Creds"
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/avm#Tx
let tx_bytes_hash = hash::sha256(&tx_bytes_with_no_signature);
// number of of credentials
let fx_creds_len = signers.len() as u32;
// pack the second field in the struct
packer.pack_u32(fx_creds_len)?;
// sign the hash with the signers (in case of multi-sig)
// and combine all signatures into a secp256k1fx credential
self.fx_creds = Vec::new();
for keys in signers.iter() {
let mut sigs: Vec<Vec<u8>> = Vec::new();
for k in keys.iter() {
let sig = k.sign_digest(&tx_bytes_hash).await?;
sigs.push(Vec::from(sig));
}
let cred = key::secp256k1::txs::Credential { signatures: sigs };
let fx_cred = fx::Credential {
cred,
..Default::default()
};
// add a new credential to "Tx"
self.fx_creds.push(fx_cred);
}
if fx_creds_len > 0 {
// pack each "fx_cred" which is "secp256k1fx.Credential"
// marshal type ID for "secp256k1fx.Credential"
let cred_type_id = key::secp256k1::txs::Credential::type_id();
for fx_cred in self.fx_creds.iter() {
packer.pack_u32(cred_type_id)?;
packer.pack_u32(fx_cred.cred.signatures.len() as u32)?;
for sig in fx_cred.cred.signatures.iter() {
packer.pack_bytes(sig)?;
}
}
}
let tx_bytes_with_signatures = packer.take_bytes();
let tx_id = hash::sha256(&tx_bytes_with_signatures);
// update "BaseTx.Metadata" with id/unsigned bytes/bytes
// ref. "avalanchego/vms/avm.Tx.SignSECP256K1Fx"
// ref. "avalanchego/vms/components/avax.BaseTx.Metadata.Initialize"
self.base_tx.metadata = Some(txs::Metadata {
id: ids::Id::from_slice(&tx_id),
tx_bytes_with_no_signature: tx_bytes_with_no_signature.to_vec(),
tx_bytes_with_signatures: tx_bytes_with_signatures.to_vec(),
});
Ok(())
}
}
/// RUST_LOG=debug cargo test --package avalanche-types --lib -- avm::txs::test_tx_serialization_with_two_signers --exact --show-output
/// ref. "avalanchego/vms/avm.TestBaseTxSerialization"
#[test]
fn test_tx_serialization_with_two_signers() {
use crate::ids::short;
macro_rules! ab {
($e:expr) => {
tokio_test::block_on($e)
};
}
// ref. "avalanchego/vms/avm/vm_test.go"
let test_key = key::secp256k1::private_key::Key::from_cb58(
"PrivateKey-24jUJ9vZexUM6expyMcT48LBx27k1m7xpraoV62oSQAHdziao5",
)
.expect("failed to load private key");
let test_key_short_addr = test_key
.to_public_key()
.to_short_bytes()
.expect("failed short_address_bytes");
let test_key_short_addr = short::Id::from_slice(&test_key_short_addr);
let unsigned_tx = txs::Tx {
network_id: 10,
blockchain_id: ids::Id::from_slice(&<Vec<u8>>::from([5, 4, 3, 2, 1])),
transferable_outputs: Some(vec![txs::transferable::Output {
asset_id: ids::Id::from_slice(&<Vec<u8>>::from([1, 2, 3])),
transfer_output: Some(key::secp256k1::txs::transfer::Output {
amount: 12345,
output_owners: key::secp256k1::txs::OutputOwners {
locktime: 0,
threshold: 1,
addresses: vec![test_key_short_addr.clone()],
},
}),
..txs::transferable::Output::default()
}]),
transferable_inputs: Some(vec![txs::transferable::Input {
utxo_id: txs::utxo::Id {
tx_id: ids::Id::from_slice(&<Vec<u8>>::from([
0xff, 0xfe, 0xfd, 0xfc, 0xfb, 0xfa, 0xf9, 0xf8, //
0xf7, 0xf6, 0xf5, 0xf4, 0xf3, 0xf2, 0xf1, 0xf0, //
0xef, 0xee, 0xed, 0xec, 0xeb, 0xea, 0xe9, 0xe8, //
0xe7, 0xe6, 0xe5, 0xe4, 0xe3, 0xe2, 0xe1, 0xe0, //
])),
output_index: 1,
symbol: false,
id: ids::Id::empty(),
},
asset_id: ids::Id::from_slice(&<Vec<u8>>::from([1, 2, 3])),
transfer_input: Some(key::secp256k1::txs::transfer::Input {
amount: 54321,
sig_indices: vec![2],
}),
..txs::transferable::Input::default()
}]),
memo: Some(vec![0x00, 0x01, 0x02, 0x03]),
..txs::Tx::default()
};
let keys1: Vec<key::secp256k1::private_key::Key> = vec![test_key.clone(), test_key.clone()];
let keys2: Vec<key::secp256k1::private_key::Key> = vec![test_key.clone(), test_key.clone()];
let signers: Vec<Vec<key::secp256k1::private_key::Key>> = vec![keys1, keys2];
let mut tx_with_two_signers = Tx::new(unsigned_tx);
ab!(tx_with_two_signers.sign(signers)).expect("failed to sign");
let tx_with_two_signers_metadata = tx_with_two_signers.base_tx.metadata.clone().unwrap();
let tx_bytes_with_signatures = tx_with_two_signers_metadata.tx_bytes_with_signatures;
assert_eq!(
tx_with_two_signers.tx_id().to_string(),
"QnTUuie2qe6BKyYrC2jqd73bJ828QNhYnZbdA2HWsnVRPjBfV"
);
let expected_signed_bytes: &[u8] = &[
// codec version
0x00, 0x00, //
//
// avm.BaseTx type ID
0x00, 0x00, 0x00, 0x00, //
//
// network id
0x00, 0x00, 0x00, 0x0a, //
//
// blockchain id
0x05, 0x04, 0x03, 0x02, 0x01, 0x00, 0x00, 0x00, //
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
//
// outs.len()
0x00, 0x00, 0x00, 0x01, //
//
// "outs[0]" TransferableOutput.asset_id
0x01, 0x02, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, //
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
//
// NOTE: fx_id is serialize:"false"
//
// "outs[0]" secp256k1fx.TransferOutput type ID
0x00, 0x00, 0x00, 0x07, //
//
// "outs[0]" TransferableOutput.out.key::secp256k1::txs::transfer::Output.amount
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x30, 0x39, //
//
// "outs[0]" TransferableOutput.out.key::secp256k1::txs::transfer::Output.output_owners.locktime
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
//
// "outs[0]" TransferableOutput.out.key::secp256k1::txs::transfer::Output.output_owners.threshold
0x00, 0x00, 0x00, 0x01, //
//
// "outs[0]" TransferableOutput.out.key::secp256k1::txs::transfer::Output.output_owners.addrs.len()
0x00, 0x00, 0x00, 0x01, //
//
// "outs[0]" TransferableOutput.out.key::secp256k1::txs::transfer::Output.output_owners.addrs[0]
0xfc, 0xed, 0xa8, 0xf9, 0x0f, 0xcb, 0x5d, 0x30, //
0x61, 0x4b, 0x99, 0xd7, 0x9f, 0xc4, 0xba, 0xa2, //
0x93, 0x07, 0x76, 0x26, //
//
// ins.len()
0x00, 0x00, 0x00, 0x01, //
//
// "ins[0]" TransferableInput.utxo_id.tx_id
0xff, 0xfe, 0xfd, 0xfc, 0xfb, 0xfa, 0xf9, 0xf8, //
0xf7, 0xf6, 0xf5, 0xf4, 0xf3, 0xf2, 0xf1, 0xf0, //
0xef, 0xee, 0xed, 0xec, 0xeb, 0xea, 0xe9, 0xe8, //
0xe7, 0xe6, 0xe5, 0xe4, 0xe3, 0xe2, 0xe1, 0xe0, //
//
// "ins[0]" TransferableInput.utxo_id.output_index
0x00, 0x00, 0x00, 0x01, //
//
// "ins[0]" TransferableInput.asset_id
0x01, 0x02, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, //
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, //
//
// "ins[0]" secp256k1fx.TransferInput type ID
0x00, 0x00, 0x00, 0x05, //
//
// "ins[0]" TransferableInput.input.key::secp256k1::txs::transfer::Input.amount
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xd4, 0x31, //
//
// "ins[0]" TransferableInput.input.key::secp256k1::txs::transfer::Input.sig_indices.len()
0x00, 0x00, 0x00, 0x01, //
//
// "ins[0]" TransferableInput.input.key::secp256k1::txs::transfer::Input.sig_indices[0]
0x00, 0x00, 0x00, 0x02, //
//
// memo.len()
0x00, 0x00, 0x00, 0x04, //
//
// memo
0x00, 0x01, 0x02, 0x03, //
//
// number of of credentials (avax.Tx.fx_creds.len())
0x00, 0x00, 0x00, 0x02, //
//
//
// NOTE: fx_id is serialize:"false"
//
// struct field type ID "fx::Credential.cred"
// "secp256k1fx.Credential" type ID
0x00, 0x00, 0x00, 0x09, //
//
// number of signers ("fx::Credential.cred.sigs.len()")
0x00, 0x00, 0x00, 0x02, //
//
// first 65-byte signature
0x7d, 0x89, 0x8e, 0xe9, 0x8a, 0xf8, 0x33, 0x5d, 0x37, 0xe6, //
0xfa, 0xda, 0x0c, 0xbb, 0x44, 0xa1, 0x44, 0x05, 0xd3, 0xbb, //
0x94, 0x0d, 0xfc, 0x0d, 0x99, 0xa6, 0xd3, 0xff, 0x5c, 0x71, //
0x5a, 0xff, 0x26, 0xd1, 0x84, 0x84, 0xf2, 0x9b, 0x28, 0x96, //
0x44, 0x96, 0x8f, 0xed, 0xff, 0xeb, 0x23, 0xe0, 0x30, 0x66, //
0x5d, 0x73, 0x6d, 0x94, 0xfc, 0x80, 0xbc, 0x73, 0x5f, 0x51, //
0xc8, 0x06, 0xd7, 0x43, 0x00, //
//
// second 65-byte signature
0x7d, 0x89, 0x8e, 0xe9, 0x8a, 0xf8, 0x33, 0x5d, 0x37, 0xe6, //
0xfa, 0xda, 0x0c, 0xbb, 0x44, 0xa1, 0x44, 0x05, 0xd3, 0xbb, //
0x94, 0x0d, 0xfc, 0x0d, 0x99, 0xa6, 0xd3, 0xff, 0x5c, 0x71, //
0x5a, 0xff, 0x26, 0xd1, 0x84, 0x84, 0xf2, 0x9b, 0x28, 0x96, //
0x44, 0x96, 0x8f, 0xed, 0xff, 0xeb, 0x23, 0xe0, 0x30, 0x66, //
0x5d, 0x73, 0x6d, 0x94, 0xfc, 0x80, 0xbc, 0x73, 0x5f, 0x51, //
0xc8, 0x06, 0xd7, 0x43, 0x00, //
//
//
// NOTE: fx_id is serialize:"false"
//
// struct field type ID "fx::Credential.cred"
// "secp256k1fx.Credential" type ID
0x00, 0x00, 0x00, 0x09, //
//
// number of signers ("fx::Credential.cred.sigs.len()")
0x00, 0x00, 0x00, 0x02, //
//
// first 65-byte signature
0x7d, 0x89, 0x8e, 0xe9, 0x8a, 0xf8, 0x33, 0x5d, 0x37, 0xe6, //
0xfa, 0xda, 0x0c, 0xbb, 0x44, 0xa1, 0x44, 0x05, 0xd3, 0xbb, //
0x94, 0x0d, 0xfc, 0x0d, 0x99, 0xa6, 0xd3, 0xff, 0x5c, 0x71, //
0x5a, 0xff, 0x26, 0xd1, 0x84, 0x84, 0xf2, 0x9b, 0x28, 0x96, //
0x44, 0x96, 0x8f, 0xed, 0xff, 0xeb, 0x23, 0xe0, 0x30, 0x66, //
0x5d, 0x73, 0x6d, 0x94, 0xfc, 0x80, 0xbc, 0x73, 0x5f, 0x51, //
0xc8, 0x06, 0xd7, 0x43, 0x00, //
//
// second 65-byte signature
0x7d, 0x89, 0x8e, 0xe9, 0x8a, 0xf8, 0x33, 0x5d, 0x37, 0xe6, //
0xfa, 0xda, 0x0c, 0xbb, 0x44, 0xa1, 0x44, 0x05, 0xd3, 0xbb, //
0x94, 0x0d, 0xfc, 0x0d, 0x99, 0xa6, 0xd3, 0xff, 0x5c, 0x71, //
0x5a, 0xff, 0x26, 0xd1, 0x84, 0x84, 0xf2, 0x9b, 0x28, 0x96, //
0x44, 0x96, 0x8f, 0xed, 0xff, 0xeb, 0x23, 0xe0, 0x30, 0x66, //
0x5d, 0x73, 0x6d, 0x94, 0xfc, 0x80, 0xbc, 0x73, 0x5f, 0x51, //
0xc8, 0x06, 0xd7, 0x43, 0x00, //
];
// for c in &signed_bytes {
// print!("{:#02x},", *c);
// }
assert!(cmp_manager::eq_vectors(
expected_signed_bytes,
&tx_bytes_with_signatures
));
}