feat(bitcoin): Added support for Bitcoin transfers

package.json

@@ -25,7 +25,12 @@
     "evm:lint": "yarn workspace @buildwithsygma/evm lint",
     "evm:lint:fix": "yarn workspace @buildwithsygma/evm lint:fix",
     "evm:test:unit": "yarn workspace @buildwithsygma/evm test:unit",
-    "build:all": "yarn workspace @buildwithsygma/core build:all; yarn workspace @buildwithsygma/evm build:all",
+    "btc:build": "yarn workspace @buildwithsygma/btc build:all",
+    "btc:cleanDist": "yarn workspace @buildwithsygma/btc clean",
+    "btc:test": "yarn workspace @buildwithsygma/btc test",
+    "btc:lint": "yarn workspace @buildwithsygma/btc lint",
+    "btc:lint:fix": "yarn workspace @buildwithsygma/btc lint:fix",
+    "build:all": "yarn workspace @buildwithsygma/core build:all; yarn workspace @buildwithsygma/evm build:all; yarn workspace @buildwithsygma/btc build:all",
     "clean:all": "yarn workspace @buildwithsygma/core clean; yarn workspace @buildwithsygma/evm clean",
     "docs": "typedoc"
   },

packages/btc/.eslintrc.cjs

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: '../../.eslintrc.cjs',
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    sourceType: 'module',
+    tsconfigRootDir: __dirname,
+  },
+};

packages/btc/.gitignore

@@ -0,0 +1,45 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+/dist
+/dist-cjs
+/dist-esm
+/types
+
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+.env
+.vscode
+.history
+
+# runtime config
+public/chainbridge-runtime-config.js
+
+# IDE
+.idea/
+
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

packages/btc/.npmignore

@@ -0,0 +1,26 @@
+
+
+integration/
+coverage/
+dist/
+keysN1/
+keysN2/
+config/
+src/
+
+# Ignore configs
+setupTests.ts
+.eslintrc.cjs
+.prettierrc.json
+docker-compose.yml
+Dockerfile
+jest.config.cjs
+tsconfig.json
+tsconfig.*.json
+tsconfig.tsbuildinfo
+rollup.config.js
+**/__test__/*
+
+# Ignore random junk
+.DS_Store
+node_modules/**

packages/btc/.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "useTabs": false,
+  "arrowParens": "avoid"
+}

packages/btc/README.md

@@ -0,0 +1 @@
+# btc

packages/btc/jest.config.cjs

@@ -0,0 +1,19 @@
+module.exports = {
+    roots: ['<rootDir>/src', '<rootDir>/test'],
+    extensionsToTreatAsEsm: ['.ts', '.tsx'],
+    verbose: true,
+    preset: 'ts-jest/presets/default-esm',
+    moduleNameMapper: {
+      '^(\\.{1,2}/.*)\\.js$': '$1',
+    },
+    testEnvironment: 'jsdom',
+    testTimeout: 15000,
+    transform: {
+      '^.+\\.(ts|tsx)?$': ['ts-jest', { useESM: true }],
+    },
+    testPathIgnorePatterns: ['./dist'],
+    automock: false,
+    setupFiles: [
+      "./test/setupJest.js"
+    ]
+  };

packages/btc/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@buildwithsygma/btc",
+  "version": "0.0.1",
+  "description": "Core primitives for bridging and message passing",
+  "main": "dist-esm/index.js",
+  "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist-esm/index.js",
+      "require": "./dist-cjs/index.js"
+    }
+  },
+  "type": "module",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sygmaprotocol/sygma-sdk"
+  },
+  "scripts": {
+    "test": "jest --watchAll --detectOpenHandles --silent",
+    "test:unit": "jest --detectOpenHandles",
+    "run:all": "concurrently \"yarn run prepareNodes\" \"yarn run test\"",
+    "build:esm": "tsc -p tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./dist-esm/package.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./dist-cjs/package.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "build:all": "yarn build:esm && yarn build:cjs && yarn build:types",
+    "build:typedocs:html": "typedoc --options typedoc.json",
+    "build:typedocs:markdown": "typedoc --options typedoc.markdown.json",
+    "build:typedocs:asjson": "typedoc --options typedoc.asjson.json",
+    "lint": "eslint 'src/**/*.ts'",
+    "lint:fix": "yarn run lint --fix",
+    "run:nodes": "docker-compose -f docker-compose.yml up",
+    "clean": "rm -rf ./dist ./dist-cjs ./dist-esm ./types"
+  },
+  "keywords": [
+    "sygma",
+    "sygmaprotocol",
+    "buildwithsygma",
+    "web3",
+    "bridge",
+    "bitcoin"
+  ],
+  "author": "Sygmaprotocol Product Team",
+  "license": "LGPL-3.0-or-later",
+  "devDependencies": {
+    "@types/jest": "^29.4.0",
+    "concurrently": "7.0.0",
+    "eslint": "8",
+    "hardhat": "2.8.2",
+    "jest": "^29.4.1",
+    "jest-environment-jsdom": "^29.4.1",
+    "jest-extended": "1.2.0",
+    "jest-fetch-mock": "^3.0.3",
+    "ts-jest": "^29.0.5",
+    "ts-node": "10.9.1",
+    "typedoc": "^0.24.1",
+    "typedoc-plugin-markdown": "^3.15.1",
+    "typescript": "5.0.4"
+  },
+  "dependencies": {
+    "@buildwithsygma/core": "workspace:^"
+  }
+}

