signet.js 0.0.7 → 0.0.9-retry

package/docs/pages/signetjs/chain-adapters/cosmos/index.mdx

@@ -1,108 +0,0 @@
-# Cosmos Chain
-
-The Cosmos chain implementation in Signet.js provides support for Cosmos SDK-based networks (Cosmos Hub, Osmosis, etc.) with a focus on standard transactions and IBC transfers.
-
-## Overview
-
-The Cosmos implementation allows you to:
-
-- Generate addresses and public keys
-- Check balances
-- Prepare, sign, and broadcast transactions
-- Support for various Cosmos SDK message types
-
-## Complete Transaction Example
-
-Below is a complete example of sending a transaction on a Cosmos chain using Signet.js:
-
-```ts twoslash
-import { chainAdapters } from 'signet.js'
-// [!include ~/snippets/code/evm/contract.ts]
-
-const cosmos = new chainAdapters.cosmos.Cosmos({
-  chainId: 'cosmoshub-4',
-  contract: evmChainSigContract,
-})
-
-const path = 'cosmos'
-const predecessorId = walletClient.account.address
-
-const { address: from, publicKey } = await cosmos.deriveAddressAndPublicKey(
-  predecessorId,
-  path
-)
-
-const { balance, decimals } = await cosmos.getBalance(from)
-
-const { transaction, hashesToSign } = await cosmos.prepareTransactionForSigning(
-  {
-    address: from,
-    publicKey,
-    messages: [
-      {
-        typeUrl: '/cosmos.bank.v1beta1.MsgSend',
-        value: {
-          fromAddress: from,
-          toAddress: 'cosmos1jq304cthpx0lwhpqzrdjrcza559ukyy347xu57',
-          amount: [
-            {
-              denom: 'uatom',
-              amount: '1000000', // 1 ATOM (1,000,000 uatom)
-            },
-          ],
-        },
-      },
-    ],
-    memo: 'Sent via Signet.js',
-  }
-)
-
-const rsvSignature = await evmChainSigContract.sign({
-  payload: hashesToSign[0],
-  path,
-  key_version: 0,
-})
-
-const tx = cosmos.finalizeTransactionSigning({
-  transaction,
-  rsvSignatures: [rsvSignature],
-})
-
-const txHash = await cosmos.broadcastTx(tx)
-```
-
-### Supported Networks
-
-You can use any Cosmos SDK-based network by providing the appropriate chain ID:
-
-```ts twoslash
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-import { chainAdapters } from 'signet.js'
-
-// Cosmos Hub
-const cosmosHub = new chainAdapters.cosmos.Cosmos({
-  chainId: 'cosmoshub-4',
-  contract: evmChainSigContract,
-})
-
-// Osmosis
-const osmosis = new chainAdapters.cosmos.Cosmos({
-  chainId: 'osmosis-1',
-  contract: evmChainSigContract,
-})
-
-// Juno
-const juno = new chainAdapters.cosmos.Cosmos({
-  chainId: 'juno-1',
-  contract: evmChainSigContract,
-})
-```
-
-## Types
-
-The following types are used on the Cosmos chain:
-
-```ts twoslash
-// [!include ~/../src/chain-adapters/Cosmos/types.ts]
-```

package/docs/pages/signetjs/chain-adapters/cosmos/prepare-transaction-for-signing.mdx

