@0xslots/sdk 0.8.0 → 0.8.3

package/dist/index.js

@@ -1,7 +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';
+import { getMetadataModuleAddress, metadataModuleAbi, getSlotsHubAddress, slotAbi, slotFactoryAbi } from '@0xslots/contracts';
 
 // src/client.ts
 var AccountFieldsFragmentDoc = gql`
@@ -26,6 +26,30 @@ var CurrencyFieldsFragmentDoc = gql`
   decimals
 }
     `;
+var MetadataSlotFieldsFragmentDoc = gql`
+    fragment MetadataSlotFields on MetadataSlot {
+  id
+  uri
+  updatedBy
+  updateCount
+  createdAt
+  createdTx
+  updatedAt
+  updatedTx
+  slot {
+    id
+    recipient
+    occupant
+    price
+    deposit
+    currency {
+      id
+      symbol
+      decimals
+    }
+  }
+}
+    `;
 var SlotFieldsFragmentDoc = gql`
     fragment SlotFields on Slot {
   id
@@ -91,9 +115,64 @@ var GetAccountsDocument = gql`
   }
 }
     ${AccountFieldsFragmentDoc}`;
+var GetSlotDeployedEventsDocument = gql`
+    query GetSlotDeployedEvents($first: Int!, $skip: Int, $orderBy: SlotDeployedEvent_orderBy, $orderDirection: OrderDirection, $where: SlotDeployedEvent_filter, $block: Block_height) {
+  slotDeployedEvents(
+    first: $first
+    skip: $skip
+    orderBy: $orderBy
+    orderDirection: $orderDirection
+    where: $where
+    block: $block
+  ) {
+    id
+    slot {
+      id
+    }
+    recipient
+    currency {
+      ...CurrencyFields
+    }
+    manager
+    mutableTax
+    mutableModule
+    taxPercentage
+    module
+    liquidationBountyBps
+    minDepositSeconds
+    deployer
+    timestamp
+    blockNumber
+    tx
+  }
+}
+    ${CurrencyFieldsFragmentDoc}`;
 var GetRecentEventsDocument = gql`
-    query GetRecentEvents($first: Int!) {
-  boughtEvents(first: $first, orderBy: timestamp, orderDirection: desc) {
+    query GetRecentEvents($first: Int!, $skip: Int) {
+  slotDeployedEvents(
+    first: $first
+    skip: $skip
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
+    id
+    slot {
+      id
+    }
+    recipient
+    currency {
+      ...CurrencyFields
+    }
+    deployer
+    timestamp
+    tx
+  }
+  boughtEvents(
+    first: $first
+    skip: $skip
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
     id
     slot {
       id
@@ -109,7 +188,12 @@ var GetRecentEventsDocument = gql`
     timestamp
     tx
   }
