@avalabs/bridge-unified 1.0.1

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     473.00 B
+CJS dist/index.cjs.map 3.67 KB
+CJS ⚡️ Build success in 464ms
+ESM dist/index.js     459.00 B
+ESM dist/index.js.map 3.67 KB
+ESM ⚡️ Build success in 464ms
+DTS Build start
+DTS ⚡️ Build success in 7247ms
+DTS dist/index.d.cts 1.23 KB
+DTS dist/index.d.ts  1.23 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,7 @@
+# @avalabs/unified-bridge
+
+## 1.0.1
+
+### Patch Changes
+
+- a397015: Shared tsup config

package/README.md

@@ -0,0 +1,92 @@
+<br/>
+
+<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">
+  Parse arbitrary VM data for display in the Avalanche Subnet Explorer.
+<p>
+
+<br>
+
+## Supported VMs
+
+- MoveVM
+
+## Getting Started
+
+```sh
+  npm install @avalabs/vm-parser
+  # or
+  yarn add @avalabs/vm-parser
+  # or
+  pnpm add @avalabs/vm-parser
+```
+
+## Overview
+
+```tsx
+// 1. Import modules.
+import { createMoveVmConfig, DataDisplayFormat } from '@avalabs/vm-parser';
+import {
+  Card,
+  CardTitle,
+  CardContent,
+  Chip,
+  TableContainer,
+  Table,
+  TableBody,
+  TableRow,
+  TableCell,
+} from 'some-ui-library';
+import useSWR from 'swr'; // Or your preferred data fetching library
+
+const MOVE_RPC_URL =
+  'https://seed-node1-rpc.movementlabs.xyz/ext/bc/2gLyawqthdiyrJktJmdnDAb1XVc6xwJXU6iJKu3Uwj21F2mXAK/rpc';
+// 2. Set up your config
+const moveVmConfig = createMoveVmConfig(MOVE_RPC_URL);
+
+const TransactionDetails = ({ txId }: { txId: string }) => {
+  // 2. Get the data from the config's `getPageData` function
+  const { data } = useSWR(txId, moveVmConfig.transactionDetails.getPageData);
+
+  // 3. Display the data dynamically based on the config's displayFormat.
+  return (
+    <>
+      {moveVmConfig.displayFormat.map(({ sectionTitle, fields }) => (
+        <Card>
+          <CardTitle>{sectionTitle}</CardTitle>
+          <CardContent>
+            <TableContainer>
+              <Table>
+                <TableBody>
+                  {fields.map(({ name, displayValue, displayFormat }) => (
+                    <TableRow>
+                      <TableCell>{field.name}</TableCell>
+                      <TableCell>
+                        /* Display the field differently depending on its display formatter */
+                        {field.displayFormat === DataDisplayFormat.CHIP ? (
+                          <Chip>{field.displayValue}</Chip>
+                        ) : field.displayFormat === DataDisplayFormat.DATETIME ? (
+                          new Date(field.displayValue).toLocaleString()
+                        ) : (
+                          fields.displayValue
+                        )}
+                      </TableCell>
+                    </TableRow>
+                  ))}
+                </TableBody>
+              </Table>
+            </TableContainer>
+          </CardContent>
+        </Card>
+      ))}
+    </>
+  );
+};
+```

