withdraw
function withdraw(client, options): Promise<`0x${string}`>;Defined in: packages/synapse-core/src/pay/payments.ts:179
Withdraw funds from the payments contract.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
client | Client<Transport, Chain, Account> | The client to use. |
options | WithdrawOptions | The options to use. |
Returns
Section titled “Returns”Promise<`0x${string}`>
The hash of the withdraw transaction.
Throws
Section titled “Throws”- SimulateContractErrorType if the simulate contract fails.
Throws
Section titled “Throws”- WriteContractErrorType if the write contract fails.