@avalabs/bridge-unified 4.4.2 → 4.5.0

package/README.md

@@ -10,6 +10,10 @@
   A package for routing tokens from Chain A to Chain B, and unifying multiple bridge tools into one.
 <p>
 
+> [!IMPORTANT]
+> This package is **deprecated** and is no longer the recommended SDK for new integrations.
+> Please migrate to **@avalabs/fusion-sdk**.
+
 ## What is this?
 
 The bridging ecosystem is complex. There are often multiple tools that can be used to bridge tokens from one chain to another, and sometimes to get a token from chain A to C you need to use multiple bridging tools and route through chain B first. This package simplifies that process by creating the _Unified Bridge API_, a standard interface for bridging tokens from one chain to another without having to worry about the underlying tools or the underlying intermediary chains.

package/dist/index.d.cts

@@ -183,23 +183,23 @@ declare enum ErrorCode {
     NOTARIZATION_FAILED = 5006
 }
 declare enum ErrorReason {
-    ASSET_NOT_SUPPORTED = "ASSET_NOT_SUPPORTED",
-    CHAIN_NOT_SUPPORTED = "CHAIN_NOT_SUPPORTED",
-    CONFIG_NOT_AVAILABLE = "CONFIG_NOT_AVAILABLE",
-    CONFIRMATION_COUNT_UNKNOWN = "CONFIRMATION_COUNT_UNKNOWN",
-    ENVIRONMENT_NOT_SUPPORTED = "ENVIRONMENT_NOT_SUPPORTED",
-    IDENTICAL_CHAINS_PROVIDED = "IDENTICAL_CHAINS_PROVIDED",
-    INCORRECT_ADDRESS_PROVIDED = "INCORRECT_ADDRESS_PROVIDED",
-    INCORRECT_AMOUNT_PROVIDED = "INCORRECT_AMOUNT_PROVIDED",
-    INCORRECT_HASH_PROVIDED = "INCORRECT_HASH_PROVIDED",
-    INCORRECT_PROVIDER_PROVIDED = "INCORRECT_PROVIDER_PROVIDED",
-    INCORRECT_SIGNER_PROVIDED = "INCORRECT_SIGNER_PROVIDED",
-    INCORRECT_TXHASH_PROVIDED = "INCORRECT_TXHASH_PROVIDED",
-    INVALID_PARAMS = "INVALID_PARAMS",
-    UNKNOWN = "UNKNOWN",
-    VULNERABLE_TOKEN_APPROVAL_ADDRESS = "VULNERABLE_TOKEN_APPROVAL_ADDRESS",
-    WARDEN_CONFIG_MISMATCH = "WARDEN_CONFIG_MISMATCH",
-    WARDEN_CONFIG_MISSING_NETWORK = "WARDEN_CONFIG_MISSING_NETWORK",
+    ASSET_NOT_SUPPORTED = "ASSET_NOT_SUPPORTED",// the provided asset is not supported by the bridge
+    CHAIN_NOT_SUPPORTED = "CHAIN_NOT_SUPPORTED",// the provided source or target chain is not supported by the bridge
+    CONFIG_NOT_AVAILABLE = "CONFIG_NOT_AVAILABLE",// error while fetching or parsing the config
+    CONFIRMATION_COUNT_UNKNOWN = "CONFIRMATION_COUNT_UNKNOWN",// required confirmation count of the source or target chain is unknown
+    ENVIRONMENT_NOT_SUPPORTED = "ENVIRONMENT_NOT_SUPPORTED",// bridge does not support specified environment
+    IDENTICAL_CHAINS_PROVIDED = "IDENTICAL_CHAINS_PROVIDED",// provided source and target chains are the same
+    INCORRECT_ADDRESS_PROVIDED = "INCORRECT_ADDRESS_PROVIDED",// the sender or recipient address is incorrect
+    INCORRECT_AMOUNT_PROVIDED = "INCORRECT_AMOUNT_PROVIDED",// the transfer amount is incorrect (e.g.: lesser than or equal to zero)
+    INCORRECT_HASH_PROVIDED = "INCORRECT_HASH_PROVIDED",// the transaction is not hex
+    INCORRECT_PROVIDER_PROVIDED = "INCORRECT_PROVIDER_PROVIDED",// The provided provider is incorrect type (Provider VS BitcoinProvider)
+    INCORRECT_SIGNER_PROVIDED = "INCORRECT_SIGNER_PROVIDED",// The provided signer is incorrect type
+    INCORRECT_TXHASH_PROVIDED = "INCORRECT_TXHASH_PROVIDED",// the sourceTxHash or targetTxHash is incorrect
+    INVALID_PARAMS = "INVALID_PARAMS",// generic error with the params
+    UNKNOWN = "UNKNOWN",// generic, not specified error
+    VULNERABLE_TOKEN_APPROVAL_ADDRESS = "VULNERABLE_TOKEN_APPROVAL_ADDRESS",// error when the address has token approvals for addresses involved in the multichain incident
+    WARDEN_CONFIG_MISMATCH = "WARDEN_CONFIG_MISMATCH",// error when warden config was not found or it is over the mismatch threshold
+    WARDEN_CONFIG_MISSING_NETWORK = "WARDEN_CONFIG_MISSING_NETWORK",// fetched warden config does not contain network IDs
     ADDRESS_IS_BLOCKED = "ADDRESS_IS_BLOCKED"
 }
 

