@percolatorct/sdk 0.3.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,492 @@
+# @percolator/sdk
+
+TypeScript SDK for building clients, bots, and UIs on top of the [Percolator](https://github.com/dcccrypto/percolator) perpetual futures protocol on Solana.
+
+> **⚠️ DISCLAIMER: FOR EDUCATIONAL PURPOSES ONLY** — This code has NOT been audited. Do NOT use in production or with real funds.
+
+[![npm](https://img.shields.io/npm/v/@percolator/sdk?color=14F195)](https://www.npmjs.com/package/@percolator/sdk)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+---
+
+## Installation
+
+```bash
+pnpm add @percolator/sdk
+# or
+npm install @percolator/sdk
+```
+
+**Peer dependency:** `@solana/web3.js ^1.95`
+
+---
+
+## Quick Start
+
+```typescript
+import {
+  getProgramId,
+  deriveVaultAuthority,
+  buildInitUserIxData,
+  buildDepositCollateralIxData,
+  buildTradeNoCpiIxData,
+  parseSlab,
+  computeMarkPnl,
+  computeLiqPrice,
+  simulateOrSend,
+} from "@percolator/sdk";
+
+// Get program ID (defaults to devnet)
+const programId = getProgramId("devnet");
+
+// Derive vault authority PDA
+const [vaultAuth, bump] = deriveVaultAuthority(programId, slabPubkey);
+
+// Read and parse on-chain slab account
+const slabData = await connection.getAccountInfo(slabPubkey);
+const { header, config, accounts } = parseSlab(slabData.data);
+
+// Compute PnL for a position
+const pnl = computeMarkPnl(positionSize, entryPrice, oraclePrice);
+const liqPrice = computeLiqPrice(entryPrice, capital, positionSize, 500n);
+```
+
+---
+
+## Features
+
+### ABI Encoding & Decoding
+
+Type-safe instruction builders matching the on-chain Rust layout byte-for-byte:
+
+```typescript
+import { buildInitMarketIxData, buildTradeNoCpiIxData, IX_TAG } from "@percolator/sdk";
+
+// Build InitMarket instruction data (256 bytes)
+const data = buildInitMarketIxData({
+  admin: adminPubkey,
+  collateralMint: mintPubkey,
+  indexFeedId: pythFeedId,
+  maxStaleSecs: 60n,
+  confFilterBps: 250,
+  invert: false,
+  unitScale: 1_000_000_000, // lamports per unit
+  riskParams: { /* ... */ },
+});
+
+// Build trade instruction
+const tradeData = buildTradeNoCpiIxData({
+  userIdx: 0,
+  lpIdx: 0,
+  requestedSize: 1_000_000n, // positive = long, negative = short
+  maxSlippage: 50,           // bps
+});
+```
+
+**Supported instructions:** `InitMarket`, `InitUser`, `InitLP`, `DepositCollateral`, `WithdrawCollateral`, `KeeperCrank`, `TradeNoCpi`, `TradeCpi`, `LiquidateAtOracle`, `CloseAccount`, `TopUpInsurance`, `SetRiskThreshold`, `UpdateAdmin`, `UpdateConfig`, `SetMaintenanceFee`, `PushOraclePrice`, `ResolveMarket`, `SetOiImbalanceHardBlock`, `SetOracleAuthority`, and more.
+
+### Admin Instructions
+
+#### SetOiImbalanceHardBlock (tag=71)
+
+Prevents new trades from pushing the long/short OI skew above a configurable threshold.
+When triggered, the on-chain error `OiImbalanceHardBlock` (code 59) is returned.
+
+```typescript
+import {
+  encodeSetOiImbalanceHardBlock,
+  ACCOUNTS_SET_OI_IMBALANCE_HARD_BLOCK,
+  buildAccountMetas,
+  buildIx,
+  simulateOrSend,
+} from "@percolator/sdk";
+
+// threshold_bps = 0         → hard block disabled (default)
+// threshold_bps = 5_000     → block trades that push skew above 50%
+// threshold_bps = 8_000     → block trades that push skew above 80%
+// threshold_bps = 10_000    → lock dominant side once any OI exists
+
+const data = encodeSetOiImbalanceHardBlock({ thresholdBps: 8_000 });
+const keys = buildAccountMetas(ACCOUNTS_SET_OI_IMBALANCE_HARD_BLOCK, [
+  adminPublicKey,  // [signer]
+  slabPublicKey,   // [writable]
+]);
+const ix = buildIx({ programId, keys, data });
+
+const result = await simulateOrSend({ connection, ix, signers: [admin] });
+console.log("signature:", result.signature);
+```
+
+#### SetOracleAuthority (tag=16)
+
+Delegates the `PushOraclePrice` right to a specific keypair (e.g. a crank bot).
+Pass `PublicKey.default` (all zeros) to revoke — the program then falls back to Pyth/Chainlink.
+
+```typescript
+import { PublicKey } from "@solana/web3.js";
+import {
+  encodeSetOracleAuthority,
+  ACCOUNTS_SET_ORACLE_AUTHORITY,
+  buildAccountMetas,
+  buildIx,
+  simulateOrSend,
+} from "@percolator/sdk";
+
+// Delegate to a crank bot
+const data = encodeSetOracleAuthority({ newAuthority: crankBot.publicKey });
+const keys = buildAccountMetas(ACCOUNTS_SET_ORACLE_AUTHORITY, [
+  adminPublicKey,  // [signer, writable]
+  slabPublicKey,   // [writable]
+]);
+const ix = buildIx({ programId, keys, data });
+
+await simulateOrSend({ connection, ix, signers: [admin] });
+
+// Revoke — fall back to Pyth/Chainlink
+const revokeData = encodeSetOracleAuthority({ newAuthority: PublicKey.default });
+```
+
+See [`examples/admin-instructions.ts`](examples/admin-instructions.ts) for full end-to-end examples.
+
+### Account Deserialization
+
+Parse the on-chain slab account into typed TypeScript objects:
+
+```typescript
+import { parseSlab, parseSlabHeader, parseMarketConfig } from "@percolator/sdk";
+
+const { header, config, accounts } = parseSlab(accountData);
+
+// header.magic, header.version, header.admin, header.nonce
+// header.resolved, header.paused
+
+// config.collateralMint, config.vaultPubkey, config.indexFeedId
+// config.maxStalenessSlots, config.confFilterBps
+// config.fundingHorizonSlots, config.fundingKBps
+// config.threshFloor, config.threshRiskBps
+
+// accounts[i].owner, accounts[i].capital, accounts[i].pnl, accounts[i].positionSize
+```
+
+### PDA Derivation
+
+All program-derived addresses with correct seeds:
+
+```typescript
+import {
+  deriveVaultAuthority,
+  deriveLpPda,
+  deriveInsuranceLpMint,
+} from "@percolator/sdk";
+
+const [vaultAuth, bump] = deriveVaultAuthority(programId, slab);
+const [lpPda, lpBump] = deriveLpPda(programId, slab, lpIndex);
+const [insMint, insBump] = deriveInsuranceLpMint(programId, slab);
+```
+
+### Trading Math
+
+Coin-margined perpetual math utilities (all BigInt, no floating-point):
+
+```typescript
+import {
+  computeMarkPnl,
+  computeLiqPrice,
+  computeEntryPrice,
+  computeEffectiveLeverage,
+} from "@percolator/sdk";
+
+// Mark-to-market PnL (in native token units)
+const pnl = computeMarkPnl(positionSize, entryPriceE6, oraclePriceE6);
+
+// Liquidation price given capital and maintenance margin
+const liqPrice = computeLiqPrice(entryPriceE6, capital, positionSize, 500n);
+
+// All values use e6 format: 1 USD = 1_000_000
+```
+
+### Oracle Price Router
+
+Automatic oracle discovery and ranking for any Solana token:
+
+```typescript
+import { resolvePrice } from "@percolator/sdk";
+
+const result = await resolvePrice(tokenMint);
+// result.bestSource — highest-confidence price source
+// result.allSources — all discovered sources ranked by liquidity
+```
+
+Supports **Pyth**, **DexScreener** (Raydium, Orca, Meteora), and **Jupiter** price feeds.
+
+### Program ID Configuration
+
+Network-aware program ID resolution:
+
+```typescript
+import { getProgramId, getMatcherProgramId } from "@percolator/sdk";
+
+// Defaults to devnet
+const programId = getProgramId();
+
+// Explicit network selection
+const mainnetId = getProgramId("mainnet");
+
+// Environment variable override: PROGRAM_ID=<your-id>
+```
+
+### Auto-Deleveraging (ADL)
+
+ADL (Auto-Deleveraging) reduces the most-profitable opposing positions when the insurance fund is depleted. The SDK provides both on-chain and API-based ADL utilities.
+
+#### Checking if ADL is triggered
+
+```typescript
+import { isAdlTriggered } from "@percolator/sdk";
+
+const accountInfo = await connection.getAccountInfo(slabKey);
+if (isAdlTriggered(accountInfo!.data)) {
+  console.log("Insurance fund depleted — ADL is active");
+}
+```
+
+#### Ranking positions for ADL
+
+```typescript
+import { fetchAdlRankedPositions } from "@percolator/sdk";
+
+const { ranked, longs, shorts, isTriggered } = await fetchAdlRankedPositions(
+  connection,
+  slabKey,
+);
+// ranked  — all positions sorted by PnL% descending (ADL priority order)
+// longs   — top-ranked long position (ADL target if insurance negative on short side)
+// shorts  — top-ranked short position
+// isTriggered — whether pnl_pos_tot exceeds max_pnl_cap on-chain
+```
+
+#### Building an ADL instruction
+
+```typescript
+import { buildAdlInstruction, buildAdlTransaction, getProgramId } from "@percolator/sdk";
+
+const programId = getProgramId("devnet");
+
+// Build instruction directly (caller already has target index)
+const ix = buildAdlInstruction(
+  callerPublicKey,   // keeper / crank wallet
+  slabPublicKey,
+  oracleFeedPublicKey,
+  programId,
+  targetAccountIndex, // number — index of account to deleverage
+);
+
+// OR: fetch + rank + pick top target automatically
+const ix2 = await buildAdlTransaction(
+  connection,
+  callerPublicKey,
+  slabPublicKey,
+  oracleFeedPublicKey,
+  programId,
+  "long", // side to deleverage ("long" | "short")
+);
+```
+
+#### Decoding on-chain ADL events
+
+```typescript
+import { parseAdlEvent } from "@percolator/sdk";
+
+// After sending / confirming an ExecuteAdl transaction:
+const tx = await connection.getTransaction(sig, { commitment: "confirmed" });
+const event = parseAdlEvent(tx?.meta?.logMessages ?? []);
+// event.tag          — 0xAD1E_0001 (2904424449)
+// event.targetIdx    — account index that was deleveraged
+// event.price        — oracle price at execution (e6)
+// event.closedAbs    — absolute position size closed (i128)
+```
+
+#### Fetching ADL rankings via HTTP API
+
+```typescript
+import { fetchAdlRankings } from "@percolator/sdk";
+
+const result = await fetchAdlRankings(
+  "https://api.percolatorlaunch.com",
+  slabAddress,
+);
+// result.slabAddress              — slab public key (base58)
+// result.adlNeeded                — true if ADL is triggered (capExceeded or utilizationTriggered)
+// result.capExceeded              — true if pnlPosTot > maxPnlCap
+// result.insuranceDepleted        — true if insurance fund balance == 0
+// result.utilizationTriggered     — true if utilization BPS exceeds the configured ADL threshold
+// result.pnlPosTot                — aggregate profitable PnL (decimal string)
+// result.maxPnlCap                — max PnL cap from market config (decimal string, "0" if unconfigured)
+// result.excess                   — excess PnL above cap (decimal string)
+// result.insuranceFundBalance     — insurance fund balance (decimal string)
+// result.insuranceFundFeeRevenue  — insurance fund lifetime fee revenue (decimal string)
+// result.insuranceUtilizationBps  — insurance utilization in basis points (0–10000)
+// result.rankings                 — AdlApiRanking[] sorted by rank (1 = first to deleverage)
+//   .rank             — rank (1 = highest PnL%, deleveraged first)
+//   .idx              — slab account index (pass as targetIdx to buildAdlInstruction)
+//   .pnlAbs           — absolute PnL in lamports (decimal string)
+//   .capital          — capital at entry in lamports (decimal string)
+//   .pnlPctMillionths — pnl * 1_000_000 / capital (decimal string)
+```
+
+#### ADL error codes (61–65)
+
+| Code | Name | Description |
+|------|------|-------------|
+| 61 | `EngineSideBlocked` | ADL blocked — dominant side already at cap |
+| 62 | `EngineCorruptState` | Slab state corrupt — contact support |
+| 63 | `InsuranceFundNotDepleted` | ADL not triggered yet (insurance fund healthy) |
+| 64 | `NoAdlCandidates` | No eligible positions to deleverage |
+| 65 | `BankruptPositionAlreadyClosed` | Target position already closed |
+
+---
+
+### Transaction Helpers
+
+Build, simulate, and send transactions with error parsing:
+
+```typescript
+import { buildIx, simulateOrSend } from "@percolator/sdk";
+
+const ix = buildIx({ programId, keys: accountMetas, data: ixData });
+
+const result = await simulateOrSend({
+  connection,
+  ix,
+  signers: [payer],
+  simulate: false,        // true = simulate only
+  computeUnitLimit: 400_000,
+});
+
+// result.signature, result.slot, result.err, result.logs
+// Errors are automatically parsed from logs into human-readable messages
+```
+
+### Client-Side Validation
+
+Validate parameters before submitting transactions:
+
+```typescript
+import { validateRiskParams, validateTradeParams } from "@percolator/sdk";
+
+const errors = validateRiskParams(params);
+if (errors.length > 0) {
+  console.error("Invalid risk params:", errors);
+}
+```
+
+---
+
+## Architecture
+
+```
+@percolator/sdk
+├── abi/                 # Binary encoding/decoding matching on-chain layout
+│   ├── instructions.ts  # Instruction data builders (all 28+ instructions)
+│   ├── accounts.ts      # Account struct deserialization
+│   ├── encode.ts        # Low-level binary encoding (u8/u16/u32/u64/i128/pubkey)
+│   ├── errors.ts        # On-chain error code → human-readable parsing
+│   └── index.ts
+├── solana/              # Solana-specific helpers
+│   ├── slab.ts          # Slab account parser (header + config + accounts)
+│   ├── pda.ts           # PDA derivation (vault, LP, insurance mint)
+│   ├── discovery.ts     # Market discovery (find all Percolator markets)
+│   ├── dex-oracle.ts    # DEX oracle price integration
+│   ├── token-program.ts # SPL Token helpers
+│   ├── ata.ts           # Associated Token Account helpers
+│   └── index.ts
+├── runtime/             # Transaction building and submission
+│   ├── tx.ts            # buildIx, simulateOrSend, error handling
+│   └── index.ts
+├── math/                # Trading math (all BigInt)
+│   ├── trading.ts       # PnL, liquidation price, leverage, entry price
+│   └── index.ts
+├── oracle/              # Price feed integration
+│   └── price-router.ts  # Multi-source oracle resolution (Pyth, DEX, Jupiter)
+├── config/              # Configuration
+│   └── program-ids.ts   # Network-aware program IDs
+├── validation.ts        # Client-side parameter validation
+└── index.ts             # Public API re-exports
+```
+
+---
+
+## Development
+
+### Prerequisites
+
+- Node.js 20+ and pnpm 9+
+
+### Commands
+
+```bash
+pnpm install              # Install dependencies
+pnpm build                # Build with tsup (outputs to dist/)
+pnpm test                 # Run test suite (vitest)
+pnpm lint                 # Type-check (tsc --noEmit)
+```
+
+### Testing
+
+Tests cover ABI encoding roundtrips, PDA derivation, slab parsing, validation, and trading math:
+
+```bash
+pnpm test                 # Run all tests
+pnpm test -- --watch      # Watch mode
+```
+
+### Publishing
+
+```bash
+pnpm build
+npm publish --access public
+```
+
+---
+
+## Configuration
+
+| Environment Variable | Description | Default |
+|---------------------|-------------|---------|
+| `PROGRAM_ID` | Override Percolator program ID | Network default |
+| `MATCHER_PROGRAM_ID` | Override Matcher program ID | Network default |
+| `NETWORK` | Target network (`devnet` / `mainnet`) | `devnet` |
+
+### Devnet Program Addresses
+
+| Program | Address |
+|---------|---------|
+| Percolator | `FxfD37s1AZTeWfFQps9Zpebi2dNQ9QSSDtfMKdbsfKrD` |
+| Matcher | `4HcGCsyjAqnFua5ccuXyt8KRRQzKFbGTJkVChpS7Yfzy` |
+
+---
+
+## Browser Compatibility
+
+The SDK uses `DataView` for all binary reads (no Node.js `Buffer` dependency). Works in:
+- Node.js 20+
+- Modern browsers (Chrome, Firefox, Safari, Edge)
+- React Native (via `@solana/web3.js`)
+
+---
+
+## Related Repositories
+
+| Repository | Description |
+|-----------|-------------|
+| [percolator](https://github.com/dcccrypto/percolator) | Core risk engine crate (Rust) |
+| [percolator-prog](https://github.com/dcccrypto/percolator-prog) | Solana on-chain program (wrapper) |
+| [percolator-matcher](https://github.com/dcccrypto/percolator-matcher) | Reference matcher program for LP pricing |
+| [percolator-stake](https://github.com/dcccrypto/percolator-stake) | Insurance LP staking program |
+| [percolator-ops](https://github.com/dcccrypto/percolator-ops) | Operations dashboard |
+| [percolator-mobile](https://github.com/dcccrypto/percolator-mobile) | Solana Seeker mobile trading app |
+| [percolator-launch](https://github.com/dcccrypto/percolator-launch) | Full-stack launch platform (monorepo) |
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).