feat(protocol-contracts): add bnb configs

Author: jatZama

protocol-contracts/token/.env.example

@@ -3,9 +3,11 @@ PRIVATE_KEY=
 # mainnet
 MAINNET_RPC_URL=
 RPC_URL_ZAMA_GATEWAY_MAINNET=
+RPC_URL_BNB_MAINNET=
 # testnet
 SEPOLIA_RPC_URL=
 RPC_URL_ZAMA_GATEWAY_TESTNET=
+RPC_URL_BNB_TESTNET=
 # API for contract verification
 ETHERSCAN_API=TA5XXXXXXXXXXXXXXXXXXXXXXXXXXXGX9
 BLOCKSCOUT_API=https://explorer-xxxx-xxxxxxx.conduit.xyz/api # don't forget the /api suffix at the end

protocol-contracts/token/hardhat.config.ts

@@ -91,6 +91,16 @@ const config: HardhatUserConfig = {
             url: process.env.RPC_URL_ZAMA_GATEWAY_TESTNET || '',
             accounts,
         },
+        'bnb-mainnet': {
+            eid: EndpointId.BSC_V2_MAINNET,
+            url: process.env.RPC_URL_BNB_MAINNET || '',
+            accounts,
+        },
+        'bnb-testnet': {
+            eid: EndpointId.BSC_V2_TESTNET,
+            url: process.env.RPC_URL_BNB_TESTNET || '',
+            accounts,
+        },
         hardhat: {
             // Need this for testing because TestHelperOz5.sol is exceeding the compiled contract size limit
             allowUnlimitedContractSize: true,

protocol-contracts/token/layerzero.config.mainnet.ts

@@ -15,8 +15,14 @@ const zamaMainnetContract: OmniPointHardhat = {
     contractName: 'ZamaOFT',
 }
 
-// To connect all the above chains to each other, we need the following pathways:
+const bnbContract: OmniPointHardhat = {
+    eid: EndpointId.BSC_V2_MAINNET,
+    contractName: 'ZamaOFT',
+}
+
+// We need the following pathways:
 // ZamaGatewayMainnet <-> Ethereum
+// BNB <-> Ethereum
 
 // For this example's simplicity, we will use the same enforced options values for sending to all chains
 // For production, you should ensure `gas` is set to the correct value through profiling the gas usage of calling OFT._lzReceive(...) on the destination chain
@@ -41,13 +47,21 @@ const pathways: TwoWayConfig[] = [
         [15, 20], // [A to B confirmations, B to A confirmations]
         [EVM_ENFORCED_OPTIONS, EVM_ENFORCED_OPTIONS], // Chain B enforcedOptions, Chain A enforcedOptions
     ],
+    [
+        ethereumContract, // Chain A contract
+        bnbContract, // Chain B contract
+        // TODO: Add custom ZAMA DVN in next line?
+        [['LayerZero Labs'], [['Nethermind', 'Luganodes', 'P2P'], 2]], // [ requiredDVN[], [ optionalDVN[], threshold ] ]
+        [15, 20], // [A to B confirmations, B to A confirmations]
+        [EVM_ENFORCED_OPTIONS, EVM_ENFORCED_OPTIONS], // Chain B enforcedOptions, Chain A enforcedOptions
+    ],
 ]
 
 export default async function () {
     // Generate the connections config based on the pathways
     const connections = await generateConnectionsConfig(pathways)
     return {
-        contracts: [{ contract: zamaMainnetContract }, { contract: ethereumContract }],
+        contracts: [{ contract: zamaMainnetContract }, { contract: ethereumContract }, { contract: bnbContract }],
         connections,
     }
 }

protocol-contracts/token/layerzero.config.testnet.ts

@@ -15,8 +15,14 @@ const zamaTestnetContract: OmniPointHardhat = {
     contractName: 'ZamaOFT',
 }
 
-// To connect all the above chains to each other, we need the following pathways:
+const bnbTestnetContract: OmniPointHardhat = {
+    eid: EndpointId.BSC_V2_TESTNET,
+    contractName: 'ZamaOFT',
+}
+
+// We need the following pathways:
 // ZamaGatewayTestnet <-> Sepolia
+// BNBTestnet <-> Sepolia
 
 // For this example's simplicity, we will use the same enforced options values for sending to all chains
 // For production, you should ensure `gas` is set to the correct value through profiling the gas usage of calling OFT._lzReceive(...) on the destination chain
