@avalabs/bridge-unified 0.0.0-hello-world-20230824162317

package/.turbo/turbo-build.log

@@ -0,0 +1,22 @@
+
+> @avalabs/bridge-unified@1.0.1 build /home/runner/work/consumer-sdks/consumer-sdks/packages/bridge-unified
+> tsup
+
+CLI Building entry: ./src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v7.2.0
+CLI Using tsup config: /home/runner/work/consumer-sdks/consumer-sdks/packages/bridge-unified/tsup.config.ts
+CLI Target: es2021
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+CJS dist/index.cjs     496.00 B
+CJS dist/index.cjs.map 4.71 KB
+CJS ⚡️ Build success in 730ms
+ESM dist/index.js     484.00 B
+ESM dist/index.js.map 4.71 KB
+ESM ⚡️ Build success in 746ms
+DTS Build start
+DTS ⚡️ Build success in 8791ms
+DTS dist/index.d.cts 1.25 KB
+DTS dist/index.d.ts  1.25 KB

package/.turbo/turbo-lint.log

@@ -0,0 +1,4 @@
+
+> @avalabs/bridge-unified@1.0.1 lint /home/runner/work/consumer-sdks/consumer-sdks/packages/bridge-unified
+> eslint "src/**/*.ts"
+

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @avalabs/unified-bridge
+
+## 0.0.0-hello-world-20230824162317
+
+## 1.0.1
+
+### Patch Changes
+
+- a397015: Shared tsup config

package/README.md

@@ -0,0 +1,39 @@
+<p align="center">
+  <a href="https://subnets.avax.network/">
+      <picture>
+        <img alt="Avalanche Logo" src="https://images.ctfassets.net/gcj8jwzm6086/Gse8dqDEnJtT87RsbbEf4/1609daeb09e9db4a6617d44623028356/Avalanche_Horizontal_White.svg" width="auto" height="60">
+      </picture>
+  </a>
+</p>
+
+<p align="center">
+  A package for routing tokens from Chain A to Chain B, and unifying multiple bridge tools into one.
+<p>
+
+## 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.
+
+These are the bridges we currently support:
+
+- **Avalanche Bridge** - is capable of transferring a fixed list of tokens between Ethereum and Avalanche C-Chain. See the `@avalabs/bridge-avalanche` package.
+- **CCTP** - preferred for brdiging USDC between Ethereum and Avalanche C-Chain. See the `@avalabs/bridge-cctp` package.
+
+Future bridges we plan to support:
+
+- **Teleporter** - for moving tokens between subnets.
+- **Cross-Chain Transfer** - for moving tokens between the three Avalanche Primary Network chains (X-Chain, C-Chain, and P-Chain).
+
+## Getting Started
+
+```sh
+  npm install @avalabs/bridge-unified
+  # or
+  yarn add @avalabs/bridge-unified
+  # or
+  pnpm add @avalabs/bridge-unified
+```
+
+## How it works
+
+TODO: Explain details of this api.

package/dist/index.cjs

