@slvr-labs/sdk 0.1.0

package/dist/connect.d.ts

@@ -0,0 +1,47 @@
+import { Account, Chain, PublicClient, Transport, WalletClient } from 'viem';
+import { SlvrDeployment } from './deployments';
+/**
+ * Options for {@link createSlvrClients} / {@link SlvrSDK.connect}.
+ */
+export interface ConnectOptions {
+    /** Which deployment to target. Defaults to `robinhood`. */
+    deployment?: SlvrDeployment;
+    /** RPC URL. Defaults to the deployment's `rpcUrl`. Ignored if `transport` is given. */
+    rpcUrl?: string;
+    /** A fully-custom viem transport (overrides `rpcUrl`). */
+    transport?: Transport;
+    /** A private key to build a wallet client from (for sending transactions). */
+    privateKey?: `0x${string}`;
+    /** …or an already-built viem `Account` (alternative to `privateKey`). */
+    account?: Account;
+    /** Auto-batch concurrent reads through Multicall3. Defaults to `true`. */
+    batchMulticall?: boolean;
+    /** viem polling interval (ms) used by event watchers. */
+    pollingInterval?: number;
+}
+/**
+ * Build a viem `Chain` for a deployment. Returns the shipped `robinhoodChain`
+ * (which already registers Multicall3) for the Robinhood deployment; otherwise
+ * synthesizes one, wiring `multicall3` when the deployment provides it.
+ */
+export declare function chainFromDeployment(deployment: SlvrDeployment): Chain;
+/** Clients returned by {@link createSlvrClients}. */
+export interface SlvrClients {
+    chain: Chain;
+    publicClient: PublicClient;
+    /** Present only when a `privateKey` or `account` was supplied. */
+    walletClient?: WalletClient;
+}
+/**
+ * Create ready-to-use viem clients for a Slvr deployment with sensible, resilient
+ * defaults — Multicall3 auto-batching, a longer timeout, and retries — so you
+ * don't have to hand-tune the transport for a polling bot.
+ *
+ * @example
+ * ```typescript
+ * import { createSlvrClients } from '@slvr-labs/sdk';
+ * const { publicClient, walletClient } = createSlvrClients({ privateKey: process.env.PRIVATE_KEY });
+ * ```
+ */
+export declare function createSlvrClients(opts?: ConnectOptions): SlvrClients;
+//# sourceMappingURL=connect.d.ts.map

package/dist/connect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connect.d.ts","sourceRoot":"","sources":["../src/connect.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,KAAK,EACL,YAAY,EACZ,SAAS,EACT,YAAY,EAKb,MAAM,MAAM,CAAC;AAEd,OAAO,EAAE,cAAc,EAA6B,MAAM,eAAe,CAAC;AAE1E;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,2DAA2D;IAC3D,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,uFAAuF;IACvF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0DAA0D;IAC1D,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,KAAK,MAAM,EAAE,CAAC;IAC3B,yEAAyE;IACzE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0EAA0E;IAC1E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yDAAyD;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,cAAc,GAAG,KAAK,CAcrE;AAED,qDAAqD;AACrD,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,EAAE,YAAY,CAAC;IAC3B,kEAAkE;IAClE,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,GAAE,cAAmB,GAAG,WAAW,CAkBxE"}

