signet.js 0.0.3 → 0.0.4

package/docs/pages/signetjs/chains/evm.mdx

@@ -1,319 +0,0 @@
-# EVM Chain Implementation
-
-This implementation supports all EVM-compatible networks (Ethereum, Binance Smart Chain, Polygon, etc.).
-
-## Configuration
-
-```ts twoslash filename="base.ts"
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-import { EVM } from 'signet.js'
-
-// Initialize the chain
-const chain = new EVM({
-  rpcUrl: 'https://mainnet.infura.io/v3/YOUR-PROJECT-ID',
-  contract,
-})
-```
-
-## Methods
-
-### getBalance
-
-Gets the native token balance of an address in the chain's base units.
-
-```ts twoslash
-// [!include base.ts]
-// ---cut---
-const { balance, decimals } = await chain.getBalance('0x...')
-```
-
-**Parameters:**
-
-- `address`: The EVM address to check
-
-**Returns:**
-
-- The balance in the chain's base units as a bigint
-- The number of decimals used to format the balance
-
-### deriveAddressAndPublicKey
-
-Derives an EVM address and public key from a predecessor ID and derivation path.
-
-```ts twoslash
-// [!include base.ts]
-// ---cut---
-const { address, publicKey } = await chain.deriveAddressAndPublicKey(
-  '0x...',
-  'any_string'
-)
-```
-
-**Parameters:**
-
-- `predecessor`: The wallet/contract address requesting the signature
-- `path`: The derivation path to use
-
-**Returns:**
-
-- Object containing:
-  - `address`: The derived EVM address
-  - `publicKey`: The corresponding public key in SEC1 uncompressed format
-
-### prepareTransactionForSigning
-
-Prepares a transaction for MPC signing.
-
-```ts twoslash filename="unsigned-transaction.ts"
-// [!include base.ts]
-// ---cut---
-import { EVMTransactionRequest } from 'signet.js'
-
-const transactionRequest: EVMTransactionRequest = {
-  to: '0x...',
-  from: '0x...',
-  value: 100000000000000000n,
-  data: '0x...',
-}
-
-const { transaction: unsignedTransaction, hashesToSign } =
-  await chain.prepareTransactionForSigning(transactionRequest)
-```
-
-The transaction is enhanced with:
-
-- Gas estimation
-- Nonce calculation
-- Chain ID
-- EIP-1559 fee parameters
-
-### attachTransactionSignature
-
-Adds a signature to an unsigned transaction.
-
-```ts twoslash
-// [!include unsigned-transaction.ts]
-// ---cut---
-import { RSVSignature } from 'signet.js'
-
-// Ideally it would be a request to the Sig Network Smart Contract
-const rsvSignatures: RSVSignature[] = [
-  {
-    r: '0x...',
-    s: '0x...',
-    v: 27,
-  },
-]
-
-const txSerialized = await chain.attachTransactionSignature({
-  transaction: unsignedTransaction,
-  rsvSignatures,
-})
-```
-
-**Parameters:**
-
-- `transaction`: The unsigned transaction
-- `rsvSignatures`: Array of RSV signatures from MPC
-
-**Returns:**
-
-- The serialized signed transaction
-
-### broadcastTx
-
-Broadcasts a signed transaction to the network.
-
-```ts twoslash
-// [!include base.ts]
-// ---cut---
-const txHash = await chain.broadcastTx('0x...transactionSerialized')
-```
-
-**Parameters:**
-
-- `txSerialized`: The serialized signed transaction
-
-**Returns:**
-
-- The transaction hash
-
-### prepareMessageForSigning
-
-Prepares a message for MPC signing according to EIP-191.
-
-```ts twoslash filename="message-signing.ts"
-// [!include base.ts]
-// ---cut---
-import { EVMMessage } from 'signet.js'
-
-const message: EVMMessage = 'Sign this message'
-
-const { hashesToSign } = await chain.prepareMessageForSigning(message)
-```
-
-**Parameters:**
-
-- `message`: The message to be signed
-
-**Returns:**
-
-- Object containing:
-
-  - `hashesToSign`: Array of payloads for MPC signing
-
-### assembleMessageSignature
-
-Adds a signature to a message.
-
-```ts twoslash
-// [!include message-signing.ts]
-// ---cut---
-import { RSVSignature } from 'signet.js'
-
-// Ideally it would be a request to the Sig Network Smart Contract
-const rsvSignatures: RSVSignature[] = [
-  {
-    r: '0x...',
-    s: '0x...',
-    v: 27,
-  },
-]
-
-const signature = chain.assembleMessageSignature({
-  rsvSignatures,
-})
-```
-
-**Parameters:**
-
-- `rsvSignatures`: Array of RSV signatures from MPC
-
-**Returns:**
-
-- The signature in hex format
-
-### prepareTypedDataForSigning
-
-Prepares EIP-712 typed data for MPC signing.
-
-```ts twoslash filename="typed-data-signing.ts"
-// [!include base.ts]
-// ---cut---
-import { EVMTypedData } from 'signet.js'
-
-const typedData: EVMTypedData = {
-  domain: {
-    name: 'Test',
-    version: '1',
-    chainId: 1,
-    verifyingContract: '0x1234567890123456789012345678901234567890',
-  },
-  types: {
-    Person: [
-      { name: 'name', type: 'string' },
-      { name: 'wallet', type: 'address' },
-    ],
-  },
-  primaryType: 'Person',
-  message: {
-    name: 'Bob',
-    wallet: '0x1234567890123456789012345678901234567890',
-  },
-}
-
-const { hashesToSign } = await chain.prepareTypedDataForSigning(typedData)
-```
-
-**Parameters:**
-
-- `typedData`: The EIP-712 typed data object to be signed
-
-**Returns:**
-
-- Object containing:
-  - `hashesToSign`: Array of payloads for MPC signing
-
-### assembleTypedDataSignature
-
-Adds a signature to typed data.
-
-```ts twoslash
-// [!include typed-data-signing.ts]
-// ---cut---
-import { RSVSignature } from 'signet.js'
-
-// Ideally it would be a request to the Sig Network Smart Contract
-const rsvSignatures: RSVSignature[] = [
-  {
-    r: '0x...',
-    s: '0x...',
-    v: 27,
-  },
-]
-
-const signature = chain.assembleTypedDataSignature({
-  rsvSignatures,
-})
-```
-
-**Parameters:**
-
-- `rsvSignatures`: Array of RSV signatures from MPC
-
-**Returns:**
-
-- The signature in hex format
-
-## Adding New EVM Chains
-
-To add support for a new EVM-compatible chain, you only need to configure the provider URL. The chain ID and network configuration are automatically retrieved from the provider.
-
-```ts twoslash
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-import { EVM } from 'signet.js'
-
-// For Polygon (Matic)
-const polygonChain = new EVM({
-  rpcUrl: 'https://polygon-rpc.com',
-  contract,
-})
-
-// For Binance Smart Chain
-const bscChain = new EVM({
-  rpcUrl: 'https://bsc-dataseed.binance.org',
-  contract,
-})
-
-// For Arbitrum
-const arbitrumChain = new EVM({
-  rpcUrl: 'https://arb1.arbitrum.io/rpc',
-  contract,
-})
-```
-
-## Types
-
-The following types are used on the EVM chain:
-
-```ts twoslash
-// [!include ~/../src/chains/EVM/types.ts]
-```
-
-## Technical Details
-
-The implementation:
-
-- Uses `viem` for transaction handling and RPC communication
-- Supports both legacy and EIP-1559 transactions
-- Handles automatic nonce management
-- Supports contract interactions through ABI encoding
-- Provides automatic gas estimation and fee calculation
-- Compatible with all EVM-based networks
-- Supports ENS name resolution on networks that implement it
-- Handles transaction signing according to EIP-155
-- Supports raw transaction data for custom contract interactions
-- Supports EIP-191 personal message signing
-- Supports EIP-712 typed data signing

