Skip to content
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

Jump to bottom

[bridge] add get token payload for dev inspect #17563

Closed
wants to merge 1 commit into from
Closed

[bridge] add get token payload for dev inspect #17563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 22 additions & 9 deletions crates/sui-bridge/src/e2e_tests/basic.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,16 +131,29 @@ async fn test_bridge_from_eth_to_sui_to_eth() {
.await;
// There are exactly 1 deposit and 1 approved event
assert_eq!(events.len(), 2);
let message = eth_sui_bridge::Message::from(sui_to_eth_bridge_action);

let signatures = get_signatures(
&sui_bridge_client,
nonce,
sui_chain_id,
&sui_client,
message.message_type,
)
.await;
// Test `get_parsed_token_transfer_message`
let parsed_msg = sui_bridge_client
.get_parsed_token_transfer_message(sui_chain_id, nonce)
.await
.unwrap()
.unwrap();
assert_eq!(parsed_msg.source_chain as u8, sui_chain_id);
assert_eq!(parsed_msg.seq_num, nonce);
assert_eq!(
parsed_msg.parsed_payload.sender_address,
sui_address.to_vec()
);
assert_eq!(
&parsed_msg.parsed_payload.target_address,
eth_address_1.as_bytes()
);
assert_eq!(parsed_msg.parsed_payload.target_chain, eth_chain_id as u8);
assert_eq!(parsed_msg.parsed_payload.token_type, TOKEN_ID_ETH);
assert_eq!(parsed_msg.parsed_payload.amount, sui_amount);

let message = eth_sui_bridge::Message::from(sui_to_eth_bridge_action);
let signatures = get_signatures(&sui_bridge_client, nonce, sui_chain_id).await;