package/dist/connect.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chainFromDeployment = chainFromDeployment;
+exports.createSlvrClients = createSlvrClients;
+const viem_1 = require("viem");
+const accounts_1 = require("viem/accounts");
+const deployments_1 = require("./deployments");
+/**
+ * Build a viem `Chain` for a deployment. Returns the shipped `robinhoodChain`
+ * (which already registers Multicall3) for the Robinhood deployment; otherwise
+ * synthesizes one, wiring `multicall3` when the deployment provides it.
+ */
+function chainFromDeployment(deployment) {
+    if (deployment.chainId === deployments_1.robinhood.chainId)
+        return deployments_1.robinhoodChain;
+    return (0, viem_1.defineChain)({
+        id: deployment.chainId,
+        name: deployment.name,
+        nativeCurrency: { decimals: 18, name: 'Ether', symbol: 'ETH' },
+        rpcUrls: { default: { http: [deployment.rpcUrl] } },
+        ...(deployment.blockExplorer
+            ? { blockExplorers: { default: { name: 'Explorer', url: deployment.blockExplorer } } }
+            : {}),
+        ...(deployment.addresses.multicall3
+            ? { contracts: { multicall3: { address: deployment.addresses.multicall3 } } }
+            : {}),
+    });
+}
+/**
+ * Create ready-to-use viem clients for a Slvr deployment with sensible, resilient
+ * defaults — Multicall3 auto-batching, a longer timeout, and retries — so you
+ * don't have to hand-tune the transport for a polling bot.
+ *
+ * @example
+ * ```typescript
+ * import { createSlvrClients } from '@slvr-labs/sdk';
+ * const { publicClient, walletClient } = createSlvrClients({ privateKey: process.env.PRIVATE_KEY });
+ * ```
+ */
+function createSlvrClients(opts = {}) {
+    const deployment = opts.deployment ?? deployments_1.robinhood;
+    const chain = chainFromDeployment(deployment);
+    const transport = opts.transport ?? (0, viem_1.http)(opts.rpcUrl ?? deployment.rpcUrl, { timeout: 20000, retryCount: 3 });
+    const publicClient = (0, viem_1.createPublicClient)({
+        chain,
+        transport,
+        batch: { multicall: opts.batchMulticall ?? true },
+        ...(opts.pollingInterval ? { pollingInterval: opts.pollingInterval } : {}),
+    });
+    const account = opts.account ?? (opts.privateKey ? (0, accounts_1.privateKeyToAccount)(opts.privateKey) : undefined);
+    const walletClient = account
+        ? (0, viem_1.createWalletClient)({ chain, transport, account })
+        : undefined;
+    return { chain, publicClient, walletClient };
+}
+//# sourceMappingURL=connect.js.map

package/dist/connect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connect.js","sourceRoot":"","sources":["../src/connect.ts"],"names":[],"mappings":";;AAuCA,kDAcC;AAqBD,8CAkBC;AA5FD,+BAUc;AACd,4CAAoD;AACpD,+CAA0E;AAsB1E;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,UAA0B;IAC5D,IAAI,UAAU,CAAC,OAAO,KAAK,uBAAS,CAAC,OAAO;QAAE,OAAO,4BAAc,CAAC;IACpE,OAAO,IAAA,kBAAW,EAAC;QACjB,EAAE,EAAE,UAAU,CAAC,OAAO;QACtB,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,cAAc,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE;QAC9D,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE;QACnD,GAAG,CAAC,UAAU,CAAC,aAAa;YAC1B,CAAC,CAAC,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,UAAU,CAAC,aAAa,EAAE,EAAE,EAAE;YACtF,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,UAAU;YACjC,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,UAAU,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,EAAE;YAC7E,CAAC,CAAC,EAAE,CAAC;KACR,CAAC,CAAC;AACL,CAAC;AAUD;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAAC,OAAuB,EAAE;IACzD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,uBAAS,CAAC;IAChD,MAAM,KAAK,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,IAAA,WAAI,EAAC,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,KAAM,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;IAE/G,MAAM,YAAY,GAAG,IAAA,yBAAkB,EAAC;QACtC,KAAK;QACL,SAAS;QACT,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI,EAAE;QACjD,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC3E,CAAiB,CAAC;IAEnB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,8BAAmB,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACrG,MAAM,YAAY,GAAG,OAAO;QAC1B,CAAC,CAAE,IAAA,yBAAkB,EAAC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,CAAkB;QACrE,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;AAC/C,CAAC"}

package/dist/contracts/autoCommit.d.ts

