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

package/docs/pages/chains/cosmos.mdx

@@ -1,181 +0,0 @@
-# Cosmos Chain Implementation
-
-The Cosmos chain implementation supports Cosmos SDK-based networks (Cosmos Hub, Osmosis, etc.) with a focus on standard transactions and IBC transfers.
-
-## Configuration
-
-```ts twoslash filename="base.ts"
-// [!include ~/snippets/contract.ts]
-// ---cut---
-import { Cosmos } from 'signet.js'
-
-const cosmosChain = new Cosmos({
-  chainId: 'cosmoshub-4', // Chain ID of the target network
-  contract,
-})
-```
-
-## Methods
-
-### getBalance
-
-Gets the native token balance of an address.
-
-```ts twoslash
-// [!include base.ts]
-// ---cut---
-const balance = await cosmosChain.getBalance('cosmos1...')
-```
-
-**Parameters:**
-
-- `address`: The Cosmos address to check
-
-**Returns:**
-
-- The balance formatted according to the chain's decimal places
-
-### deriveAddressAndPublicKey
-
-Derives a Cosmos address and public key for a given path.
-
-```ts twoslash
-// [!include base.ts]
-// ---cut---
-const { address, publicKey } = await cosmosChain.deriveAddressAndPublicKey(
-  'predecessor_id',
-  'any_string'
-)
-```
-
-**Parameters:**
-
-- `predecessor`: The ID of the signer to derive from
-- `path`: The derivation path to use
-
-**Returns:**
-
-- Object containing:
-  - `address`: The derived Cosmos address (bech32 format)
-  - `publicKey`: The corresponding compressed public key
-
-### getMPCPayloadAndTransaction
-
-Prepares a transaction for MPC signing.
-
-```ts twoslash filename="unsigned-transaction.ts"
-// [!include base.ts]
-// ---cut---
-import { CosmosTransactionRequest } from 'signet.js'
-import { MsgSend } from 'cosmjs-types/cosmos/bank/v1beta1/tx'
-
-// Create a token transfer message
-const sendMsg = {
-  typeUrl: '/cosmos.bank.v1beta1.MsgSend',
-  value: MsgSend.fromPartial({
-    fromAddress: 'cosmos1...',
-    toAddress: 'cosmos1...',
-    amount: [
-      {
-        denom: 'uatom',
-        amount: '1000000', // 1 ATOM (1,000,000 uatom)
-      },
-    ],
-  }),
-}
-
-const transactionRequest: CosmosTransactionRequest = {
-  address: 'cosmos1...',
-  publicKey: '0235a3...',
-  messages: [sendMsg],
-  memo: 'Token transfer',
-}
-
-const { transaction: unsignedTransaction, mpcPayloads } =
-  await cosmosChain.getMPCPayloadAndTransaction(transactionRequest)
-```
-
-**Parameters:**
-
-- `transactionRequest`: Transaction configuration:
-  ```ts
-  {
-    address: string      // Sender's address
-    publicKey: string    // Signer's public key
-    messages: Message[]  // Array of Cosmos SDK messages
-    memo?: string       // Optional transaction memo
-    gas?: number        // Optional gas limit (default: 200,000)
-  }
-  ```
-
-**Returns:**
-
-- Object containing:
-  - `transaction`: The unsigned transaction
-  - `mpcPayloads`: Array of payloads to be signed
-
-### addSignature
-
-Adds signatures to a transaction.
-
-```ts twoslash filename="add-signature.ts"
-// [!include unsigned-transaction.ts]
-// ---cut---
-import { RSVSignature } from 'signet.js'
-
-// Ideally it would be a request to the Sig Network Smart Contract
-const mpcSignatures: RSVSignature[] = [
-  {
-    r: '0x...',
-    s: '0x...',
-    v: 27,
-  },
-]
-
-const signedTx = cosmosChain.addSignature({
-  transaction: unsignedTransaction,
-  mpcSignatures,
-})
-```
-
-**Parameters:**
-
-- `transaction`: The unsigned transaction
-- `mpcSignatures`: Array of RSV signatures from MPC
-
-**Returns:**
-
-- The serialized signed transaction in hex format
-
-### broadcastTx
-
-Broadcasts a signed transaction to the network.
-
-```ts twoslash filename="broadcast-tx.ts"
-// [!include add-signature.ts]
-// ---cut---
-const txHash = await cosmosChain.broadcastTx(signedTx)
-```
-
-**Parameters:**
-
-- `txSerialized`: The serialized transaction in hex format
-
-**Returns:**
-
-- The transaction hash
-
-## Technical Details
-
-The implementation:
-
-- Uses `@cosmjs/stargate` for transaction handling
-- Supports SIGN_MODE_DIRECT signing
-- Uses Protobuf for message encoding
-- Supports standard Cosmos SDK messages:
-  - Bank (Send, MultiSend)
-  - Staking (Delegate, Undelegate, Redelegate)
-  - Distribution (Withdraw Rewards)
-  - IBC (Transfer)
-- Handles automatic fee calculation based on gas prices
-- Supports custom message types through the Registry

