@0xslots/sdk 0.8.1 → 0.8.3

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { GraphQLClient, RequestOptions } from 'graphql-request';
 import * as graphql from 'graphql';
-import { Address, PublicClient, WalletClient, Hash } from 'viem';
+import { PublicClient, WalletClient, Address, Hash } from 'viem';
 
 type Maybe<T> = T | null;
 type InputMaybe<T> = T | null;
@@ -3311,6 +3311,149 @@ type GetModulesQuery = {
         version: string;
     }>;
 };
+type MetadataSlotFieldsFragment = {
+    __typename?: 'MetadataSlot';
+    id: string;
+    uri: string;
+    updatedBy: string;
+    updateCount: string;
+    createdAt: string;
+    createdTx: string;
+    updatedAt: string;
+    updatedTx: string;
+    slot: {
+        __typename?: 'Slot';
+        id: string;
+        recipient: string;
+        occupant?: string | null;
+        price: string;
+        deposit: string;
+        currency: {
+            __typename?: 'Currency';
+            id: string;
+            symbol?: string | null;
+            decimals: number;
+        };
+    };
+};
+type GetMetadataSlotsQueryVariables = Exact<{
+    first?: InputMaybe<Scalars['Int']['input']>;
+    skip?: InputMaybe<Scalars['Int']['input']>;
+    orderBy?: InputMaybe<MetadataSlot_OrderBy>;
+    orderDirection?: InputMaybe<OrderDirection>;
+}>;
+type GetMetadataSlotsQuery = {
+    __typename?: 'Query';
+    metadataSlots: Array<{
+        __typename?: 'MetadataSlot';
+        id: string;
+        uri: string;
+        updatedBy: string;
+        updateCount: string;
+        createdAt: string;
+        createdTx: string;
+        updatedAt: string;
+        updatedTx: string;
+        slot: {
+            __typename?: 'Slot';
+            id: string;
+            recipient: string;
+            occupant?: string | null;
+            price: string;
+            deposit: string;
+            currency: {
+                __typename?: 'Currency';
+                id: string;
+                symbol?: string | null;
+                decimals: number;
+            };
+        };
+    }>;
+};
+type GetMetadataSlotQueryVariables = Exact<{
+    id: Scalars['ID']['input'];
+}>;
+type GetMetadataSlotQuery = {
+    __typename?: 'Query';
+    metadataSlot?: {
+        __typename?: 'MetadataSlot';
+        id: string;
+        uri: string;
+        updatedBy: string;
+        updateCount: string;
+        createdAt: string;
+        createdTx: string;
+        updatedAt: string;
+        updatedTx: string;
+        slot: {
+            __typename?: 'Slot';
+            id: string;
+            recipient: string;
+            occupant?: string | null;
+            price: string;
+            deposit: string;
+            currency: {
+                __typename?: 'Currency';
+                id: string;
+                symbol?: string | null;
+                decimals: number;
+            };
+        };
+    } | null;
+};
+type GetMetadataSlotsByRecipientQueryVariables = Exact<{
+    recipient: Scalars['Bytes']['input'];
+    first?: InputMaybe<Scalars['Int']['input']>;
+}>;
+type GetMetadataSlotsByRecipientQuery = {
+    __typename?: 'Query';
+    metadataSlots: Array<{
+        __typename?: 'MetadataSlot';
+        id: string;
+        uri: string;
+        updatedBy: string;
+        updateCount: string;
+        createdAt: string;
+        createdTx: string;
+        updatedAt: string;
+        updatedTx: string;
+        slot: {
+            __typename?: 'Slot';
+            id: string;
+            recipient: string;
+            occupant?: string | null;
+            price: string;
+            deposit: string;
+            currency: {
+                __typename?: 'Currency';
+                id: string;
+                symbol?: string | null;
+                decimals: number;
+            };
+        };
+    }>;
+};
+type GetMetadataUpdatedEventsQueryVariables = Exact<{
+    slot?: InputMaybe<Scalars['String']['input']>;
+    first?: InputMaybe<Scalars['Int']['input']>;
+    orderBy?: InputMaybe<MetadataUpdatedEvent_OrderBy>;
+    orderDirection?: InputMaybe<OrderDirection>;
+}>;
+type GetMetadataUpdatedEventsQuery = {
+    __typename?: 'Query';
+    metadataUpdatedEvents: Array<{
+        __typename?: 'MetadataUpdatedEvent';
+        id: string;
+        uri: string;
+        timestamp: string;
+        blockNumber: string;
+        tx: string;
+        slot: {
+            __typename?: 'Slot';
+            id: string;
+        };
+    }>;
+};
 type SlotFieldsFragment = {
     __typename?: 'Slot';
     id: string;
@@ -3588,6 +3731,7 @@ type GetSlotsByOccupantQuery = {
 };
 declare const AccountFieldsFragmentDoc: graphql.DocumentNode;
 declare const CurrencyFieldsFragmentDoc: graphql.DocumentNode;
+declare const MetadataSlotFieldsFragmentDoc: graphql.DocumentNode;
 declare const SlotFieldsFragmentDoc: graphql.DocumentNode;
 declare const GetAccountDocument: graphql.DocumentNode;
 declare const GetAccountsDocument: graphql.DocumentNode;
@@ -3604,6 +3748,10 @@ declare const GetPriceUpdatedEventsDocument: graphql.DocumentNode;
 declare const GetSlotActivityDocument: graphql.DocumentNode;
 declare const GetFactoryDocument: graphql.DocumentNode;
 declare const GetModulesDocument: graphql.DocumentNode;
+declare const GetMetadataSlotsDocument: graphql.DocumentNode;
+declare const GetMetadataSlotDocument: graphql.DocumentNode;
+declare const GetMetadataSlotsByRecipientDocument: graphql.DocumentNode;
+declare const GetMetadataUpdatedEventsDocument: graphql.DocumentNode;
 declare const GetSlotsDocument: graphql.DocumentNode;
 declare const GetSlotDocument: graphql.DocumentNode;
 declare const GetSlotsByRecipientDocument: graphql.DocumentNode;
@@ -3625,6 +3773,10 @@ declare function getSdk(client: GraphQLClient, withWrapper?: SdkFunctionWrapper)
     GetSlotActivity(variables: GetSlotActivityQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetSlotActivityQuery>;
     GetFactory(variables?: GetFactoryQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetFactoryQuery>;
     GetModules(variables: GetModulesQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetModulesQuery>;
+    GetMetadataSlots(variables?: GetMetadataSlotsQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetMetadataSlotsQuery>;
+    GetMetadataSlot(variables: GetMetadataSlotQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetMetadataSlotQuery>;
+    GetMetadataSlotsByRecipient(variables: GetMetadataSlotsByRecipientQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetMetadataSlotsByRecipientQuery>;
+    GetMetadataUpdatedEvents(variables?: GetMetadataUpdatedEventsQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetMetadataUpdatedEventsQuery>;
     GetSlots(variables: GetSlotsQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetSlotsQuery>;
     GetSlot(variables: GetSlotQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetSlotQuery>;
     GetSlotsByRecipient(variables: GetSlotsByRecipientQueryVariables, requestHeaders?: GraphQLClientRequestHeaders, signal?: RequestInit["signal"]): Promise<GetSlotsByRecipientQuery>;
@@ -3632,6 +3784,54 @@ declare function getSdk(client: GraphQLClient, withWrapper?: SdkFunctionWrapper)
 };
 type Sdk = ReturnType<typeof getSdk>;
 
+/**
+ * Module namespace for MetadataModule operations.
+ * Accessible via `client.modules.metadata`.
+ *
+ * Read: subgraph queries for MetadataSlot entities
+ * Write: `updateMetadata(slot, uri)` on the MetadataModule contract
+ * RPC read: `tokenURI(slot)` on the MetadataModule contract
+ */
+declare class MetadataModuleClient {
+    private readonly sdk;
+    private readonly chainId;
+    private readonly _publicClient?;
+    private readonly _walletClient?;
+    private readonly _moduleAddress?;
+    constructor(opts: {
+        sdk: ReturnType<typeof getSdk>;
+        chainId: number;
+        publicClient?: PublicClient;
+        walletClient?: WalletClient;
+        moduleAddress?: Address;
+    });
+    private get moduleAddress();
+    private get wallet();
+    private get account();
+    private get chain();
+    private get publicClient();
+    private query;
+    /** Get all slots with metadata, ordered by most recently updated. */
+    getSlots(...args: Parameters<ReturnType<typeof getSdk>["GetMetadataSlots"]>): Promise<GetMetadataSlotsQuery>;
+    /** Get a single metadata slot by slot address. */
+    getSlot(...args: Parameters<ReturnType<typeof getSdk>["GetMetadataSlot"]>): Promise<GetMetadataSlotQuery>;
+    /** Get all metadata slots for a given recipient. */
+    getSlotsByRecipient(...args: Parameters<ReturnType<typeof getSdk>["GetMetadataSlotsByRecipient"]>): Promise<GetMetadataSlotsByRecipientQuery>;
+    /** Get metadata update history for a slot. */
+    getUpdateHistory(...args: Parameters<ReturnType<typeof getSdk>["GetMetadataUpdatedEvents"]>): Promise<GetMetadataUpdatedEventsQuery>;
+    /** Read the current URI for a slot directly from chain (bypasses subgraph). */
+    getURI(slot: Address): Promise<string>;
+    /**
+     * 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
+     */
+    updateMetadata(slot: Address, uri: string): Promise<Hash>;
+    /** Returns the MetadataModule contract address for the configured chain. */
+    getAddress(): Address;
+}
+
 interface SubgraphMeta {
     _meta: {
         block: {
@@ -3678,6 +3878,7 @@ interface SlotsClientConfig {
     publicClient?: PublicClient;
     walletClient?: WalletClient;
     subgraphUrl?: string;
+    subgraphApiKey?: string;
     headers?: Record<string, string>;
 }
 /**
@@ -3704,6 +3905,10 @@ declare class SlotsClient {
     private readonly walletClient?;
     private readonly _factory?;
     private _atomicSupport;
+    /** Module namespaces for protocol extensions. */
+    readonly modules: {
+        metadata: MetadataModuleClient;
+    };
     constructor(config: SlotsClientConfig);
     /** Returns the chain ID this client was configured for. */
     getChainId(): SlotsChain;
@@ -3726,6 +3931,10 @@ declare class SlotsClient {
         GetSlotActivity(variables: GetSlotActivityQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetSlotActivityQuery>;
         GetFactory(variables?: GetFactoryQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetFactoryQuery>;
         GetModules(variables: GetModulesQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetModulesQuery>;
+        GetMetadataSlots(variables?: GetMetadataSlotsQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetMetadataSlotsQuery>;
+        GetMetadataSlot(variables: GetMetadataSlotQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetMetadataSlotQuery>;
+        GetMetadataSlotsByRecipient(variables: GetMetadataSlotsByRecipientQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetMetadataSlotsByRecipientQuery>;
+        GetMetadataUpdatedEvents(variables?: GetMetadataUpdatedEventsQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetMetadataUpdatedEventsQuery>;
         GetSlots(variables: GetSlotsQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetSlotsQuery>;
         GetSlot(variables: GetSlotQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetSlotQuery>;
         GetSlotsByRecipient(variables: GetSlotsByRecipientQueryVariables, requestHeaders?: any, signal?: RequestInit["signal"]): Promise<GetSlotsByRecipientQuery>;
@@ -3925,4 +4134,4 @@ declare class SlotsError extends Error {
     constructor(operation: string, cause: unknown);
 }
 
-export { type Account, type AccountFieldsFragment, AccountFieldsFragmentDoc, type AccountSlotsAsOccupantArgs, type AccountSlotsAsRecipientArgs, type AccountType, type Account_Filter, type Account_OrderBy, type Aggregation_Current, type Aggregation_Interval, type BlockChangedFilter, type Block_Height, type BoughtEvent, type BoughtEvent_Filter, type BoughtEvent_OrderBy, type BuyParams, type CreateSlotParams, type CreateSlotsParams, type Currency, type CurrencyFieldsFragment, CurrencyFieldsFragmentDoc, type Currency_Filter, type Currency_OrderBy, type DepositedEvent, type DepositedEvent_Filter, type DepositedEvent_OrderBy, type Exact, type Factory, type FactoryModulesArgs, type Factory_Filter, type Factory_OrderBy, GetAccountDocument, type GetAccountQuery, type GetAccountQueryVariables, GetAccountsDocument, type GetAccountsQuery, type GetAccountsQueryVariables, GetBoughtEventsDocument, type GetBoughtEventsQuery, type GetBoughtEventsQueryVariables, GetDepositedEventsDocument, type GetDepositedEventsQuery, type GetDepositedEventsQueryVariables, GetFactoryDocument, type GetFactoryQuery, type GetFactoryQueryVariables, GetLiquidatedEventsDocument, type GetLiquidatedEventsQuery, type GetLiquidatedEventsQueryVariables, GetModulesDocument, type GetModulesQuery, type GetModulesQueryVariables, GetPriceUpdatedEventsDocument, type GetPriceUpdatedEventsQuery, type GetPriceUpdatedEventsQueryVariables, GetRecentEventsDocument, type GetRecentEventsQuery, type GetRecentEventsQueryVariables, GetReleasedEventsDocument, type GetReleasedEventsQuery, type GetReleasedEventsQueryVariables, GetSettledEventsDocument, type GetSettledEventsQuery, type GetSettledEventsQueryVariables, GetSlotActivityDocument, type GetSlotActivityQuery, type GetSlotActivityQueryVariables, GetSlotDeployedEventsDocument, type GetSlotDeployedEventsQuery, type GetSlotDeployedEventsQueryVariables, GetSlotDocument, type GetSlotQuery, type GetSlotQueryVariables, GetSlotsByOccupantDocument, type GetSlotsByOccupantQuery, type GetSlotsByOccupantQueryVariables, GetSlotsByRecipientDocument, type GetSlotsByRecipientQuery, type GetSlotsByRecipientQueryVariables, GetSlotsDocument, type GetSlotsQuery, type GetSlotsQueryVariables, GetTaxCollectedEventsDocument, type GetTaxCollectedEventsQuery, type GetTaxCollectedEventsQueryVariables, GetWithdrawnEventsDocument, type GetWithdrawnEventsQuery, type GetWithdrawnEventsQueryVariables, type Incremental, type InputMaybe, type LiquidatedEvent, type LiquidatedEvent_Filter, type LiquidatedEvent_OrderBy, type MakeEmpty, type MakeMaybe, type MakeOptional, type Maybe, type MetadataSlot, type MetadataSlot_Filter, type MetadataSlot_OrderBy, type MetadataUpdatedEvent, type MetadataUpdatedEvent_Filter, type MetadataUpdatedEvent_OrderBy, type Module, type ModuleUpdateProposedEvent, type ModuleUpdateProposedEvent_Filter, type ModuleUpdateProposedEvent_OrderBy, type Module_Filter, type Module_OrderBy, type OrderDirection, type PendingUpdateCancelledEvent, type PendingUpdateCancelledEvent_Filter, type PendingUpdateCancelledEvent_OrderBy, type PriceUpdatedEvent, type PriceUpdatedEvent_Filter, type PriceUpdatedEvent_OrderBy, type Query, type QueryAccountArgs, type QueryAccountsArgs, type QueryBoughtEventArgs, type QueryBoughtEventsArgs, type QueryCurrenciesArgs, type QueryCurrencyArgs, type QueryDepositedEventArgs, type QueryDepositedEventsArgs, type QueryFactoriesArgs, type QueryFactoryArgs, type QueryLiquidatedEventArgs, type QueryLiquidatedEventsArgs, type QueryMetadataSlotArgs, type QueryMetadataSlotsArgs, type QueryMetadataUpdatedEventArgs, type QueryMetadataUpdatedEventsArgs, type QueryModuleArgs, type QueryModuleUpdateProposedEventArgs, type QueryModuleUpdateProposedEventsArgs, type QueryModulesArgs, type QueryPendingUpdateCancelledEventArgs, type QueryPendingUpdateCancelledEventsArgs, type QueryPriceUpdatedEventArgs, type QueryPriceUpdatedEventsArgs, type QueryReleasedEventArgs, type QueryReleasedEventsArgs, type QuerySettledEventArgs, type QuerySettledEventsArgs, type QuerySlotArgs, type QuerySlotDeployedEventArgs, type QuerySlotDeployedEventsArgs, type QuerySlotsArgs, type QueryTaxCollectedEventArgs, type QueryTaxCollectedEventsArgs, type QueryTaxUpdateProposedEventArgs, type QueryTaxUpdateProposedEventsArgs, type QueryWithdrawnEventArgs, type QueryWithdrawnEventsArgs, type Query_MetaArgs, type ReleasedEvent, type ReleasedEvent_Filter, type ReleasedEvent_OrderBy, SUBGRAPH_URLS, type Scalars, type Sdk, type SdkFunctionWrapper, type SettledEvent, type SettledEvent_Filter, type SettledEvent_OrderBy, type Slot, type SlotConfig, type SlotDeployedEvent, type SlotDeployedEvent_Filter, type SlotDeployedEvent_OrderBy, type SlotDepositsArgs, type SlotFieldsFragment, SlotFieldsFragmentDoc, type SlotInitParams, type SlotLiquidationsArgs, type SlotMetadataUpdatesArgs, type SlotModuleUpdateProposalsArgs, type SlotPendingUpdateCancellationsArgs, type SlotPriceUpdatesArgs, type SlotPurchasesArgs, type SlotReleasesArgs, type SlotSettlementsArgs, type SlotTaxCollectionsArgs, type SlotTaxUpdateProposalsArgs, type SlotWithdrawalsArgs, type Slot_Filter, type Slot_OrderBy, SlotsChain, SlotsClient, type SlotsClientConfig, SlotsError, type SubgraphMeta, type TaxCollectedEvent, type TaxCollectedEvent_Filter, type TaxCollectedEvent_OrderBy, type TaxUpdateProposedEvent, type TaxUpdateProposedEvent_Filter, type TaxUpdateProposedEvent_OrderBy, type WithdrawnEvent, type WithdrawnEvent_Filter, type WithdrawnEvent_OrderBy, type _Block_, type _Meta_, type _SubgraphErrorPolicy_, createSlotsClient, getSdk };
+export { type Account, type AccountFieldsFragment, AccountFieldsFragmentDoc, type AccountSlotsAsOccupantArgs, type AccountSlotsAsRecipientArgs, type AccountType, type Account_Filter, type Account_OrderBy, type Aggregation_Current, type Aggregation_Interval, type BlockChangedFilter, type Block_Height, type BoughtEvent, type BoughtEvent_Filter, type BoughtEvent_OrderBy, type BuyParams, type CreateSlotParams, type CreateSlotsParams, type Currency, type CurrencyFieldsFragment, CurrencyFieldsFragmentDoc, type Currency_Filter, type Currency_OrderBy, type DepositedEvent, type DepositedEvent_Filter, type DepositedEvent_OrderBy, type Exact, type Factory, type FactoryModulesArgs, type Factory_Filter, type Factory_OrderBy, GetAccountDocument, type GetAccountQuery, type GetAccountQueryVariables, GetAccountsDocument, type GetAccountsQuery, type GetAccountsQueryVariables, GetBoughtEventsDocument, type GetBoughtEventsQuery, type GetBoughtEventsQueryVariables, GetDepositedEventsDocument, type GetDepositedEventsQuery, type GetDepositedEventsQueryVariables, GetFactoryDocument, type GetFactoryQuery, type GetFactoryQueryVariables, GetLiquidatedEventsDocument, type GetLiquidatedEventsQuery, type GetLiquidatedEventsQueryVariables, GetMetadataSlotDocument, type GetMetadataSlotQuery, type GetMetadataSlotQueryVariables, GetMetadataSlotsByRecipientDocument, type GetMetadataSlotsByRecipientQuery, type GetMetadataSlotsByRecipientQueryVariables, GetMetadataSlotsDocument, type GetMetadataSlotsQuery, type GetMetadataSlotsQueryVariables, GetMetadataUpdatedEventsDocument, type GetMetadataUpdatedEventsQuery, type GetMetadataUpdatedEventsQueryVariables, GetModulesDocument, type GetModulesQuery, type GetModulesQueryVariables, GetPriceUpdatedEventsDocument, type GetPriceUpdatedEventsQuery, type GetPriceUpdatedEventsQueryVariables, GetRecentEventsDocument, type GetRecentEventsQuery, type GetRecentEventsQueryVariables, GetReleasedEventsDocument, type GetReleasedEventsQuery, type GetReleasedEventsQueryVariables, GetSettledEventsDocument, type GetSettledEventsQuery, type GetSettledEventsQueryVariables, GetSlotActivityDocument, type GetSlotActivityQuery, type GetSlotActivityQueryVariables, GetSlotDeployedEventsDocument, type GetSlotDeployedEventsQuery, type GetSlotDeployedEventsQueryVariables, GetSlotDocument, type GetSlotQuery, type GetSlotQueryVariables, GetSlotsByOccupantDocument, type GetSlotsByOccupantQuery, type GetSlotsByOccupantQueryVariables, GetSlotsByRecipientDocument, type GetSlotsByRecipientQuery, type GetSlotsByRecipientQueryVariables, GetSlotsDocument, type GetSlotsQuery, type GetSlotsQueryVariables, GetTaxCollectedEventsDocument, type GetTaxCollectedEventsQuery, type GetTaxCollectedEventsQueryVariables, GetWithdrawnEventsDocument, type GetWithdrawnEventsQuery, type GetWithdrawnEventsQueryVariables, type Incremental, type InputMaybe, type LiquidatedEvent, type LiquidatedEvent_Filter, type LiquidatedEvent_OrderBy, type MakeEmpty, type MakeMaybe, type MakeOptional, type Maybe, MetadataModuleClient, type MetadataSlot, type MetadataSlotFieldsFragment, MetadataSlotFieldsFragmentDoc, type MetadataSlot_Filter, type MetadataSlot_OrderBy, type MetadataUpdatedEvent, type MetadataUpdatedEvent_Filter, type MetadataUpdatedEvent_OrderBy, type Module, type ModuleUpdateProposedEvent, type ModuleUpdateProposedEvent_Filter, type ModuleUpdateProposedEvent_OrderBy, type Module_Filter, type Module_OrderBy, type OrderDirection, type PendingUpdateCancelledEvent, type PendingUpdateCancelledEvent_Filter, type PendingUpdateCancelledEvent_OrderBy, type PriceUpdatedEvent, type PriceUpdatedEvent_Filter, type PriceUpdatedEvent_OrderBy, type Query, type QueryAccountArgs, type QueryAccountsArgs, type QueryBoughtEventArgs, type QueryBoughtEventsArgs, type QueryCurrenciesArgs, type QueryCurrencyArgs, type QueryDepositedEventArgs, type QueryDepositedEventsArgs, type QueryFactoriesArgs, type QueryFactoryArgs, type QueryLiquidatedEventArgs, type QueryLiquidatedEventsArgs, type QueryMetadataSlotArgs, type QueryMetadataSlotsArgs, type QueryMetadataUpdatedEventArgs, type QueryMetadataUpdatedEventsArgs, type QueryModuleArgs, type QueryModuleUpdateProposedEventArgs, type QueryModuleUpdateProposedEventsArgs, type QueryModulesArgs, type QueryPendingUpdateCancelledEventArgs, type QueryPendingUpdateCancelledEventsArgs, type QueryPriceUpdatedEventArgs, type QueryPriceUpdatedEventsArgs, type QueryReleasedEventArgs, type QueryReleasedEventsArgs, type QuerySettledEventArgs, type QuerySettledEventsArgs, type QuerySlotArgs, type QuerySlotDeployedEventArgs, type QuerySlotDeployedEventsArgs, type QuerySlotsArgs, type QueryTaxCollectedEventArgs, type QueryTaxCollectedEventsArgs, type QueryTaxUpdateProposedEventArgs, type QueryTaxUpdateProposedEventsArgs, type QueryWithdrawnEventArgs, type QueryWithdrawnEventsArgs, type Query_MetaArgs, type ReleasedEvent, type ReleasedEvent_Filter, type ReleasedEvent_OrderBy, SUBGRAPH_URLS, type Scalars, type Sdk, type SdkFunctionWrapper, type SettledEvent, type SettledEvent_Filter, type SettledEvent_OrderBy, type Slot, type SlotConfig, type SlotDeployedEvent, type SlotDeployedEvent_Filter, type SlotDeployedEvent_OrderBy, type SlotDepositsArgs, type SlotFieldsFragment, SlotFieldsFragmentDoc, type SlotInitParams, type SlotLiquidationsArgs, type SlotMetadataUpdatesArgs, type SlotModuleUpdateProposalsArgs, type SlotPendingUpdateCancellationsArgs, type SlotPriceUpdatesArgs, type SlotPurchasesArgs, type SlotReleasesArgs, type SlotSettlementsArgs, type SlotTaxCollectionsArgs, type SlotTaxUpdateProposalsArgs, type SlotWithdrawalsArgs, type Slot_Filter, type Slot_OrderBy, SlotsChain, SlotsClient, type SlotsClientConfig, SlotsError, type SubgraphMeta, type TaxCollectedEvent, type TaxCollectedEvent_Filter, type TaxCollectedEvent_OrderBy, type TaxUpdateProposedEvent, type TaxUpdateProposedEvent_Filter, type TaxUpdateProposedEvent_OrderBy, type WithdrawnEvent, type WithdrawnEvent_Filter, type WithdrawnEvent_OrderBy, type _Block_, type _Meta_, type _SubgraphErrorPolicy_, createSlotsClient, getSdk };

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
@@ -694,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(
@@ -791,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);
     },
@@ -816,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`
@@ -836,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 {
@@ -847,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. */
@@ -1345,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, GetSlotDeployedEventsDocument, 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