@filoz/synapse-react
Synapse React - Main Entry Point
Example
Section titled “Example”import * as react from '@filoz/synapse-react'Interfaces
Section titled “Interfaces”| Interface | Description |
|---|---|
| DataSetStats | - |
| DataSetWithPieces | Data set type |
| UseAccountInfoProps | - |
| UseApproveAllowanceProps | - |
| UseCreateDataSetProps | - |
| UseCreateDataSetVariables | - |
| UseDataSetsProps | - |
| UseDeletePieceProps | - |
| UseDeletePieceVariables | - |
| UseDepositAndApproveProps | - |
| UseDepositProps | - |
| UseEgressQuotaProps | The props for the useEgressQuota hook. |
| UseERC20BalanceProps | - |
| UseFundWalletProps | - |
| UseOperatorApprovalsProps | - |
| UseProvidersProps | - |
| UseServicePriceProps | The props for the useServicePrice hook. |
| UseUploadProps | - |
| UseUploadVariables | - |
| UseWatchUsdfcProps | - |
Type Aliases
Section titled “Type Aliases”| Type Alias | Description |
|---|---|
| ApproveOperatorProps | - |
| PieceWithMetadata | - |
| RevokeOperatorProps | - |
| UseApproveAllowanceVariables | - |
| UseCreateDataSetResult | - |
| UseDataSetsResult | - |
| UseDepositAndApproveVariables | - |
| UseDepositVariables | - |
| UseEgressQuotaResult | The result for the useEgressQuota hook. |
| UseProvidersResult | - |
| UseServicePriceResult | The result for the useServicePrice hook. |
| UseWithdrawProps | - |
| UseWithdrawVariables | - |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| useAccountInfo | Get the account info from the payments contract. |
| useAddUsdfc | Add the USDFC token to the wallet. |
| useApproveAllowance | Approve the allowance of the ERC20 token to the payments contract. |
| useApproveOperator | Approve a service contract to act as an operator for payment rails. |
| useCreateDataSet | - |
| useDataSets | - |
| useDeletePiece | - |
| useDeposit | Deposit ERC20 tokens into the payments contract. |
| useDepositAndApprove | Deposit and approve ERC20 tokens into the payments contract. |
| useEgressQuota | Get the egress quota for a data set from FilBeam. |
| useERC20Balance | Get the balance and allowance of the ERC20 token. |
| useFundWallet | Fund the wallet with USDFC and FIL. |
| useOperatorApprovals | Get the operator approvals from the payments contract. |
| useProviders | - |
| useRevokeOperator | Revoke the operator to deposit and withdraw ERC20 tokens from the payments contract. |
| useServicePrice | Get the service price for the warm storage. |
| useUpload | - |
| useWithdraw | Withdraw ERC20 tokens from the payments contract. |