feat: testnet bnb support (#172)

* feat: simplified finalisation from solana

* chore: bumped versions

* docs: updated near-fin-transfer examples

* feat: introduce wormhole fee

* chore: bumped versions

* feat: account for wormhole fee for other methods

* fix: disable wormhole fee for eth

* feat: bnb support

* chore: bumped versions

Author: frolvanya

Cargo.lock

@@ -48,7 +48,7 @@ tracing-subscriber = { version = "0.3", features = ["env-filter"] }
 base64 = "0.22"
 near-token = "0.3"
 near-contract-standards = "5.5"
-omni-types = { git = "https://github.com/near-one/omni-bridge", package = "omni-types", rev = "306bd60ecb9e55fb946d8fe81185003baaa016cf" }
+omni-types = { git = "https://github.com/near-one/omni-bridge", package = "omni-types", rev = "0639b0595992e353d88551d0ffb8e8a2cf1ee76b" }
 serde_with = "3.12.0"
 solana-sdk = "2.0.13"
 solana-client = "2.0.13"

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bridge-cli"
-version = "0.3.2"
+version = "0.3.3"
 edition = "2021"
 repository = "https://github.com/Near-One/bridge-sdk-rs"
 

bridge-cli/Cargo.toml

@@ -52,6 +52,12 @@ pub const ARB_BRIDGE_TOKEN_FACTORY_ADDRESS_TESTNET: &str =
     "0x0C981337fFe39a555d3A40dbb32f21aD0eF33FFA";
 pub const ARB_WORMHOLE_ADDRESS_TESTNET: &str = "0x6b9C8671cdDC8dEab9c719bB87cBd3e782bA6a35";
 
+pub const BNB_RPC_TESTNET: &str = "https://bsc-testnet-rpc.publicnode.com";
+pub const BNB_CHAIN_ID_TESTNET: u64 = 97;
+pub const BNB_BRIDGE_TOKEN_FACTORY_ADDRESS_TESTNET: &str =
+    "0xEC81aFc3485a425347Ac03316675e58a680b283A";
+pub const BNB_WORMHOLE_ADDRESS_TESTNET: &str = "0x68605AD7b15c732a30b1BbC62BE8F2A509D74b4D";
+
 pub const SOLANA_RPC_TESTNET: &str = "https://api.devnet.solana.com";
 pub const SOLANA_BRIDGE_ADDRESS_TESTNET: &str = "862HdJV59Vp83PbcubUnvuXc4EAXP8CDDs6LTxFpunTe";
 pub const SOLANA_WORMHOLE_ADDRESS_TESTNET: &str = "3u8hJUVTA4jH1wYAyUur7FFZVQ8H635K3tSHHF4ssjQ5";
@@ -84,6 +90,12 @@ pub const ARB_BRIDGE_TOKEN_FACTORY_ADDRESS_DEVNET: &str =
     "0xd025b38762B4A4E36F0Cde483b86CB13ea00D989";
 pub const ARB_WORMHOLE_ADDRESS_DEVNET: &str = "0x6b9C8671cdDC8dEab9c719bB87cBd3e782bA6a35";
 
+pub const BNB_RPC_DEVNET: &str = "https://bsc-testnet-rpc.publicnode.com";
+pub const BNB_CHAIN_ID_DEVNET: u64 = 97;
+pub const BNB_BRIDGE_TOKEN_FACTORY_ADDRESS_DEVNET: &str =
+    "0xEC81aFc3485a425347Ac03316675e58a680b283A";
+pub const BNB_WORMHOLE_ADDRESS_DEVNET: &str = "0x68605AD7b15c732a30b1BbC62BE8F2A509D74b4D";
+
 pub const SOLANA_RPC_DEVNET: &str = "https://api.devnet.solana.com";
 pub const SOLANA_BRIDGE_ADDRESS_DEVNET: &str = "Gy1XPwYZURfBzHiGAxnw3SYC33SfqsEpGSS5zeBge28p";
 pub const SOLANA_WORMHOLE_ADDRESS_DEVNET: &str = "3u8hJUVTA4jH1wYAyUur7FFZVQ8H635K3tSHHF4ssjQ5";

bridge-cli/src/defaults.rs

@@ -52,6 +52,17 @@ struct CliConfig {
     #[arg(long)]
     arb_wormhole_address: Option<String>,
 
+    #[arg(long)]
+    bnb_rpc: Option<String>,
+    #[arg(long)]
+    bnb_chain_id: Option<u64>,
+    #[arg(long)]
+    bnb_private_key: Option<String>,
+    #[arg(long)]
+    bnb_bridge_token_factory_address: Option<String>,
+    #[arg(long)]
+    bnb_wormhole_address: Option<String>,
+
     #[arg(long)]
     solana_rpc: Option<String>,
     #[arg(long)]
@@ -109,6 +120,14 @@ impl CliConfig {
                 .or(other.arb_bridge_token_factory_address),
             arb_wormhole_address: self.arb_wormhole_address.or(other.arb_wormhole_address),
 
+            bnb_rpc: self.bnb_rpc.or(other.bnb_rpc),
+            bnb_chain_id: self.bnb_chain_id.or(other.bnb_chain_id),
+            bnb_private_key: self.bnb_private_key.or(other.bnb_private_key),
+            bnb_bridge_token_factory_address: self
+                .bnb_bridge_token_factory_address
+                .or(other.bnb_bridge_token_factory_address),
+            bnb_wormhole_address: self.bnb_wormhole_address.or(other.bnb_wormhole_address),
+
             solana_rpc: self.solana_rpc.or(other.solana_rpc),
             solana_bridge_address: self.solana_bridge_address.or(other.solana_bridge_address),
             solana_wormhole_address: self
@@ -158,6 +177,14 @@ fn env_config() -> CliConfig {
         arb_bridge_token_factory_address: env::var("ARB_BRIDGE_TOKEN_FACTORY_ADDRESS").ok(),
         arb_wormhole_address: env::var("ARB_WORMHOLE_ADDRESS").ok(),
 
+        bnb_rpc: env::var("BNB_RPC").ok(),
+        bnb_chain_id: env::var("BNB_CHAIN_ID")
+            .ok()
+            .and_then(|val| val.parse::<u64>().ok()),
+        bnb_private_key: env::var("BNB_PRIVATE_KEY").ok(),
+        bnb_bridge_token_factory_address: env::var("BNB_BRIDGE_TOKEN_FACTORY_ADDRESS").ok(),
+        bnb_wormhole_address: env::var("BNB_WORMHOLE_ADDRESS").ok(),
+
         solana_rpc: env::var("SOLANA_RPC").ok(),
         solana_bridge_address: env::var("SOLANA_BRIDGE_ADDRESS").ok(),
         solana_wormhole_address: env::var("SOLANA_WORMHOLE_ADDRESS").ok(),
@@ -207,6 +234,13 @@ fn default_config(network: Network) -> CliConfig {
             ),
             arb_wormhole_address: Some(defaults::ARB_WORMHOLE_ADDRESS_MAINNET.to_owned()),
 
+            // TODO: Replace with actual BNB defaults once it'll be deployed on mainnet
+            bnb_rpc: None,
+            bnb_chain_id: None,
+            bnb_private_key: None,
+            bnb_bridge_token_factory_address: None,
+            bnb_wormhole_address: None,
+
             solana_rpc: Some(defaults::SOLANA_RPC_MAINNET.to_owned()),
             solana_bridge_address: Some(defaults::SOLANA_BRIDGE_ADDRESS_MAINNET.to_owned()),
             solana_wormhole_address: Some(defaults::SOLANA_WORMHOLE_ADDRESS_MAINNET.to_owned()),
@@ -250,6 +284,14 @@ fn default_config(network: Network) -> CliConfig {
             ),
             arb_wormhole_address: Some(defaults::ARB_WORMHOLE_ADDRESS_TESTNET.to_owned()),
 
+            bnb_rpc: Some(defaults::BNB_RPC_TESTNET.to_owned()),
+            bnb_chain_id: Some(defaults::BNB_CHAIN_ID_TESTNET),
+            bnb_private_key: None,
+            bnb_bridge_token_factory_address: Some(
+                defaults::BNB_BRIDGE_TOKEN_FACTORY_ADDRESS_TESTNET.to_owned(),
+            ),
+            bnb_wormhole_address: Some(defaults::BNB_WORMHOLE_ADDRESS_TESTNET.to_owned()),
+
             solana_rpc: Some(defaults::SOLANA_RPC_TESTNET.to_owned()),
             solana_bridge_address: Some(defaults::SOLANA_BRIDGE_ADDRESS_TESTNET.to_owned()),
             solana_wormhole_address: Some(defaults::SOLANA_WORMHOLE_ADDRESS_TESTNET.to_owned()),
@@ -293,6 +335,14 @@ fn default_config(network: Network) -> CliConfig {
             ),
             arb_wormhole_address: Some(defaults::ARB_WORMHOLE_ADDRESS_DEVNET.to_owned()),
 
+            bnb_rpc: Some(defaults::BNB_RPC_DEVNET.to_owned()),
+            bnb_chain_id: Some(defaults::BNB_CHAIN_ID_DEVNET),
+            bnb_private_key: None,
+            bnb_bridge_token_factory_address: Some(
+                defaults::BNB_BRIDGE_TOKEN_FACTORY_ADDRESS_DEVNET.to_owned(),
+            ),
+            bnb_wormhole_address: Some(defaults::BNB_WORMHOLE_ADDRESS_DEVNET.to_owned()),
+
             solana_rpc: Some(defaults::SOLANA_RPC_DEVNET.to_owned()),
             solana_bridge_address: Some(defaults::SOLANA_BRIDGE_ADDRESS_DEVNET.to_owned()),
             solana_wormhole_address: Some(defaults::SOLANA_WORMHOLE_ADDRESS_DEVNET.to_owned()),

bridge-cli/src/main.rs

@@ -398,7 +398,7 @@ pub async fn match_subcommand(cmd: OmniConnectorSubCommand, network: Network) {
                         .unwrap();
                 }
             },
-            ChainKind::Eth | ChainKind::Arb | ChainKind::Base => {
+            ChainKind::Eth | ChainKind::Arb | ChainKind::Base | ChainKind::Bnb => {
                 omni_connector(network, config_cli)
                     .deploy_token(DeployTokenArgs::EvmDeployTokenWithTxHash {
                         chain_kind: chain,
@@ -509,7 +509,7 @@ pub async fn match_subcommand(cmd: OmniConnectorSubCommand, network: Network) {
                         .await
                         .unwrap();
                 }
-                ChainKind::Arb | ChainKind::Base | ChainKind::Sol => {
+                ChainKind::Arb | ChainKind::Base | ChainKind::Bnb | ChainKind::Sol => {
                     let vaa = connector
                         .wormhole_get_vaa_by_tx_hash(tx_hash.clone())
                         .await
@@ -831,6 +831,15 @@ fn omni_connector(network: Network, cli_config: CliConfig) -> OmniConnector {
         .build()
         .unwrap();
 
+    let bnb_bridge_client = EvmBridgeClientBuilder::default()
+        .endpoint(combined_config.bnb_rpc)
+        .chain_id(combined_config.bnb_chain_id)
+        .private_key(combined_config.bnb_private_key)
+        .omni_bridge_address(combined_config.bnb_bridge_token_factory_address)
+        .wormhole_core_address(combined_config.bnb_wormhole_address)
+        .build()
+        .unwrap();
+
     let solana_bridge_client = SolanaBridgeClientBuilder::default()
         .client(Some(RpcClient::new(combined_config.solana_rpc.unwrap())))
         .program_id(
@@ -870,6 +879,7 @@ fn omni_connector(network: Network, cli_config: CliConfig) -> OmniConnector {
         .eth_bridge_client(Some(eth_bridge_client))
         .base_bridge_client(Some(base_bridge_client))
         .arb_bridge_client(Some(arb_bridge_client))
+        .bnb_bridge_client(Some(bnb_bridge_client))
         .solana_bridge_client(Some(solana_bridge_client))
         .wormhole_bridge_client(Some(wormhole_bridge_client))
         .btc_bridge_client(Some(btc_bridge_client))

bridge-cli/src/omni_connector_command.rs

@@ -1,6 +1,6 @@
 [package]
 name = "omni-connector"
-version = "0.2.10"
+version = "0.2.11"
 edition = "2021"
 
 [dependencies]

bridge-sdk/connectors/omni-connector/Cargo.toml

@@ -38,6 +38,7 @@ pub struct OmniConnector {
     eth_bridge_client: Option<EvmBridgeClient>,
     base_bridge_client: Option<EvmBridgeClient>,
     arb_bridge_client: Option<EvmBridgeClient>,
+    bnb_bridge_client: Option<EvmBridgeClient>,
     solana_bridge_client: Option<SolanaBridgeClient>,
     wormhole_bridge_client: Option<WormholeBridgeClient>,
     btc_bridge_client: Option<BtcBridgeClient>,
@@ -1111,15 +1112,17 @@ impl OmniConnector {
         transaction_options: TransactionOptions,
     ) -> Result<String> {
         match &token {
-            OmniAddress::Eth(address) | OmniAddress::Arb(address) | OmniAddress::Base(address) => {
-                self.evm_log_metadata(
+            OmniAddress::Eth(address)
+            | OmniAddress::Arb(address)
+            | OmniAddress::Base(address)
+            | OmniAddress::Bnb(address) => self
+                .evm_log_metadata(
                     address.clone(),
                     token.get_chain(),
                     transaction_options.nonce.map(std::convert::Into::into),
                 )
                 .await
-                .map(|hash| hash.to_string())
-            }
+                .map(|hash| hash.to_string()),
             OmniAddress::Near(token_id) => self
                 .near_log_metadata(token_id.to_string(), transaction_options)
                 .await
@@ -1394,7 +1397,7 @@ impl OmniConnector {
                 })
                 .await
             }
-            ChainKind::Eth | ChainKind::Base | ChainKind::Arb => {
+            ChainKind::Eth | ChainKind::Base | ChainKind::Arb | ChainKind::Bnb => {
                 self.evm_is_transfer_finalised(destination_chain, nonce)
                     .await
             }
@@ -1441,10 +1444,11 @@ impl OmniConnector {
 
     pub fn evm_bridge_client(&self, chain_kind: ChainKind) -> Result<&EvmBridgeClient> {
         let bridge_client = match chain_kind {
+            ChainKind::Eth => self.eth_bridge_client.as_ref(),
             ChainKind::Base => self.base_bridge_client.as_ref(),
             ChainKind::Arb => self.arb_bridge_client.as_ref(),
-            ChainKind::Eth => self.eth_bridge_client.as_ref(),
-            _ => unreachable!("Unsupported chain kind"),
+            ChainKind::Bnb => self.bnb_bridge_client.as_ref(),
+            ChainKind::Near | ChainKind::Sol => unreachable!("Unsupported chain kind"),
         };
 
         bridge_client.ok_or(BridgeSdkError::ConfigError(
@@ -1515,7 +1519,7 @@ impl OmniConnector {
         tx_hash: String,
     ) -> Result<Vec<StorageDepositAction>> {
         match chain {
-            ChainKind::Eth | ChainKind::Base | ChainKind::Arb => {
+            ChainKind::Eth | ChainKind::Base | ChainKind::Arb | ChainKind::Bnb => {
                 let tx_hash = TxHash::from_str(&tx_hash).map_err(|_| {
                     BridgeSdkError::InvalidArgument(format!("Failed to parse tx hash: {tx_hash}"))
                 })?;