Documentation Index
Fetch the complete documentation index at: https://developers.paxoslabs.com/llms.txt
Use this file to discover all available pages before exploring further.
Fetches a paginated list of withdrawal requests for a user from the backend API. Supports filtering by chain, account, and status.
Import
import { getWithdrawalRequests } from '@paxoslabs/amplify-sdk'
Usage
const result = await getWithdrawalRequests({
userAddress: '0x1234...5678',
status: 'PENDING',
chainId: 1,
})
for (const request of result.withdrawalRequests) {
console.log(request.id, request.status, request.orderAmount)
}
Parameters
| Parameter | Type | Required | Description |
|---|
userAddress | Address | Yes | User’s wallet address |
chainId | number | No | Filter by blockchain network |
vaultAddress | Address | No | Filter by account contract address |
vaultName | string | No | Filter by account name (resolved to address via cache) |
status | WithdrawalRequestStatus | No | Filter by status |
pageSize | number | No | Number of results per page |
pageToken | string | No | Pagination token for next page |
interface GetWithdrawalRequestsParams {
userAddress: Address
chainId?: number
vaultAddress?: Address
vaultName?: string
status?: WithdrawalRequestStatus
pageSize?: number
pageToken?: string
}
Return Type
interface WithdrawalRequestsResult {
withdrawalRequests: WithdrawalRequest[]
nextPageToken: string | null
}
interface WithdrawalRequest {
id: string
vaultAddress: Address
chainId: number
wantAssetAddress: Address
status: WithdrawalRequestStatus
createdAt: string
userAddress: Address
receiverAddress: Address
refundReceiverAddress: Address
orderAmount: string
orderIndex: number
isSubmittedViaSignature: boolean
isForceProcessed: boolean
isMarkedForRefund: boolean
isMarkedForRefundByUser: boolean
didOrderFailTransfer: boolean
}
type WithdrawalRequestStatus =
| 'PENDING'
| 'COMPLETE'
| 'PENDING_REFUND'
| 'REFUNDED'
Example: Withdrawal History Component
import { useQuery } from '@tanstack/react-query'
import { getWithdrawalRequests } from '@paxoslabs/amplify-sdk'
function WithdrawalHistory({ userAddress }: { userAddress: `0x${string}` }) {
const { data, isLoading } = useQuery({
queryKey: ['withdrawalRequests', userAddress],
queryFn: () => getWithdrawalRequests({ userAddress }),
})
if (isLoading) return <p>Loading...</p>
return (
<ul>
{data?.withdrawalRequests.map((req) => (
<li key={req.id}>
{req.orderAmount} - {req.status}
</li>
))}
</ul>
)
}
Error Handling
| Error Message Pattern | Description | Resolution |
|---|
"SDK not initialized" | SDK not initialized | Call initAmplifySDK() first |
"Failed to fetch withdrawal requests" | Network or API error | Check connection and retry |