package/dist/index.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+require('viem');
+
+var t=class extends Error{constructor(a,m){super(a);this.code=m;this.code=m;}},e=class extends t{constructor(o="Not implemented"){super(o,5001),this.name="NotImplementedError";}};var n=async r=>{throw new e};var i=r=>{throw new e};var s=()=>{};var v=r=>({getBridgeRouter:i,submitBridgeTransactionStep:n,submitAndWatchBridgeTransaction:s});
+
+exports.createBridgeService = v;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/handlers/submit-bridge-transaction-step.ts","../src/errors/index.ts","../src/handlers/get-bridge-router.ts","../src/handlers/submit-and-watch-bridge-transaction.ts","../src/bridge-service.ts"],"names":["BridgeError","message","code","NotImplementedError","submitBridgeTransactionStep","_params","getBridgeRouter","submitAndWatchBridgeTransaction","createBridgeService","_options"],"mappings":"AAAA,MAA6B,OCI7B,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,EDPO,IAAMG,EAA8B,MAAOC,GAA2C,CAQ3F,MAAM,IAAIF,CACZ,EEAO,IAAMG,EAAmBD,GAA4D,CAE1F,MAAM,IAAIF,CACZ,ECxBO,IAAMI,EAAkC,IAAM,CAAC,ECW/C,IAAMC,EAAuBC,IAC3B,CACL,gBAAAH,EACA,4BAAAF,EACA,gCAAAG,CACF","sourcesContent":["import { type Address } from 'viem';\nimport type { Token } from '@internal/bridge-shared';\nimport { NotImplementedError } from '../errors';\n\ntype SubmitBridgeTransactionParams = {\n  fromChainId: string;\n  toChainId: string;\n  fromAddress: Address;\n  token: Token;\n  amount: string;\n};\n\nexport const submitBridgeTransactionStep = async (_params: SubmitBridgeTransactionParams) => {\n  /**\n   * 1. Validate the token is supported on the fromChainId\n   * 2. Validate the token is supported on the toChainId\n   * 3. Figure out which bridge platform to use based on the from/to chains and the token being transferred\n   *       - Ex: Ethereum -> Avalanche USDC = use CCTP, but Ethereum -> Avalanche WAVAX use Avalanche bridge\n   * 4. Return the transaction id\n   */\n  throw new NotImplementedError();\n};\n","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';\nimport type { BridgePlatform, 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 the steps required to complete a bridge transaction.\n * It could sometimes take multiple transactions to complete a bridge from chain A to B.\n */\nexport const getBridgeRouter = (_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","export const submitAndWatchBridgeTransaction = () => {};\n","import { submitBridgeTransactionStep } from './handlers/submit-bridge-transaction-step';\nimport { getBridgeRouter } from './handlers/get-bridge-router';\nimport { submitAndWatchBridgeTransaction } from './handlers/submit-and-watch-bridge-transaction';\nimport type { Environment, MaybePromise, NativeToken } from '@internal/bridge-shared';\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 createBridgeService = (_options: BridgeServiceConfig) => {\n  return {\n    getBridgeRouter,\n    submitBridgeTransactionStep,\n    submitAndWatchBridgeTransaction,\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 createBridgeService: (_options: BridgeServiceConfig) => {
+    getBridgeRouter: (_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;
+    }[];
+    submitBridgeTransactionStep: (_params: {
+        fromChainId: string;
+        toChainId: string;
+        fromAddress: `0x${string}`;
+        token: _internal_bridge_shared.Token;
+        amount: string;
+    }) => Promise<never>;
+    submitAndWatchBridgeTransaction: () => void;
+};
+
+export { BridgeServiceConfig, createBridgeService };

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 createBridgeService: (_options: BridgeServiceConfig) => {
+    getBridgeRouter: (_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;
+    }[];
+    submitBridgeTransactionStep: (_params: {
+        fromChainId: string;
+        toChainId: string;
+        fromAddress: `0x${string}`;
+        token: _internal_bridge_shared.Token;
+        amount: string;
+    }) => Promise<never>;
+    submitAndWatchBridgeTransaction: () => void;
+};
+
+export { BridgeServiceConfig, createBridgeService };

package/dist/index.js

