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

package/package.json

@@ -1,14 +1,27 @@
 {
   "name": "signet.js",
-  "version": "0.0.1-beta.6",
+  "version": "0.0.1-beta.8",
   "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",
+    "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 && cd dist && npm publish --tag beta",
     "test": "jest",
     "docs:dev": "vocs dev",
@@ -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/utils/chains/near/contract.d.ts → utils/chains/near/ChainSignatureContract.d.ts}

@@ -1,10 +1,9 @@
-import { type Account } from '@near-js/accounts';
+import { Account } from '@near-js/accounts';
 import { KeyPair } from '@near-js/crypto';
-import BN from 'bn.js';
-import { ChainSignatureContract } from '../../../chains/ChainSignatureContract';
-import type { RSVSignature, UncompressedPubKeySEC1 } from '../../../chains/types';
-import type { SignArgs } from '../../../chains/ChainSignatureContract';
-import { type NearNetworkIds, type ChainSignatureContractIds } from '../../chains/near/types';
+import { default as BN } from 'bn.js';
+import { ChainSignatureContract as AbstractChainSignatureContract, SignArgs } from '../../../chains/ChainSignatureContract';
+import { RSVSignature, UncompressedPubKeySEC1 } from '../../../chains/types';
+import { NearNetworkIds, ChainSignatureContractIds } from './types';
 interface ChainSignatureContractArgs {
     networkId: NearNetworkIds;
     contractId: ChainSignatureContractIds;
@@ -15,14 +14,13 @@ interface ChainSignatureContractArgs {
  * This contract will default to view methods only.
  * If you want to use the change methods, you need to provide an account and keypair.
  */
-export declare class NearChainSignatureContract extends ChainSignatureContract {
+export declare class ChainSignatureContract extends AbstractChainSignatureContract {
     private readonly networkId;
     private readonly contractId;
     private readonly accountId;
     private readonly keypair;
     constructor({ networkId, contractId, accountId, keypair, }: ChainSignatureContractArgs);
     private getContract;
-    getPublicKey(): Promise<UncompressedPubKeySEC1>;
     getCurrentSignatureDeposit(): Promise<BN>;
     getDerivedPublicKey(args: {
         path: string;

package/{src/utils → utils}/chains/near/constants.d.ts

@@ -1,3 +1,3 @@
-import BN from 'bn.js';
+import { default as BN } from 'bn.js';
 export declare const NEAR_MAX_GAS: BN;
 export declare const DONT_CARE_ACCOUNT_ID = "dontcare";

package/{src/utils → utils}/chains/near/index.d.ts

@@ -1,3 +1,3 @@
 export * as transactionBuilder from './transactionBuilder';
 export * as signAndSend from './signAndSend';
-export * as contract from './contract';
+export * from './ChainSignatureContract';

package/{src/utils → utils}/chains/near/relayer/relayer.d.ts

@@ -1,5 +1,5 @@
-import { type SignedDelegate } from '@near-js/transactions';
-import { type SignedDelegateRelayerFormat } from './types';
+import { SignedDelegate } from '@near-js/transactions';
+import { SignedDelegateRelayerFormat } from './types';
 /**
  * Parses the signedDelegate object from the Multi-Party Computation (MPC) format to the Relayer format.
  * @param signedDelegate - The signedDelegate object in MPC format.

package/{src/utils → utils}/chains/near/signAndSend/keypair.d.ts

@@ -1,6 +1,6 @@
-import { type KeyPair } from '@near-js/crypto';
-import { type Response } from '../../../../chains/types';
-import { type BitcoinRequest, type CosmosRequest, type EVMRequest } from '../../../chains/near/types';
+import { KeyPair } from '@near-js/crypto';
+import { Response } from '../../../../chains/types';
+import { BitcoinRequest, CosmosRequest, EVMRequest } from '../types';
 export declare const EVMTransaction: (req: EVMRequest, keyPair: KeyPair) => Promise<Response>;
 export declare const BTCTransaction: (req: BitcoinRequest, keyPair: KeyPair) => Promise<Response>;
 export declare const CosmosTransaction: (req: CosmosRequest, keyPair: KeyPair) => Promise<Response>;

package/{src/utils → utils}/chains/near/transactionBuilder.d.ts

@@ -1,6 +1,6 @@
-import type { Action, FinalExecutionOutcome, NetworkId } from '@near-wallet-selector/core';
-import { type RSVSignature, type KeyDerivationPath, type MPCPayloads } from '../../../chains/types';
-import { type NFTKeysContracts, type ChainSignatureContractIds } from '../../chains/near/types';
+import { Action, FinalExecutionOutcome, NetworkId } from '@near-wallet-selector/core';
+import { RSVSignature, KeyDerivationPath, MPCPayloads } from '../../../chains/types';
+import { NFTKeysContracts, ChainSignatureContractIds } from './types';
 export declare const mpcPayloadsToChainSigTransaction: ({ networkId, contractId, mpcPayloads, path, }: {
     networkId: NetworkId;
     contractId: ChainSignatureContractIds;

package/{src/utils → utils}/chains/near/types.d.ts

@@ -1,7 +1,7 @@
-import type { KeyDerivationPath } from '../../../chains/types';
-import type { BTCTransactionRequest, BTCNetworkIds } from '../../../chains/Bitcoin/types';
-import type { CosmosNetworkIds, CosmosTransactionRequest } from '../../../chains/Cosmos/types';
-import { type EVMTransactionRequest } from '../../../chains/EVM/types';
+import { BTCTransactionRequest, BTCNetworkIds } from '../../../chains/Bitcoin/types';
+import { CosmosNetworkIds, CosmosTransactionRequest } from '../../../chains/Cosmos/types';
+import { EVMTransactionRequest } from '../../../chains/EVM/types';
+import { KeyDerivationPath } from '../../../chains/types';
 /**
 Available ChainSignature contracts:
   - Mainnet: v1.signer

package/src/chains/Bitcoin/BTCRpcAdapter/BTCRpcAdapter.js

@@ -1,2 +0,0 @@
-export class BTCRpcAdapter {
-}

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

@@ -1,69 +0,0 @@
-// 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 '../../../Bitcoin/BTCRpcAdapter/BTCRpcAdapter';
-export class Mempool extends BTCRpcAdapter {
-    constructor(providerUrl) {
-        super();
-        this.providerUrl = providerUrl;
-    }
-    async fetchFeeRate(confirmationTarget = 6) {
-        const response = await fetch(`${this.providerUrl}/v1/fees/recommended`);
-        const data = (await response.json());
-        if (confirmationTarget <= 1) {
-            return data.fastestFee;
-        }
-        else if (confirmationTarget <= 3) {
-            return data.halfHourFee;
-        }
-        else if (confirmationTarget <= 6) {
-            return data.hourFee;
-        }
-        else {
-            return data.economyFee;
-        }
-    }
-    async fetchUTXOs(address) {
-        try {
-            const response = await fetch(`${this.providerUrl}/address/${address}/utxo`);
-            return (await response.json());
-        }
-        catch (error) {
-            console.error('Failed to fetch UTXOs:', error);
-            return [];
-        }
-    }
-    async selectUTXOs(from, targets, confirmationTarget = 6) {
-        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) {
-        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) {
-        const response = await fetch(`${this.providerUrl}/address/${address}`);
-        const data = (await response.json());
-        return data.chain_stats.funded_txo_sum - data.chain_stats.spent_txo_sum;
-    }
-    async getTransaction(txid) {
-        const response = await fetch(`${this.providerUrl}/tx/${txid}`);
-        return (await response.json());
-    }
-}

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

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

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

@@ -1 +0,0 @@
-export {};

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

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

package/src/chains/Bitcoin/Bitcoin.js

@@ -1,198 +0,0 @@
-import * as bitcoin from 'bitcoinjs-lib';
-import { Chain } from '../Chain';
-import { utils } from '../index.js';
-import { parseBTCNetwork } from '../Bitcoin/utils';
-/**
- * Implementation of the Chain interface for Bitcoin network.
- * Handles interactions with both Bitcoin mainnet and testnet, supporting P2WPKH transactions.
- */
-export class Bitcoin extends Chain {
-    /**
-     * Creates a new Bitcoin chain instance
-     * @param params - Configuration parameters
-     * @param params.network - Network identifier (mainnet/testnet)
-     * @param params.contract - Instance of the chain signature contract for MPC operations
-     * @param params.btcRpcAdapter - Bitcoin RPC adapter for network interactions
-     */
-    constructor({ network, contract, btcRpcAdapter, }) {
-        super();
-        this.network = network;
-        this.btcRpcAdapter = btcRpcAdapter;
-        this.contract = contract;
-    }
-    /**
-     * Converts satoshis to BTC
-     * @param satoshis - Amount in satoshis
-     * @returns Amount in BTC
-     */
-    static toBTC(satoshis) {
-        return satoshis / Bitcoin.SATOSHIS_PER_BTC;
-    }
-    /**
-     * Converts BTC to satoshis
-     * @param btc - Amount in BTC
-     * @returns Amount in satoshis (rounded)
-     */
-    static toSatoshi(btc) {
-        return Math.round(btc * Bitcoin.SATOSHIS_PER_BTC);
-    }
-    async fetchTransaction(transactionId) {
-        const data = await this.btcRpcAdapter.getTransaction(transactionId);
-        const tx = new bitcoin.Transaction();
-        data.vout.forEach((vout) => {
-            const scriptPubKey = Buffer.from(vout.scriptpubkey, 'hex');
-            tx.addOutput(scriptPubKey, Number(vout.value));
-        });
-        return tx;
-    }
-    static parseRSVSignature(signature) {
-        const r = signature.r.padStart(64, '0');
-        const s = signature.s.padStart(64, '0');
-        const rawSignature = Buffer.from(r + s, 'hex');
-        if (rawSignature.length !== 64) {
-            throw new Error('Invalid signature length.');
-        }
-        return rawSignature;
-    }
-    /**
-     * Creates a Partially Signed Bitcoin Transaction (PSBT)
-     * @param params - Parameters for creating the PSBT
-     * @param params.transactionRequest - Transaction request containing inputs and outputs
-     * @returns Created PSBT instance
-     */
-    async createPSBT({ transactionRequest, }) {
-        const { inputs, outputs } = transactionRequest.inputs && transactionRequest.outputs
-            ? transactionRequest
-            : await this.btcRpcAdapter.selectUTXOs(transactionRequest.from, [
-                {
-                    address: transactionRequest.to,
-                    value: parseFloat(transactionRequest.value),
-                },
-            ]);
-        const psbt = new bitcoin.Psbt({ network: parseBTCNetwork(this.network) });
-        await Promise.all(inputs.map(async (input) => {
-            if (!input.scriptPubKey) {
-                const transaction = await this.fetchTransaction(input.txid);
-                const prevOut = transaction.outs[input.vout];
-                input.scriptPubKey = prevOut.script;
-            }
-            // Prepare the input as P2WPKH
-            psbt.addInput({
-                hash: input.txid,
-                index: input.vout,
-                witnessUtxo: {
-                    script: input.scriptPubKey,
-                    value: input.value,
-                },
-            });
-        }));
-        outputs.forEach((out) => {
-            if (out.address) {
-                psbt.addOutput({
-                    address: out.address,
-                    value: out.value,
-                });
-            }
-            else if (out.script) {
-                psbt.addOutput({
-                    script: out.script,
-                    value: out.value,
-                });
-            }
-        });
-        return psbt;
-    }
-    async getBalance(address) {
-        const balance = await this.btcRpcAdapter.getBalance(address);
-        return Bitcoin.toBTC(balance).toString();
-    }
-    async deriveAddressAndPublicKey(predecessor, path) {
-        const uncompressedPubKey = await this.contract.getDerivedPublicKey({
-            path,
-            predecessor,
-        });
-        if (!uncompressedPubKey) {
-            throw new Error('Failed to get derived public key');
-        }
-        const derivedKey = utils.compressPubKey(uncompressedPubKey);
-        const publicKeyBuffer = Buffer.from(derivedKey, 'hex');
-        const network = parseBTCNetwork(this.network);
-        const payment = bitcoin.payments.p2wpkh({
-            pubkey: publicKeyBuffer,
-            network,
-        });
-        const { address } = payment;
-        if (!address) {
-            throw new Error('Failed to generate Bitcoin address');
-        }
-        return { address, publicKey: derivedKey };
-    }
-    setTransaction(transaction, storageKey) {
-        window.localStorage.setItem(storageKey, JSON.stringify({
-            psbt: transaction.psbt.toHex(),
-            publicKey: transaction.publicKey,
-        }));
-    }
-    getTransaction(storageKey, options) {
-        const txSerialized = window.localStorage.getItem(storageKey);
-        if (!txSerialized)
-            return undefined;
-        if (options?.remove) {
-            window.localStorage.removeItem(storageKey);
-        }
-        const transactionJSON = JSON.parse(txSerialized);
-        return {
-            psbt: bitcoin.Psbt.fromHex(transactionJSON.psbt),
-            publicKey: transactionJSON.publicKey,
-        };
-    }
-    async getMPCPayloadAndTransaction(transactionRequest) {
-        const publicKeyBuffer = Buffer.from(transactionRequest.publicKey, 'hex');
-        const psbt = await this.createPSBT({
-            transactionRequest,
-        });
-        // We can't double sign a PSBT, therefore we serialize the payload before to return it
-        const psbtHex = psbt.toHex();
-        const mpcPayloads = [];
-        const mockKeyPair = (index) => ({
-            publicKey: publicKeyBuffer,
-            sign: (hash) => {
-                mpcPayloads.push({
-                    index,
-                    payload: Array.from(hash),
-                });
-                // Return dummy signature to satisfy the interface
-                return Buffer.alloc(64);
-            },
-        });
-        for (let index = 0; index < psbt.inputCount; index++) {
-            psbt.signInput(index, mockKeyPair(index));
-        }
-        return {
-            transaction: {
-                psbt: bitcoin.Psbt.fromHex(psbtHex),
-                publicKey: transactionRequest.publicKey,
-            },
-            mpcPayloads: mpcPayloads.sort((a, b) => a.index - b.index),
-        };
-    }
-    addSignature({ transaction: { psbt, publicKey }, mpcSignatures, }) {
-        const publicKeyBuffer = Buffer.from(publicKey, 'hex');
-        const keyPair = (index) => ({
-            publicKey: publicKeyBuffer,
-            sign: () => {
-                const mpcSignature = mpcSignatures[index];
-                return Bitcoin.parseRSVSignature(mpcSignature);
-            },
-        });
-        for (let index = 0; index < psbt.inputCount; index++) {
-            psbt.signInput(index, keyPair(index));
-        }
-        psbt.finalizeAllInputs();
-        return psbt.extractTransaction().toHex();
-    }
-    async broadcastTx(txSerialized) {
-        return await this.btcRpcAdapter.broadcastTransaction(txSerialized);
-    }
-}
-Bitcoin.SATOSHIS_PER_BTC = 100000000;

package/src/chains/Bitcoin/types.js

@@ -1 +0,0 @@
-export {};

package/src/chains/Bitcoin/utils.js

@@ -1,13 +0,0 @@
-import * as bitcoin from 'bitcoinjs-lib';
-export function parseBTCNetwork(network) {
-    switch (network.toLowerCase()) {
-        case 'mainnet':
-            return bitcoin.networks.bitcoin;
-        case 'testnet':
-            return bitcoin.networks.testnet;
-        case 'regtest':
-            return bitcoin.networks.regtest;
-        default:
-            throw new Error(`Unknown Bitcoin network: ${network}`);
-    }
-}

package/src/chains/Chain.js

@@ -1,9 +0,0 @@
-/**
- * Core interface for blockchain implementations.
- * Provides a standardized way to interact with different blockchain networks through a common set of methods.
- *
- * @typeParam TransactionRequest - The type of transaction request specific to the blockchain
- * @typeParam UnsignedTransaction - The type of unsigned transaction specific to the blockchain
- */
-export class Chain {
-}

package/src/chains/ChainSignatureContract.d.ts

@@ -1,62 +0,0 @@
-import type BN from 'bn.js';
-import type { RSVSignature, UncompressedPubKeySEC1 } from './types';
-/**
- * Arguments for the sign method
- */
-export interface SignArgs {
-    /** The payload to sign as an array of 32 bytes */
-    payload: number[];
-    /** The derivation path for key generation */
-    path: string;
-    /** Version of the key to use */
-    key_version: number;
-}
-/**
- * Abstract class defining the interface for chain signature contracts.
- * This contract handles MPC (Multi-Party Computation) operations for secure key derivation and signing.
- * It serves as a bridge between the blockchain implementations and the MPC infrastructure.
- */
-export declare abstract class ChainSignatureContract {
-    /**
-     * Gets the current signature deposit required by the contract.
-     * This deposit amount helps manage network congestion.
-     *
-     * @returns Promise resolving to the required deposit amount as a BigNumber
-     * @throws Error if the deposit check fails
-     */
-    abstract getCurrentSignatureDeposit(): Promise<BN>;
-    /**
-     * Gets the public key associated with this contract.
-     * This is the root public key from which child keys can be derived.
-     *
-     * @returns Promise resolving to the uncompressed public key
-     * @throws Error if public key retrieval fails
-     */
-    abstract getPublicKey(): Promise<UncompressedPubKeySEC1>;
-    /**
-     * Signs a payload using MPC.
-     * This is the core signing operation that coordinates with the MPC infrastructure.
-     *
-     * @param args - Arguments for the signing operation
-     * @param args.payload - The data to sign
-     * @param args.path - Derivation path for the signing key
-     * @param args.key_version - Version of the key to use
-     * @returns Promise resolving to the RSV signature
-     * @throws Error if signing fails or is rejected
-     */
-    abstract sign(args: SignArgs & Record<string, unknown>): Promise<RSVSignature>;
-    /**
-     * Derives a child public key using a derivation path and predecessor.
-     * This method implements hierarchical deterministic key derivation.
-     *
-     * @param args - Arguments for key derivation
-     * @param args.path - The derivation path to use
-     * @param args.predecessor - The predecessor key (usually a NEAR account) that controls this derived key
-     * @returns Promise resolving to the derived uncompressed public key
-     * @throws Error if key derivation fails
-     */
-    abstract getDerivedPublicKey(args: {
-        path: string;
-        predecessor: string;
-    } & Record<string, unknown>): Promise<UncompressedPubKeySEC1>;
-}

package/src/chains/ChainSignatureContract.js

@@ -1,7 +0,0 @@
-/**
- * Abstract class defining the interface for chain signature contracts.
- * This contract handles MPC (Multi-Party Computation) operations for secure key derivation and signing.
- * It serves as a bridge between the blockchain implementations and the MPC infrastructure.
- */
-export class ChainSignatureContract {
-}