package/docs/pages/signetjs/contract-addresses.mdx

@@ -1,27 +0,0 @@
-# Contract Addresses
-
-All the necessary constants to interact with the Sig Network are exported from the `constants.ts` file.
-
-## Using the Constants in your code
-
-You can import and use them in your code as follows:
-
-```ts twoslash
-import { utils } from 'signet.js'
-
-const evmTestnetAddress = utils.constants.CONTRACT_ADDRESSES.ETHEREUM.TESTNET
-
-console.log(evmTestnetAddress) // '0x83458E8Bf8206131Fe5c05127007FA164c0948A2'
-
-const testnetPublicKey = utils.constants.ROOT_PUBLIC_KEYS.TESTNET
-
-console.log(testnetPublicKey) // 'secp256k1:3Ww8iFjqTHufye5aRGUvrQqETegR4gVUcW8FX5xzscaN9ENhpkffojsxJwi6N1RbbHMTxYa9UyKeqK3fsMuwxjR5'
-```
-
-## Constants file
-
-For reference, here is the file with the full list of constants and their explanations:
-
-```ts twoslash
-// [!include ~/../src/utils/constants.ts]
-```

package/docs/pages/signetjs/index.mdx

@@ -1,88 +0,0 @@
-# Quick Start
-
-## Installation
-
-```bash
-npm install signet.js
-# or
-yarn add signet.js
-# or
-pnpm add signet.js
-```
-
-## Signing a Transaction
-
-Here's a basic example using the EVM implementation:
-
-```ts twoslash
-import { utils, EVM } from 'signet.js'
-// [!include ~/snippets/code/evm/env.ts]
-
-const chainSigContract = new utils.chains.evm.ChainSignatureContract({
-  publicClient,
-  walletClient,
-  contractAddress: utils.constants.CONTRACT_ADDRESSES.ETHEREUM
-    .TESTNET_DEV as `0x${string}`,
-})
-
-const evm = new EVM({
-  rpcUrl: 'https://sepolia.infura.io/v3/YOUR-PROJECT-ID',
-  contract: chainSigContract,
-})
-
-const path = 'eth' // The path is an arbitrary string, it can be anything, each path will map to a different address/key
-const predecessorId = walletClient.account.address // The predecessor ID is your wallet/contract address that will call the ChainSignatureContract
-
-const { address: from, publicKey } = await evm.deriveAddressAndPublicKey(
-  predecessorId,
-  path
-)
-
-const { balance, decimals } = await evm.getBalance(from)
-
-const { transaction, hashesToSign } = await evm.prepareTransactionForSigning({
-  from: from as `0x${string}`,
-  to: '0x4174678c78fEaFd778c1ff319D5D326701449b25',
-  value: 1n, // Amount in wei (1 wei in this example)
-})
-
-const rsvSignature = await chainSigContract?.sign({
-  payload: hashesToSign[0],
-  path,
-  key_version: 0, // The version of the key to use (usually 0)
-})
-
-const tx = evm.attachTransactionSignature({
-  transaction,
-  rsvSignatures: [rsvSignature],
-})
-
-const txHash = await evm.broadcastTx(tx)
-```
-
-## Supported Chains
-
-- [EVM Chains](/signetjs/chains/evm.mdx) - Ethereum and compatible networks
-- [Bitcoin](/signetjs/chains/bitcoin/bitcoin.mdx) - Bitcoin network
-- [Cosmos Chains](/signetjs/chains/cosmos.mdx) - Cosmos SDK-based networks
-
-## 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](/signetjs/advanced/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:
-
-- Near
-- EVM
-
-## Repositories
-
-- Signet.js: [https://github.com/sig-net/signet.js](https://github.com/sig-net/signet.js).
-- Examples: [https://github.com/sig-net/signet-examples](https://github.com/sig-net/signet-examples).
-- MPC: [https://github.com/sig-net/mpc](https://github.com/sig-net/mpc).

package/docs/snippets/code/contract.ts

@@ -1,21 +0,0 @@
-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/code/evm/env.ts

@@ -1,16 +0,0 @@
-import { createPublicClient, createWalletClient, http } from 'viem'
-import { privateKeyToAccount } from 'viem/accounts'
-import { sepolia } from 'viem/chains'
-
-const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`)
-
-const publicClient = createPublicClient({
-  chain: sepolia,
-  transport: http(),
-})
-
-const walletClient = createWalletClient({
-  account,
-  chain: sepolia,
-  transport: http(),
-})

package/docs/snippets/code/near/env.ts

@@ -1,13 +0,0 @@
-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/hardhat.config.mts

@@ -1,19 +0,0 @@
-import '@nomicfoundation/hardhat-toolbox'
-
-const config = {
-  solidity: '0.8.24',
-  networks: {
-    hardhat: {
-      mining: {
-        auto: true,
-        interval: 1000,
-      },
-    },
-    localhost: {
-      url: 'http://127.0.0.1:8545',
-      chainId: 31337,
-    },
-  },
-}
-
-export default config

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

@@ -1,11 +0,0 @@
-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

@@ -1,96 +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 '@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

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

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

@@ -1,72 +0,0 @@
-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

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