@@ -0,0 +1,7 @@
+'use strict';
+
+var o=class extends Error{constructor(s,a){super(s);this.code=a;this.code=a;}},e=class extends o{constructor(t="Not implemented"){super(t,5001),this.name="NotImplementedError";}};var n=async r=>{throw new e};var i=r=>{throw new e};var m=async({address:r,chainIds:t})=>{throw new e};var O=r=>({planBridgeJourney:i,executeBridgeJourneyStep:n,checkForPendingBridgeJourney:m});
+
+exports.createUnifiedBridgeService = O;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors/index.ts","../src/handlers/execute-bridge-journey-step.ts","../../../packages-internal/bridge-shared/src/constants/constants.ts","../src/handlers/plan-bridge-journey.ts","../src/handlers/check-for-pending-bridge-journey.ts","../src/unified-bridge-service.ts"],"names":["BridgeError","message","code","NotImplementedError","executeBridgeJourneyStep","_params","ETHEREUM_INFO","planBridgeJourney","checkForPendingBridgeJourney","_address","_chainIds","createUnifiedBridgeService","_options"],"mappings":"AAIA,IAAMA,EAAN,cAA0B,KAAM,CAC9B,YACEC,EACOC,EACP,CACA,MAAMD,CAAO,EAFN,UAAAC,EAGP,KAAK,KAAOA,CACd,CACF,EAEaC,EAAN,cAAkCH,CAAY,CACnD,YAAYC,EAAU,kBAAmB,CACvC,MAAMA,EAAS,IAAyB,EACxC,KAAK,KAAO,qBACd,CACF,ECZO,IAAMG,EAA2B,MAAOC,GAA4C,CAWzF,MAAM,IAAIF,CACZ,ECjBO,IAAMG,EAAgB,CAC3B,aACA,WAAY,IACZ,sBAAuB,GACvB,OAAQ,+DACV,ECcO,IAAMC,EAAqBF,GAA4D,CAE5F,MAAM,IAAIF,CACZ,ECjBO,IAAMK,EAA+B,MAAO,CACjD,QAASC,EACT,SAAUC,CACZ,IAGM,CAKJ,MAAM,IAAIP,CACZ,ECPO,IAAMQ,EAA8BC,IAClC,CACL,kBAAAL,EACA,yBAAAH,EACA,6BAAAI,CACF","sourcesContent":["export enum ErrorCode {\n  NOT_IMPLEMENTED = 5001,\n}\n\nclass BridgeError extends Error {\n  constructor(\n    message: string,\n    public code: ErrorCode,\n  ) {\n    super(message);\n    this.code = code;\n  }\n}\n\nexport class NotImplementedError extends BridgeError {\n  constructor(message = 'Not implemented') {\n    super(message, ErrorCode.NOT_IMPLEMENTED);\n    this.name = 'NotImplementedError';\n  }\n}\n","import { NotImplementedError } from '../errors';\n\ntype ExecuteBridgeJourneyStepParams = {\n  stepIndex: number;\n  journey: unknown;\n};\n\nexport const executeBridgeJourneyStep = async (_params: ExecuteBridgeJourneyStepParams) => {\n  /**\n   * 1. Validate the journey\n   * 3. Forward request along to the right bridge platform's package.\n   * 4. Return an observable that emits events when:\n   *    - User signs the transaction (returns the fromChain txId)\n   *    - Every block confirmation on fromChain\n   *    - fromChain tx completed, starting the toChain tx (returns the toChainTxId)\n   *    - Every block confirmation on toChain\n   *    - toChain tx completed\n   */\n  throw new NotImplementedError();\n};\n","import { ChainVm, type EvmChain } from '../types/chain';\n\nexport const ETHEREUM_INFO = {\n  vmType: ChainVm.EthereumVM,\n  evmChainId: '1',\n  confirmationThreshold: 96,\n  rpcUrl: 'https://mainnet.infura.io/v3/3d8a7c0b1b5a4b0e8b0b3b0f2b0b0b0b',\n} as const satisfies EvmChain;\n","import { NotImplementedError } from '../errors';\nimport { BridgePlatform, type Token } from '@internal/bridge-shared';\n\ntype GetBridgeRouterParams = {\n  fromChainId: string;\n  toChainId: string;\n  fromToken: Token;\n};\n\ntype BridgeTransactionStep = {\n  fromChainId: string;\n  toChainId: string;\n  bridgePlatform: BridgePlatform;\n  fromToken: Token;\n  toToken: Token;\n};\n\n/**\n * Returns a list of transaction steps needed to complete a bridge from chain A to B.\n * The response may include multiple steps if the bridge requires multiple hops.\n */\nexport const planBridgeJourney = (_params: GetBridgeRouterParams): BridgeTransactionStep[] => {\n  // Implement smart logic for determining how to get the token from chain A to B\n  throw new NotImplementedError();\n};\n","import type { Address } from 'viem';\nimport { NotImplementedError } from '../errors';\n\n/**\n * Checks for any currently pending bridge transactions.  Useful for dApps that want\n * to display the current tx's status after a page refresh.\n */\nexport const checkForPendingBridgeJourney = async ({\n  address: _address,\n  chainIds: _chainIds,\n}: {\n  address: Address;\n  chainIds: string[];\n}) => {\n  /**\n   * 1. If wallet is Core, request current bridge journey.  Otherwise, check glacier to see if the provided wallet has bridge tx in the past 100 transactions on the provided chains.\n   * 3. Returns an array of txIds for all pending transactions\n   */\n  throw new NotImplementedError();\n};\n","import { executeBridgeJourneyStep } from './handlers/execute-bridge-journey-step';\nimport { planBridgeJourney } from './handlers/plan-bridge-journey';\n\nimport type { Environment, MaybePromise, NativeToken } from '@internal/bridge-shared';\nimport { checkForPendingBridgeJourney } from './handlers/check-for-pending-bridge-journey';\n\nexport type BridgeServiceConfig = {\n  environment: `${Environment}`;\n  getChainNativeAsset: ({ evmChainId }: { evmChainId: string }) => MaybePromise<NativeToken>;\n  getChainErc20Asset: ({ evmChainId, address }: { evmChainId: string; address: string }) => MaybePromise<NativeToken>;\n};\n\nexport const createUnifiedBridgeService = (_options: BridgeServiceConfig) => {\n  return {\n    planBridgeJourney,\n    executeBridgeJourneyStep,\n    checkForPendingBridgeJourney,\n  };\n};\n"]}

package/dist/index.d.cts

@@ -0,0 +1,36 @@
+import * as _internal_bridge_shared from '@internal/bridge-shared';
+import { Environment, MaybePromise, NativeToken } from '@internal/bridge-shared';
+
+type BridgeServiceConfig = {
+    environment: `${Environment}`;
+    getChainNativeAsset: ({ evmChainId }: {
+        evmChainId: string;
+    }) => MaybePromise<NativeToken>;
+    getChainErc20Asset: ({ evmChainId, address }: {
+        evmChainId: string;
+        address: string;
+    }) => MaybePromise<NativeToken>;
+};
+declare const createUnifiedBridgeService: (_options: BridgeServiceConfig) => {
+    planBridgeJourney: (_params: {
+        fromChainId: string;
+        toChainId: string;
+        fromToken: _internal_bridge_shared.Token;
+    }) => {
+        fromChainId: string;
+        toChainId: string;
+        bridgePlatform: _internal_bridge_shared.BridgePlatform;
+        fromToken: _internal_bridge_shared.Token;
+        toToken: _internal_bridge_shared.Token;
+    }[];
+    executeBridgeJourneyStep: (_params: {
+        stepIndex: number;
+        journey: unknown;
+    }) => Promise<never>;
+    checkForPendingBridgeJourney: ({ address: _address, chainIds: _chainIds, }: {
+        address: `0x${string}`;
+        chainIds: string[];
+    }) => Promise<never>;
+};
+
+export { BridgeServiceConfig, createUnifiedBridgeService };

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+import * as _internal_bridge_shared from '@internal/bridge-shared';
+import { Environment, MaybePromise, NativeToken } from '@internal/bridge-shared';
+
+type BridgeServiceConfig = {
+    environment: `${Environment}`;
+    getChainNativeAsset: ({ evmChainId }: {
+        evmChainId: string;
+    }) => MaybePromise<NativeToken>;
+    getChainErc20Asset: ({ evmChainId, address }: {
+        evmChainId: string;
+        address: string;
+    }) => MaybePromise<NativeToken>;
+};
+declare const createUnifiedBridgeService: (_options: BridgeServiceConfig) => {
+    planBridgeJourney: (_params: {
+        fromChainId: string;
+        toChainId: string;
+        fromToken: _internal_bridge_shared.Token;
+    }) => {
+        fromChainId: string;
+        toChainId: string;
+        bridgePlatform: _internal_bridge_shared.BridgePlatform;
+        fromToken: _internal_bridge_shared.Token;
+        toToken: _internal_bridge_shared.Token;
+    }[];
+    executeBridgeJourneyStep: (_params: {
+        stepIndex: number;
+        journey: unknown;
+    }) => Promise<never>;
+    checkForPendingBridgeJourney: ({ address: _address, chainIds: _chainIds, }: {
+        address: `0x${string}`;
+        chainIds: string[];
+    }) => Promise<never>;
+};
+
+export { BridgeServiceConfig, createUnifiedBridgeService };

package/dist/index.js

@@ -0,0 +1,5 @@
+var o=class extends Error{constructor(s,a){super(s);this.code=a;this.code=a;}},e=class extends o{constructor(t="Not implemented"){super(t,5001),this.name="NotImplementedError";}};var n=async r=>{throw new e};var i=r=>{throw new e};var m=async({address:r,chainIds:t})=>{throw new e};var O=r=>({planBridgeJourney:i,executeBridgeJourneyStep:n,checkForPendingBridgeJourney:m});
+
+export { O as createUnifiedBridgeService };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors/index.ts","../src/handlers/execute-bridge-journey-step.ts","../../../packages-internal/bridge-shared/src/constants/constants.ts","../src/handlers/plan-bridge-journey.ts","../src/handlers/check-for-pending-bridge-journey.ts","../src/unified-bridge-service.ts"],"names":["BridgeError","message","code","NotImplementedError","executeBridgeJourneyStep","_params","ETHEREUM_INFO","planBridgeJourney","checkForPendingBridgeJourney","_address","_chainIds","createUnifiedBridgeService","_options"],"mappings":"AAIA,IAAMA,EAAN,cAA0B,KAAM,CAC9B,YACEC,EACOC,EACP,CACA,MAAMD,CAAO,EAFN,UAAAC,EAGP,KAAK,KAAOA,CACd,CACF,EAEaC,EAAN,cAAkCH,CAAY,CACnD,YAAYC,EAAU,kBAAmB,CACvC,MAAMA,EAAS,IAAyB,EACxC,KAAK,KAAO,qBACd,CACF,ECZO,IAAMG,EAA2B,MAAOC,GAA4C,CAWzF,MAAM,IAAIF,CACZ,ECjBO,IAAMG,EAAgB,CAC3B,aACA,WAAY,IACZ,sBAAuB,GACvB,OAAQ,+DACV,ECcO,IAAMC,EAAqBF,GAA4D,CAE5F,MAAM,IAAIF,CACZ,ECjBO,IAAMK,EAA+B,MAAO,CACjD,QAASC,EACT,SAAUC,CACZ,IAGM,CAKJ,MAAM,IAAIP,CACZ,ECPO,IAAMQ,EAA8BC,IAClC,CACL,kBAAAL,EACA,yBAAAH,EACA,6BAAAI,CACF","sourcesContent":["export enum ErrorCode {\n  NOT_IMPLEMENTED = 5001,\n}\n\nclass BridgeError extends Error {\n  constructor(\n    message: string,\n    public code: ErrorCode,\n  ) {\n    super(message);\n    this.code = code;\n  }\n}\n\nexport class NotImplementedError extends BridgeError {\n  constructor(message = 'Not implemented') {\n    super(message, ErrorCode.NOT_IMPLEMENTED);\n    this.name = 'NotImplementedError';\n  }\n}\n","import { NotImplementedError } from '../errors';\n\ntype ExecuteBridgeJourneyStepParams = {\n  stepIndex: number;\n  journey: unknown;\n};\n\nexport const executeBridgeJourneyStep = async (_params: ExecuteBridgeJourneyStepParams) => {\n  /**\n   * 1. Validate the journey\n   * 3. Forward request along to the right bridge platform's package.\n   * 4. Return an observable that emits events when:\n   *    - User signs the transaction (returns the fromChain txId)\n   *    - Every block confirmation on fromChain\n   *    - fromChain tx completed, starting the toChain tx (returns the toChainTxId)\n   *    - Every block confirmation on toChain\n   *    - toChain tx completed\n   */\n  throw new NotImplementedError();\n};\n","import { ChainVm, type EvmChain } from '../types/chain';\n\nexport const ETHEREUM_INFO = {\n  vmType: ChainVm.EthereumVM,\n  evmChainId: '1',\n  confirmationThreshold: 96,\n  rpcUrl: 'https://mainnet.infura.io/v3/3d8a7c0b1b5a4b0e8b0b3b0f2b0b0b0b',\n} as const satisfies EvmChain;\n","import { NotImplementedError } from '../errors';\nimport { BridgePlatform, type Token } from '@internal/bridge-shared';\n\ntype GetBridgeRouterParams = {\n  fromChainId: string;\n  toChainId: string;\n  fromToken: Token;\n};\n\ntype BridgeTransactionStep = {\n  fromChainId: string;\n  toChainId: string;\n  bridgePlatform: BridgePlatform;\n  fromToken: Token;\n  toToken: Token;\n};\n\n/**\n * Returns a list of transaction steps needed to complete a bridge from chain A to B.\n * The response may include multiple steps if the bridge requires multiple hops.\n */\nexport const planBridgeJourney = (_params: GetBridgeRouterParams): BridgeTransactionStep[] => {\n  // Implement smart logic for determining how to get the token from chain A to B\n  throw new NotImplementedError();\n};\n","import type { Address } from 'viem';\nimport { NotImplementedError } from '../errors';\n\n/**\n * Checks for any currently pending bridge transactions.  Useful for dApps that want\n * to display the current tx's status after a page refresh.\n */\nexport const checkForPendingBridgeJourney = async ({\n  address: _address,\n  chainIds: _chainIds,\n}: {\n  address: Address;\n  chainIds: string[];\n}) => {\n  /**\n   * 1. If wallet is Core, request current bridge journey.  Otherwise, check glacier to see if the provided wallet has bridge tx in the past 100 transactions on the provided chains.\n   * 3. Returns an array of txIds for all pending transactions\n   */\n  throw new NotImplementedError();\n};\n","import { executeBridgeJourneyStep } from './handlers/execute-bridge-journey-step';\nimport { planBridgeJourney } from './handlers/plan-bridge-journey';\n\nimport type { Environment, MaybePromise, NativeToken } from '@internal/bridge-shared';\nimport { checkForPendingBridgeJourney } from './handlers/check-for-pending-bridge-journey';\n\nexport type BridgeServiceConfig = {\n  environment: `${Environment}`;\n  getChainNativeAsset: ({ evmChainId }: { evmChainId: string }) => MaybePromise<NativeToken>;\n  getChainErc20Asset: ({ evmChainId, address }: { evmChainId: string; address: string }) => MaybePromise<NativeToken>;\n};\n\nexport const createUnifiedBridgeService = (_options: BridgeServiceConfig) => {\n  return {\n    planBridgeJourney,\n    executeBridgeJourneyStep,\n    checkForPendingBridgeJourney,\n  };\n};\n"]}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@avalabs/bridge-unified",
+  "version": "0.0.0-hello-world-20230824162317",
+  "main": "dist/index.js",
+  "type": "module",
+  "dependencies": {
+    "aptos": "1.17.0",
+    "lodash-es": "4.17.21",
+    "viem": "1.6.0"
+  },
+  "devDependencies": {
+    "tsup": "7.2.0",
+    "type-fest": "4.2.0",
+    "eslint-config-custom": "0.0.0-hello-world-20230824162317",
+    "@internal/bridge-shared": "0.0.0-hello-world-20230824162317",
+    "@internal/tsup-config": "0.0.0-hello-world-20230824162317"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "eslint \"src/**/*.ts\""
+  }
+}

package/src/errors/index.ts

@@ -0,0 +1,20 @@
+export enum ErrorCode {
+  NOT_IMPLEMENTED = 5001,
+}
+
+class BridgeError extends Error {
+  constructor(
+    message: string,
+    public code: ErrorCode,
+  ) {
+    super(message);
+    this.code = code;
+  }
+}
+
+export class NotImplementedError extends BridgeError {
+  constructor(message = 'Not implemented') {
+    super(message, ErrorCode.NOT_IMPLEMENTED);
+    this.name = 'NotImplementedError';
+  }
+}

package/src/handlers/check-for-pending-bridge-journey.ts

@@ -0,0 +1,20 @@
+import type { Address } from 'viem';
+import { NotImplementedError } from '../errors';
+
+/**
+ * Checks for any currently pending bridge transactions.  Useful for dApps that want
+ * to display the current tx's status after a page refresh.
+ */
+export const checkForPendingBridgeJourney = async ({
+  address: _address,
+  chainIds: _chainIds,
+}: {
+  address: Address;
+  chainIds: string[];
+}) => {
+  /**
+   * 1. If wallet is Core, request current bridge journey.  Otherwise, check glacier to see if the provided wallet has bridge tx in the past 100 transactions on the provided chains.
+   * 3. Returns an array of txIds for all pending transactions
+   */
+  throw new NotImplementedError();
+};

package/src/handlers/execute-bridge-journey-step.ts

@@ -0,0 +1,20 @@
+import { NotImplementedError } from '../errors';
+
+type ExecuteBridgeJourneyStepParams = {
+  stepIndex: number;
+  journey: unknown;
+};
+
+export const executeBridgeJourneyStep = async (_params: ExecuteBridgeJourneyStepParams) => {
+  /**
+   * 1. Validate the journey
+   * 3. Forward request along to the right bridge platform's package.
+   * 4. Return an observable that emits events when:
+   *    - User signs the transaction (returns the fromChain txId)
+   *    - Every block confirmation on fromChain
+   *    - fromChain tx completed, starting the toChain tx (returns the toChainTxId)
+   *    - Every block confirmation on toChain
+   *    - toChain tx completed
+   */
+  throw new NotImplementedError();
+};

package/src/handlers/plan-bridge-journey.ts

@@ -0,0 +1,25 @@
+import { NotImplementedError } from '../errors';
+import { BridgePlatform, type Token } from '@internal/bridge-shared';
+
+type GetBridgeRouterParams = {
+  fromChainId: string;
+  toChainId: string;
+  fromToken: Token;
+};
+
+type BridgeTransactionStep = {
+  fromChainId: string;
+  toChainId: string;
+  bridgePlatform: BridgePlatform;
+  fromToken: Token;
+  toToken: Token;
+};
+
+/**
+ * Returns a list of transaction steps needed to complete a bridge from chain A to B.
+ * The response may include multiple steps if the bridge requires multiple hops.
+ */
+export const planBridgeJourney = (_params: GetBridgeRouterParams): BridgeTransactionStep[] => {
+  // Implement smart logic for determining how to get the token from chain A to B
+  throw new NotImplementedError();
+};

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './unified-bridge-service';
+// Hello world!

package/src/unified-bridge-service.ts

@@ -0,0 +1,19 @@
+import { executeBridgeJourneyStep } from './handlers/execute-bridge-journey-step';
+import { planBridgeJourney } from './handlers/plan-bridge-journey';
+
+import type { Environment, MaybePromise, NativeToken } from '@internal/bridge-shared';
+import { checkForPendingBridgeJourney } from './handlers/check-for-pending-bridge-journey';
+
+export type BridgeServiceConfig = {
+  environment: `${Environment}`;
+  getChainNativeAsset: ({ evmChainId }: { evmChainId: string }) => MaybePromise<NativeToken>;
+  getChainErc20Asset: ({ evmChainId, address }: { evmChainId: string; address: string }) => MaybePromise<NativeToken>;
+};
+
+export const createUnifiedBridgeService = (_options: BridgeServiceConfig) => {
+  return {
+    planBridgeJourney,
+    executeBridgeJourneyStep,
+    checkForPendingBridgeJourney,
+  };
+};

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@internal/tsconfig/tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "incremental": false // Need to turn off because of tsup dts
+  },
+  "include": ["src", "../shared/src/types"]
+}

package/tsup.config.ts

@@ -0,0 +1,4 @@
+import { defineConfig } from 'tsup';
+import { baseConfig } from '@internal/tsup-config';
+
+export default defineConfig(baseConfig);