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 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
pub mod raw;
pub mod transferable;
pub mod utxo;
use std::io::{self, Error, ErrorKind};
use super::{
codec,
formatting::{self, serde::hex_0x_bytes::HexBytes},
ids, key, packer, platformvm,
};
use ring::digest::{digest, SHA256};
use serde::{Deserialize, Serialize};
use serde_with::serde_as;
/// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#BaseTx
#[serde_as]
#[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Clone)]
pub struct Tx {
#[serde(skip)]
pub metadata: Option<Metadata>, // skip serialization due to serialize:"false"
#[serde(rename = "networkID")]
pub network_id: u32,
#[serde(rename = "blockchainID")]
pub blockchain_id: ids::Id,
#[serde(rename = "outputs")]
pub transferable_outputs: Option<Vec<transferable::Output>>,
#[serde(rename = "inputs")]
pub transferable_inputs: Option<Vec<transferable::Input>>,
#[serde_as(as = "Option<HexBytes>")]
#[serde(skip_serializing_if = "Option::is_none")]
pub memo: Option<Vec<u8>>,
}
impl Default for Tx {
fn default() -> Self {
Self::default()
}
}
impl Tx {
pub fn default() -> Self {
Self {
metadata: None,
network_id: 0,
blockchain_id: ids::Id::empty(),
transferable_outputs: None,
transferable_inputs: None,
memo: None,
}
}
pub fn type_name() -> String {
"avm.BaseTx".to_string()
}
pub fn type_id() -> u32 {
*(codec::X_TYPES.get(&Self::type_name()).unwrap()) as u32
}
/// "Tx.Unsigned" is implemented by "avax.BaseTx"
/// but for marshal, it's passed as an interface.
/// Then marshaled via "avalanchego/codec/linearcodec.linearCodec"
/// which then calls "genericCodec.marshal".
/// ref. "avalanchego/vms/avm.Tx.SignSECP256K1Fx"
/// ref. "avalanchego/codec.manager.Marshal"
/// ref. "avalanchego/codec.manager.Marshal(codecVersion, &t.UnsignedTx)"
/// ref. "avalanchego/codec/linearcodec.linearCodec.MarshalInto"
/// ref. "avalanchego/codec/reflectcodec.genericCodec.MarshalInto"
/// ref. "avalanchego/codec/reflectcodec.genericCodec.marshal"
///
/// Returns the packer itself so that the following marshals can reuse.
///
/// "BaseTx" is an interface in Go (reflect.Interface)
/// thus the underlying type must be specified by the caller
/// TODO: can we do better in Rust? Go does so with reflect...
/// e.g., pack prefix with the type ID for "avm.BaseTx" (linearCodec.PackPrefix)
/// ref. "avalanchego/codec/linearcodec.linearCodec.MarshalInto"
/// ref. "avalanchego/codec/reflectcodec.genericCodec.MarshalInto"
pub fn pack(&self, codec_version: u16, type_id: u32) -> io::Result<packer::Packer> {
// ref. "avalanchego/codec.manager.Marshal", "vms/avm.newCustomCodecs"
// ref. "math.MaxInt32" and "constants.DefaultByteSliceCap" in Go
let packer = packer::Packer::new((1 << 31) - 1, 128);
// codec version
// ref. "avalanchego/codec.manager.Marshal"
packer.pack_u16(codec_version).map_err(|e| {
return Error::new(
ErrorKind::InvalidInput,
format!("couldn't pack codec version {}", e), // ref. "errCantPackVersion"
);
})?;
packer.pack_u32(type_id)?;
// marshal the actual struct "avm.BaseTx"
// "BaseTx.Metadata" is not serialize:"true" thus skipping serialization!!!
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#BaseTx
// ref. "avalanchego/codec/reflectcodec.structFielder"
packer.pack_u32(self.network_id)?;
packer.pack_bytes(self.blockchain_id.as_ref())?;
// "transferable_outputs" field; pack the number of slice elements
if self.transferable_outputs.is_some() {
let transferable_outputs = self.transferable_outputs.as_ref().unwrap();
packer.pack_u32(transferable_outputs.len() as u32)?;
for transferable_output in transferable_outputs.iter() {
// "TransferableOutput.Asset" is struct and serialize:"true"
// but embedded inline in the struct "TransferableOutput"
// so no need to encode type ID
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#TransferableOutput
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#Asset
packer.pack_bytes(transferable_output.asset_id.as_ref())?;
// fx_id is serialize:"false" thus skipping serialization
// decide the type
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#TransferableOutput
if transferable_output.transfer_output.is_none()
&& transferable_output.stakeable_lock_out.is_none()
{
return Err(Error::new(
ErrorKind::InvalidInput,
"unexpected Nones in TransferableOutput transfer_output and stakeable_lock_out",
));
}
let type_id_transferable_out = {
if transferable_output.transfer_output.is_some() {
key::secp256k1::txs::transfer::Output::type_id()
} else {
platformvm::txs::StakeableLockOut::type_id()
}
};
// marshal type ID for "key::secp256k1::txs::transfer::Output" or "platformvm::txs::StakeableLockOut"
packer.pack_u32(type_id_transferable_out)?;
match type_id_transferable_out {
7 => {
// "key::secp256k1::txs::transfer::Output"
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#TransferOutput
let transfer_output = transferable_output.transfer_output.clone().unwrap();
// marshal "secp256k1fx.TransferOutput.Amt" field
packer.pack_u64(transfer_output.amount)?;
// "secp256k1fx.TransferOutput.OutputOwners" is struct and serialize:"true"
// but embedded inline in the struct "TransferOutput"
// so no need to encode type ID
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#TransferOutput
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#OutputOwners
packer.pack_u64(transfer_output.output_owners.locktime)?;
packer.pack_u32(transfer_output.output_owners.threshold)?;
packer.pack_u32(transfer_output.output_owners.addresses.len() as u32)?;
for addr in transfer_output.output_owners.addresses.iter() {
packer.pack_bytes(addr.as_ref())?;
}
}
22 => {
// "platformvm::txs::StakeableLockOut"
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/platformvm#StakeableLockOut
let stakeable_lock_out =
transferable_output.stakeable_lock_out.clone().unwrap();
// marshal "platformvm::txs::StakeableLockOut.locktime" field
packer.pack_u64(stakeable_lock_out.locktime)?;
// "platformvm.StakeableLockOut.TransferOutput" is struct and serialize:"true"
// but embedded inline in the struct "StakeableLockOut"
// so no need to encode type ID
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/platformvm#StakeableLockOut
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#TransferOutput
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#OutputOwners
//
// marshal "secp256k1fx.TransferOutput.Amt" field
packer.pack_u64(stakeable_lock_out.transfer_output.amount)?;
packer
.pack_u64(stakeable_lock_out.transfer_output.output_owners.locktime)?;
packer
.pack_u32(stakeable_lock_out.transfer_output.output_owners.threshold)?;
packer.pack_u32(
stakeable_lock_out
.transfer_output
.output_owners
.addresses
.len() as u32,
)?;
for addr in stakeable_lock_out
.transfer_output
.output_owners
.addresses
.iter()
{
packer.pack_bytes(addr.as_ref())?;
}
}
_ => {
return Err(Error::new(
ErrorKind::InvalidInput,
format!(
"unexpected type ID {} for TransferableOutput",
type_id_transferable_out
),
));
}
}
}
} else {
packer.pack_u32(0_u32)?;
}
// "transferable_inputs" field; pack the number of slice elements
if self.transferable_inputs.is_some() {
let transferable_inputs = self.transferable_inputs.as_ref().unwrap();
packer.pack_u32(transferable_inputs.len() as u32)?;
for transferable_input in transferable_inputs.iter() {
// "TransferableInput.UTXOID" is struct and serialize:"true"
// but embedded inline in the struct "TransferableInput"
// so no need to encode type ID
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#TransferableInput
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#UTXOID
packer.pack_bytes(transferable_input.utxo_id.tx_id.as_ref())?;
packer.pack_u32(transferable_input.utxo_id.output_index)?;
// "TransferableInput.Asset" is struct and serialize:"true"
// but embedded inline in the struct "TransferableInput"
// so no need to encode type ID
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#TransferableInput
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#Asset
packer.pack_bytes(transferable_input.asset_id.as_ref())?;
// fx_id is serialize:"false" thus skipping serialization
// decide the type
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#TransferableInput
if transferable_input.transfer_input.is_none()
&& transferable_input.stakeable_lock_in.is_none()
{
return Err(Error::new(
ErrorKind::InvalidInput,
"unexpected Nones in TransferableInput transfer_input and stakeable_lock_in",
));
}
let type_id_transferable_in = {
if transferable_input.transfer_input.is_some() {
key::secp256k1::txs::transfer::Input::type_id()
} else {
platformvm::txs::StakeableLockIn::type_id()
}
};
// marshal type ID for "key::secp256k1::txs::transfer::Input" or "platformvm::txs::StakeableLockIn"
packer.pack_u32(type_id_transferable_in)?;
match type_id_transferable_in {
5 => {
// "key::secp256k1::txs::transfer::Input"
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#TransferInput
let transfer_input = transferable_input.transfer_input.clone().unwrap();
// marshal "secp256k1fx.TransferInput.Amt" field
packer.pack_u64(transfer_input.amount)?;
// "secp256k1fx.TransferInput.Input" is struct and serialize:"true"
// but embedded inline in the struct "TransferInput"
// so no need to encode type ID
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#TransferInput
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#Input
packer.pack_u32(transfer_input.sig_indices.len() as u32)?;
for idx in transfer_input.sig_indices.iter() {
packer.pack_u32(*idx)?;
}
}
21 => {
// "platformvm::txs::StakeableLockIn"
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/platformvm#StakeableLockIn
let stakeable_lock_in =
transferable_input.stakeable_lock_in.clone().unwrap();
// marshal "platformvm::txs::StakeableLockIn.locktime" field
packer.pack_u64(stakeable_lock_in.locktime)?;
// "platformvm.StakeableLockIn.TransferableIn" is struct and serialize:"true"
// but embedded inline in the struct "StakeableLockIn"
// so no need to encode type ID
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/platformvm#StakeableLockIn
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#TransferInput
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#Input
//
// marshal "secp256k1fx.TransferInput.Amt" field
packer.pack_u64(stakeable_lock_in.transfer_input.amount)?;
//
// "secp256k1fx.TransferInput.Input" is struct and serialize:"true"
// but embedded inline in the struct "TransferInput"
// so no need to encode type ID
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#TransferInput
// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/secp256k1fx#Input
packer
.pack_u32(stakeable_lock_in.transfer_input.sig_indices.len() as u32)?;
for idx in stakeable_lock_in.transfer_input.sig_indices.iter() {
packer.pack_u32(*idx)?;
}
}
_ => {
return Err(Error::new(
ErrorKind::InvalidInput,
format!(
"unexpected type ID {} for TransferableInpu",
type_id_transferable_in
),
));
}
}
}
} else {
packer.pack_u32(0_u32)?;
}
// marshal "BaseTx.memo"
if self.memo.is_some() {
let memo = self.memo.as_ref().unwrap();
packer.pack_u32(memo.len() as u32)?;
packer.pack_bytes(memo)?;
} else {
packer.pack_u32(0_u32)?;
}
Ok(packer)
}
}
/// RUST_LOG=debug cargo test --package avalanche-types --lib -- txs::test_base_tx_serialization --exact --show-output
/// ref. "avalanchego/vms/avm.TestBaseTxSerialization"
#[test]
fn test_base_tx_serialization() {
use crate::{ids::short, key};
// 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 to_short_bytes");
let test_key_short_addr = short::Id::from_slice(&test_key_short_addr);
let unsigned_tx = Tx {
network_id: 10,
blockchain_id: ids::Id::from_slice(&<Vec<u8>>::from([5, 4, 3, 2, 1])),
transferable_outputs: Some(vec![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],
},
}),
..transferable::Output::default()
}]),
transferable_inputs: Some(vec![transferable::Input {
utxo_id: 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,
..utxo::Id::default()
},
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],
}),
..transferable::Input::default()
}]),
memo: Some(vec![0x00, 0x01, 0x02, 0x03]),
..Tx::default()
};
let unsigned_tx_packer = unsigned_tx
.pack(0, Tx::type_id())
.expect("failed to pack unsigned_tx");
let unsigned_tx_bytes = unsigned_tx_packer.take_bytes();
let expected_unsigned_tx_bytes: Vec<u8> = vec![
// 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, //
];
// for c in &unsigned_bytes {
// print!("{:#02x},", *c);
// }
assert!(cmp_manager::eq_vectors(
&expected_unsigned_tx_bytes,
&unsigned_tx_bytes
));
}
/// ref. https://pkg.go.dev/github.com/ava-labs/avalanchego/vms/components/avax#Metadata
#[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Clone)]
pub struct Metadata {
pub id: ids::Id,
pub unsigned_bytes: Vec<u8>,
pub bytes: Vec<u8>,
}
impl Default for Metadata {
fn default() -> Self {
Self::default()
}
}
impl Metadata {
pub fn default() -> Self {
Self {
id: ids::Id::empty(),
unsigned_bytes: Vec::new(),
bytes: Vec::new(),
}
}
pub fn new(unsigned_bytes: &[u8], bytes: &[u8]) -> Self {
let id: Vec<u8> = digest(&SHA256, bytes).as_ref().into();
let id = ids::Id::from_slice(&id);
Self {
id,
unsigned_bytes: Vec::from(unsigned_bytes),
bytes: Vec::from(bytes),
}
}
pub fn verify(&self) -> io::Result<()> {
if self.id.is_empty() {
return Err(Error::new(
ErrorKind::InvalidInput,
"metadata was never initialized and is not valid", // ref. "errMetadataNotInitialize"
));
}
Ok(())
}
}