@@ -1,39 +0,0 @@
-# prepareTransactionForSigning
-
-The `prepareTransactionForSigning` method prepares a Cosmos transaction for MPC signing by creating the transaction structure and computing the hash that needs to be signed.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/chains.ts]
-// ---cut---
-const { transaction, hashesToSign } =
-  await cosmosChain.prepareTransactionForSigning({
-    address: 'cosmos1...',
-    publicKey: '0350e8...',
-    messages: [
-      {
-        typeUrl: '/cosmos.bank.v1beta1.MsgSend',
-        value: {
-          fromAddress: 'cosmos1...',
-          toAddress: 'cosmos1...',
-          amount: [{ denom: 'uatom', amount: '1000000' }],
-        },
-      },
-    ],
-    memo: 'Token transfer',
-  })
-```
-
-## Parameters
-
-| Parameter            | Type                       | Description                                                                                                |
-| -------------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------- |
-| `transactionRequest` | `CosmosTransactionRequest` | The transaction request object containing address, publicKey, messages, and optional memo and fee settings |
-
-## Returns
-
-| Property       | Type                        | Description                                |
-| -------------- | --------------------------- | ------------------------------------------ |
-| `transaction`  | `CosmosUnsignedTransaction` | Object containing the unsigned transaction |
-| `hashesToSign` | `string[]`                  | Array of hashes that need to be signed     |

package/docs/pages/signetjs/chain-adapters/derive-address-and-public-key.mdx

@@ -1,28 +0,0 @@
-# deriveAddressAndPublicKey
-
-The `deriveAddressAndPublicKey` method derives an address and public key from a predecessor ID and derivation path.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/chains.ts]
-// ---cut---
-const { address, publicKey } = await evmChain.deriveAddressAndPublicKey(
-  '0x8626f6940E2eb28930eFb4CeF49B2d1F2C9C1199',
-  'my_derivation_path'
-)
-```
-
-## Parameters
-
-| Parameter     | Type     | Description                                          |
-| ------------- | -------- | ---------------------------------------------------- |
-| `predecessor` | `string` | The wallet/contract address requesting the signature |
-| `path`        | `string` | The derivation path to use                           |
-
-## Returns
-
-| Property    | Type     | Description                                              |
-| ----------- | -------- | -------------------------------------------------------- |
-| `address`   | `string` | The derived address                                      |
-| `publicKey` | `string` | The corresponding public key in SEC1 uncompressed format |

package/docs/pages/signetjs/chain-adapters/evm/finalize-message-signing.mdx

@@ -1,33 +0,0 @@
-# finalizeMessageSigning
-
-The `finalizeMessageSigning` assemble the Message signature
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/chains.ts]
-// ---cut---
-import { RSVSignature } from 'signet.js'
-
-const rsvSignature: RSVSignature = {
-  r: '0x123...',
-  s: '0x123...',
-  v: 27,
-}
-
-const signature = evmChain.finalizeMessageSigning({
-  rsvSignature,
-})
-```
-
-## Parameters
-
-| Parameter      | Type           | Description                            |
-| -------------- | -------------- | -------------------------------------- |
-| `rsvSignature` | `RSVSignature` | The RSV signature from the MPC network |
-
-## Returns
-
-| Type     | Description                                  |
-| -------- | -------------------------------------------- |
-| `string` | The signature in hex format (with 0x prefix) |

package/docs/pages/signetjs/chain-adapters/evm/finalize-transaction-signing.mdx

@@ -1,44 +0,0 @@
-# finalizeTransactionSigning
-
-The `finalizeTransactionSigning` method adds a signature to an unsigned transaction, producing a signed transaction that can be broadcast to the network.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/chains.ts]
-const { transaction, hashesToSign } =
-  await evmChain.prepareTransactionForSigning({
-    to: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
-    from: '0x8626f6940E2eb28930eFb4CeF49B2d1F2C9C1199',
-    value: 1n,
-    data: '0x',
-  })
-// ---cut---
-import { RSVSignature } from 'signet.js'
-
-const rsvSignatures: RSVSignature[] = [
-  {
-    r: '0x123...',
-    s: '0x123...',
-    v: 27,
-  },
-]
-
-const signedTx = evmChain.finalizeTransactionSigning({
-  transaction,
-  rsvSignatures,
-})
-```
-
-## Parameters
-
-| Parameter       | Type                     | Description                                                         |
-| --------------- | ------------------------ | ------------------------------------------------------------------- |
-| `transaction`   | `EVMUnsignedTransaction` | The unsigned transaction prepared by `prepareTransactionForSigning` |
-| `rsvSignatures` | `RSVSignature[]`         | Array of RSV signatures from the MPC network                        |
-
-## Returns
-
-| Type     | Description                                                   |
-| -------- | ------------------------------------------------------------- |
-| `string` | The serialized signed transaction (hex string with 0x prefix) |

