signet.js 0.0.7 → 0.0.8

package/docs/pages/signetjs/contracts/near/constructor.mdx

@@ -1,29 +0,0 @@
-# Constructor
-
-Creates a new instance of the NEAR Chain Signature Contract.
-
-## Usage
-
-```ts twoslash
-import { contracts } from 'signet.js'
-import { KeyPair } from '@near-js/crypto'
-
-const contract = new contracts.near.ChainSignatureContract({
-  networkId: 'testnet',
-  contractId: 'chainsig.testnet',
-  accountId: 'your-account.testnet',
-  keypair: KeyPair.fromString('ed25519:your-private-key'),
-})
-```
-
-## Parameters
-
-| Parameter                      | Type                         | Description                                                                     |
-| ------------------------------ | ---------------------------- | ------------------------------------------------------------------------------- |
-| `args`                         | `ChainSignatureContractArgs` | Configuration options for the contract                                          |
-| `args.networkId`               | `NearNetworkIds`             | The NEAR network ID ('mainnet', 'testnet', etc.)                                |
-| `args.contractId`              | `ChainSignatureContractIds`  | The contract ID of the Chain Signatures contract                                |
-| `args.accountId?`              | `string`                     | Optional account ID to use for transactions. Defaults to a placeholder account  |
-| `args.keypair?`                | `KeyPair`                    | Optional keypair to use for transactions. Defaults to a random keypair          |
-| `args.rootPublicKey?`          | `NajPublicKey`               | Optional root public key. If not provided, it will be fetched from the contract |
-| `args.sendTransactionOptions?` | `SendTransactionOptions`     | Optional configuration for sending transactions                                 |

package/docs/pages/signetjs/contracts/near/get-current-signature-deposit.mdx

@@ -1,17 +0,0 @@
-# getCurrentSignatureDeposit
-
-Retrieves the current signature deposit amount required by the contract.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-const deposit = await nearChainSigContract.getCurrentSignatureDeposit()
-```
-
-## Returns
-
-| Type          | Description                                       |
-| ------------- | ------------------------------------------------- |
-| `Promise<BN>` | The current signature deposit amount in yoctoNEAR |

package/docs/pages/signetjs/contracts/near/get-derived-public-key.mdx

@@ -1,28 +0,0 @@
-# getDerivedPublicKey
-
-Derives a public key from a predecessor ID and derivation path.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-const publicKey = await nearChainSigContract.getDerivedPublicKey({
-  path: 'my_derivation_path',
-  predecessor: 'your-account.testnet',
-})
-```
-
-## Parameters
-
-| Parameter          | Type     | Description                             |
-| ------------------ | -------- | --------------------------------------- |
-| `args`             | `object` | Arguments for deriving the public key   |
-| `args.path`        | `string` | The derivation path to use              |
-| `args.predecessor` | `string` | The account ID requesting the signature |
-
-## Returns
-
-| Type                              | Description                                        |
-| --------------------------------- | -------------------------------------------------- |
-| `Promise<UncompressedPubKeySEC1>` | The derived public key in SEC1 uncompressed format |

package/docs/pages/signetjs/contracts/near/get-public-key.mdx

@@ -1,17 +0,0 @@
-# getPublicKey
-
-Retrieves the root public key from the contract.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-const publicKey = await nearChainSigContract.getPublicKey()
-```
-
-## Returns
-
-| Type                              | Description                                     |
-| --------------------------------- | ----------------------------------------------- |
-| `Promise<UncompressedPubKeySEC1>` | The root public key in SEC1 uncompressed format |

package/docs/pages/signetjs/contracts/near/sign.mdx

@@ -1,32 +0,0 @@
-# sign
-
-Signs data using the Chain Signatures contract.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-const signature = await nearChainSigContract.sign({
-  path: 'my_derivation_path',
-  payload: Array.from(new Uint8Array(32).fill(1)), // 32-byte array
-  key_version: 0,
-})
-```
-
-## Parameters
-
-| Parameter          | Type       | Description                               |
-| ------------------ | ---------- | ----------------------------------------- |
-| `args`             | `SignArgs` | Arguments for signing data                |
-| `args.path`        | `string`   | The derivation path to use                |
-| `args.predecessor` | `string`   | The account ID requesting the signature   |
-| `args.payload`     | `string`   | The data to sign (32-byte hex string)     |
-| `options?`         | `object`   | Optional configuration for signing        |
-| `options.nonce?`   | `number`   | Optional nonce to use for the transaction |
-
-## Returns
-
-| Type                    | Description                 |
-| ----------------------- | --------------------------- |
-| `Promise<RSVSignature>` | The signature in RSV format |