package/dist/index.d.ts

@@ -183,23 +183,23 @@ declare enum ErrorCode {
     NOTARIZATION_FAILED = 5006
 }
 declare enum ErrorReason {
-    ASSET_NOT_SUPPORTED = "ASSET_NOT_SUPPORTED",
-    CHAIN_NOT_SUPPORTED = "CHAIN_NOT_SUPPORTED",
-    CONFIG_NOT_AVAILABLE = "CONFIG_NOT_AVAILABLE",
-    CONFIRMATION_COUNT_UNKNOWN = "CONFIRMATION_COUNT_UNKNOWN",
-    ENVIRONMENT_NOT_SUPPORTED = "ENVIRONMENT_NOT_SUPPORTED",
-    IDENTICAL_CHAINS_PROVIDED = "IDENTICAL_CHAINS_PROVIDED",
-    INCORRECT_ADDRESS_PROVIDED = "INCORRECT_ADDRESS_PROVIDED",
-    INCORRECT_AMOUNT_PROVIDED = "INCORRECT_AMOUNT_PROVIDED",
-    INCORRECT_HASH_PROVIDED = "INCORRECT_HASH_PROVIDED",
-    INCORRECT_PROVIDER_PROVIDED = "INCORRECT_PROVIDER_PROVIDED",
-    INCORRECT_SIGNER_PROVIDED = "INCORRECT_SIGNER_PROVIDED",
-    INCORRECT_TXHASH_PROVIDED = "INCORRECT_TXHASH_PROVIDED",
-    INVALID_PARAMS = "INVALID_PARAMS",
-    UNKNOWN = "UNKNOWN",
-    VULNERABLE_TOKEN_APPROVAL_ADDRESS = "VULNERABLE_TOKEN_APPROVAL_ADDRESS",
-    WARDEN_CONFIG_MISMATCH = "WARDEN_CONFIG_MISMATCH",
-    WARDEN_CONFIG_MISSING_NETWORK = "WARDEN_CONFIG_MISSING_NETWORK",
+    ASSET_NOT_SUPPORTED = "ASSET_NOT_SUPPORTED",// the provided asset is not supported by the bridge
+    CHAIN_NOT_SUPPORTED = "CHAIN_NOT_SUPPORTED",// the provided source or target chain is not supported by the bridge
+    CONFIG_NOT_AVAILABLE = "CONFIG_NOT_AVAILABLE",// error while fetching or parsing the config
+    CONFIRMATION_COUNT_UNKNOWN = "CONFIRMATION_COUNT_UNKNOWN",// required confirmation count of the source or target chain is unknown
+    ENVIRONMENT_NOT_SUPPORTED = "ENVIRONMENT_NOT_SUPPORTED",// bridge does not support specified environment
+    IDENTICAL_CHAINS_PROVIDED = "IDENTICAL_CHAINS_PROVIDED",// provided source and target chains are the same
+    INCORRECT_ADDRESS_PROVIDED = "INCORRECT_ADDRESS_PROVIDED",// the sender or recipient address is incorrect
+    INCORRECT_AMOUNT_PROVIDED = "INCORRECT_AMOUNT_PROVIDED",// the transfer amount is incorrect (e.g.: lesser than or equal to zero)
+    INCORRECT_HASH_PROVIDED = "INCORRECT_HASH_PROVIDED",// the transaction is not hex
+    INCORRECT_PROVIDER_PROVIDED = "INCORRECT_PROVIDER_PROVIDED",// The provided provider is incorrect type (Provider VS BitcoinProvider)
+    INCORRECT_SIGNER_PROVIDED = "INCORRECT_SIGNER_PROVIDED",// The provided signer is incorrect type
+    INCORRECT_TXHASH_PROVIDED = "INCORRECT_TXHASH_PROVIDED",// the sourceTxHash or targetTxHash is incorrect
+    INVALID_PARAMS = "INVALID_PARAMS",// generic error with the params
+    UNKNOWN = "UNKNOWN",// generic, not specified error
+    VULNERABLE_TOKEN_APPROVAL_ADDRESS = "VULNERABLE_TOKEN_APPROVAL_ADDRESS",// error when the address has token approvals for addresses involved in the multichain incident
+    WARDEN_CONFIG_MISMATCH = "WARDEN_CONFIG_MISMATCH",// error when warden config was not found or it is over the mismatch threshold
+    WARDEN_CONFIG_MISSING_NETWORK = "WARDEN_CONFIG_MISSING_NETWORK",// fetched warden config does not contain network IDs
     ADDRESS_IS_BLOCKED = "ADDRESS_IS_BLOCKED"
 }
 

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@avalabs/bridge-unified",
   "license": "Limited Ecosystem License",
-  "version": "4.4.2",
+  "version": "4.5.0",
+  "deprecated": "This package is deprecated. Please use @avalabs/fusion-sdk instead.",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -33,9 +34,9 @@
   },
   "scripts": {
     "build": "tsup",
-    "build:watch": "tsup --watch",
-    "lint": "eslint \"src/**/*.ts\"",
-    "test": "jest",
-    "test:watch": "jest --watch"
+    "deprecated:build:watch": "tsup --watch",
+    "deprecated:lint": "eslint \"src/**/*.ts\"",
+    "deprecated:test": "jest",
+    "deprecated:test:watch": "jest --watch"
   }
 }