@avalabs/bridge-unified 0.0.0-license-20240801163452 → 0.0.0-tmp-lombard-sdk-integration-20251210211743

package/README.md

@@ -16,7 +16,7 @@ The bridging ecosystem is complex. There are often multiple tools that can be us
 
 These are the bridges we currently support:
 
-- **CCTP** - preferred for brdiging USDC between Ethereum and Avalanche C-Chain. See the `bridges/cctp` folder.
+- **CCTP** - preferred for bridging USDC between Ethereum and Avalanche C-Chain. See the `bridges/cctp` folder.
 
 Future bridges we plan to support:
 
@@ -40,8 +40,62 @@ Future bridges we plan to support:
 import { createUnifiedBridgeService, getEnabledBridgeServices, Environment, BridgeTransfer } from '@avalabs/bridge-unified';
 
 const environment = Environment.TEST;
+const evmSigner: EvmSigner = {
+  sign: async ({ data, from, to, value }) => {
+    return await window.ethereum.request({
+      method: 'eth_sendTransaction,',
+      params:{
+        account: from,
+        data: data ?? undefined,
+        from,
+        to: to ?? null,
+        chain: undefined,
+        value
+      }
+    });
+  },
+};
+
+const btcSigner: BtcSigner = {
+  sign: async ({ inputs, outputs }) => {
+    return await window.ethereum.request({
+      method: 'bitcoin_signTransaction',
+      params: { inputs, outputs },
+    });
+  },
+};
+
+const cctpInitializer: EvmBridgeInitializer = {
+  type: BridgeType.CCTP,
+  signer: evmSigner,
+};
+const icttErc20Initializer: EvmBridgeInitializer = {
+  type: BridgeType.ICTT_ERC20_ERC20,
+  signer: evmSigner,
+};
+const avalancheEvmInitializer: EvmBridgeInitializer = {
+  type: BridgeType.AVALANCHE_EVM,
+  signer: evmSigner,
+};
+const avalancheBtcInitializer: AvaToBtcBridgeInitializer = {
+  type: BridgeType.AVALANCHE_AVA_BTC,
+  signer: evmSigner,
+  bitcoinFunctions: bitcoinProvider as BitcoinFunctions,
+};
+const bitcoinAvaInitializer: BtcToAvaBridgeInitializer = {
+  type: BridgeType.AVALANCHE_BTC_AVA,
+  signer: btcSigner,
+  bitcoinFunctions: bitcoinProvider as BitcoinFunctions,
+};
+
 // use all available bridges
-const disabledBridgeTypes = []
+const enabledBridgeInitializers: BridgeInitializer[] = [
+  cctpInitializer,
+  icttErc20Initializer,
+  avalancheEvmInitializer,
+  avalancheBtcInitializer,
+  bitcoinAvaInitializer,
+]
 
 // fetch all available bridge services
 const enabledBridgeServices = await getEnabledBridgeServices(environment, disabledBridgeTypes);
@@ -69,7 +123,7 @@ const updateListener = (transfer: BridgeTransfer) => {
 // start tracking the transfer's state. whenever the state changes, it will call the provided `updateListener`
 const { cancel, result } = await unifiedService.trackTransfer({bridgeTransfer, updateListener, ...})
 
-// immediatelly stops tracking and rejects the tracker's promise
+// immediately stops tracking and rejects the tracker's promise
 // cancel()
 
 // wait for the transfer to finish and get its final state
@@ -78,9 +132,9 @@ const finalizedBridgeTransfer = await result
 
 ## API
 
-### getEnabledBridgeServices(environment, disabledBridgeTypes);
+### getEnabledBridgeServices(environment, enabledBridgeInitializers);
 
-Type: `(environment: Environment, disabledBridgeTypes: BridgeType[]) => Promise<BridgeServicesMap>`
+Type: `(environment: Environment, enabledBridgeInitializers: BridgeInitializer[]) => Promise<BridgeServicesMap>`
 
 Returns all available bridge services for a given environment (excluding disabledBridgeTypes). Any bridge service which fails to initialize will be absent from this returned value.
 
@@ -90,11 +144,11 @@ Type: `Environment`
 
 Defines if the bridge service should use `testnet` or `mainnet`.
 
-#### disabledBridgeTypes
+#### enabledBridgeInitializers
 
-Type: `BridgeType[]`
+Type: `BridgeInitializer[]`
 
-Disables the integration of the provided `BridgeType`s.
+Enables the integration of the provided `BridgeType`s based on each `BridgeInitializer`.
 
 #### enabledBridgeServices
 
@@ -141,20 +195,34 @@ Type: `(params: TransferParams) => Promise<bigint>`
 
 Estimates the gas cost of a specific transfer.
 
-#### canTransferAsset
+#### getMinimumTransferAmount
 
-Type: `(asset: BridgeAsset, targetChainId: string) => boolean` 
+Type: `(params: FeeParams) => Promise<bigint>`
 
-Indicates whether the unified bridge supports transferring a specific asset to a specific target chain.
+Calculates and returns the minimum transfer amount for a given bridge transfer.
 
 #### transferAsset
 
 Type: `(params: TransferParams) => Promise<BridgeTransfer>`
 
 Starts a new bridge transfer, executing every required step in a single call.
-Transactions signing is done by either the provided `sourceProvider` or a custom `sign` callback. Clients using their custom `sign` implementation may use their own solution or the default `dispatch` callback to submit the transaction to the network.
+Transactions signing is done by a custom `sign` callback. The custom `sign` implementation may use their own solution or the default `dispatch` callback to submit the transaction to the network.
 Returns a `BridgeTransfer` containing all the (known) initial values such as: environment, addresses, amount, fee, transaction hash, required and actual block confirmation counts, etc.
 
+Notes about TransferParams:
+fromAddress: The address where the bridge amount is from.
+
+toAddress: The address where the bridge amount is going to end up.
+
+For example, A user has an account with AddressC and AddressBtc.
+The user wants to bridge some funds from Ethereum to Avalanche using the same address. FromAddress and toAddress will be both AddressC.
+
+The user wants to bridge some funds from Bitcoin to Avalanche.
+FromAddress is AddressBtc and toAddress is AddressC.
+
+Some bridges allows you to bridge the tokens to a different address. (CCTP and ICTT ERC20).
+In this case, fromAddress is the address of the token is getting bridged from. And toAddress is the address which is going to receive the bridged funds.
+
 #### trackTransfer
 
 Type: `(params: TrackingParams) => ({cancel, result})`
@@ -165,7 +233,7 @@ Tracks the given `BridgeTransfer`'s progress and invokes the provided listener c
 
 Type: `() => void`
 
-If it's still pending, rejects the tracker's promise (`result`) immediatelly and breaks its loop under the hood.
+If it's still pending, rejects the tracker's promise (`result`) immediately and breaks its loop under the hood.
 
 ###### result