package/docs/pages/signetjs/chain-adapters/evm/finalize-typed-data-signing.mdx

@@ -1,34 +0,0 @@
-# finalizeTypedDataSigning
-
-The `finalizeTypedDataSigning` method adds a signature to EIP-712 typed data, producing a signature that can be verified by Ethereum-compatible systems.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/chains.ts]
-// ---cut---
-import { RSVSignature } from 'signet.js'
-
-const rsvSignature: RSVSignature = {
-  r: '0x123...',
-  s: '0x123...',
-  v: 27,
-}
-
-// Assuming you have a signature from the MPC network
-const signature = evmChain.finalizeTypedDataSigning({
-  rsvSignature,
-})
-```
-
-## Parameters
-
-| Parameter      | Type           | Description                            |
-| -------------- | -------------- | -------------------------------------- |
-| `rsvSignature` | `RSVSignature` | The RSV signature from the MPC network |
-
-## Returns
-
-| Type     | Description                                  |
-| -------- | -------------------------------------------- |
-| `string` | The signature in hex format (with 0x prefix) |

package/docs/pages/signetjs/chain-adapters/evm/index.mdx

@@ -1,84 +0,0 @@
-# EVM Chain
-
-The EVM (Ethereum Virtual Machine) chain implementation in Signet.js provides support for all EVM-compatible networks, including Ethereum, Binance Smart Chain, Polygon, Arbitrum, and more.
-
-## Overview
-
-The EVM implementation allows you to:
-
-- Derive addresses and public keys
-- Check balances
-- Prepare, sign, and broadcast transactions
-- Sign messages (EIP-191)
-- Sign typed data (EIP-712)
-
-## Complete Transaction Example
-
-Below is a complete example of sending a transaction on an EVM chain using Signet.js:
-
-```ts twoslash
-import { chainAdapters } from 'signet.js'
-// [!include ~/snippets/code/evm/contract.ts]
-
-const evm = new chainAdapters.evm.EVM({
-  rpcUrl: 'https://sepolia.infura.io/v3/YOUR-PROJECT-ID',
-  contract: evmChainSigContract,
-})
-
-const path = 'eth'
-const predecessorId = walletClient.account.address
-
-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 evmChainSigContract.sign({
-  payload: hashesToSign[0],
-  path,
-  key_version: 0,
-})
-
-const tx = evm.finalizeTransactionSigning({
-  transaction,
-  rsvSignatures: [rsvSignature],
-})
-
-const txHash = await evm.broadcastTx(tx)
-```
-
-### Supported Networks
-
-You can use any EVM-compatible network by providing the appropriate RPC URL:
-
-```ts twoslash
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-import { chainAdapters } from 'signet.js'
-
-// Ethereum Mainnet
-const ethereumChain = new chainAdapters.evm.EVM({
-  rpcUrl: 'https://mainnet.infura.io/v3/YOUR-PROJECT-ID',
-  contract: evmChainSigContract,
-})
-
-// Polygon (Matic)
-const polygonChain = new chainAdapters.evm.EVM({
-  rpcUrl: 'https://polygon-rpc.com',
-  contract: evmChainSigContract,
-})
-
-// Binance Smart Chain
-const bscChain = new chainAdapters.evm.EVM({
-  rpcUrl: 'https://bsc-dataseed.binance.org',
-  contract: evmChainSigContract,
-})
-```

package/docs/pages/signetjs/chain-adapters/evm/prepare-message-for-signing.mdx

@@ -1,26 +0,0 @@
-# prepareMessageForSigning
-
-The `prepareMessageForSigning` method prepares a message for MPC signing according to EIP-191 (Ethereum signed message standard).
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/chains.ts]
-// ---cut---
-
-const message: chainAdapters.evm.EVMMessage = 'Sign this message'
-
-const { hashToSign } = await evmChain.prepareMessageForSigning(message)
-```
-
-## Parameters
-
-| Parameter | Type         | Description              |
-| --------- | ------------ | ------------------------ |
-| `message` | `EVMMessage` | The message to be signed |
-
-## Returns
-
-| Property     | Type         | Description                              |
-| ------------ | ------------ | ---------------------------------------- |
-| `hashToSign` | `HashToSign` | The hash to be signed by the MPC network |