package/docs/snippets/code/chains.ts

@@ -1,42 +0,0 @@
-import { createPublicClient, createWalletClient, http } from 'viem'
-import { privateKeyToAccount } from 'viem/accounts'
-import { sepolia } from 'viem/chains'
-import { chainAdapters, contracts, constants } from 'signet.js'
-
-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(),
-})
-
-const chainSigContract = new contracts.evm.ChainSignatureContract({
-  publicClient,
-  walletClient,
-  contractAddress: constants.CONTRACT_ADDRESSES.ETHEREUM
-    .TESTNET_DEV as `0x${string}`,
-})
-
-const evmChain = new chainAdapters.evm.EVM({
-  rpcUrl: 'https://sepolia.infura.io/v3/YOUR-PROJECT-ID',
-  contract: chainSigContract,
-})
-
-const cosmosChain = new chainAdapters.cosmos.Cosmos({
-  chainId: 'cosmoshub-4',
-  contract: chainSigContract,
-})
-
-const btcChain = new chainAdapters.btc.Bitcoin({
-  network: 'testnet',
-  btcRpcAdapter: new chainAdapters.btc.BTCRpcAdapters.Mempool(
-    'https://mempool.space/api'
-  ),
-  contract: chainSigContract,
-})

package/docs/snippets/code/contract.ts

@@ -1,44 +0,0 @@
-import { contracts, constants } from 'signet.js'
-import { createPublicClient, createWalletClient, http } from 'viem'
-import { privateKeyToAccount } from 'viem/accounts'
-import { sepolia } from 'viem/chains'
-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)
-
-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(),
-})
-
-const evmChainSigContract = new contracts.evm.ChainSignatureContract({
-  publicClient,
-  walletClient,
-  contractAddress: constants.CONTRACT_ADDRESSES.ETHEREUM
-    .TESTNET_DEV as `0x${string}`,
-})
-
-const nearChainSigContract = new contracts.near.ChainSignatureContract({
-  networkId: 'testnet',
-  contractId: constants.CONTRACT_ADDRESSES.NEAR.TESTNET,
-  accountId,
-  keypair,
-})

package/docs/snippets/code/evm/contract.ts

@@ -1,24 +0,0 @@
-import { contracts, constants } from 'signet.js'
-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(),
-})
-
-const evmChainSigContract = new contracts.evm.ChainSignatureContract({
-  publicClient,
-  walletClient,
-  contractAddress: constants.CONTRACT_ADDRESSES.ETHEREUM
-    .TESTNET_DEV as `0x${string}`,
-})

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/chain-adapters/Bitcoin/BTCRpcAdapter/BTCRpcAdapter.ts

@@ -1,15 +0,0 @@
-import type {
-  BTCTransaction,
-  BTCInput,
-  BTCOutput,
-} from '@chain-adapters/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/chain-adapters/Bitcoin/BTCRpcAdapter/Mempool/Mempool.ts

@@ -1,101 +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 '@chain-adapters/Bitcoin/BTCRpcAdapter/BTCRpcAdapter'
-import {
-  type BTCFeeRecommendation,
-  type UTXO,
-} from '@chain-adapters/Bitcoin/BTCRpcAdapter/Mempool/types'
-import type {
-  BTCTransaction,
-  BTCInput,
-  BTCOutput,
-} from '@chain-adapters/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/chain-adapters/Bitcoin/BTCRpcAdapter/Mempool/index.ts

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

package/src/chain-adapters/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/chain-adapters/Bitcoin/BTCRpcAdapter/index.ts

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