signet.js 0.0.1-beta.6 → 0.0.1-beta.7

package/docs/pages/index.mdx

@@ -0,0 +1,99 @@
+# Signet.js Documentation
+
+A TypeScript library for handling interactions with Sig Network MPC and Smart Contracts
+
+## Supported Chains
+
+- [EVM Chains](./chains/evm.mdx) - Ethereum and compatible networks
+- [Bitcoin](./chains/bitcoin/bitcoin.mdx) - Bitcoin network
+- [Cosmos Chains](./chains/cosmos.mdx) - Cosmos SDK-based networks
+
+## Core Features
+
+- **Balance Checking**: Query account balances across different chains
+- **Address and Public Key Derivation**: Derive addresses and public keys following Sig Network derivation function
+- **Transaction Management**: Create, store, and retrieve transactions
+- **Signature Handling**: Process MPC signatures for transactions
+- **Transaction Broadcasting**: Submit signed transactions to the network
+
+## Installation
+
+```bash
+npm install signet.js
+# or
+yarn add signet.js
+# or
+pnpm add signet.js
+```
+
+## Quick Start
+
+Here's a basic example using the EVM implementation:
+
+```ts twoslash
+import { EVM, utils } from 'signet.js'
+// [!include ~/snippets/env.ts]
+
+const contract = new utils.chains.near.ChainSignatureContract({
+  networkId: 'testnet',
+  contractId: 'v1.signer-prod.testnet',
+  accountId,
+  keypair,
+})
+
+const evmChain = new EVM({
+  rpcUrl: 'https://mainnet.infura.io/v3/YOUR-PROJECT-ID',
+  contract,
+})
+
+// Derive address and public key
+const { address, publicKey } = await evmChain.deriveAddressAndPublicKey(
+  accountId,
+  'any_string'
+)
+
+// Check balance
+const balance = await evmChain.getBalance(address)
+
+// Create and sign transaction
+const { transaction, mpcPayloads } = await evmChain.getMPCPayloadAndTransaction(
+  {
+    from: '0x...',
+    to: '0x...',
+    value: '1000000000000000000',
+  }
+)
+
+// Sign with MPC
+const signature = await contract.sign({
+  payload: mpcPayloads[0].payload,
+  path: 'any_string',
+  key_version: 0,
+})
+
+// Add signature
+const signedTx = evmChain.addSignature({
+  transaction,
+  mpcSignatures: [signature],
+})
+
+// Broadcast transaction
+const txHash = await evmChain.broadcastTx(signedTx)
+```
+
+## Architecture
+
+The library is built around a core `Chain` interface that defines common functionality across all supported blockchain networks. Each specific chain implementation extends this interface with network-specific features while maintaining a consistent API.
+
+For more details check the [Chain](./chain.mdx) page.
+
+## Utility Functions
+
+Besides the Chain classes the library also provide utility functions to assist you on building transactions, requesting signature in wrapped methods.
+
+Currently we support only Near, but we are working on adding support for other chains.
+
+## Repositories
+
+- Signet.js: [https://github.com/sig-net/signet.js](https://github.com/sig-net/signet.js).
+- MPC: [https://github.com/sig-net/mpc](https://github.com/sig-net/mpc).

package/docs/snippets/contract.ts

@@ -0,0 +1,21 @@
+import { KeyPair, type KeyPairString } from '@near-js/crypto'
+import { utils } from 'signet.js'
+
+// Initialize NEAR connection with credentials from environment
+const accountId = process.env.NEAR_ACCOUNT_ID
+const privateKey = process.env.NEAR_PRIVATE_KEY as KeyPairString
+
+if (!accountId || !privateKey) {
+  throw new Error(
+    'NEAR_ACCOUNT_ID and NEAR_PRIVATE_KEY must be set in environment'
+  )
+}
+
+const keypair = KeyPair.fromString(privateKey)
+
+const contract = new utils.chains.near.ChainSignatureContract({
+  networkId: 'testnet',
+  contractId: 'v1.signer-prod.testnet',
+  accountId,
+  keypair,
+})

package/docs/snippets/env.ts

@@ -0,0 +1,13 @@
+import { KeyPair, type KeyPairString } from '@near-js/crypto'
+
+// Initialize NEAR connection with credentials from environment
+const accountId = process.env.NEAR_ACCOUNT_ID
+const privateKey = process.env.NEAR_PRIVATE_KEY as KeyPairString
+
+if (!accountId || !privateKey) {
+  throw new Error(
+    'NEAR_ACCOUNT_ID and NEAR_PRIVATE_KEY must be set in environment'
+  )
+}
+
+const keypair = KeyPair.fromString(privateKey)

package/jest.config.ts

@@ -0,0 +1,199 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type {Config} from 'jest';
+
+const config: Config = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/dn/p7pfr0cd1x94jsqf6_79fg8m0000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

package/package.json

@@ -1,15 +1,28 @@
 {
   "name": "signet.js",
-  "version": "0.0.1-beta.6",
+  "version": "0.0.1-beta.7",
   "description": "",
   "type": "module",
-  "main": "./src/index.js",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": {
+        "browser": "./index.js",
+        "node": "./index.js"
+      },
+      "require": "./index.cjs"
+    }
+  },
+  "main": "./index.cjs",
+  "module": "./index.js",
+  "browser": "./index.js",
   "types": "./src/index.d.ts",
   "scripts": {
-    "build": "tsc --project tsconfig.json && tsc-alias",
-    "pre:deploy": "npm run build && cp package.json README.md dist/",
-    "publish-npm": "npm run pre:deploy && cd dist && npm publish",
-    "publish-npm:beta": "npm run pre:deploy && cd dist && npm publish --tag beta",
+    "build": "rm -rf dist && vite build && cp package.json README.md LICENSE dist/",
+    "watch": "vite build --watch",
+    "pre:deploy": "npm run build && npm run docs:build",
+    "publish-npm": "npm run pre:deploy && npm publish",
+    "publish-npm:beta": "npm run pre:deploy && npm publish --tag beta",
     "test": "jest",
     "docs:dev": "vocs dev",
     "docs:build": "vocs build",
@@ -18,9 +31,6 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@babel/core": "^7.25.2",
-    "@babel/preset-env": "^7.25.3",
-    "@babel/preset-typescript": "^7.24.7",
     "@types/bn.js": "^5.1.5",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "babel-jest": "^29.7.0",
@@ -34,9 +44,9 @@
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.7.0",
     "prettier": "^3.2.5",
-    "ts-node": "^10.9.2",
-    "tsc-alias": "^1.8.10",
     "typescript": "^5.4.3",
+    "vite": "^6.0.7",
+    "vite-plugin-dts": "^4.4.0",
     "vocs": "1.0.0-alpha.62"
   },
   "dependencies": {

package/src/chains/Bitcoin/BTCRpcAdapter/BTCRpcAdapter.ts

@@ -0,0 +1,11 @@
+import type { BTCTransaction, BTCInput, BTCOutput } from '@chains/Bitcoin/types'
+
+export abstract class BTCRpcAdapter {
+  abstract selectUTXOs(
+    from: string,
+    targets: BTCOutput[]
+  ): Promise<{ inputs: BTCInput[]; outputs: BTCOutput[] }>
+  abstract broadcastTransaction(transactionHex: string): Promise<string>
+  abstract getBalance(address: string): Promise<number>
+  abstract getTransaction(txid: string): Promise<BTCTransaction>
+}

package/src/chains/Bitcoin/BTCRpcAdapter/Mempool/Mempool.ts

@@ -0,0 +1,96 @@
+// There is no types for coinselect
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-expect-error
+import coinselect from 'coinselect'
+
+import { BTCRpcAdapter } from '@chains/Bitcoin/BTCRpcAdapter/BTCRpcAdapter'
+import {
+  type BTCFeeRecommendation,
+  type UTXO,
+} from '@chains/Bitcoin/BTCRpcAdapter/Mempool/types'
+import type { BTCTransaction, BTCInput, BTCOutput } from '@chains/Bitcoin/types'
+
+export class Mempool extends BTCRpcAdapter {
+  private readonly providerUrl: string
+
+  constructor(providerUrl: string) {
+    super()
+    this.providerUrl = providerUrl
+  }
+
+  private async fetchFeeRate(confirmationTarget = 6): Promise<number> {
+    const response = await fetch(`${this.providerUrl}/v1/fees/recommended`)
+    const data = (await response.json()) as BTCFeeRecommendation
+
+    if (confirmationTarget <= 1) {
+      return data.fastestFee
+    } else if (confirmationTarget <= 3) {
+      return data.halfHourFee
+    } else if (confirmationTarget <= 6) {
+      return data.hourFee
+    } else {
+      return data.economyFee
+    }
+  }
+
+  private async fetchUTXOs(address: string): Promise<UTXO[]> {
+    try {
+      const response = await fetch(
+        `${this.providerUrl}/address/${address}/utxo`
+      )
+      return (await response.json()) as UTXO[]
+    } catch (error) {
+      console.error('Failed to fetch UTXOs:', error)
+      return []
+    }
+  }
+
+  async selectUTXOs(
+    from: string,
+    targets: BTCOutput[],
+    confirmationTarget = 6
+  ): Promise<{ inputs: BTCInput[]; outputs: BTCOutput[] }> {
+    const utxos = await this.fetchUTXOs(from)
+    const feeRate = await this.fetchFeeRate(confirmationTarget)
+
+    // Add a small amount to the fee rate to ensure the transaction is confirmed
+    const ret = coinselect(utxos, targets, Math.ceil(feeRate + 1))
+
+    if (!ret.inputs || !ret.outputs) {
+      throw new Error(
+        'Invalid transaction: coinselect failed to find a suitable set of inputs and outputs. This could be due to insufficient funds, or no inputs being available that meet the criteria.'
+      )
+    }
+
+    return {
+      inputs: ret.inputs,
+      outputs: ret.outputs,
+    }
+  }
+
+  async broadcastTransaction(transactionHex: string): Promise<string> {
+    const response = await fetch(`${this.providerUrl}/tx`, {
+      method: 'POST',
+      body: transactionHex,
+    })
+
+    if (response.ok) {
+      return await response.text()
+    }
+
+    throw new Error(`Failed to broadcast transaction: ${await response.text()}`)
+  }
+
+  async getBalance(address: string): Promise<number> {
+    const response = await fetch(`${this.providerUrl}/address/${address}`)
+    const data = (await response.json()) as {
+      chain_stats: { funded_txo_sum: number; spent_txo_sum: number }
+    }
+    return data.chain_stats.funded_txo_sum - data.chain_stats.spent_txo_sum
+  }
+
+  async getTransaction(txid: string): Promise<BTCTransaction> {
+    const response = await fetch(`${this.providerUrl}/tx/${txid}`)
+    return (await response.json()) as BTCTransaction
+  }
+}

package/src/chains/Bitcoin/BTCRpcAdapter/Mempool/index.ts

@@ -0,0 +1 @@
+export { Mempool } from './Mempool'

package/src/chains/Bitcoin/BTCRpcAdapter/Mempool/types.ts

@@ -0,0 +1,72 @@
+export interface BTCFeeRecommendation {
+  fastestFee: number
+  halfHourFee: number
+  hourFee: number
+  economyFee: number
+  minimumFee: number
+}
+
+interface BTCAddressStats {
+  funded_txo_count: number
+  funded_txo_sum: number
+  spent_txo_count: number
+  spent_txo_sum: number
+  tx_count: number
+}
+
+export interface BTCAddressInfo {
+  address: string
+  chain_stats: BTCAddressStats
+  mempool_stats: BTCAddressStats
+}
+
+export interface Transaction {
+  txid: string
+  version: number
+  locktime: number
+  vin: Array<{
+    txid: string
+    vout: number
+    prevout: {
+      scriptpubkey: string
+      scriptpubkey_asm: string
+      scriptpubkey_type: string
+      scriptpubkey_address: string
+      value: number
+    }
+    scriptsig: string
+    scriptsig_asm: string
+    witness: string[]
+    is_coinbase: boolean
+    sequence: number
+  }>
+  vout: Array<{
+    scriptpubkey: string
+    scriptpubkey_asm: string
+    scriptpubkey_type: string
+    scriptpubkey_address: string
+    value: number
+  }>
+  size: number
+  weight: number
+  sigops?: number
+  fee: number
+  status: {
+    confirmed: boolean
+    block_height: number
+    block_hash: string
+    block_time: number
+  }
+}
+
+export interface UTXO {
+  txid: string
+  vout: number
+  status: {
+    confirmed: boolean
+    block_height: number
+    block_hash: string
+    block_time: number
+  }
+  value: number
+}

package/src/chains/Bitcoin/BTCRpcAdapter/index.ts

@@ -0,0 +1,6 @@
+import { Mempool } from './Mempool'
+export { BTCRpcAdapter } from './BTCRpcAdapter'
+
+export const BTCRpcAdapters = {
+  Mempool,
+}