@sig-net/signet.js 0.5.0-rc1

package/LICENSE

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+# Signet.js
+
+A TypeScript library for handling multi-chain transactions and signatures using MPC (Multi-Party Computation).
+
+## Overview
+
+This library provides a unified interface for interacting with different blockchain networks through a common set of methods. It uses MPC for secure key management and transaction signing.
+
+## Features
+
+- **Multi-Chain Support**: Built-in support for EVM chains, Bitcoin, and Cosmos networks
+- **Unified Interface**: Common API across all supported chains
+- **MPC Integration**: Secure key management and transaction signing
+- **Type Safety**: Full TypeScript support with comprehensive type definitions
+- **Modular Design**: Easy to extend with new chain implementations
+- **Secure**: No private keys stored or transmitted
+
+## Installation
+
+```bash
+npm install @sig-net/signet.js
+# or
+yarn add @sig-net/signet.js
+```
+
+## Quick Example (EVM)
+
+```ts twoslash
+import { chainAdapters, contracts } from '@sig-net/signet.js'
+import { createPublicClient, http } from 'viem'
+import { mainnet } from 'viem/chains'
+
+const publicClient = createPublicClient({
+  chain: mainnet,
+  transport: http(),
+})
+
+// Assume you already instantiated your ChainSignatures EVM contract wrapper
+const contract = new contracts.evm.ChainSignatureContract({
+  publicClient,
+  contractAddress: '0xYourContractAddress' as `0x${string}`,
+  walletClient: /* your WalletClient */ undefined as any,
+})
+
+const evmChain = new chainAdapters.evm.EVM({
+  publicClient,
+  contract,
+})
+
+// Derive address and public key for a predecessor identifier
+const predecessorId = '0xYourEOAOrContract'
+const { address, publicKey } = await evmChain.deriveAddressAndPublicKey(
+  predecessorId,
+  'any_string',
+  1
+)
+
+// Check balance
+const { balance, decimals } = await evmChain.getBalance(address)
+
+// Create and sign transaction
+const { transaction, hashesToSign } =
+  await evmChain.prepareTransactionForSigning({
+    from: address,
+    to: '0x...',
+    value: 1n,
+  })
+
+// Request MPC signature
+const rsvSignature = await contract.sign({
+  payload: hashesToSign[0],
+  path: 'any_string',
+  key_version: 1,
+})
+
+// Finalize and broadcast
+const signedTx = evmChain.finalizeTransactionSigning({
+  transaction,
+  rsvSignatures: [rsvSignature],
+})
+
+const txHash = await evmChain.broadcastTx(signedTx)
+```
+
+## Documentation
+
+For detailed documentation, including:
+
+- Getting started guide
+- Chain-specific implementations
+- MPC system overview
+- Implementation guides
+- API reference
+
+Visit our [documentation site](https://docs.sig.network/).