-  releasedEvents(first: $first, orderBy: timestamp, orderDirection: desc) {
+  releasedEvents(
+    first: $first
+    skip: $skip
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
     id
     slot {
       id
@@ -122,7 +206,12 @@ var GetRecentEventsDocument = gql`
     timestamp
     tx
   }
-  liquidatedEvents(first: $first, orderBy: timestamp, orderDirection: desc) {
+  liquidatedEvents(
+    first: $first
+    skip: $skip
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
     id
     slot {
       id
@@ -136,7 +225,12 @@ var GetRecentEventsDocument = gql`
     timestamp
     tx
   }
-  priceUpdatedEvents(first: $first, orderBy: timestamp, orderDirection: desc) {
+  priceUpdatedEvents(
+    first: $first
+    skip: $skip
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
     id
     slot {
       id
@@ -149,7 +243,12 @@ var GetRecentEventsDocument = gql`
     timestamp
     tx
   }
-  depositedEvents(first: $first, orderBy: timestamp, orderDirection: desc) {
+  depositedEvents(
+    first: $first
+    skip: $skip
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
     id
     slot {
       id
@@ -162,7 +261,12 @@ var GetRecentEventsDocument = gql`
     timestamp
     tx
   }
-  withdrawnEvents(first: $first, orderBy: timestamp, orderDirection: desc) {
+  withdrawnEvents(
+    first: $first
+    skip: $skip
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
     id
     slot {
       id
@@ -175,7 +279,12 @@ var GetRecentEventsDocument = gql`
     timestamp
     tx
   }
-  taxCollectedEvents(first: $first, orderBy: timestamp, orderDirection: desc) {
+  taxCollectedEvents(
+    first: $first
+    skip: $skip
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
     id
     slot {
       id
@@ -188,7 +297,12 @@ var GetRecentEventsDocument = gql`
     timestamp
     tx
   }
-  taxUpdateProposedEvents(first: $first, orderBy: timestamp, orderDirection: desc) {
+  taxUpdateProposedEvents(
+    first: $first
+    skip: $skip
+    orderBy: timestamp
+    orderDirection: desc
+  ) {
     id
     slot {
       id
@@ -199,6 +313,7 @@ var GetRecentEventsDocument = gql`
   }
   moduleUpdateProposedEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
   ) {
@@ -212,6 +327,7 @@ var GetRecentEventsDocument = gql`
   }
   pendingUpdateCancelledEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
   ) {
@@ -430,9 +546,10 @@ var GetPriceUpdatedEventsDocument = gql`
 }
     ${CurrencyFieldsFragmentDoc}`;
 var GetSlotActivityDocument = gql`
-    query GetSlotActivity($slotId: String!, $first: Int!) {
+    query GetSlotActivity($slotId: String!, $first: Int!, $skip: Int) {
   boughtEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -451,6 +568,7 @@ var GetSlotActivityDocument = gql`
   }
   releasedEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -466,6 +584,7 @@ var GetSlotActivityDocument = gql`
   }
   liquidatedEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -482,6 +601,7 @@ var GetSlotActivityDocument = gql`
   }
   priceUpdatedEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -497,6 +617,7 @@ var GetSlotActivityDocument = gql`
   }
   depositedEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -512,6 +633,7 @@ var GetSlotActivityDocument = gql`
   }
   withdrawnEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -527,6 +649,7 @@ var GetSlotActivityDocument = gql`
   }
   taxCollectedEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -542,6 +665,7 @@ var GetSlotActivityDocument = gql`
   }
   taxUpdateProposedEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -553,6 +677,7 @@ var GetSlotActivityDocument = gql`
   }
   moduleUpdateProposedEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -564,6 +689,7 @@ var GetSlotActivityDocument = gql`
   }
   pendingUpdateCancelledEvents(
     first: $first
+    skip: $skip
     orderBy: timestamp
     orderDirection: desc
     where: {slot: $slotId}
@@ -592,6 +718,56 @@ var GetModulesDocument = gql`
   }
 }
     `;
+var GetMetadataSlotsDocument = gql`
+    query GetMetadataSlots($first: Int = 100, $skip: Int = 0, $orderBy: MetadataSlot_orderBy = updatedAt, $orderDirection: OrderDirection = desc) {
+  metadataSlots(
+    first: $first
+    skip: $skip
+    orderBy: $orderBy
+    orderDirection: $orderDirection
+  ) {
+    ...MetadataSlotFields
+  }
+}
+    ${MetadataSlotFieldsFragmentDoc}`;
+var GetMetadataSlotDocument = gql`
+    query GetMetadataSlot($id: ID!) {
+  metadataSlot(id: $id) {
+    ...MetadataSlotFields
+  }
+}
+    ${MetadataSlotFieldsFragmentDoc}`;
+var GetMetadataSlotsByRecipientDocument = gql`
+    query GetMetadataSlotsByRecipient($recipient: Bytes!, $first: Int = 100) {
+  metadataSlots(
+    first: $first
+    where: {slot_: {recipient: $recipient}}
+    orderBy: updatedAt
+    orderDirection: desc
+  ) {
+    ...MetadataSlotFields
+  }
+}
+    ${MetadataSlotFieldsFragmentDoc}`;
+var GetMetadataUpdatedEventsDocument = gql`
+    query GetMetadataUpdatedEvents($slot: String, $first: Int = 50, $orderBy: MetadataUpdatedEvent_orderBy = timestamp, $orderDirection: OrderDirection = desc) {
+  metadataUpdatedEvents(
+    first: $first
+    where: {slot: $slot}
+    orderBy: $orderBy
+    orderDirection: $orderDirection
+  ) {
+    id
+    slot {
+      id
+    }
+    uri
+    timestamp
+    blockNumber
+    tx
+  }
+}
+    `;
 var GetSlotsDocument = gql`
     query GetSlots($first: Int!, $skip: Int, $orderBy: Slot_orderBy, $orderDirection: OrderDirection, $where: Slot_filter, $block: Block_height) {
   slots(
@@ -650,6 +826,9 @@ function getSdk(client, withWrapper = defaultWrapper) {
     GetAccounts(variables, requestHeaders, signal) {
       return withWrapper((wrappedRequestHeaders) => client.request({ document: GetAccountsDocument, variables, requestHeaders: { ...requestHeaders, ...wrappedRequestHeaders }, signal }), "GetAccounts", "query", variables);
     },
+    GetSlotDeployedEvents(variables, requestHeaders, signal) {
+      return withWrapper((wrappedRequestHeaders) => client.request({ document: GetSlotDeployedEventsDocument, variables, requestHeaders: { ...requestHeaders, ...wrappedRequestHeaders }, signal }), "GetSlotDeployedEvents", "query", variables);
+    },
     GetRecentEvents(variables, requestHeaders, signal) {
       return withWrapper((wrappedRequestHeaders) => client.request({ document: GetRecentEventsDocument, variables, requestHeaders: { ...requestHeaders, ...wrappedRequestHeaders }, signal }), "GetRecentEvents", "query", variables);
     },
@@ -686,6 +865,18 @@ function getSdk(client, withWrapper = defaultWrapper) {
     GetModules(variables, requestHeaders, signal) {
       return withWrapper((wrappedRequestHeaders) => client.request({ document: GetModulesDocument, variables, requestHeaders: { ...requestHeaders, ...wrappedRequestHeaders }, signal }), "GetModules", "query", variables);
     },
+    GetMetadataSlots(variables, requestHeaders, signal) {
+      return withWrapper((wrappedRequestHeaders) => client.request({ document: GetMetadataSlotsDocument, variables, requestHeaders: { ...requestHeaders, ...wrappedRequestHeaders }, signal }), "GetMetadataSlots", "query", variables);
+    },
+    GetMetadataSlot(variables, requestHeaders, signal) {
+      return withWrapper((wrappedRequestHeaders) => client.request({ document: GetMetadataSlotDocument, variables, requestHeaders: { ...requestHeaders, ...wrappedRequestHeaders }, signal }), "GetMetadataSlot", "query", variables);
+    },
+    GetMetadataSlotsByRecipient(variables, requestHeaders, signal) {
+      return withWrapper((wrappedRequestHeaders) => client.request({ document: GetMetadataSlotsByRecipientDocument, variables, requestHeaders: { ...requestHeaders, ...wrappedRequestHeaders }, signal }), "GetMetadataSlotsByRecipient", "query", variables);
+    },
+    GetMetadataUpdatedEvents(variables, requestHeaders, signal) {
+      return withWrapper((wrappedRequestHeaders) => client.request({ document: GetMetadataUpdatedEventsDocument, variables, requestHeaders: { ...requestHeaders, ...wrappedRequestHeaders }, signal }), "GetMetadataUpdatedEvents", "query", variables);
+    },
     GetSlots(variables, requestHeaders, signal) {
       return withWrapper((wrappedRequestHeaders) => client.request({ document: GetSlotsDocument, variables, requestHeaders: { ...requestHeaders, ...wrappedRequestHeaders }, signal }), "GetSlots", "query", variables);
     },
@@ -711,6 +902,101 @@ var SlotsError = class extends Error {
     this.cause = cause;
   }
 };
+var MetadataModuleClient = class {
+  constructor(opts) {
+    this.sdk = opts.sdk;
+    this.chainId = opts.chainId;
+    this._publicClient = opts.publicClient;
+    this._walletClient = opts.walletClient;
+    this._moduleAddress = opts.moduleAddress ?? getMetadataModuleAddress(opts.chainId);
+  }
+  get moduleAddress() {
+    if (!this._moduleAddress) throw new SlotsError("metadata", `No MetadataModule deployed on chain ${this.chainId}`);
+    return this._moduleAddress;
+  }
+  get wallet() {
+    if (!this._walletClient) throw new SlotsError("metadata", "No walletClient provided");
+    return this._walletClient;
+  }
+  get account() {
+    const account = this.wallet.account;
+    if (!account) throw new SlotsError("metadata", "WalletClient must have an account");
+    return account.address;
+  }
+  get chain() {
+    const chain = this.wallet.chain;
+    if (!chain) throw new SlotsError("metadata", "WalletClient must have a chain");
+    return chain;
+  }
+  get publicClient() {
+    if (!this._publicClient) throw new SlotsError("metadata", "No publicClient provided");
+    return this._publicClient;
+  }
+  async query(operation, fn) {
+    try {
+      return await fn();
+    } catch (error) {
+      throw new SlotsError(operation, error);
+    }
+  }
+  // ═══════════════════════════════════════════════════════════════════════════
+  // READ — Subgraph
+  // ═══════════════════════════════════════════════════════════════════════════
+  /** Get all slots with metadata, ordered by most recently updated. */
+  getSlots(...args) {
+    return this.query("metadata.getSlots", () => this.sdk.GetMetadataSlots(...args));
+  }
+  /** Get a single metadata slot by slot address. */
+  getSlot(...args) {
+    return this.query("metadata.getSlot", () => this.sdk.GetMetadataSlot(...args));
+  }
+  /** Get all metadata slots for a given recipient. */
+  getSlotsByRecipient(...args) {
+    return this.query("metadata.getSlotsByRecipient", () => this.sdk.GetMetadataSlotsByRecipient(...args));
+  }
+  /** Get metadata update history for a slot. */
+  getUpdateHistory(...args) {
+    return this.query("metadata.getUpdateHistory", () => this.sdk.GetMetadataUpdatedEvents(...args));
+  }
+  // ═══════════════════════════════════════════════════════════════════════════
+  // READ — RPC
+  // ═══════════════════════════════════════════════════════════════════════════
+  /** Read the current URI for a slot directly from chain (bypasses subgraph). */
+  async getURI(slot) {
+    return this.query(
+      "metadata.getURI",
+      () => this.publicClient.readContract({
+        address: this.moduleAddress,
+        abi: metadataModuleAbi,
+        functionName: "tokenURI",
+        args: [slot]
+      })
+    );
+  }
+  // ═══════════════════════════════════════════════════════════════════════════
+  // WRITE
+  // ═══════════════════════════════════════════════════════════════════════════
+  /**
+   * Update the metadata URI for a slot. Only callable by the current occupant.
+   * @param slot - The slot contract address
+   * @param uri - The new URI (e.g. ipfs://..., https://...)
+   * @returns Transaction hash
+   */
+  async updateMetadata(slot, uri) {
+    return this.wallet.writeContract({
+      address: this.moduleAddress,
+      abi: metadataModuleAbi,
+      functionName: "updateMetadata",
+      args: [slot, uri],
+      account: this.account,
+      chain: this.chain
+    });
+  }
+  /** Returns the MetadataModule contract address for the configured chain. */
+  getAddress() {
+    return this.moduleAddress;
+  }
+};
 
 // src/client.ts
 var META_QUERY = gql$1`
@@ -731,7 +1017,7 @@ 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/version/latest",
+  [84532 /* BASE_SEPOLIA */]: "https://gateway.thegraph.com/api/subgraphs/id/Z361DLoMdPh9WAopH7shJP8WoXYAB9XeKrLUCTYjdZR",
   [42161 /* ARBITRUM */]: "https://api.studio.thegraph.com/query/958/0-x-slots-arb/version/latest"
 };
 var SlotsClient = class {
@@ -742,8 +1028,20 @@ var SlotsClient = class {
     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.gqlClient = new GraphQLClient(url, { headers: config.headers });
+    const headers = { ...config.headers };
+    if (config.subgraphApiKey) {
+      headers["Authorization"] = `Bearer ${config.subgraphApiKey}`;
+    }
+    this.gqlClient = new GraphQLClient(url, { headers });
     this.sdk = getSdk(this.gqlClient);
+    this.modules = {
+      metadata: new MetadataModuleClient({
+        sdk: this.sdk,
+        chainId: config.chainId,
+        publicClient: config.publicClient,
+        walletClient: config.walletClient
+      })
+    };
   }
   // ─── Accessors ──────────────────────────────────────────────────────────────
   /** Returns the chain ID this client was configured for. */
@@ -821,6 +1119,10 @@ var SlotsClient = class {
     return this.query("getModules", () => this.sdk.GetModules(...args));
   }
   // Event queries
+  /** Fetch slot deployed events with optional filters. */
+  getSlotDeployedEvents(...args) {
+    return this.query("getSlotDeployedEvents", () => this.sdk.GetSlotDeployedEvents(...args));
+  }
   /** Fetch bought events with optional filters. */
   getBoughtEvents(...args) {
     return this.query("getBoughtEvents", () => this.sdk.GetBoughtEvents(...args));
@@ -1236,6 +1538,6 @@ function createSlotsClient(config) {
   return new SlotsClient(config);
 }
 
-export { AccountFieldsFragmentDoc, CurrencyFieldsFragmentDoc, GetAccountDocument, GetAccountsDocument, GetBoughtEventsDocument, GetDepositedEventsDocument, GetFactoryDocument, GetLiquidatedEventsDocument, GetModulesDocument, GetPriceUpdatedEventsDocument, GetRecentEventsDocument, GetReleasedEventsDocument, GetSettledEventsDocument, GetSlotActivityDocument, GetSlotDocument, GetSlotsByOccupantDocument, GetSlotsByRecipientDocument, GetSlotsDocument, GetTaxCollectedEventsDocument, GetWithdrawnEventsDocument, SUBGRAPH_URLS, SlotFieldsFragmentDoc, SlotsChain, SlotsClient, SlotsError, createSlotsClient, getSdk };
+export { AccountFieldsFragmentDoc, CurrencyFieldsFragmentDoc, GetAccountDocument, GetAccountsDocument, GetBoughtEventsDocument, GetDepositedEventsDocument, GetFactoryDocument, GetLiquidatedEventsDocument, GetMetadataSlotDocument, GetMetadataSlotsByRecipientDocument, GetMetadataSlotsDocument, GetMetadataUpdatedEventsDocument, GetModulesDocument, GetPriceUpdatedEventsDocument, GetRecentEventsDocument, GetReleasedEventsDocument, GetSettledEventsDocument, GetSlotActivityDocument, GetSlotDeployedEventsDocument, GetSlotDocument, GetSlotsByOccupantDocument, GetSlotsByRecipientDocument, GetSlotsDocument, GetTaxCollectedEventsDocument, GetWithdrawnEventsDocument, MetadataModuleClient, MetadataSlotFieldsFragmentDoc, SUBGRAPH_URLS, SlotFieldsFragmentDoc, SlotsChain, SlotsClient, SlotsError, createSlotsClient, getSdk };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map