package/docs/pages/signetjs/chain-adapters/evm/prepare-transaction-for-signing.mdx

@@ -1,30 +0,0 @@
-# prepareTransactionForSigning
-
-The `prepareTransactionForSigning` method prepares an EVM transaction for MPC signing by adding necessary fields like gas estimation, nonce, and chain ID.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/chains.ts]
-// ---cut---
-const { transaction, hashesToSign } =
-  await evmChain.prepareTransactionForSigning({
-    to: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
-    from: '0x8626f6940E2eb28930eFb4CeF49B2d1F2C9C1199',
-    value: 1n, // 1 wei
-    data: '0x', // Empty data for a simple ETH transfer
-  })
-```
-
-## Parameters
-
-| Parameter            | Type                    | Description                    |
-| -------------------- | ----------------------- | ------------------------------ |
-| `transactionRequest` | `EVMTransactionRequest` | The transaction request object |
-
-## Returns
-
-| Property       | Type                     | Description                                       |
-| -------------- | ------------------------ | ------------------------------------------------- |
-| `transaction`  | `EVMUnsignedTransaction` | The prepared transaction with all required fields |
-| `hashesToSign` | `HashToSign[]`           | Array of hash(es) to be signed by the MPC network |

package/docs/pages/signetjs/chain-adapters/evm/prepare-typed-data-for-signing.mdx

@@ -1,44 +0,0 @@
-# prepareTypedDataForSigning
-
-The `prepareTypedDataForSigning` method prepares EIP-712 typed data for MPC signing.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/chains.ts]
-// ---cut---
-
-const typedData: chainAdapters.evm.EVMTypedData = {
-  domain: {
-    name: 'My dApp',
-    version: '1',
-    chainId: 1,
-    verifyingContract: '0x1234567890123456789012345678901234567890',
-  },
-  types: {
-    Person: [
-      { name: 'name', type: 'string' },
-      { name: 'wallet', type: 'address' },
-    ],
-  },
-  primaryType: 'Person',
-  message: {
-    name: 'Alice',
-    wallet: '0x1234567890123456789012345678901234567890',
-  },
-}
-
-const { hashToSign } = await evmChain.prepareTypedDataForSigning(typedData)
-```
-
-## Parameters
-
-| Parameter   | Type           | Description                                |
-| ----------- | -------------- | ------------------------------------------ |
-| `typedData` | `EVMTypedData` | The EIP-712 typed data object to be signed |
-
-## Returns
-
-| Property     | Type         | Description                              |
-| ------------ | ------------ | ---------------------------------------- |
-| `hashToSign` | `HashToSign` | The hash to be signed by the MPC network |

package/docs/pages/signetjs/chain-adapters/get-balance.mdx

