Skip to content

@filoz/synapse-react

Synapse React - Main Entry Point

import * as react from '@filoz/synapse-react'
InterfaceDescription
DataSetStats-
DataSetWithPiecesData set type
UseCreateDataSetProps-
UseCreateDataSetVariables-
UseDataSetsProps-
UseDeletePieceProps-
UseDeletePieceVariables-
UseEgressQuotaPropsThe props for the useEgressQuota hook.
UseOperatorApprovalsProps-
UseProvidersProps-
UseServicePricePropsThe props for the useServicePrice hook.
UseUploadProps-
UseUploadVariables-
UseWatchUsdfcProps-
Type AliasDescription
OperatorApprovalsResult-
PieceWithMetadata-
UseCreateDataSetResult-
UseDataSetsResult-
UseEgressQuotaResultThe result for the useEgressQuota hook.
UseProvidersResult-
UseServicePriceResultThe result for the useServicePrice hook.
FunctionDescription
useAccountInfoGet the account info from the payments contract.
useAddUsdfcAdd the USDFC token to the wallet.
useApproveAllowanceApprove the allowance of the ERC20 token to the payments contract.
useApproveOperatorApprove a service contract to act as an operator for payment rails.
useCreateDataSet-
useDataSets-
useDeletePiece-
useDepositDeposit ERC20 tokens into the payments contract.
useDepositAndApproveDeposit ERC20 tokens into the payments contract.
useEgressQuotaGet the egress quota for a data set from FilBeam.
useERC20BalanceGet the balance and allowance of the ERC20 token.
useFundWalletFund the wallet with USDFC and FIL.
useOperatorApprovalsGet the operator approvals from the payments contract.
useProviders-
useRevokeOperatorRevoke the operator to deposit and withdraw ERC20 tokens from the payments contract.
useServicePriceGet the service price for the warm storage.
useUpload-
useWithdrawWithdraw ERC20 tokens from the payments contract.