package/docs/pages/chains/evm.mdx

@@ -1,189 +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/contract.ts]
-// ---cut---
-import { EVM } from 'signet.js'
-
-// Initialize the chain
-const evmChain = new EVM({
-  rpcUrl: 'https://mainnet.infura.io/v3/YOUR-PROJECT-ID',
-  contract,
-})
-```
-
-## Methods
-
-### getBalance
-
-Gets the native token balance of an address in ETH units.
-
-```ts twoslash
-// [!include base.ts]
-// ---cut---
-const balance = await evmChain.getBalance('0x...')
-```
-
-**Parameters:**
-
-- `address`: The Ethereum address to check
-
-**Returns:**
-
-- The balance in ETH as a string
-
-### deriveAddressAndPublicKey
-
-Derives an Ethereum address and public key from a signer ID and derivation path.
-
-```ts twoslash
-// [!include base.ts]
-// ---cut---
-const { address, publicKey } = await evmChain.deriveAddressAndPublicKey(
-  '0x...',
-  'any_string'
-)
-```
-
-**Parameters:**
-
-- `predecessor`: The ID/address of the signer requesting the signature
-- `path`: The derivation path to use
-
-**Returns:**
-
-- Object containing:
-  - `address`: The derived Ethereum address
-  - `publicKey`: The corresponding public key in SEC1 uncompressed format
-
-### getMPCPayloadAndTransaction
-
-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: '100000000000000000',
-  data: '0x...',
-}
-
-const { transaction: unsignedTransaction, mpcPayloads } =
-  await evmChain.getMPCPayloadAndTransaction(transactionRequest)
-```
-
-The transaction is enhanced with:
-
-- Gas estimation
-- Nonce calculation
-- Chain ID
-- EIP-1559 fee parameters
-
-### addSignature
-
-Adds a signature to an unsigned transaction.
-
-```ts twoslash filename="add-signature.ts"
-// [!include unsigned-transaction.ts]
-// ---cut---
-import { RSVSignature } from 'signet.js'
-
-// Ideally it would be a request to the Sig Network Smart Contract
-const mpcSignatures: RSVSignature[] = [
-  {
-    r: '0x...',
-    s: '0x...',
-    v: 27,
-  },
-]
-
-const txSerialized = await evmChain.addSignature({
-  transaction: unsignedTransaction,
-  mpcSignatures,
-})
-```
-
-**Parameters:**
-
-- `transaction`: The unsigned transaction
-- `mpcSignatures`: Array of RSV signatures from MPC
-
-**Returns:**
-
-- The serialized signed transaction
-
-### broadcastTx
-
-Broadcasts a signed transaction to the network.
-
-```ts twoslash filename="broadcast-tx.ts"
-// [!include add-signature.ts]
-// ---cut---
-const txHash = await evmChain.broadcastTx(txSerialized)
-```
-
-**Parameters:**
-
-- `txSerialized`: The serialized signed transaction
-
-**Returns:**
-
-- The transaction hash
-
-## 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/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,
-})
-```
-
-## Technical Details
-
-The implementation:
-
-- Uses `ethers.js` 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
-
-## Types
-
-The following types are used on the EVM chain:
-
-```ts twoslash
-// [!include ~/../src/chains/EVM/types.ts]
-```

package/docs/pages/index.mdx

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

@@ -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/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/jest.config.ts

@@ -1,199 +0,0 @@
-/**
- * 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;