@filoz/synapse-react 0.1.4 → 0.2.1

package/src/payments/index.ts

@@ -1,17 +1,5 @@
 import { getChain } from '@filoz/synapse-core/chains'
-import {
-  type AccountInfoOptions,
-  type AccountInfoResult,
-  accountInfo,
-  type DepositOptions,
-  deposit,
-  type OperatorApprovalsOptions,
-  type OperatorApprovalsResult,
-  operatorApprovals,
-  setOperatorApproval,
-  type WithdrawOptions,
-  withdraw,
-} from '@filoz/synapse-core/pay'
+import { accounts, deposit, operatorApprovals, setOperatorApproval, withdraw } from '@filoz/synapse-core/pay'
 import {
   type MutateOptions,
   skipToken,
@@ -23,16 +11,16 @@ import {
 import type { SetOptional } from 'type-fest'
 import type { Address, TransactionReceipt } from 'viem'
 import { waitForTransactionReceipt } from 'viem/actions'
-import { useAccount, useBlock, useChainId, useConfig } from 'wagmi'
+import { useAccount, useBlock, useChainId, useConfig, useConnection } from 'wagmi'
 import { getConnectorClient } from 'wagmi/actions'
 
-interface UseAccountInfoProps extends SetOptional<AccountInfoOptions, 'address'> {
+export interface UseAccountInfoProps extends SetOptional<accounts.OptionsType, 'address'> {
   /**
    * Whether to watch blocks.
    * @default false
    */
   watch?: boolean
-  query?: Omit<UseQueryOptions<AccountInfoResult>, 'queryKey' | 'queryFn'>
+  query?: Omit<UseQueryOptions<accounts.OutputType>, 'queryKey' | 'queryFn'>
 }
 
 /**
@@ -50,7 +38,7 @@ export function useAccountInfo(props?: UseAccountInfoProps) {
   const chainId = useChainId({ config })
   const chain = getChain(chainId)
   const token = props?.token ?? chain.contracts.usdfc.address
-  const address = props?.address
+  const owner = props?.address
   const { data } = useBlock({
     blockTag: 'latest',
     chainId,
@@ -59,12 +47,13 @@ export function useAccountInfo(props?: UseAccountInfoProps) {
 
   const result = useQuery({
     ...props?.query,
-    queryKey: ['synapse-payments-account-info', address, token, data?.number?.toString()],
-    queryFn: address
+    queryKey: ['synapse-payments-account-info', owner, token, data?.number?.toString()],
+    queryFn: owner
       ? async () => {
-          return await accountInfo(config.getClient(), {
+          return await accounts(config.getClient(), {
             token,
-            address,
+            address: owner,
+
             blockNumber: data?.number,
           })
         }
@@ -73,12 +62,10 @@ export function useAccountInfo(props?: UseAccountInfoProps) {
   return result
 }
 
-export interface UseOperatorApprovalsProps extends SetOptional<OperatorApprovalsOptions, 'address'> {
-  query?: Omit<UseQueryOptions<OperatorApprovalsResult>, 'queryKey' | 'queryFn'>
+export interface UseOperatorApprovalsProps extends SetOptional<operatorApprovals.OptionsType, 'address'> {
+  query?: Omit<UseQueryOptions<operatorApprovals.OutputType>, 'queryKey' | 'queryFn'>
 }
 
-export type { OperatorApprovalsResult } from '@filoz/synapse-core/pay'
-
 /**
  * Get the operator approvals from the payments contract.
  *
@@ -90,7 +77,7 @@ export function useOperatorApprovals(props?: UseOperatorApprovalsProps) {
   const chainId = useChainId({ config })
   const chain = getChain(chainId)
   const token = props?.token ?? chain.contracts.usdfc.address
-  const operator = props?.operator ?? chain.contracts.storage.address
+  const operator = props?.operator ?? chain.contracts.fwss.address
   const address = props?.address
 
   const result = useQuery({
@@ -109,8 +96,8 @@ export function useOperatorApprovals(props?: UseOperatorApprovalsProps) {
   return result
 }
 
-type UseDepositVariables = Pick<DepositOptions, 'amount'>
-interface UseDepositProps extends Omit<DepositOptions, 'amount'> {
+export type UseDepositVariables = Pick<deposit.OptionsType, 'amount'>
+export interface UseDepositProps extends Omit<deposit.OptionsType, 'amount'> {
   /**
    * The mutation options.
    */
@@ -124,21 +111,17 @@ interface UseDepositProps extends Omit<DepositOptions, 'amount'> {
 /**
  * Deposit ERC20 tokens into the payments contract.
  *
- * @param props - The props for the deposit.
- * @param props.address - The address of the account to deposit from.
- * @param props.token - The address of the ERC20 token to deposit.
- * @param props.mutation - The mutation options.
- * @param props.onHash - The callback to call when the hash is available.
+ * @param props - The props for the deposit. {@link UseDepositProps}
  * @returns The deposit mutation.
  */
 export function useDeposit(props?: UseDepositProps) {
   const config = useConfig()
   const chainId = useChainId({ config })
   const chain = getChain(chainId)
-  const account = useAccount({ config })
+  const account = useConnection({ config })
   const queryClient = useQueryClient()
   const token = props?.token ?? chain.contracts.usdfc.address
-  const from = props?.address ?? account.address
+  const to = props?.to ?? account.address
 
   return useMutation({
     mutationFn: async ({ amount }: UseDepositVariables) => {
@@ -149,8 +132,9 @@ export function useDeposit(props?: UseDepositProps) {
 
       const hash = await deposit(client, {
         amount,
-        address: account.address,
+        to,
         token,
+        contractAddress: props?.contractAddress,
       })
 
       props?.onHash?.(hash)
@@ -159,10 +143,10 @@ export function useDeposit(props?: UseDepositProps) {
       })
 
       queryClient.invalidateQueries({
-        queryKey: ['synapse-payments-account-info', from, token],
+        queryKey: ['synapse-payments-account-info', to, token],
       })
       queryClient.invalidateQueries({
-        queryKey: ['synapse-erc20-balance', from, token],
+        queryKey: ['synapse-erc20-balance', to, token],
       })
       return transactionReceipt
     },
@@ -170,8 +154,8 @@ export function useDeposit(props?: UseDepositProps) {
   })
 }
 
-type UseWithdrawVariables = Pick<WithdrawOptions, 'amount'>
-type UseWithdrawProps = Omit<WithdrawOptions, 'amount'> & {
+export type UseWithdrawVariables = Pick<withdraw.OptionsType, 'amount'>
+export type UseWithdrawProps = Omit<withdraw.OptionsType, 'amount'> & {
   mutation?: Omit<MutateOptions<TransactionReceipt, Error, UseWithdrawVariables>, 'mutationFn'>
   onHash?: (hash: string) => void
 }
@@ -185,10 +169,9 @@ export function useWithdraw(props?: UseWithdrawProps) {
   const config = useConfig()
   const chainId = useChainId({ config })
   const chain = getChain(chainId)
-  const account = useAccount({ config })
+  const account = useConnection({ config })
   const queryClient = useQueryClient()
   const token = props?.token ?? chain.contracts.usdfc.address
-  const from = props?.address ?? account.address
 
   return useMutation({
     mutationFn: async ({ amount }: UseWithdrawVariables) => {
@@ -199,7 +182,6 @@ export function useWithdraw(props?: UseWithdrawProps) {
 
       const hash = await withdraw(client, {
         amount,
-        address: account.address,
         token,
       })
       props?.onHash?.(hash)
@@ -208,10 +190,10 @@ export function useWithdraw(props?: UseWithdrawProps) {
       })
 
       queryClient.invalidateQueries({
-        queryKey: ['synapse-payments-account-info', from, token],
+        queryKey: ['synapse-payments-account-info', account.address, token],
       })
       queryClient.invalidateQueries({
-        queryKey: ['synapse-erc20-balance', from, token],
+        queryKey: ['synapse-erc20-balance', account.address, token],
       })
       return transactionReceipt
     },
@@ -219,7 +201,7 @@ export function useWithdraw(props?: UseWithdrawProps) {
   })
 }
 
-type ApproveOperatorProps =
+export type ApproveOperatorProps =
   | {
       /**
        * The address of the operator to approve.
@@ -242,11 +224,7 @@ type ApproveOperatorProps =
 /**
  * Approve a service contract to act as an operator for payment rails.
  *
- * @param props - The props for the deposit.
- * @param props.operator - The address of the operator to approve.
- * @param props.token - The address of the ERC20 token to deposit.
- * @param props.mutation - The mutation options.
- * @param props.onHash - The callback to call when the hash is available.
+ * @param props - The props for the deposit. {@link ApproveOperatorProps}
  * @returns The deposit mutation.
  */
 export function useApproveOperator(props?: ApproveOperatorProps) {
@@ -256,7 +234,7 @@ export function useApproveOperator(props?: ApproveOperatorProps) {
   const account = useAccount({ config })
   const queryClient = useQueryClient()
   const token = props?.token ?? chain.contracts.usdfc.address
-  const operator = props?.operator ?? chain.contracts.storage.address
+  const operator = props?.operator ?? chain.contracts.fwss.address
 
   return useMutation({
     ...props?.mutation,
@@ -288,7 +266,7 @@ export function useApproveOperator(props?: ApproveOperatorProps) {
   })
 }
 
-type RevokeOperatorProps =
+export type RevokeOperatorProps =
   | {
       /**
        * The address of the operator to revoke.
@@ -304,6 +282,9 @@ type RevokeOperatorProps =
        * The mutation options.
        */
       mutation?: Omit<MutateOptions<TransactionReceipt, Error>, 'mutationFn'>
+      /**
+       * The callback to call when the hash is available.
+       */
       onHash?: (hash: string) => void
     }
   | undefined
@@ -311,11 +292,7 @@ type RevokeOperatorProps =
 /**
  * Revoke the operator to deposit and withdraw ERC20 tokens from the payments contract.
  *
- * @param props - The props for the deposit.
- * @param props.operator - The address of the operator to approve.
- * @param props.token - The address of the ERC20 token to deposit.
- * @param props.mutation - The mutation options.
- * @param props.onHash - The callback to call when the hash is available.
+ * @param props - The props for the deposit. {@link RevokeOperatorProps}
  * @returns The deposit mutation.
  */
 export function useRevokeOperator(props?: RevokeOperatorProps) {
@@ -325,7 +302,7 @@ export function useRevokeOperator(props?: RevokeOperatorProps) {
   const account = useAccount({ config })
   const queryClient = useQueryClient()
   const token = props?.token ?? chain.contracts.usdfc.address
-  const operator = props?.operator ?? chain.contracts.storage.address
+  const operator = props?.operator ?? chain.contracts.fwss.address
 
   return useMutation({
     ...props?.mutation,

package/src/payments/use-deposit-and-approve.ts

@@ -7,12 +7,12 @@ import { waitForTransactionReceipt } from 'viem/actions'
 import { useAccount, useChainId, useConfig } from 'wagmi'
 import { getConnectorClient } from 'wagmi/actions'
 
-type UseDepositVariables = Pick<DepositAndApproveOptions, 'amount'>
-interface UseDepositAndApproveProps extends Omit<DepositAndApproveOptions, 'amount'> {
+export type UseDepositAndApproveVariables = Pick<DepositAndApproveOptions, 'amount'>
+export interface UseDepositAndApproveProps extends Omit<DepositAndApproveOptions, 'amount'> {
   /**
    * The mutation options.
    */
-  mutation?: Omit<MutateOptions<TransactionReceipt, Error, UseDepositVariables>, 'mutationFn'>
+  mutation?: Omit<MutateOptions<TransactionReceipt, Error, UseDepositAndApproveVariables>, 'mutationFn'>
   /**
    * The callback to call when the hash is available.
    */
@@ -20,14 +20,10 @@ interface UseDepositAndApproveProps extends Omit<DepositAndApproveOptions, 'amou
 }
 
 /**
- * Deposit ERC20 tokens into the payments contract.
+ * Deposit and approve ERC20 tokens into the payments contract.
  *
- * @param props - The props for the deposit.
- * @param props.address - The address of the account to deposit from.
- * @param props.token - The address of the ERC20 token to deposit.
- * @param props.mutation - The mutation options.
- * @param props.onHash - The callback to call when the hash is available.
- * @returns The deposit mutation.
+ * @param props - The props for the deposit. {@link UseDepositAndApproveProps}
+ * @returns The deposit and approve mutation.
  */
 export function useDepositAndApprove(props?: UseDepositAndApproveProps) {
   const config = useConfig()
@@ -39,7 +35,7 @@ export function useDepositAndApprove(props?: UseDepositAndApproveProps) {
   const from = props?.address ?? account.address
 
   return useMutation({
-    mutationFn: async ({ amount }: UseDepositVariables) => {
+    mutationFn: async ({ amount }: UseDepositAndApproveVariables) => {
       const client = await getConnectorClient(config, {
         account: account.address,
         chainId,
@@ -61,7 +57,7 @@ export function useDepositAndApprove(props?: UseDepositAndApproveProps) {
         queryKey: ['synapse-erc20-balance', from, token],
       })
       queryClient.invalidateQueries({
-        queryKey: ['synapse-payments-operator-approvals', from, token, chain.contracts.storage.address],
+        queryKey: ['synapse-payments-operator-approvals', from, token, chain.contracts.fwss.address],
       })
 
       return transactionReceipt

package/src/warm-storage/use-create-data-set.ts

@@ -1,6 +1,5 @@
-import type { DataSetCreatedResponse } from '@filoz/synapse-core/sp'
 import * as SP from '@filoz/synapse-core/sp'
-import { createDataSet, type PDPProvider } from '@filoz/synapse-core/warm-storage'
+import type { PDPProvider } from '@filoz/synapse-core/sp-registry'
 import { type MutateOptions, useMutation, useQueryClient } from '@tanstack/react-query'
 import { useAccount, useChainId, useConfig } from 'wagmi'
 import { getConnectorClient } from 'wagmi/actions'
@@ -10,7 +9,7 @@ export interface UseCreateDataSetProps {
    * The callback to call when the hash is available.
    */
   onHash?: (hash: string) => void
-  mutation?: Omit<MutateOptions<DataSetCreatedResponse, Error, UseCreateDataSetVariables>, 'mutationFn'>
+  mutation?: Omit<MutateOptions<SP.waitForCreateDataSet.ReturnType, Error, UseCreateDataSetVariables>, 'mutationFn'>
 }
 
 export interface UseCreateDataSetVariables {
@@ -21,7 +20,7 @@ export interface UseCreateDataSetVariables {
   cdn: boolean
 }
 
-export type UseCreateDataSetResult = DataSetCreatedResponse
+export type UseCreateDataSetResult = SP.waitForCreateDataSet.ReturnType
 
 export function useCreateDataSet(props: UseCreateDataSetProps) {
   const config = useConfig()
@@ -36,10 +35,10 @@ export function useCreateDataSet(props: UseCreateDataSetProps) {
         chainId,
       })
 
-      const { txHash, statusUrl } = await createDataSet(connectorClient, {
+      const { txHash, statusUrl } = await SP.createDataSet(connectorClient, {
         payee: provider.payee,
         payer: account.address,
-        endpoint: provider.pdp.serviceURL,
+        serviceURL: provider.pdp.serviceURL,
         cdn,
         // metadata: {
         //   title: 'Test Data Set',
@@ -48,13 +47,10 @@ export function useCreateDataSet(props: UseCreateDataSetProps) {
       })
       props?.onHash?.(txHash)
 
-      const dataSet = await SP.pollForDataSetCreationStatus({ statusUrl })
+      const dataSet = await SP.waitForCreateDataSet({ statusUrl })
 
       queryClient.invalidateQueries({
-        queryKey: ['synapse-warm-storage-data-sets', account.address],
-      })
-      queryClient.invalidateQueries({
-        queryKey: ['synapse-warm-storage-providers-with-data-sets', account.address],
+        queryKey: ['synapse-warm-storage-data-sets', account.address, config.getClient().chain.id],
       })
       return dataSet
     },

package/src/warm-storage/use-data-sets.ts

@@ -1,15 +1,10 @@
-import { getChain } from '@filoz/synapse-core/chains'
-import { type MetadataObject, metadataArrayToObject } from '@filoz/synapse-core/utils'
-import { type DataSet, getDataSets, getPieces, type Piece } from '@filoz/synapse-core/warm-storage'
+import { getPiecesWithMetadata } from '@filoz/synapse-core/pdp-verifier'
+import { getPdpDataSets, type PdpDataSet, type PieceWithMetadata } from '@filoz/synapse-core/warm-storage'
 import { skipToken, type UseQueryOptions, useQuery } from '@tanstack/react-query'
-import type { Simplify } from 'type-fest'
 import type { Address } from 'viem'
-import { readContract } from 'viem/actions'
-import { useChainId, useConfig } from 'wagmi'
+import { useConfig } from 'wagmi'
 
-export type PieceWithMetadata = Simplify<Piece & { metadata: MetadataObject }>
-
-export interface DataSetWithPieces extends DataSet {
+export interface DataSetWithPieces extends PdpDataSet {
   pieces: PieceWithMetadata[]
 }
 
@@ -22,39 +17,22 @@ export interface UseDataSetsProps {
 
 export function useDataSets(props: UseDataSetsProps) {
   const config = useConfig()
-  const chainId = useChainId()
   const address = props.address
-  const chain = getChain(chainId)
   return useQuery({
-    queryKey: ['synapse-warm-storage-data-sets', address],
+    queryKey: ['synapse-warm-storage-data-sets', address, config.getClient().chain.id],
     queryFn: address
       ? async () => {
-          const dataSets = await getDataSets(config.getClient(), { address })
+          const dataSets = await getPdpDataSets(config.getClient(), { address })
           const dataSetsWithPieces = await Promise.all(
             dataSets.map(async (dataSet) => {
-              const piecesPaginated = await getPieces(config.getClient(), {
+              const result = await getPiecesWithMetadata(config.getClient(), {
                 dataSet,
                 address,
               })
 
-              const piecesWithMetadata = await Promise.all(
-                piecesPaginated.pieces.map(async (piece) => {
-                  const metadata = await readContract(config.getClient(), {
-                    address: chain.contracts.storageView.address,
-                    abi: chain.contracts.storageView.abi,
-                    functionName: 'getAllPieceMetadata',
-                    args: [dataSet.dataSetId, BigInt(piece.id)],
-                  })
-                  return {
-                    ...piece,
-                    metadata: metadataArrayToObject(metadata),
-                  }
-                })
-              )
-
               return {
                 ...dataSet,
-                pieces: piecesWithMetadata,
+                pieces: result.pieces,
               }
             })
           )

package/src/warm-storage/use-delete-piece.ts

@@ -1,8 +1,10 @@
 import { getChain } from '@filoz/synapse-core/chains'
 import type { SessionKey } from '@filoz/synapse-core/session-key'
-import { type DataSet, deletePiece, pollForDeletePieceStatus } from '@filoz/synapse-core/warm-storage'
+import * as SP from '@filoz/synapse-core/sp'
+import type { PdpDataSet } from '@filoz/synapse-core/warm-storage'
 import { type MutateOptions, useMutation, useQueryClient } from '@tanstack/react-query'
 import type { TransactionReceipt } from 'viem'
+import { waitForTransactionReceipt } from 'viem/actions'
 import { useAccount, useChainId, useConfig } from 'wagmi'
 import { getConnectorClient } from 'wagmi/actions'
 
@@ -16,7 +18,7 @@ export interface UseDeletePieceProps {
 }
 
 export interface UseDeletePieceVariables {
-  dataSet: DataSet
+  dataSet: PdpDataSet
   pieceId: bigint
 }
 export function useDeletePiece(props: UseDeletePieceProps) {
@@ -39,18 +41,18 @@ export function useDeletePiece(props: UseDeletePieceProps) {
         connectorClient = props?.sessionKey.client(chain, client.transport)
       }
 
-      const deletePieceRsp = await deletePiece(connectorClient, {
-        endpoint: dataSet.pdp.serviceURL,
+      const deletePieceRsp = await SP.schedulePieceDeletion(connectorClient, {
+        serviceURL: dataSet.provider.pdp.serviceURL,
         dataSetId: dataSet.dataSetId,
         clientDataSetId: dataSet.clientDataSetId,
         pieceId,
       })
 
-      props?.onHash?.(deletePieceRsp.txHash)
-      const rsp = await pollForDeletePieceStatus(client, deletePieceRsp)
+      props?.onHash?.(deletePieceRsp.hash)
+      const rsp = await waitForTransactionReceipt(client, deletePieceRsp)
 
       queryClient.invalidateQueries({
-        queryKey: ['synapse-warm-storage-data-sets', account.address],
+        queryKey: ['synapse-warm-storage-data-sets', account.address, config.getClient().chain.id],
       })
       return rsp
     },

package/src/warm-storage/use-providers.ts

@@ -1,4 +1,4 @@
-import { type PDPProvider, readProviders } from '@filoz/synapse-core/warm-storage'
+import { getApprovedPDPProviders } from '@filoz/synapse-core/sp-registry'
 import { type UseQueryOptions, useQuery } from '@tanstack/react-query'
 import { useConfig } from 'wagmi'
 
@@ -6,16 +6,16 @@ export interface UseProvidersProps {
   query?: Omit<UseQueryOptions<UseProvidersResult>, 'queryKey' | 'queryFn'>
 }
 
-export type UseProvidersResult = PDPProvider[]
+export type UseProvidersResult = getApprovedPDPProviders.OutputType
 
 export function useProviders(props?: UseProvidersProps) {
   const config = useConfig()
 
   return useQuery({
     ...props?.query,
-    queryKey: ['synapse-warm-storage-providers'],
+    queryKey: ['synapse-warm-storage-providers', config.getClient().chain.id],
     queryFn: () => {
-      return readProviders(config.getClient())
+      return getApprovedPDPProviders(config.getClient())
     },
   })
 }

package/src/warm-storage/use-service-price.ts

@@ -1,18 +1,18 @@
-import { type ServicePriceResult, servicePrice } from '@filoz/synapse-core/warm-storage'
+import { getServicePrice } from '@filoz/synapse-core/warm-storage'
 import { type UseQueryOptions, useQuery } from '@tanstack/react-query'
 import { useConfig } from 'wagmi'
 
 /**
- * The props for the useServicePrice hook.
+ * The result for the useServicePrice hook.
  */
-export interface UseServicePriceProps {
-  query?: Omit<UseQueryOptions<ServicePriceResult>, 'queryKey' | 'queryFn'>
-}
+export type UseServicePriceResult = getServicePrice.OutputType
 
 /**
- * The result for the useServicePrice hook.
+ * The props for the useServicePrice hook.
  */
-export type UseServicePriceResult = ServicePriceResult
+export interface UseServicePriceProps {
+  query?: Omit<UseQueryOptions<UseServicePriceResult>, 'queryKey' | 'queryFn'>
+}
 
 /**
  * Get the service price for the warm storage.
@@ -25,9 +25,9 @@ export function useServicePrice(props?: UseServicePriceProps) {
 
   return useQuery({
     ...props?.query,
-    queryKey: ['synapse-warm-storage-get-service-price'],
+    queryKey: ['synapse-warm-storage-get-service-price', config.getClient().chain.id],
     queryFn: async () => {
-      const result = await servicePrice(config.getClient())
+      const result = await getServicePrice(config.getClient())
       return result
     },
   })

package/src/warm-storage/use-upload.ts

@@ -1,8 +1,7 @@
 import { getChain } from '@filoz/synapse-core/chains'
 import type { SessionKey } from '@filoz/synapse-core/session-key'
-import type { AddPiecesSuccess } from '@filoz/synapse-core/sp'
 import * as SP from '@filoz/synapse-core/sp'
-import { upload } from '@filoz/synapse-core/warm-storage'
+import { type AddPiecesSuccess, upload } from '@filoz/synapse-core/sp'
 import { type MutateOptions, useMutation, useQueryClient } from '@tanstack/react-query'
 import { useAccount, useChainId, useConfig } from 'wagmi'
 import { getConnectorClient } from 'wagmi/actions'
@@ -45,10 +44,10 @@ export function useUpload(props: UseUploadProps) {
       })
 
       props?.onHash?.(uploadRsp.txHash)
-      const rsp = await SP.pollForAddPiecesStatus(uploadRsp)
+      const rsp = await SP.waitForAddPieces(uploadRsp)
 
       queryClient.invalidateQueries({
-        queryKey: ['synapse-warm-storage-data-sets', account.address],
+        queryKey: ['synapse-warm-storage-data-sets', account.address, config.getClient().chain.id],
       })
       return rsp
     },