packages/btc/src/base-transfer.ts

@@ -1,46 +1,49 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
-
-import { BitcoinResource } from "@buildwithsygma/core/src";
-import { Config } from "@buildwithsygma/core/types";
-
-type BaseTransferParams = {
-  destinationAddress: string;
-  amount: bigint;
-};
-
-type BitcoinTransferRequest = {
-  destinationAddress: string;
-  amount: bigint;
-  depositAddress: string;
-};
-
-export async function createBitcoinTransferRequest(params: BaseTransferParams): Promise<BaseTransfer> {
-  throw new Error("Method not implemented");
-}
+import type { BitcoinResource } from '@buildwithsygma/core/src';
+import type { Config, Domain } from '@buildwithsygma/core/types';
+import type { BaseTransferParams } from 'types';
 
 export abstract class BaseTransfer {
-  constructor(transfer: BaseTransferParams, config: Config) {}
+  protected destinationAddress: string;
+  protected amount: bigint;
+  protected config: Config;
+  protected resource: BitcoinResource;
+  protected sourceDomain: Domain;
+
+  constructor(transfer: BaseTransferParams, config: Config) {
+    this.destinationAddress = transfer.destinationAddress;
+    this.amount = transfer.amount;
+    this.sourceDomain = config.getDomain(transfer.sourceDomain);
+
+    const resources = config.getResources(this.sourceDomain) as BitcoinResource[];
+    const resource = this.findResource(resources, transfer.resource);
+
+    if (resource) {
+      this.resource = resource;
+    } else {
+      throw new Error('Resource not found.');
+    }
+
+    this.config = config;
+  }
 
   private findResource(
     resources: BitcoinResource[],
     resourceIdentifier: string | BitcoinResource,
   ): BitcoinResource | undefined {
-    throw new Error("Method not implemented");
+    return resources.find(resource => {
+      if (typeof resourceIdentifier === 'string') {
+        return resource.resourceId === resourceIdentifier;
+      }
+
+      return resource === resourceIdentifier;
+    });
   }
 
   /**
    * Set resource to be transferred.
    * @param {BitcoinResource} resource
    */
   setResource(resource: BitcoinResource): void {
-    throw new Error("Method not implemented");
-  }
-
-  getUriEncodedUtxoRequest(btcTransferRequest: BaseTransferParams): string {
-    throw new Error("Method not implemented");
+    this.resource = resource;
   }
-
-  getBTCTransferRequest(): BitcoinTransferRequest {
-    throw new Error("Method not implemented");
-  }
-}
+}

packages/btc/src/environment.d.ts

@@ -0,0 +1,9 @@
+import type { Environment } from '@buildwithsygma/core';
+
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      SYGMA_ENV: Environment;
+    }
+  }
+}

packages/btc/src/fungible.ts

@@ -0,0 +1,38 @@
+import { Config } from '@buildwithsygma/core';
+import type { BaseTransferParams, BitcoinTransferRequest } from 'types';
+
+import { BaseTransfer } from './base-transfer.js';
+
+export async function createBitcoinFungibleTransfer(
+  params: BaseTransferParams,
+): Promise<BitcoinTransfer> {
+  const config = new Config();
+  await config.init(process.env.SYGMA_ENV);
+  const transfer = new BitcoinTransfer(params, config);
+
+  return transfer;
+}
+
+class BitcoinTransfer extends BaseTransfer {
+  protected destinationAddress: string;
+  protected amount: bigint;
+
+  constructor(transfer: BaseTransferParams, config: Config) {
+    super(transfer, config);
+    this.destinationAddress = transfer.destinationAddress;
+    this.amount = transfer.amount;
+  }
+
+  getUriEncodedUtxoRequest(): string {
+    const { address } = this.resource;
+    return `bitcoin:${address}?amount=${this.amount}&destinationAddress=${this.destinationAddress}`;
+  }
+
+  getBTCTransferRequest(): BitcoinTransferRequest {
+    return {
+      destinationAddress: this.destinationAddress,
+      amount: this.amount,
+      depositAddress: this.resource.address,
+    };
+  }
+}

packages/btc/src/index.ts

@@ -1 +1,2 @@
-export * from "./base-transfer.js";
+export * from './base-transfer.js';
+export * from './fungible.js';

packages/btc/src/types.ts

@@ -0,0 +1,14 @@
+import type { BitcoinResource, Domainlike } from '@buildwithsygma/core';
+
+export type BaseTransferParams = {
+  sourceDomain: Domainlike;
+  destinationAddress: string;
+  amount: bigint;
+  resource: BitcoinResource | string;
+};
+
+export type BitcoinTransferRequest = {
+  destinationAddress: string;
+  amount: bigint;
+  depositAddress: string;
+};

packages/btc/test/setupTest.js

@@ -0,0 +1,2 @@
+// setupJest.js or similar file
+require('jest-fetch-mock').enableMocks();

packages/btc/tsconfig.cjs.json

@@ -0,0 +1,13 @@
+{
+  "exclude": [
+    "src/**/__test__/**",
+    "test/**",
+  ],
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "esModuleInterop": true,
+    "module": "commonjs",
+    "outDir": "./dist-cjs"
+  }
+}

packages/btc/tsconfig.esm.json

@@ -0,0 +1,12 @@
+{
+  "exclude": [
+    "src/**/__test__/**",
+    "test/**"
+  ],
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "ES2020",
+    "esModuleInterop": true,
+    "outDir": "./dist-esm"
+  }
+}