@wuwei-labs/srsly 2.3.3-canary.36.16828894446.0 → 3.0.0-beta.2

package/README.md

@@ -1,533 +1,197 @@
-# SRSLY SDK
+# @wuwei-labs/srsly
 
-[![npm version](https://img.shields.io/npm/v/@wuwei-labs/srsly.svg)](https://www.npmjs.com/package/@wuwei-labs/srsly)
-[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=flat&logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
-[![Solana](https://img.shields.io/badge/Solana-000?style=flat&logo=solana&logoColor=9945FF)](https://solana.com/)
+> Simplified TypeScript SDK for SRSLY
 
-A TypeScript SDK for building Solana instructions to interact with the SRSLY (Space Rental from SLY) program - a decentralized rental system for Star Atlas fleets.
+**Status:** 🚧 Beta - Under active development
 
-## What This SDK Does
+## What is this?
 
-The SRSLY SDK is a focused instruction builder that helps you create Solana instructions for fleet rentals. It provides:
+This is a simplified TypeScript SDK for SRSLY. It's a thin convenience wrapper around Codama-generated TypeScript clients, focusing on simplicity and maintainability.
 
-- ✅ **Instruction Building** - Creates properly formatted Solana instructions using @solana/kit
-- ✅ **Account derivation and validation** - Automatically derives required accounts
-- ✅ **Instruction data encoding** - Handles all the complex encoding for you
-- ✅ **Type-safe parameter handling** - Full TypeScript support with validation
-- ✅ **Smart Parameters** - Intuitive parameter formats with ATLAS as default unit
-- ✅ **Network Agnostic** - Same program works across all networks (mainnet, devnet, etc.)
+## Key Differences from `@wuwei-labs/srsly`
 
-**Current Status**: Instruction-only SDK using @solana/kit. Users handle transaction assembly and sending.
+### Simpler (80% less code)
+- **Old**: 4,000+ lines of custom abstractions
+- **New**: ~800 lines of thin wrappers
 
-**RPC Requirement**: The SDK requires an RPC URL to fetch account states. This enables automatic PDA derivation and validation but means you must configure an RPC endpoint.
+### Clearer Purpose
+- **Old**: Framework with fluent APIs, factories, builders
+- **New**: Convenience wrapper around Codama
+
+### Easier Configuration
+- **Old**: Fluent selectors, chainable configs, network modules
+- **New**: Simple global config + optional overrides
+
+### Better Maintenance
+- **Old**: Complex abstractions break when Codama updates
+- **New**: Thin wrappers adapt easily to Codama changes
 
 ## Installation
 
 ```bash
-# Install the SDK (includes @solana/kit as a dependency)
-npm install @wuwei-labs/srsly
+pnpm add @wuwei-labs/srsly
 ```
 
-The SDK uses @solana/kit internally and provides seamless conversion to @solana/web3.js format for browser wallet compatibility.
-
 ## Quick Start
 
-### Using with @solana/kit (Default)
+### With @solana/kit (default)
 
 ```typescript
-import { createContract, setConfig } from '@wuwei-labs/srsly';
+import { setSdkConfig, createContract } from '@wuwei-labs/srsly';
 
-// 1. Configure SDK with your RPC endpoint
-setConfig({
-  rpcUrl: 'https://your-rpc-endpoint.com' // Required - no defaults provided
-});
+// Set global config once
+setSdkConfig({ network: 'atlasnet' });
 
-// 2. Create an instruction with smart parameters (v3)
+// Create a contract - returns @solana/kit instruction
 const instruction = await createContract({
-  owner: signer,  // Can be a signer object or string address
-  fleet: "FleetAddress123...",        // String address
-  ownerProfile: "ProfileAddr...",     // String address
-  rate: 10,                           // ATLAS tokens per payment period (v3 default)
-  durationMax: { days: 7 },           // Smart duration parameter
-  paymentsFreq: 'daily'               // Payment frequency
-});
-
-// 3. Add instruction to your transaction and send
-// (Use your preferred transaction building and sending method)
-```
-
-### Using with @solana/web3.js (wallet-adapter)
-
-```typescript
-import { createContract, setConfig } from '@wuwei-labs/srsly';
-import { Transaction, PublicKey } from '@solana/web3.js';
-
-// 1. Configure SDK with your RPC endpoint
-setConfig({
-  rpcUrl: 'https://your-rpc-endpoint.com', // Required - no defaults provided
-  library: 'web3js',
-  PublicKey // required to ensure addresses use web3js publickey format
-});
-
-// 2. Create and convert to web3.js format
-const web3jsInstruction = await createContract({
-  owner: wallet.publicKey.toString(),  // String address
-  fleet: "FleetAddress123...",         // String address
-  ownerProfile: "ProfileAddr...",      // String address
-  rate: 10,                            // ATLAS per period (v3 default)
-  durationMax: { days: 7 },            // Smart duration parameter
-  paymentsFreq: 'daily'
-});
-
-// 3. Add to transaction and send
-const transaction = new Transaction().add(web3jsInstruction);
-const signature = await wallet.sendTransaction(transaction, connection);
-```
-
-## Core Features
-
-### Universal Signer Pattern
-
-The SDK supports both CLI/Node.js and browser usage patterns through its Universal Signer functionality:
-
-**Browser Usage** (String Addresses):
-
-```typescript
-// Pass string addresses for browser wallets
-const instruction = await acceptRental({
-  borrower: wallet.publicKey.toString(),  // String address
-  // ... other params
-});
-// Browser wallet handles signing separately
-```
-
-**CLI/Node.js Usage** (Signer Objects):
-
-```typescript
-// Pass signer objects for full signing capability
-const instruction = await acceptRental({
-  borrower: wallet,  // Signer object
-  // ... other params
-});
-// Can sign transactions directly
-```
-
-### Instruction Building & Format Conversion
-
-The SDK creates @solana/kit compatible instructions with seamless web3.js conversion:
-
-- **📦 Instruction-Only**: Focus on instruction building, users handle transaction assembly/sending
-- **🔄 Format Conversion**: Built-in `.web3js(PublicKey)` method for wallet compatibility
-- **🎯 Universal Signer**: Accepts both string addresses and signer objects
-- **⚡ Lightweight**: Uses @solana/kit internally with optional web3.js conversion
-
-### Web3.js Format Conversion
-
-The SDK accepts string addresses as input and provides seamless conversion to @solana/web3.js format for browser wallet compatibility:
-
-```typescript
-import { createContract } from '@wuwei-labs/srsly';
-import { Transaction, PublicKey } from '@solana/web3.js';
-
-// Web3.js format with PublicKey instances
-const web3jsInstruction = await createContract({
-  owner: "OwnerAddress123...",     // String address input
-  fleet: "FleetAddress123...",    // String address input
-  ownerProfile: "ProfileAddr...", // String address input
-  rate: 1000000,
-  durationMax: days(7),
-  paymentsFreq: 'daily'
-}).web3js(PublicKey);
-
-// Chain configuration with conversion
-const configuredInstruction = await createContract({
-  owner: "OwnerAddress123...",
-  fleet: "FleetAddress123...",
-  ownerProfile: "ProfileAddr...",
-  rate: 1000000,
-  durationMax: days(7),
-  paymentsFreq: 'daily'
-}).set({
-  rpcUrl: 'https://api.mainnet-beta.solana.com'
-}).web3js(PublicKey);
-
-// Use in transactions
-const transaction = new Transaction().add(web3jsInstruction);
-```
-
-**Key points:**
-
-- SDK inputs are always **string addresses**
-- `.web3js(PublicKey)` converts output to web3.js format with PublicKey instances
-- Use when working with browser wallets (Phantom, Solflare, etc.)
-
-### Smart Parameters (v3)
-
-The SDK v3 introduces smart parameters that make working with amounts and durations more intuitive:
-
-#### Duration Parameters
-```typescript
-// Smart duration objects - no mental math needed!
-const contract = await createContract({
-  owner: wallet,
+  owner: walletAddress,  // string address
   fleet: fleetAddress,
   ownerProfile: profileAddress,
-  rate: 10,                        // ATLAS per period (v3 default)
-  durationMin: { hours: 1 },       // 1 hour minimum
-  durationMax: { weeks: 2 },       // 2 weeks maximum
-  paymentsFreq: 'daily'
-});
-
-// Supported duration formats
-duration: { minutes: 30 }   // 30 minutes
-duration: { hours: 12 }     // 12 hours  
-duration: { days: 7 }       // 7 days
-duration: { weeks: 4 }      // 4 weeks
-duration: { months: 3 }     // 3 months (31 days each)
-
-// Backwards compatible - raw seconds still work
-duration: 604800            // 7 days in seconds
-```
-
-#### Amount and Rate Parameters
-```typescript
-// v3 Default: Numbers are ATLAS
-const contract = await createContract({
-  rate: 10,                  // 10 ATLAS per period (NEW DEFAULT)
+  gameId: gameAddress,
+  rate: 100, // 100 ATLAS per payment
   durationMax: { days: 30 },
-  // ...
-});
-
-// Explicit formats for clarity
-rate: { atlas: 10 }          // 10 ATLAS per period
-rate: { stardust: 1000000000 } // 10 ATLAS in stardust units
-
-// Accept rental with smart amount
-const rental = await acceptRental({
-  borrower: wallet,
-  contract: "ContractAddr...",
-  duration: { days: 7 },     // Smart duration
-  // amount calculated automatically
+  paymentsFreq: '@daily'
 });
 ```
 
-#### Breaking Change Notice
-**v3 Breaking Change**: Rate and amount parameters now default to ATLAS units instead of stardust. This makes the SDK more intuitive but requires updating existing code:
-
-```typescript
-// v2 (old) - rate in stardust
-rate: 1000000000  // 10 ATLAS in stardust
-
-// v3 (new) - rate in ATLAS  
-rate: 10          // 10 ATLAS (much cleaner!)
-
-// v3 with explicit unit
-rate: { atlas: 10 }
-```
-
-### Contract Management
+### With @solana/web3.js
 
 ```typescript
-import { createContract, closeContract } from '@wuwei-labs/srsly';
+import { PublicKey } from '@solana/web3.js';
+import { setSdkConfig, createContract } from '@wuwei-labs/srsly';
 
-// Create rental contract instruction
-const createIx = await createContract({
-  owner: wallet,
-  fleet: fleetAddress,
-  ownerProfile: profileAddress,
-  rate: 5,                     // 5 ATLAS per day (v3 default)
-  durationMax: { months: 1 },  // 1 month maximum
-  paymentsFreq: 'daily'
+// Set global config with PublicKey constructor
+setSdkConfig({
+  network: 'mainnet-beta',
+  PublicKey // Enable web3.js mode
 });
 
-// Close contract instruction
-const closeIx = await closeContract({
-  owner: wallet,
-  fleet: fleetAddress,
-  contract: contractAddress,
-  faction: 'mud' // or 1, 2, 3
-});
-```
-
-#### Important Contract Close Behavior
-
-**Contract closure behavior depends on the rental state:**
-
-- **No Active Rental**: If `current_rental_state` is not set (equals system program ID), the contract closes immediately
-- **Active Rental**: If there's an active rental (`current_rental_state` is set), the contract is only flagged for closure (`to_close = true`)
-- **Two-Step Closure Process**: When a contract has an active rental, you must:
-  1. Use `closeRental()` to close the rental (when expired)
-  2. Then use `closeContract()` to close the flagged contract
-
-```typescript
-// Step 1: Close the expired rental
-const closeRentalIx = await closeRental({
-  borrower: borrowerWallet,
-  contract: contractAddress,
-  rentalState: rentalStateAddress,
-  ownerTokenAccount: ownerTokenAccountAddress
+// Create a contract - returns web3.js TransactionInstruction
+const instruction = await createContract({
+  owner: keypair,  // Accepts web3.js Keypair
+  fleet: fleetPubkey,  // Accepts web3.js PublicKey
+  ownerProfile: profilePubkey,
+  gameId: gamePubkey,
+  rate: 100,
+  durationMax: { days: 30 },
+  paymentsFreq: '@daily'
 });
 
-// Step 2: Close the flagged contract (must be done by contract owner)
-const closeContractIx = await closeContract({
-  owner: wallet,
-  fleet: fleetAddress,
-  contract: contractAddress,
-  faction: 'mud'
-});
+// instruction.keys[0].pubkey is a PublicKey instance
 ```
 
-**Thread-based Payment Processing**: The SRSLY program uses automated thread-based payment processing through the Antegen/Clockwork system. The `rental_pay` instruction automatically:
-
-- Processes periodic payments from escrow to owner
-- Handles rental completion and cleanup when expired
-- Closes flagged contracts after rental ends
-
-Manual intervention is only needed when the automated system doesn't process successfully.
+## Configuration
 
-### Rental Operations
+### Basic Configuration
 
 ```typescript
-import { acceptRental, cancelRental, closeRental, resetRental } from '@wuwei-labs/srsly';
-import { Transaction, PublicKey } from '@solana/web3.js';
-
-// Accept rental offer instruction (all addresses are strings)
-const acceptIx = await acceptRental({
-  borrower: borrowerWallet,                // signer object or string address
-  borrowerProfile: borrowerProfileAddress, // string address
-  borrowerFaction: 'mud',                  // or 1, 2, 3 (optional - auto-resolved from fleet)
-  contract: contractAddress,               // string address
-  duration: { days: 1 }                    // Smart duration parameter (v3)
-  // amount is calculated automatically based on contract rate
-});
-
-// Cancel active rental instruction
-// Note: Must cancel at least one payment period before rental ends
-const cancelIx = await cancelRental({
-  borrower: borrowerWallet,
-  contract: contractAddress,
-  rentalState: rentalStateAddress
-});
-
-// Close completed rental instruction
-const closeIx = await closeRental({
-  borrower: borrowerWallet,
-  contract: contractAddress,
-  rentalState: rentalStateAddress,
-  ownerTokenAccount: ownerTokenAccountAddress
-});
+import { setSdkConfig, getSdkConfig, clearSdkConfig } from '@wuwei-labs/srsly';
 
-// Reset rental instruction
-const resetIx = await resetRental({
-  borrower: borrowerWallet,
-  contract: contractAddress,
-  rentalState: rentalStateAddress
+// Set global config
+setSdkConfig({
+  network: 'atlasnet' | 'mainnet-beta' | 'localnet',
+  rpcUrl: 'https://custom-rpc.com',  // Optional
+  programId: 'custom-program-id',     // Optional
+  commitment: 'confirmed',             // Optional
+  PublicKey: PublicKey                 // Optional for web3.js mode
 });
 
-// Convert any instruction to web3.js format for wallet compatibility
-const web3jsAcceptIx = await acceptRental(params).web3js(PublicKey);
-const web3jsCancelIx = await cancelRental(params).web3js(PublicKey);
-
-// Use in web3.js transactions
-const transaction = new Transaction()
-  .add(web3jsAcceptIx)
-  .add(web3jsCancelIx);
-```
+// Get current config
+const config = getSdkConfig();
 
-## Configuration
-
-The SDK provides simple configuration:
-
-```typescript
-import { setConfig, getConfig, clearConfig } from '@wuwei-labs/srsly';
-
-// Set configuration (RPC URL is always required)
-setConfig({
-  rpcUrl: 'https://your-rpc-endpoint.com', // REQUIRED - no defaults provided
-  srslyProgramAddress: 'custom-program-address...', // Optional override
-  profileFactionProgramAddress: 'custom-profile-program...', // Optional override
-  gameId: 'custom-game-id...', // Optional override
-  atlasMint: 'custom-atlas-mint...' // Optional override
-});
+// Clear config (reset to defaults)
+clearSdkConfig();
 
-// Example configurations
-setConfig({
-  rpcUrl: 'https://api.mainnet-beta.solana.com'
-});
-setConfig({
-  rpcUrl: 'https://api.devnet.solana.com'
+// Override per-call
+const ix = await createContract(params, {
+  rpcUrl: 'https://temporary-rpc.com'
 });
-
-// Check current configuration
-console.log(getConfig());
-
-// Reset to defaults (you'll need to setConfig again with rpcUrl)
-clearConfig();
 ```
 
-### Configuration Options
-
-| Option | Type | Description | Default |
-|--------|------|-------------|---------|
-| `rpcUrl` | `string` | **REQUIRED** - RPC endpoint for fetching accounts | None (must provide) |
-| `srslyProgramAddress` | `string` | SRSLY program address override | `SRSLY1fq9TJqCk1gNSE7VZL2bztvTn9wm4VR8u8jMKT` |
-| `profileFactionProgramAddress` | `string` | Profile Faction program override | Network dependent |
-| `gameId` | `string` | SAGE game ID override | Network dependent |
-| `atlasMint` | `string` | ATLAS token mint override | Network dependent |
-
-## Duration and Payment Frequency
-
-**Important**: All durations must be aligned with the payment frequency to ensure proper payment calculations.
+### Network Addresses
 
-### Duration Rules
-
-1. **Duration Units**: Use smart duration objects (`{ days: 7 }`) or raw seconds for backwards compatibility
-2. **Alignment Requirement**: Durations must be multiples of the payment frequency interval
-3. **Validation**: The SDK automatically validates duration alignment and throws an error if invalid
-
-### Payment Frequency Intervals
-
-| Frequency | Interval | Example Valid Durations |
-|-----------|----------|------------------------|
-| `hourly`  | 3,600 seconds (1 hour) | 3,600 (1h), 7,200 (2h), 86,400 (24h) |
-| `daily`   | 86,400 seconds (1 day) | 86,400 (1d), 172,800 (2d), 604,800 (7d) |
-| `weekly`  | 604,800 seconds (1 week) | 604,800 (1w), 1,209,600 (2w), 2,419,200 (4w) |
-| `monthly` | 2,678,400 seconds (31 days) | 2,678,400 (1m), 5,356,800 (2m) |
-
-### Examples
+The SDK provides centralized address management for different networks:
 
 ```typescript
-// ✅ Valid: 7 day max duration with daily payments
-await createContract({
-  rate: 10,                        // 10 ATLAS per day (v3 default)
-  durationMax: { days: 7 },        // Smart duration parameter
-  paymentsFreq: 'daily'            // Min duration automatically set to 1 day
-});
-
-// ❌ Invalid: 3.5 day max duration with daily payments
-await createContract({
-  rate: 10,
-  durationMax: 302400,             // 3.5 days (302400 % 86400 = 43200) ✗
-  paymentsFreq: 'daily'
-});
-// Error: Duration (302400 seconds) must be a multiple of daily frequency (86400 seconds)
+import { getAddresses, ATLASNET_ADDRESSES, MAINNET_ADDRESSES } from '@wuwei-labs/srsly';
 
-// ✅ Valid: Hourly payments with hour-aligned max duration
-await createContract({
-  rate: 1,                         // 1 ATLAS per hour
-  durationMax: { hours: 48 },      // 48 hours (smart parameter)
-  paymentsFreq: 'hourly'           // Min duration automatically set to 1 hour
-});
-```
-
-### Rate Calculation
-
-The `rate` parameter in contracts represents ATLAS tokens per payment period that the owner will receive:
+// Get addresses for current network (from global config)
+const addresses = getAddresses();
+console.log(addresses.atlasMint);  // ATLAS token mint
+console.log(addresses.sage);       // SAGE program
+console.log(addresses.srsly);      // SRSLY program
 
-- For `daily` frequency: rate is ATLAS per day
-- For `weekly` frequency: rate is ATLAS per week
-- For `hourly` frequency: rate is ATLAS per hour
+// Override for specific network
+const mainnetAddrs = getAddresses({ network: 'mainnet-beta' });
 
-**Important**: The 10% service fee is collected upfront from the borrower. The rental state stores the net rate (after fees) to ensure consistent payments to the owner regardless of future fee changes.
+// Custom SRSLY program
+const customAddrs = getAddresses({ programId: 'MyCustomSRSLY...' });
+console.log(customAddrs.srsly); // 'MyCustomSRSLY...'
 
-## Payment System
-
-SRSLY implements an escrow-based payment system:
+// Direct access to network addresses
+console.log(ATLASNET_ADDRESSES);  // All atlasnet addresses
+console.log(MAINNET_ADDRESSES);   // All mainnet addresses
+```
 
-1. **Escrow**: Borrower deposits full rental amount upfront
-2. **Service Fee**: 10% fee collected upfront at rental acceptance
-3. **Net Rate**: Rental state stores the net rate (after fees), ensuring owners receive consistent payments
-4. **Periodic Payments**: Automated payments based on frequency (hourly/daily/weekly/monthly)
-5. **Refunds**: Pro-rata refunds for early cancellation (must cancel at least one payment period before rental ends)
+**Available Networks:**
+- `'atlasnet'` - Star Atlas testnet (default)
+- `'mainnet-beta'` - Solana mainnet / Star Atlas production
+- `'localnet'` - Local development
 
-```typescript
-// Payment calculation example (v3 with ATLAS as default)
-const rate = 10; // 10 ATLAS per day (v3 default unit)
-const paymentFrequency = 'daily'; // Payment every 86400 seconds
-const durationDays = 7; // 7 days
-const paymentPeriods = 7; // 7 daily periods
-const grossAmount = rate * paymentPeriods; // 70 ATLAS total
-const serviceFee = grossAmount * 0.10; // 7 ATLAS fee (10%)
-const netAmount = grossAmount - serviceFee; // 63 ATLAS to escrow
-
-// The rental state will store: netAmount / paymentPeriods = 9 ATLAS per period
-// This ensures the owner receives the full rate regardless of fee changes
+**Network Addresses:**
+- `srsly` - SRSLY rental program
+- `sage` - Star Atlas SAGE program
+- `atlasMint` - ATLAS token mint
+- `profileFaction` - Profile Faction program
+- `gameId` - Star Atlas game ID
 ```
 
-## Program Information
+## API Reference
 
-The SRSLY program is network agnostic with the same address across all networks:
+### Instructions
 
-**SRSLY Program ID**: `SRSLY1fq9TJqCk1gNSE7VZL2bztvTn9wm4VR8u8jMKT`
+- `createContract(params, config?)` - Create a rental contract
+- `closeContract(params, config?)` - Close a rental contract
+- `acceptRental(params, config?)` - Accept a rental
+- `cancelRental(params, config?)` - Cancel a rental
+- _(More to come)_
 
-Note: While the SRSLY program is network agnostic, Star Atlas programs (SAGE, Profile, etc.) may have different addresses on different networks. The SDK will automatically detect these based on your RPC endpoint.
+### Parameters
 
-## Types and Constants
+All instruction params accept:
 
-```typescript
-import type {
-  ContractState,
-  RentalState,
-  ConfigOptions,
-  PaymentFrequency
-} from '@wuwei-labs/srsly';
-
-import {
-  ATLAS_TO_STARDUST,
-  FACTION_MAPPING
-} from '@wuwei-labs/srsly';
-
-// Conversion rate: 1 ATLAS = 100,000,000 stardust
-console.log(ATLAS_TO_STARDUST); // 100_000_000
-
-// Faction mappings
-console.log(FACTION_MAPPING[1]); // 'mud'
-console.log(FACTION_MAPPING[2]); // 'oni'
-console.log(FACTION_MAPPING[3]); // 'ustur'
-
-// Smart duration parameters (v3)
-// Use objects for duration: { days: 7 }, { hours: 12 }, { months: 1 }
-// Or raw seconds for backwards compatibility: 604800
-```
+- **Signers**: String addresses, web3.js Keypairs, or @solana/kit signers
+- **Addresses**: String addresses or web3.js PublicKeys
+- **Rates**: Numbers (ATLAS) or objects `{ atlas: 1.5 }` or `{ stardust: 150_000_000 }`
+- **Durations**: Objects `{ days: 7 }`, `{ hours: 24 }`, `{ weeks: 2 }`, etc.
+- **Schedules**: Strings `'@daily'`, `'@hourly'`, or cron expressions
 
-## IDL and Program Information
+### Return Types
 
-```typescript
-// Access program IDL
-import idl from '@wuwei-labs/srsly/idl';
-```
+- **Without PublicKey in config**: Returns @solana/kit instruction
+- **With PublicKey in config**: Returns web3.js TransactionInstruction
 
-## Error Handling
+## Development Status
 
-```typescript
-import { SrslyError } from '@wuwei-labs/srsly';
-
-try {
-  const instruction = await createContract(params);
-  // Add to transaction and send...
-} catch (error) {
-  if (error instanceof SrslyError) {
-    console.error('SRSLY SDK Error:', error.message, error.code);
-  } else {
-    console.error('Other Error:', error);
-  }
-}
-```
+- ✅ Core config system
+- ✅ Centralized address management
+- ✅ Signer handling (web3.js + kit)
+- ✅ web3.js conversion
+- ✅ Parameter converters (amount, duration, schedule)
+- ✅ First instruction: `createContract`
+- 🚧 Additional contract instructions
+- 🚧 Rental instructions
+- 🚧 Other instructions
+- 🚧 Tests
+
+## Migration from `@wuwei-labs/srsly`
 
-## Package Structure
+Coming soon - see migration guide once this package reaches 1.0.0.
 
-The SDK provides optimized builds for different environments:
+## Contributing
 
-- **CommonJS**: `./dist/cjs/` (Node.js, webpack)
-- **ESM**: `./dist/esm/` (Modern ES modules)
-- **Types**: `./dist/types/` (TypeScript definitions)
-- **Codama**: `./dist/*/codama/` (Generated Solana program interfaces)
-- **IDL**: `./target/idl/srsly.json` (Anchor IDL)
-- **Types**: `./target/types/srsly.ts` (Generated types)
+This package is currently in beta. Please report issues on GitHub.
 
-## Links
+## License
 
-- **NPM Package**: [@wuwei-labs/srsly](https://www.npmjs.com/package/@wuwei-labs/srsly)
-- **TypeDoc Documentation**: [API Reference](https://wuwei-labs.github.io/srsly/)
-- **Browser Usage Examples**: [Browser Integration Guide](./examples/browser-usage.md)
-- **Universal Signer Tests**: [Test Examples](./tests/features/universal-signer.test.mjs)
+ISC