@@ -1,26 +0,0 @@
-# getBalance
-
-The `getBalance` method retrieves the native token balance of an address.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/chains.ts]
-// ---cut---
-const { balance, decimals } = await evmChain.getBalance(
-  '0x8626f6940E2eb28930eFb4CeF49B2d1F2C9C1199'
-)
-```
-
-## Parameters
-
-| Parameter | Type     | Description                          |
-| --------- | -------- | ------------------------------------ |
-| `address` | `string` | The address to check the balance for |
-
-## Returns
-
-| Property   | Type     | Description                                                         |
-| ---------- | -------- | ------------------------------------------------------------------- |
-| `balance`  | `bigint` | The balance in the chain's base units (wei for Ethereum)            |
-| `decimals` | `number` | The number of decimals used to format the balance (18 for Ethereum) |

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

@@ -1,38 +0,0 @@
-# EVM Chain Signatures Contract
-
-The EVM Chain Signatures Contract provides an implementation of the abstract `ChainSignatureContract` for EVM-compatible blockchains. It allows you to interact with the Chain Signatures contract deployed on EVM chains.
-
-## Usage
-
-```ts twoslash
-import { contracts, constants } from 'signet.js'
-import { createPublicClient, createWalletClient, http } from 'viem'
-import { sepolia } from 'viem/chains'
-
-const publicClient = createPublicClient({
-  chain: sepolia,
-  transport: http(),
-})
-
-const walletClient = createWalletClient({
-  chain: sepolia,
-  transport: http(),
-})
-
-const contract = new contracts.evm.ChainSignatureContract({
-  publicClient,
-  walletClient,
-  contractAddress: constants.CONTRACT_ADDRESSES.ETHEREUM
-    .TESTNET_DEV as `0x${string}`,
-})
-```
-
-## Parameters
-
-| Parameter              | Type           | Description                                                                     |
-| ---------------------- | -------------- | ------------------------------------------------------------------------------- |
-| `args`                 | `object`       | Configuration options for the contract                                          |
-| `args.publicClient`    | `PublicClient` | A Viem PublicClient instance for reading from the blockchain                    |
-| `args.walletClient`    | `WalletClient` | A Viem WalletClient instance for sending transactions                           |
-| `args.contractAddress` | `Hex`          | The address of the deployed ChainSignatures contract                            |
-| `args.rootPublicKey?`  | `NajPublicKey` | Optional root public key. If not provided, it will be derived from the contract |

package/docs/pages/signetjs/contracts/evm/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 evmChainSigContract.getCurrentSignatureDeposit()
-```
-
-## Returns
-
-| Type          | Description                                 |
-| ------------- | ------------------------------------------- |
-| `Promise<BN>` | The current signature deposit amount in wei |

package/docs/pages/signetjs/contracts/evm/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 evmChainSigContract.getDerivedPublicKey({
-  path: 'my_derivation_path',
-  predecessor: '0x8626f6940E2eb28930eFb4CeF49B2d1F2C9C1199',
-})
-```
-
-## Parameters
-
-| Parameter          | Type     | Description                                          |
-| ------------------ | -------- | ---------------------------------------------------- |
-| `args`             | `object` | Arguments for deriving the public key                |
-| `args.path`        | `string` | The derivation path to use                           |
-| `args.predecessor` | `string` | The wallet/contract address requesting the signature |
-
-## Returns
-
-| Type                              | Description                                        |
-| --------------------------------- | -------------------------------------------------- |
-| `Promise<UncompressedPubKeySEC1>` | The derived public key in SEC1 uncompressed format |

package/docs/pages/signetjs/contracts/evm/get-latest-key-version.mdx

@@ -1,17 +0,0 @@
-# getLatestKeyVersion
-
-Retrieves the latest key version from the contract.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-const keyVersion = await evmChainSigContract.getLatestKeyVersion()
-```
-
-## Returns
-
-| Type              | Description            |
-| ----------------- | ---------------------- |
-| `Promise<number>` | The latest key version |

package/docs/pages/signetjs/contracts/evm/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 evmChainSigContract.getPublicKey()
-```
-
-## Returns
-
-| Type                              | Description                                     |
-| --------------------------------- | ----------------------------------------------- |
-| `Promise<UncompressedPubKeySEC1>` | The root public key in SEC1 uncompressed format |

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

@@ -1,36 +0,0 @@
-# sign
-
-Signs data using the Chain Signatures contract.
-
-## Usage
-
-```ts twoslash
-// [!include ~/snippets/code/contract.ts]
-// ---cut---
-const signature = await evmChainSigContract.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.payload`              | `number[]`    | The data to sign as an array of 32 bytes              |
-| `args.key_version`          | `number`      | Version of the key to use                             |
-| `options?`                  | `SignOptions` | Optional configuration for signing                    |
-| `options.sign.algo?`        | `string`      | Optional algorithm to use for signing                 |
-| `options.sign.dest?`        | `string`      | Optional destination for the signature                |
-| `options.sign.params?`      | `string`      | Optional parameters for the signing process           |
-| `options.retry.delay?`      | `number`      | Delay between retries in milliseconds (default: 5000) |
-| `options.retry.retryCount?` | `number`      | Number of retries to attempt (default: 12)            |
-
-## Returns
-
-| Type                    | Description                 |
-| ----------------------- | --------------------------- |
-| `Promise<RSVSignature>` | The signature in RSV format |