@slvr-labs/sdk 0.1.0 → 0.1.2

package/README.md

@@ -1,5 +1,9 @@
 # @slvr-labs/sdk
 
+[![npm](https://img.shields.io/npm/v/@slvr-labs/sdk.svg)](https://www.npmjs.com/package/@slvr-labs/sdk)
+[![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![types: included](https://img.shields.io/badge/types-included-blue.svg)](#installation)
+
 TypeScript SDK for interacting with the Slvr protocol on Robinhood Chain.
 
 ## Installation
@@ -8,6 +12,9 @@ TypeScript SDK for interacting with the Slvr protocol on Robinhood Chain.
 npm install @slvr-labs/sdk viem
 ```
 
+Ships both **ESM and CommonJS** builds with TypeScript declarations, so `import`
+and `require` both work out of the box.
+
 ## Quick Start
 
 The fastest way — `SlvrSDK.connect` builds resilient clients (Multicall3
@@ -443,6 +450,32 @@ const stopBets = sdk.lottery.watchBets((e) => console.log(`bet of ${e.total} on
 // later: stopResolved(); stopBets();
 ```
 
+### Preflight, typed errors & gas control
+
+Catch reverts before spending gas, and get the protocol's custom errors decoded
+into typed, readable failures:
+
+```typescript
+import { SlvrRevertError, decodeSlvrRevert } from '@slvr-labs/sdk';
+
+// Preflight a bet (eth_call, no tx). Throws a typed SlvrRevertError on revert.
+try {
+  await sdk.lottery.simulateBet({ roundId, squares, amounts });
+  await sdk.lottery.bet({ roundId, squares, amounts });
+} catch (e) {
+  if (e instanceof SlvrRevertError) console.log(e.errorName, '—', e.message); // e.g. "RoundNotOpen — betting is closed…"
+}
+
+// bet() and claim() also decode reverts, and accept gas/nonce overrides:
+await sdk.lottery.bet({ roundId, squares, amounts, overrides: { maxFeePerGas, nonce } });
+
+// Decode any caught contract error yourself:
+const revert = decodeSlvrRevert(err); // SlvrRevertError | null
+```
+
+`sdk.getJackpotPool(roundId?)` returns the round's jackpot pool in wei (0 when no
+jackpot is set), and `estimateRoundEv` now reads it automatically.
+
 ### Helper Functions
 
 #### Format Token Amounts
@@ -533,6 +566,7 @@ Interface for the lottery contract.
 - `getExpectedReward(account: Address, roundId: bigint): Promise<bigint>` - estimated reward for an account in a round
 - `latestResolvedRoundId(): Promise<bigint>`
 - `getRound(roundId: bigint): Promise<RoundInfo>` - flat 16-value round tuple
+- `getRoundState(roundId?: bigint): Promise<{ roundId, open, resolved, bettingEnd, roundEnd, totalWager, winningSquare, secondsUntilBettingClose }>` - **batched** per-tick snapshot; `secondsUntilBettingClose` uses on-chain `block.timestamp`. Defaults to the current round.
 - `getTotalOnSquare(roundId: bigint, square: number): Promise<bigint>`
 - `getBettorsOnSquare(roundId: bigint, square: number): Promise<bigint>`
 - `getUserBet(roundId: bigint, square: number, bettor: Address): Promise<bigint>`
@@ -843,6 +877,14 @@ const txHash = await strategy.betOnLeastAllocated(
 
 See the [examples README](./examples/README.md) for more detailed examples and strategies.
 
+## Disclaimer
+
+This SDK is built for real use — it interacts with live smart contracts on
+Robinhood Chain and moves real ETH and SLVR. That also means it's provided **"as
+is", without warranty of any kind** (see [LICENSE](./LICENSE)); you're
+responsible for the transactions you send. Sensible precautions: review your code,
+start with small amounts, and keep your keys safe.
+
 ## License
 
 MIT