@@ -0,0 +1,151 @@
+import { Address, PublicClient, WalletClient } from 'viem';
+import { AutoCommitPlan } from '../types';
+/**
+ * SlvrAutoCommitV2 contract interface
+ *
+ * V2 economics: executors calling executeFor/claimFor are reimbursed their
+ * metered gas (plus a premium, capped at maxFeePerExecution — both owner-tunable
+ * within hard ceilings) from the user's plan balance — there is no flat
+ * AUTOMATION_FEE and the execution functions are nonpayable. Claimable winning
+ * rounds are discovered off-chain and passed in explicitly via claimRounds.
+ */
+export declare class SlvrAutoCommit {
+    private publicClient;
+    private walletClient?;
+    private address;
+    private static readonly ABI;
+    constructor(publicClient: PublicClient, walletClient: WalletClient | undefined, address: Address);
+    /**
+     * Update the wallet client
+     * @param walletClient New wallet client
+     */
+    setWalletClient(walletClient: WalletClient | undefined): void;
+    /**
+     * Get plan information for a user
+     */
+    planInfo(user: Address): Promise<AutoCommitPlan>;
+    /**
+     * Check whether a plan is ready to execute, and if not, why
+     */
+    needsExecution(user: Address): Promise<{
+        ready: boolean;
+        reason: string;
+    }>;
+    /**
+     * Check whether a specific round has already been executed for a user
+     */
+    executedRound(user: Address, roundId: bigint): Promise<boolean>;
+    /**
+     * Get lottery contract address
+     */
+    lottery(): Promise<Address>;
+    /**
+     * Get the sentinel plays value meaning "unlimited plays"
+     */
+    unlimitedPlays(): Promise<number>;
+    /**
+     * Get max plays per execution
+     */
+    maxPlaysPerExecution(): Promise<number>;
+    /**
+     * Get max claim rounds accepted per execution
+     */
+    maxClaimsPerExecution(): Promise<bigint>;
+    /**
+     * Get the current cap on the executor fee reimbursed per execution
+     * (owner-tunable within the contract's hard ceiling)
+     */
+    maxFeePerExecution(): Promise<bigint>;
+    /**
+     * Get the current executor-fee premium in basis points
+     * (owner-tunable within the contract's hard ceiling)
+     */
+    feePremiumBps(): Promise<number>;
+    /**
+     * Deposit native tokens to auto-commit plan
+     * @param value Amount to deposit
+     * @returns Transaction hash
+     * @throws WalletClientRequiredError if wallet client is not available
+     * @throws ValidationError if amount is invalid
+     * @throws ContractCallError if contract call fails
+     */
+    deposit(value: bigint): Promise<`0x${string}`>;
+    /**
+     * Withdraw from auto-commit plan
+     * @param amount Amount to withdraw
+     * @param to Recipient address
+     * @returns Transaction hash
+     * @throws WalletClientRequiredError if wallet client is not available
+     * @throws ValidationError if inputs are invalid
+     * @throws ContractCallError if contract call fails
+     */
+    withdraw(amount: bigint, to: Address): Promise<`0x${string}`>;
+    /**
+     * Configure auto-commit plan
+     * @param plays Number of plays (UNLIMITED_PLAYS = 4294967295 for unlimited;
+     *              forced to unlimited on-chain when autoClaim is true)
+     * @param amountPerPlay Amount per play
+     * @param squares Square indices to bet on
+     * @param bpsAlloc Basis points allocation for each square (must sum to 10000)
+     * @param autoClaim Whether the keeper should claim winnings back into the plan balance
+     * @returns Transaction hash
+     * @throws WalletClientRequiredError if wallet client is not available
+     * @throws ValidationError if inputs are invalid
+     * @throws ContractCallError if contract call fails
+     */
+    configurePlan(plays: number, amountPerPlay: bigint, squares: number[], bpsAlloc: number[], autoClaim: boolean): Promise<`0x${string}`>;
+    /**
+     * Configure auto-commit plan and deposit funds in a single transaction
+     * @param plays Number of plays (see configurePlan)
+     * @param amountPerPlay Amount per play
+     * @param squares Square indices to bet on
+     * @param bpsAlloc Basis points allocation for each square (must sum to 10000)
+     * @param autoClaim Whether the keeper should claim winnings back into the plan balance
+     * @param value Amount to deposit
+     * @returns Transaction hash
+     * @throws WalletClientRequiredError if wallet client is not available
+     * @throws ValidationError if inputs are invalid
+     * @throws ContractCallError if contract call fails
+     */
+    configurePlanAndDeposit(plays: number, amountPerPlay: bigint, squares: number[], bpsAlloc: number[], autoClaim: boolean, value: bigint): Promise<`0x${string}`>;
+    /**
+     * Disable auto-commit plan
+     * @returns Transaction hash
+     * @throws WalletClientRequiredError if wallet client is not available
+     * @throws ContractCallError if contract call fails
+     */
+    disablePlan(): Promise<`0x${string}`>;
+    /**
+     * Cancel the plan and refund the entire remaining balance to the caller
+     * @returns Transaction hash
+     * @throws WalletClientRequiredError if wallet client is not available
+     * @throws ContractCallError if contract call fails
+     */
+    cancelPlan(): Promise<`0x${string}`>;
+    /**
+     * Execute auto-commit plan for a user (anyone can call).
+     * The caller is reimbursed metered gas + premium from the user's plan balance.
+     * @param user User address
+     * @param maxPlays Maximum number of plays to execute
+     * @param claimRounds Winning round ids to claim into the plan balance before
+     *        betting (discovered off-chain; non-claimable entries are no-ops)
+     * @returns Transaction hash
+     * @throws WalletClientRequiredError if wallet client is not available
+     * @throws ValidationError if inputs are invalid
+     * @throws ContractCallError if contract call fails
+     */
+    executeFor(user: Address, maxPlays: number, claimRounds?: bigint[]): Promise<`0x${string}`>;
+    /**
+     * Claim winning rounds into a user's plan balance without betting (anyone can
+     * call). Useful when the plan balance is too low to bet until winnings land.
+     * @param user User address
+     * @param claimRounds Winning round ids to claim (discovered off-chain)
+     * @returns Transaction hash
+     * @throws WalletClientRequiredError if wallet client is not available
+     * @throws ValidationError if inputs are invalid
+     * @throws ContractCallError if contract call fails
+     */
+    claimFor(user: Address, claimRounds: bigint[]): Promise<`0x${string}`>;
+    private validatePlanConfig;
+}
+//# sourceMappingURL=autoCommit.d.ts.map