let eth_sui_bridge = EthSuiBridge::new(
bridge_test_cluster.contracts().sui_bridge,
Expand Down
41 changes: 2 additions & 39 deletions crates/sui-bridge/src/e2e_tests/test_utils.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,10 @@ use crate::BRIDGE_ENABLE_PROTOCOL_VERSION;
use ethers::prelude::*;
use std::process::Child;
use sui_config::local_ip_utils::get_available_port;
use sui_json_rpc_types::SuiObjectDataOptions;
use sui_sdk::SuiClient;
use sui_types::base_types::SuiAddress;
use sui_types::bridge::{MoveTypeBridgeMessageKey, MoveTypeBridgeRecord};
use sui_types::collection_types::LinkedTableNode;
use sui_types::crypto::EncodeDecodeBase64;
use sui_types::crypto::KeypairTraits;
use sui_types::dynamic_field::{DynamicFieldName, Field};
use sui_types::object::Object;
use sui_types::TypeTag;
use tempfile::tempdir;
use test_cluster::TestCluster;
use test_cluster::TestClusterBuilder;
Expand Down Expand Up @@ -815,43 +809,12 @@ pub(crate) async fn get_signatures(
sui_bridge_client: &SuiBridgeClient,
nonce: u64,
sui_chain_id: u8,
sui_client: &SuiClient,
message_type: u8,
) -> Vec<Bytes> {
// Now collect sigs from the bridge record and submit to eth to claim
let summary = sui_bridge_client.get_bridge_summary().await.unwrap();
let records_id = summary.bridge_records_id;
let key = serde_json::json!(
{
// u64 is represented as string
"bridge_seq_num": nonce.to_string(),
"message_type": message_type,
"source_chain": sui_chain_id,
}
);
let status_object_id = sui_client.read_api().get_dynamic_field_object(records_id,
DynamicFieldName {
type_: TypeTag::from_str("0x000000000000000000000000000000000000000000000000000000000000000b::message::BridgeMessageKey").unwrap(),
value: key.clone(),
},
).await.unwrap().into_object().unwrap().object_id;

let object_resp = sui_client
.read_api()
.get_object_with_options(
status_object_id,
SuiObjectDataOptions::full_content().with_bcs(),
)
let sigs = sui_bridge_client
.get_token_transfer_action_onchain_signatures_until_success(sui_chain_id, nonce)
.await
.unwrap();

let object: Object = object_resp.into_object().unwrap().try_into().unwrap();
let record: Field<
MoveTypeBridgeMessageKey,
LinkedTableNode<MoveTypeBridgeMessageKey, MoveTypeBridgeRecord>,
> = object.to_rust().unwrap();
let sigs = record.value.value.verified_signatures.unwrap();

sigs.into_iter()
.map(|sig: Vec<u8>| Bytes::from(sig))
.collect()
Expand Down
221 changes: 121 additions & 100 deletions crates/sui-bridge/src/sui_client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use core::panic;
use ethers::types::{Address, U256};
use fastcrypto::traits::KeyPair;
use fastcrypto::traits::ToFromBytes;
use serde::de::DeserializeOwned;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::str::from_utf8;
Expand All @@ -34,6 +35,8 @@ use sui_types::bridge::BridgeSummary;
use sui_types::bridge::BridgeTreasurySummary;
use sui_types::bridge::MoveTypeBridgeCommittee;
use sui_types::bridge::MoveTypeCommitteeMember;
use sui_types::bridge::MoveTypeParsedTokenTransferMessage;
use sui_types::bridge::MoveTypeTokenTransferPayload;
use sui_types::collection_types::LinkedTableNode;
use sui_types::crypto::get_key_pair;
use sui_types::dynamic_field::DynamicFieldName;
Expand Down Expand Up @@ -70,6 +73,7 @@ use crate::error::{BridgeError, BridgeResult};
use crate::events::SuiBridgeEvent;
use crate::retry_with_max_elapsed_time;
use crate::types::BridgeActionStatus;
use crate::types::ParsedTokenTransferMessage;
use crate::types::{BridgeAction, BridgeAuthority, BridgeCommittee};

pub struct SuiClient<P> {
Expand Down Expand Up @@ -338,6 +342,23 @@ where
}
}

pub async fn get_parsed_token_transfer_message(
&self,
source_chain_id: u8,
seq_number: u64,
) -> BridgeResult<Option<ParsedTokenTransferMessage>> {
let now = std::time::Instant::now();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is this used for?

let bridge_object_arg = self.get_mutable_bridge_object_arg_must_succeed().await;
let message = self
.inner
.get_parsed_token_transfer_message(bridge_object_arg, source_chain_id, seq_number)
.await?;
Ok(match message {
Some(payload) => Some(ParsedTokenTransferMessage::try_from(payload)?),
None => None,
})
}

pub async fn get_gas_data_panic_if_not_gas(
&self,
gas_object_id: ObjectID,
Expand Down Expand Up @@ -390,6 +411,13 @@ pub trait SuiClientInner: Send + Sync {
seq_number: u64,
) -> Result<Option<Vec<Vec<u8>>>, BridgeError>;

async fn get_parsed_token_transfer_message(
&self,
bridge_object_arg: ObjectArg,
source_chain_id: u8,
seq_number: u64,
) -> Result<Option<MoveTypeParsedTokenTransferMessage>, BridgeError>;

async fn get_gas_data_panic_if_not_gas(
&self,
gas_object_id: ObjectID,
Expand Down Expand Up @@ -449,60 +477,15 @@ impl SuiClientInner for SuiSdkClient {
source_chain_id: u8,
seq_number: u64,
) -> Result<BridgeActionStatus, BridgeError> {
let pt = ProgrammableTransaction {
inputs: vec![
CallArg::Object(bridge_object_arg),
CallArg::Pure(bcs::to_bytes(&source_chain_id).unwrap()),
CallArg::Pure(bcs::to_bytes(&seq_number).unwrap()),
],
commands: vec![Command::MoveCall(Box::new(ProgrammableMoveCall {
package: BRIDGE_PACKAGE_ID,
module: Identifier::new("bridge").unwrap(),
function: Identifier::new("get_token_transfer_action_status").unwrap(),
type_arguments: vec![],
arguments: vec![Argument::Input(0), Argument::Input(1), Argument::Input(2)],
}))],
};
let kind = TransactionKind::programmable(pt.clone());
let resp = self
.read_api()
.dev_inspect_transaction_block(SuiAddress::ZERO, kind, None, None, None)
.await?;
let DevInspectResults {
results, effects, ..
} = resp;
let Some(results) = results else {
return Err(BridgeError::Generic(format!(
"Can't get token transfer action status (empty results). effects: {:?}",
effects
)));
};
let return_values = &results
.first()
.ok_or(BridgeError::Generic(format!(
"Can't get token transfer action status, results: {:?}",
results
)))?
.return_values;
let (value_bytes, _type_tag) =
return_values.first().ok_or(BridgeError::Generic(format!(
"Can't get token transfer action status, results: {:?}",
results
)))?;
let status = bcs::from_bytes::<u8>(value_bytes).map_err(|_e| {
BridgeError::Generic(format!(
"Can't parse token transfer action status as u8: {:?}",
results
))
})?;
let status = BridgeActionStatus::try_from(status).map_err(|_e| {
BridgeError::Generic(format!(
"Can't parse token transfer action status as BridgeActionStatus: {:?}",
results
))
})?;

return Ok(status);
dev_inspect_bridge::<u8>(
self,
bridge_object_arg,
source_chain_id,
seq_number,
"get_token_transfer_action_status",
)
.await
.and_then(|status_byte| BridgeActionStatus::try_from(status_byte).map_err(Into::into))
}

async fn get_token_transfer_action_onchain_signatures(
Expand All @@ -511,52 +494,30 @@ impl SuiClientInner for SuiSdkClient {
source_chain_id: u8,
seq_number: u64,
) -> Result<Option<Vec<Vec<u8>>>, BridgeError> {
let pt = ProgrammableTransaction {
inputs: vec![
CallArg::Object(bridge_object_arg),
CallArg::Pure(bcs::to_bytes(&source_chain_id).unwrap()),
CallArg::Pure(bcs::to_bytes(&seq_number).unwrap()),
],
commands: vec![Command::MoveCall(Box::new(ProgrammableMoveCall {
package: BRIDGE_PACKAGE_ID,
module: Identifier::new("bridge").unwrap(),
function: Identifier::new("get_token_transfer_action_signatures").unwrap(),
type_arguments: vec![],
arguments: vec![Argument::Input(0), Argument::Input(1), Argument::Input(2)],
}))],
};
let kind = TransactionKind::programmable(pt.clone());
let resp = self
.read_api()
.dev_inspect_transaction_block(SuiAddress::ZERO, kind, None, None, None)
.await?;
let DevInspectResults {
results, effects, ..
} = resp;
let Some(results) = results else {
return Err(BridgeError::Generic(format!(
"Can't get token transfer action signatures (empty results). effects: {:?}",
effects
)));
};
let return_values = &results
.first()
.ok_or(BridgeError::Generic(format!(
"Can't get token transfer action signatures, results: {:?}",
results
)))?
.return_values;
let (value_bytes, _type_tag) =
return_values.first().ok_or(BridgeError::Generic(format!(
"Can't get token transfer action signatures, results: {:?}",
results
)))?;
bcs::from_bytes::<Option<Vec<Vec<u8>>>>(value_bytes).map_err(|_e| {
BridgeError::Generic(format!(
"Can't parse token transfer action signatures as Option<Vec<Vec<u8>>>: {:?}",
results
))
})
dev_inspect_bridge::<Option<Vec<Vec<u8>>>>(
self,
bridge_object_arg,
source_chain_id,
seq_number,
"get_token_transfer_action_signatures",
)
.await
}

async fn get_parsed_token_transfer_message(
&self,
bridge_object_arg: ObjectArg,
source_chain_id: u8,
seq_number: u64,
) -> Result<Option<MoveTypeParsedTokenTransferMessage>, BridgeError> {
dev_inspect_bridge::<Option<MoveTypeParsedTokenTransferMessage>>(
self,
bridge_object_arg,
source_chain_id,
seq_number,
"get_parsed_token_transfer_message",
)
.await
}

async fn execute_transaction_block_with_effects(
Expand Down Expand Up @@ -602,6 +563,66 @@ impl SuiClientInner for SuiSdkClient {
}
}

/// Helper function to dev-inspect `bridge::{function_name}` function
/// with bridge object arg, source chain id, seq number as param
/// and parse the return value as `T`.
async fn dev_inspect_bridge<T>(
sui_client: &SuiSdkClient,
bridge_object_arg: ObjectArg,
source_chain_id: u8,
seq_number: u64,
function_name: &str,
) -> Result<T, BridgeError>
where
T: DeserializeOwned,
{
let pt = ProgrammableTransaction {
inputs: vec![
CallArg::Object(bridge_object_arg),
CallArg::Pure(bcs::to_bytes(&source_chain_id).unwrap()),
CallArg::Pure(bcs::to_bytes(&seq_number).unwrap()),
],
commands: vec![Command::MoveCall(Box::new(ProgrammableMoveCall {
package: BRIDGE_PACKAGE_ID,
module: Identifier::new("bridge").unwrap(),
function: Identifier::new(function_name).unwrap(),
type_arguments: vec![],
arguments: vec![Argument::Input(0), Argument::Input(1), Argument::Input(2)],
}))],
};
let kind = TransactionKind::programmable(pt);
let resp = sui_client
.read_api()
.dev_inspect_transaction_block(SuiAddress::ZERO, kind, None, None, None)
.await?;
let DevInspectResults {
results, effects, ..
} = resp;
let Some(results) = results else {
return Err(BridgeError::Generic(format!(
"No results returned for '{}', effects: {:?}",
function_name, effects
)));
};
let return_values = &results
.first()
.ok_or(BridgeError::Generic(format!(
"No return values for '{}', results: {:?}",
function_name, results
)))?
.return_values;
let (value_bytes, _type_tag) = return_values.first().ok_or(BridgeError::Generic(format!(
"No first return value for '{}', results: {:?}",
function_name, results
)))?;
bcs::from_bytes::<T>(value_bytes).map_err(|e| {
BridgeError::Generic(format!(
"Failed to parse return value for '{}', error: {:?}, results: {:?}",
function_name, e, results
))
})
}

#[cfg(test)]
mod tests {
use crate::crypto::BridgeAuthorityKeyPair;
Expand Down