@0xslots/sdk 0.5.0 → 0.6.0

package/dist/index.js

@@ -1,5 +1,7 @@
 import { gql as gql$1, GraphQLClient } from 'graphql-request';
 import gql from 'graphql-tag';
+import { encodeFunctionData, erc20Abi } from 'viem';
+import { getSlotsHubAddress, slotAbi, slotFactoryAbi } from '@0xslots/contracts';
 
 // src/client.ts
 var AccountFieldsFragmentDoc = gql`
@@ -32,7 +34,12 @@ var SlotFieldsFragmentDoc = gql`
   mutableTax
   mutableModule
   taxPercentage
-  module
+  module {
+    id
+    verified
+    name
+    version
+  }
   occupant
   occupantAccount {
     id
@@ -147,6 +154,40 @@ var GetRecentEventsDocument = gql`
     timestamp
     tx
   }
+  taxUpdateProposedEvents(first: $first, orderBy: timestamp, orderDirection: desc) {
+    id
+    slot {
+      id
+    }
+    newPercentage
+    timestamp
+    tx
+  }
+  moduleUpdateProposedEvents(
+    first: $first
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
+    id
+    slot {
+      id
+    }
+    newModule
+    timestamp
+    tx
+  }
+  pendingUpdateCancelledEvents(
+    first: $first
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
+    id
+    slot {
+      id
+    }
+    timestamp
+    tx
+  }
 }
     `;
 var GetBoughtEventsDocument = gql`
@@ -420,6 +461,38 @@ var GetSlotActivityDocument = gql`
     timestamp
     tx
   }
+  taxUpdateProposedEvents(
+    first: $first
+    orderBy: timestamp
+    orderDirection: desc
+    where: {slot: $slotId}
+  ) {
+    id
+    newPercentage
+    timestamp
+    tx
+  }
+  moduleUpdateProposedEvents(
+    first: $first
+    orderBy: timestamp
+    orderDirection: desc
+    where: {slot: $slotId}
+  ) {
+    id
+    newModule
+    timestamp
+    tx
+  }
+  pendingUpdateCancelledEvents(
+    first: $first
+    orderBy: timestamp
+    orderDirection: desc
+    where: {slot: $slotId}
+  ) {
+    id
+    timestamp
+    tx
+  }
 }
     `;
 var GetFactoryDocument = gql`
@@ -548,8 +621,6 @@ function getSdk(client, withWrapper = defaultWrapper) {
     }
   };
 }
