@hyr0-xyz/client-js 0.0.1 → 0.0.2

package/README.md

@@ -1,152 +1,141 @@
-# @hyr0-xyz/program
+# @hyr0-xyz/client-js
 
-TypeScript SDK for building dApps on Hyro Protocol. This SDK provides high-level APIs for interacting with Hyro Protocol's Vault and Transaction systems.
+Auto-generated TypeScript client for Hyro Protocol programs. This package contains Codama-generated artifacts exported as an npm module.
+
+## Packages
+
+This repository publishes two separate packages:
+
+- **@hyr0-xyz/client-js** - For mainnet/devnet deployment with production program addresses
+- **@hyr0-xyz/client-js-local** - For local development with local program addresses
 
 ## Installation
 
+**For production/mainnet:**
 ```bash
-npm install @hyr0-xyz/program @solana/kit
+npm install @hyr0-xyz/client-js @solana/kit
 # or
-yarn add @hyr0-xyz/program @solana/kit
+yarn add @hyr0-xyz/client-js @solana/kit
 # or
-pnpm add @hyr0-xyz/program @solana/kit
+pnpm add @hyr0-xyz/client-js @solana/kit
 ```
 
-## Features
+**For local development:**
+```bash
+npm install @hyr0-xyz/client-js-local @solana/kit
+# or
+yarn add @hyr0-xyz/client-js-local @solana/kit
+# or
+pnpm add @hyr0-xyz/client-js-local @solana/kit
+```
 
-- **Vault Operations**: Create, fetch, and manage vaults
-- **Transaction Operations**: Create and execute transactions through vaults
-- **PDA Helpers**: Easy-to-use functions for deriving Program Derived Addresses
-- **Type-Safe**: Full TypeScript support with type-safe APIs
-- **Built on @solana/kit**: Uses the latest Solana TypeScript toolkit
+## What's Inside
 
-## Quick Start
+This package contains auto-generated code for:
 
-### Vault Operations
+- **Instructions**: Functions to create program instructions
+- **Accounts**: Type definitions and fetch helpers for program accounts
+- **Types**: All custom types used by the programs
+- **Errors**: Program error definitions
+- **PDAs**: Helper functions for deriving Program Derived Addresses
 