package/dist/contracts/autoCommit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"autoCommit.d.ts","sourceRoot":"","sources":["../../src/contracts/autoCommit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAY,YAAY,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAI1C;;;;;;;;GAQG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,YAAY,CAAC,CAAe;IACpC,OAAO,CAAC,OAAO,CAAU;IAEzB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAqBxB;gBAES,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO;IAMhG;;;OAGG;IACH,eAAe,CAAC,YAAY,EAAE,YAAY,GAAG,SAAS,GAAG,IAAI;IAI7D;;OAEG;IACG,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;IAqBtD;;OAEG;IACG,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAUhF;;OAEG;IACG,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASrE;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAQjC;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAQvC;;OAEG;IACG,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC;IAQ7C;;OAEG;IACG,qBAAqB,IAAI,OAAO,CAAC,MAAM,CAAC;IAQ9C;;;OAGG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAQ3C;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAQtC;;;;;;;OAOG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC;IAwBpD;;;;;;;;OAQG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC;IAyBnE;;;;;;;;;;;;OAYG;IACG,aAAa,CACjB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,EAAE,MAAM,EAAE,EAClB,SAAS,EAAE,OAAO,GACjB,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC;IAwBzB;;;;;;;;;;;;OAYG;IACG,uBAAuB,CAC3B,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,EAAE,MAAM,EAAE,EAClB,SAAS,EAAE,OAAO,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC;IA0BzB;;;;;OAKG;IACG,WAAW,IAAI,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC;IAqB3C;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC;IAqB1C;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC;IA2BrG;;;;;;;;;OASG;IACG,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC;IA2B5E,OAAO,CAAC,kBAAkB;CAS3B"}