-
-// src/client.ts
 var META_QUERY = gql$1`
   query GetMeta {
     _meta {
@@ -568,26 +639,50 @@ var SlotsChain = /* @__PURE__ */ ((SlotsChain2) => {
   return SlotsChain2;
 })(SlotsChain || {});
 var SUBGRAPH_URLS = {
-  [84532 /* BASE_SEPOLIA */]: "https://api.studio.thegraph.com/query/958/0-x-slots-base-sepolia/v3.5.0",
+  [84532 /* BASE_SEPOLIA */]: "https://api.studio.thegraph.com/query/958/0-x-slots-base-sepolia/version/latest",
   [42161 /* ARBITRUM */]: "https://api.studio.thegraph.com/query/958/0-x-slots-arb/version/latest"
 };
 var SlotsClient = class {
   constructor(config) {
     this.chainId = config.chainId;
+    this._publicClient = config.publicClient;
+    this.walletClient = config.walletClient;
+    this._factory = config.factoryAddress ?? getSlotsHubAddress(config.chainId);
     const url = config.subgraphUrl || SUBGRAPH_URLS[config.chainId];
     if (!url) throw new Error(`No subgraph URL for chain ${config.chainId}`);
-    this.client = new GraphQLClient(url, { headers: config.headers });
-    this.sdk = getSdk(this.client);
+    this.gqlClient = new GraphQLClient(url, { headers: config.headers });
+    this.sdk = getSdk(this.gqlClient);
   }
+  // ─── Accessors ──────────────────────────────────────────────────────────────
   getChainId() {
     return this.chainId;
   }
   getClient() {
-    return this.client;
+    return this.gqlClient;
   }
   getSdk() {
     return this.sdk;
   }
+  get publicClient() {
+    if (!this._publicClient) throw new Error("No publicClient provided");
+    return this._publicClient;
+  }
+  get factory() {
+    if (!this._factory) throw new Error("No factoryAddress provided");
+    return this._factory;
+  }
+  get wallet() {
+    if (!this.walletClient) throw new Error("No walletClient provided");
+    return this.walletClient;
+  }
+  get account() {
+    const account = this.wallet.account;
+    if (!account) throw new Error("WalletClient must have an account");
+    return account.address;
+  }
+  // ═══════════════════════════════════════════════════════════════════════════
+  // READ — Subgraph Queries
+  // ═══════════════════════════════════════════════════════════════════════════
   // Slot queries
   getSlots(...args) {
     return this.sdk.GetSlots(...args);
@@ -631,7 +726,7 @@ var SlotsClient = class {
   getAccounts(...args) {
     return this.sdk.GetAccounts(...args);
   }
-  // Individual event queries (full params)
+  // Individual event queries
   getReleasedEvents(...args) {
     return this.sdk.GetReleasedEvents(...args);
   }
@@ -649,7 +744,278 @@ var SlotsClient = class {
   }
   // Meta
   getMeta() {
-    return this.client.request(META_QUERY);
+    return this.gqlClient.request(META_QUERY);
+  }
+  // ═══════════════════════════════════════════════════════════════════════════
+  // READ — On-chain (RPC)
+  // ═══════════════════════════════════════════════════════════════════════════
+  /** Read full slot info from on-chain (RPC, not subgraph). */
+  async getSlotInfo(slot) {
+    return this.publicClient.readContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "getSlotInfo"
+    });
+  }
+  // ═══════════════════════════════════════════════════════════════════════════
+  // WRITE — Factory Functions
+  // ═══════════════════════════════════════════════════════════════════════════
+  async createSlot(params) {
+    return this.wallet.writeContract({
+      address: this.factory,
+      abi: slotFactoryAbi,
+      functionName: "createSlot",
+      args: [params.recipient, params.currency, params.config, params.initParams],
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  async createSlots(params) {
+    return this.wallet.writeContract({
+      address: this.factory,
+      abi: slotFactoryAbi,
+      functionName: "createSlots",
+      args: [params.recipient, params.currency, params.config, params.initParams, params.count],
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  // ═══════════════════════════════════════════════════════════════════════════
+  // WRITE — Slot Functions
+  // ═══════════════════════════════════════════════════════════════════════════
+  /** Buy a slot (or force buy an occupied one). Handles ERC-20 approval automatically. */
+  async buy(params) {
+    return this.withAllowance(params.slot, params.depositAmount, {
+      to: params.slot,
+      abi: slotAbi,
+      functionName: "buy",
+      args: [params.depositAmount, params.selfAssessedPrice]
+    });
+  }
+  /** Self-assess a new price for an occupied slot (occupant only). */
+  async selfAssess(slot, newPrice) {
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "selfAssess",
+      args: [newPrice],
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  /** Top up deposit on a slot (occupant only). Handles ERC-20 approval automatically. */
+  async topUp(slot, amount) {
+    return this.withAllowance(slot, amount, {
+      to: slot,
+      abi: slotAbi,
+      functionName: "topUp",
+      args: [amount]
+    });
+  }
+  /** Withdraw from deposit (occupant only). Cannot go below minimum deposit. */
+  async withdraw(slot, amount) {
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "withdraw",
+      args: [amount],
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  /** Release a slot (occupant only). Returns remaining deposit. */
+  async release(slot) {
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "release",
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  /** Collect accumulated tax (permissionless). */
+  async collect(slot) {
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "collect",
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  /** Liquidate an insolvent slot (permissionless). Caller receives bounty. */
+  async liquidate(slot) {
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "liquidate",
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  // ═══════════════════════════════════════════════════════════════════════════
+  // WRITE — Manager Functions
+  // ═══════════════════════════════════════════════════════════════════════════
+  /** Propose a tax rate update (manager only, slot must have mutableTax). */
+  async proposeTaxUpdate(slot, newPct) {
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "proposeTaxUpdate",
+      args: [newPct],
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  /** Propose a module update (manager only, slot must have mutableModule). */
+  async proposeModuleUpdate(slot, newModule) {
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "proposeModuleUpdate",
+      args: [newModule],
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  /** Cancel pending updates (manager only). */
+  async cancelPendingUpdates(slot) {
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "cancelPendingUpdates",
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  /** Set liquidation bounty bps (manager only). */
+  async setLiquidationBounty(slot, newBps) {
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "setLiquidationBounty",
+      args: [newBps],
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  // ═══════════════════════════════════════════════════════════════════════════
+  // WRITE — Multicall
+  // ═══════════════════════════════════════════════════════════════════════════
+  /** Batch multiple slot calls into one transaction via multicall. */
+  async multicall(slot, calls) {
+    const data = calls.map(
+      (call) => encodeFunctionData({
+        abi: slotAbi,
+        functionName: call.functionName,
+        args: call.args
+      })
+    );
+    return this.wallet.writeContract({
+      address: slot,
+      abi: slotAbi,
+      functionName: "multicall",
+      args: [data],
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
+  }
+  // ─── Internals ──────────────────────────────────────────────────────────────
+  /** Check if wallet supports atomic batch calls (EIP-5792). */
+  async supportsAtomicBatch() {
+    if (this._atomicSupport !== void 0) return this._atomicSupport;
+    try {
+      const capabilities = await this.wallet.getCapabilities?.();
+      if (!capabilities) {
+        this._atomicSupport = false;
+        return false;
+      }
+      const chainId = this.wallet.chain.id;
+      const chainCaps = capabilities[chainId] || capabilities[`0x${chainId.toString(16)}`];
+      const atomic = chainCaps?.atomicBatch ?? chainCaps?.atomic;
+      const status = atomic && typeof atomic === "object" && "status" in atomic ? atomic.status : void 0;
+      this._atomicSupport = status === "supported" || status === "ready";
+    } catch {
+      this._atomicSupport = false;
+    }
+    return this._atomicSupport;
+  }
+  /** Poll EIP-5792 getCallsStatus until the batch settles, then return a tx hash. */
+  async pollBatchReceipt(id) {
+    const MAX_ATTEMPTS = 60;
+    const INTERVAL = 1500;
+    for (let i = 0; i < MAX_ATTEMPTS; i++) {
+      const result = await this.wallet.getCallsStatus({ id });
+      if (result.status === "success") {
+        const receipts = result.receipts ?? [];
+        return receipts[receipts.length - 1]?.transactionHash ?? id;
+      }
+      if (result.status === "failure") {
+        throw new Error("Batch transaction reverted");
+      }
+      await new Promise((r) => setTimeout(r, INTERVAL));
+    }
+    throw new Error("Batch transaction timed out");
+  }
+  /**
+   * Execute a contract call that needs ERC-20 allowance.
+   * If wallet supports atomic batch (EIP-5792): sends approve + action as one atomic call.
+   * Otherwise: chains approve tx (if needed) then action tx.
+   */
+  async withAllowance(spender, amount, call) {
+    const currency = await this.publicClient.readContract({
+      address: spender,
+      abi: slotAbi,
+      functionName: "currency"
+    });
+    const allowance = await this.publicClient.readContract({
+      address: currency,
+      abi: erc20Abi,
+      functionName: "allowance",
+      args: [this.account, spender]
+    });
+    const needsApproval = allowance < amount;
+    if (needsApproval && await this.supportsAtomicBatch()) {
+      const approveData = encodeFunctionData({
+        abi: erc20Abi,
+        functionName: "approve",
+        args: [spender, amount]
+      });
+      const actionData = encodeFunctionData({
+        abi: call.abi,
+        functionName: call.functionName,
+        args: call.args
+      });
+      const id = await this.wallet.sendCalls({
+        account: this.wallet.account,
+        chain: this.wallet.chain,
+        calls: [
+          { to: currency, data: approveData },
+          { to: call.to, data: actionData }
+        ]
+      });
+      const txHash = await this.pollBatchReceipt(id);
+      return txHash;
+    }
+    if (needsApproval) {
+      const hash = await this.wallet.writeContract({
+        address: currency,
+        abi: erc20Abi,
+        functionName: "approve",
+        args: [spender, amount],
+        account: this.wallet.account,
+        chain: this.wallet.chain
+      });
+      await this.publicClient.waitForTransactionReceipt({ hash });
+    }
+    return this.wallet.writeContract({
+      address: call.to,
+      abi: call.abi,
+      functionName: call.functionName,
+      args: call.args,
+      account: this.wallet.account,
+      chain: this.wallet.chain
+    });
   }
 };
 function createSlotsClient(config) {