-```typescript
-import { VaultSDK } from '@hyr0-xyz/program';
-import { createSolanaRpc } from '@solana/kit';
+## Available Programs
 
-// Get RPC connection
-const rpc = createSolanaRpc('https://api.mainnet-beta.solana.com');
+The package exports clients for all Hyro Protocol programs:
 
-// Get vault PDA from seed
-const [vaultPda, authorityPda] = await VaultSDK.getVaultPda('my-vault-seed');
+- `hyroProtocol` - Core vault and transaction management
+- `policyOwners` - Owner-based policy validation
+- `policyMultisig` - Multisig policy validation
+- `policyManagerAccess` - Manager access control policy
+- `policyLimitTransfer` - Transfer limit policy
+- `policyChallenges` - Trading challenge policy
+- `policyAllowAny` - Permissive policy
+- `policyDenyAll` - Restrictive policy
+- `feeCollection` - Fee collection program
+- `feeCollectionAllInOne` - All-in-one fee collection
+- `feeCollectionFractions` - Fractional fee collection
+- `feeCollectionTimeBased` - Time-based fee collection
+- `dropper` - Airdrop management
+- `revenueGenerator` - Revenue generation
 
-// Fetch vault data
-const vault = await VaultSDK.fetch(rpc, vaultPda[0]);
-console.log('Vault data:', vault.data);
+## Usage Example
 
-// Get related PDAs
-const shareSignerPda = await VaultSDK.getShareSignerPda(vaultPda);
-const shareMintPda = await VaultSDK.getShareMintPda(vaultPda);
-```
+```typescript
+import { hyroProtocol } from '@hyr0-xyz/client-js';
+import { createSolanaRpc } from '@solana/kit';
 
-### Transaction Operations
+// Get RPC connection
+const rpc = createSolanaRpc('https://api.mainnet-beta.solana.com');
 
-```typescript
-import { TransactionSDK } from '@hyr0-xyz/program';
-
-// Get transaction PDA
-const transactionPda = await TransactionSDK.getTransactionPda(vaultPda, 1);
-
-// Fetch transaction data
-const transaction = await TransactionSDK.fetch(rpc, transactionPda[0]);
-console.log('Transaction data:', transaction.data);
-
-// Build create transaction instruction
-const createTxIx = await TransactionSDK.buildCreateTxInstruction({
-  vault: vaultPda[0],
-  nonce: 1,
-  programId: 'YourProgramId...',
-  accounts: [
-    {
-      pubkey: 'AccountAddress...',
-      isSigner: false,
-      isWritable: true,
-    },
-  ],
-  data: new Uint8Array([...]),
-  policyAccount: 'PolicyAccount...',
-  policyProgram: 'PolicyProgram...',
-  signer: yourSigner,
+// Use generated instruction builders
+const instruction = hyroProtocol.getInitializeVaultInstruction({
+  // ... instruction parameters
 });
 
-// Build execute transaction instruction
-const executeTxIx = await TransactionSDK.buildExecuteTxInstruction({
-  vault: vaultPda[0],
-  transaction: transactionPda[0],
-  policyAccount: 'PolicyAccount...',
-  policyProgram: 'PolicyProgram...',
-  signer: yourSigner,
-});
+// Fetch account data
+const vaultAddress = '...';
+const vault = await hyroProtocol.fetchVault(rpc, vaultAddress);
 ```
 
-### PDA Helpers
-
-```typescript
-import { getVaultPda, getTransactionPda, getShareSignerPda } from '@hyr0-xyz/program';
-
-// Get vault and authority PDAs
-const [vault, authority] = await getVaultPda('my-seed');
+## Generation
 
-// Get transaction PDA
-const txPda = await getTransactionPda(vault, 1);
+The packages are automatically generated from the parent repository's Anchor programs:
 
-// Get share signer PDA
-const shareSigner = await getShareSignerPda(vault);
+**For mainnet/devnet (production):**
+```bash
+# From repository root
+cd ..
+anchor build -- --features mainnet
+cd client-js
+bun create-codama-client.ts
+bun run build
 ```
 
-## API Reference
-
-### VaultSDK
-
-#### `getVaultPda(seed: string)`
-Get vault PDA and authority PDA from a seed string.
-
-#### `fetch(rpc, address)`
-Fetch vault account data from the blockchain.
-
-#### `getShareSignerPda(vault)`
-Get the share signer PDA for a vault.
-
-#### `getShareMintPda(vault)`
-Get the share mint PDA for a vault.
-
-#### `getVaultTokenAccountPda(vault, underlyingMint)`
-Get the vault token account PDA.
+**For local development:**
+```bash
+# From repository root
+cd ..
+anchor build
+cd client-js
+bun create-codama-client.ts
+bun run build
+```
 
-#### `buildInitializeVaultInstruction(params)`
-Build an instruction to initialize a new vault.
+The generation process:
 
-### TransactionSDK
+1. Builds all Anchor programs at repository root to generate IDL files (with or without `--features mainnet`)
+2. Reads IDL files from `../target/idl/`
+3. Uses Codama to generate TypeScript clients
+4. Outputs generated code to `src/`
 
-#### `getTransactionPda(vault, nonce)`
-Get transaction PDA from vault and nonce.
+## Publishing
 
-#### `fetch(rpc, address)`
-Fetch transaction account data from the blockchain.
+Both packages are automatically published to NPM via GitHub Actions (at repository root `.github/workflows/publish-client-js.yml`) when changes are pushed to the `main` branch:
 
-#### `buildCreateTxInstruction(params)`
-Build an instruction to create a new transaction.
+1. **Mainnet job**: Builds Anchor programs with mainnet feature → Generates client → Publishes `@hyr0-xyz/client-js`
+2. **Local job**: Builds Anchor programs for localnet → Generates client → Publishes `@hyr0-xyz/client-js-local`
 
-#### `buildExecuteTxInstruction(params)`
-Build an instruction to execute a transaction.
+The workflow is triggered on changes to:
+- `programs/**`
+- `client-js/**`
+- `Anchor.toml`
+- `Cargo.toml`
 
 ## Development
 
 ```bash
 # Install dependencies
-npm install
+bun install
 
-# Build
-npm run build
+# Build package only (assumes IDL already generated)
+bun run build
 
-# Type check
-npm run typecheck
+# Watch mode for development
+bun run dev
 ```
 
+**Note:** For generation, use the commands from the "Generation" section above, as they require building the entire Anchor workspace from the repository root.
+
 ## License
 
 ISC