Wallet Transfer API

This API endpoint allows users to transfer funds from their wallet to another address. It handles the authentication, retrieves the user's wallet information, and executes the transaction on the Polygon network.

Endpoint

POST /api/wallet/transfer

Authentication

This endpoint requires authentication. Ensure that the user is logged in and has a valid session.

Request Body

Parameter	Type	Description
toAddress	string	The recipient's wallet address
amount	string	The amount of MATIC to transfer

Response

The API returns a JSON object with the following structure:

{
  txHash: string;
}

Where txHash is the transaction hash of the completed transfer.

Usage Example

Transfer 1 MATIC to another address:

const response = await fetch('/api/wallet/transfer', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    toAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
    amount: '1',
  }),
});
const data = await response.json();
console.log('Transaction hash:', data.txHash);

Error Responses

Usage Notes

1. The amount should be specified in MATIC, not in Wei. The API will convert it to Wei before sending the transaction.
2. Ensure that the user has sufficient balance to cover both the transfer amount and the gas fees.
3. The API uses the user's encrypted private key stored in the database to sign the transaction.
4. The transaction is sent to the Polygon network using the RPC URL specified in the environment variables.

Best Practices

1. Always validate the toAddress on the client-side to ensure it's a valid Ethereum address.
2. Implement a confirmation step in your UI before sending the transaction to prevent accidental transfers.
3. Display a loading indicator while waiting for the transaction to be mined, as it may take several seconds.
4. Store the returned transaction hash and use it to check the transaction status or provide a link to a block explorer.

Limitations

1. This API currently only supports transfers on the Polygon network.
2. The maximum amount that can be transferred is limited by the user's balance and the network's transaction size limits.
3. Gas fees are automatically calculated and deducted from the user's balance.

Security Considerations

1. Never expose the user's private key in logs, error messages, or client-side code.
2. Implement rate limiting to prevent abuse of the API.
3. Consider implementing additional security measures such as 2FA or email confirmations for large transfers.

Stay tuned for updates and feel free to provide feedback for improvements!