@@ -0,0 +1,7 @@
+import 'viem';
+
+var t=class extends Error{constructor(a,m){super(a);this.code=m;this.code=m;}},e=class extends t{constructor(o="Not implemented"){super(o,5001),this.name="NotImplementedError";}};var n=async r=>{throw new e};var i=r=>{throw new e};var s=()=>{};var v=r=>({getBridgeRouter:i,submitBridgeTransactionStep:n,submitAndWatchBridgeTransaction:s});
+
+export { v as createBridgeService };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/handlers/submit-bridge-transaction-step.ts","../src/errors/index.ts","../src/handlers/get-bridge-router.ts","../src/handlers/submit-and-watch-bridge-transaction.ts","../src/bridge-service.ts"],"names":["BridgeError","message","code","NotImplementedError","submitBridgeTransactionStep","_params","getBridgeRouter","submitAndWatchBridgeTransaction","createBridgeService","_options"],"mappings":"AAAA,MAA6B,OCI7B,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,EDPO,IAAMG,EAA8B,MAAOC,GAA2C,CAQ3F,MAAM,IAAIF,CACZ,EEAO,IAAMG,EAAmBD,GAA4D,CAE1F,MAAM,IAAIF,CACZ,ECxBO,IAAMI,EAAkC,IAAM,CAAC,ECW/C,IAAMC,EAAuBC,IAC3B,CACL,gBAAAH,EACA,4BAAAF,EACA,gCAAAG,CACF","sourcesContent":["import { type Address } from 'viem';\nimport type { Token } from '@internal/bridge-shared';\nimport { NotImplementedError } from '../errors';\n\ntype SubmitBridgeTransactionParams = {\n  fromChainId: string;\n  toChainId: string;\n  fromAddress: Address;\n  token: Token;\n  amount: string;\n};\n\nexport const submitBridgeTransactionStep = async (_params: SubmitBridgeTransactionParams) => {\n  /**\n   * 1. Validate the token is supported on the fromChainId\n   * 2. Validate the token is supported on the toChainId\n   * 3. Figure out which bridge platform to use based on the from/to chains and the token being transferred\n   *       - Ex: Ethereum -> Avalanche USDC = use CCTP, but Ethereum -> Avalanche WAVAX use Avalanche bridge\n   * 4. Return the transaction id\n   */\n  throw new NotImplementedError();\n};\n","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';\nimport type { BridgePlatform, 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 the steps required to complete a bridge transaction.\n * It could sometimes take multiple transactions to complete a bridge from chain A to B.\n */\nexport const getBridgeRouter = (_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","export const submitAndWatchBridgeTransaction = () => {};\n","import { submitBridgeTransactionStep } from './handlers/submit-bridge-transaction-step';\nimport { getBridgeRouter } from './handlers/get-bridge-router';\nimport { submitAndWatchBridgeTransaction } from './handlers/submit-and-watch-bridge-transaction';\nimport type { Environment, MaybePromise, NativeToken } from '@internal/bridge-shared';\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 createBridgeService = (_options: BridgeServiceConfig) => {\n  return {\n    getBridgeRouter,\n    submitBridgeTransactionStep,\n    submitAndWatchBridgeTransaction,\n  };\n};\n"]}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@avalabs/bridge-unified",
+  "version": "1.0.1",
+  "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",
+    "@internal/bridge-shared": "0.0.0",
+    "@internal/tsup-config": "0.0.1",
+    "eslint-config-custom": "0.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "eslint \"src/**/*.ts\""
+  }
+}

package/src/bridge-service.ts

@@ -0,0 +1,18 @@
+import { submitBridgeTransactionStep } from './handlers/submit-bridge-transaction-step';
+import { getBridgeRouter } from './handlers/get-bridge-router';
+import { submitAndWatchBridgeTransaction } from './handlers/submit-and-watch-bridge-transaction';
+import type { Environment, MaybePromise, NativeToken } from '@internal/bridge-shared';
+
+export type BridgeServiceConfig = {
+  environment: `${Environment}`;
+  getChainNativeAsset: ({ evmChainId }: { evmChainId: string }) => MaybePromise<NativeToken>;
+  getChainErc20Asset: ({ evmChainId, address }: { evmChainId: string; address: string }) => MaybePromise<NativeToken>;
+};
+
+export const createBridgeService = (_options: BridgeServiceConfig) => {
+  return {
+    getBridgeRouter,
+    submitBridgeTransactionStep,
+    submitAndWatchBridgeTransaction,
+  };
+};

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/get-bridge-router.ts

@@ -0,0 +1,25 @@
+import { NotImplementedError } from '../errors';
+import type { BridgePlatform, 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 the steps required to complete a bridge transaction.
+ * It could sometimes take multiple transactions to complete a bridge from chain A to B.
+ */
+export const getBridgeRouter = (_params: GetBridgeRouterParams): BridgeTransactionStep[] => {
+  // Implement smart logic for determining how to get the token from chain A to B
+  throw new NotImplementedError();
+};

package/src/handlers/submit-and-watch-bridge-transaction.ts

@@ -0,0 +1 @@
+export const submitAndWatchBridgeTransaction = () => {};

package/src/handlers/submit-bridge-transaction-step.ts

@@ -0,0 +1,22 @@
+import { type Address } from 'viem';
+import type { Token } from '@internal/bridge-shared';
+import { NotImplementedError } from '../errors';
+
+type SubmitBridgeTransactionParams = {
+  fromChainId: string;
+  toChainId: string;
+  fromAddress: Address;
+  token: Token;
+  amount: string;
+};
+
+export const submitBridgeTransactionStep = async (_params: SubmitBridgeTransactionParams) => {
+  /**
+   * 1. Validate the token is supported on the fromChainId
+   * 2. Validate the token is supported on the toChainId
+   * 3. Figure out which bridge platform to use based on the from/to chains and the token being transferred
+   *       - Ex: Ethereum -> Avalanche USDC = use CCTP, but Ethereum -> Avalanche WAVAX use Avalanche bridge
+   * 4. Return the transaction id
+   */
+  throw new NotImplementedError();
+};

package/src/index.ts

@@ -0,0 +1 @@
+export * from './bridge-service';

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);