@@ -25,7 +31,7 @@ const EVM_ENFORCED_OPTIONS: OAppEnforcedOption[] = [
     {
         msgType: 1,
         optionType: ExecutorOptionType.LZ_RECEIVE,
-        gas: 50000,
+        gas: 80000,
         value: 0,
     },
 ]
@@ -41,13 +47,20 @@ const pathways: TwoWayConfig[] = [
         [15, 20], // [A to B confirmations, B to A confirmations]
         [EVM_ENFORCED_OPTIONS, EVM_ENFORCED_OPTIONS], // Chain B enforcedOptions, Chain A enforcedOptions
     ],
+    [
+        sepoliaContract,
+        bnbTestnetContract,
+        [['LayerZero Labs'], []], // [ requiredDVN[], [ optionalDVN[], threshold ] ]
+        [15, 20], // [A to B confirmations, B to A confirmations]
+        [EVM_ENFORCED_OPTIONS, EVM_ENFORCED_OPTIONS], // Chain B enforcedOptions, Chain A enforcedOptions
+    ],
 ]
 
 export default async function () {
     // Generate the connections config based on the pathways
     const connections = await generateConnectionsConfig(pathways)
     return {
-        contracts: [{ contract: zamaTestnetContract }, { contract: sepoliaContract }],
+        contracts: [{ contract: zamaTestnetContract }, { contract: sepoliaContract }, { contract: bnbTestnetContract }],
         connections,
     }
 }

protocol-contracts/token/package.json

@@ -11,7 +11,8 @@
     "lint:js": "eslint '**/*.{js,ts,json}' && prettier --check .",
     "lint:sol": "solhint 'contracts/**/*.sol'",
     "test": "hardhat test",
-    "verify:etherscan:arbitrum:sepolia": "dotenv -e .env --  bash -c 'npx @layerzerolabs/verify-contract verify-contract -d ./deployments -n arbitrum-testnet -u https://api.etherscan.io/v2/api?chainid=421614 -k $ETHERSCAN_API'",
+    "verify:etherscan:bnb:mainnet": "dotenv -e .env --  bash -c 'npx @layerzerolabs/verify-contract verify-contract -d ./deployments -n bnb-mainnet -u https://api.etherscan.io/v2/api?chainid=56 -k $ETHERSCAN_API'",
+    "verify:etherscan:bnb:testnet": "dotenv -e .env --  bash -c 'npx @layerzerolabs/verify-contract verify-contract -d ./deployments -n bnb-testnet -u https://api.etherscan.io/v2/api?chainid=97 -k $ETHERSCAN_API'",
     "verify:etherscan:ethereum:mainnet": "dotenv -e .env --  bash -c 'npx @layerzerolabs/verify-contract verify-contract -d ./deployments -n ethereum-mainnet -u https://api.etherscan.io/v2/api?chainid=1 -k $ETHERSCAN_API'",
     "verify:etherscan:ethereum:sepolia": "dotenv -e .env --  bash -c 'npx @layerzerolabs/verify-contract verify-contract -d ./deployments -n ethereum-testnet -u https://api.etherscan.io/v2/api?chainid=11155111 -k $ETHERSCAN_API'",
     "verify:etherscan:gateway:mainnet": "dotenv -e .env --  bash -c 'npx @layerzerolabs/verify-contract verify-contract -d ./deployments -n gateway-mainnet -u $BLOCKSCOUT_API'",

protocol-contracts/token/tasks/sendOFT.ts

@@ -34,7 +34,7 @@ task('lz:oft:send', 'Sends OFT tokens cross‐chain from EVM chains')
     .addParam('dstEid', 'Destination endpoint ID', undefined, types.int)
     .addParam('amount', 'Amount to send (human readable units, e.g. "1.5")', undefined, types.string)
     .addParam('to', 'Recipient address (20-byte hex for EVM)', undefined, types.string)
-    .addOptionalParam('oappConfig', 'Path to LayerZero config file', 'layerzero.config.testnet.ts', types.string)
+    .addOptionalParam('oappConfig', 'Path to LayerZero config file', 'layerzero.config.mainnet.ts', types.string)
     .addOptionalParam(
         'minAmount',
         'Minimum amount to receive in case of custom slippage or fees (human readable units, e.g. "1.5")',