Function actions

actions(
    client: Client,
): {
    drainFrom: (params: SweepParams) => Promise<TransferReturnType>;
    generateTransferLink: (
        params: GenerateTransferLinkParams,
    ) => Promise<string>;
    getSwapExactInQuote: (
        params: GetSwapExactInQuoteParams,
    ) => Promise<GetSwapExactInQuoteReturnType>;
    getSwapQuote: (
        params: GetSwapExactInQuoteParams,
    ) => Promise<GetSwapExactInQuoteReturnType>;
    swap: (params: SwapExactInParams) => Promise<`0x${string}`>;
    swapExactIn: (params: SwapExactInParams) => Promise<`0x${string}`>;
    sweep: (params: SweepParams) => Promise<TransferReturnType>;
    transfer: (params: TransferParams) => Promise<TransferReturnType>;
}
Returns an object containing action functions bound to the provided client.
Parameters
- client: Client
  The client instance to bind the actions to.
Returns {
    drainFrom: (params: SweepParams) => Promise<TransferReturnType>;
    generateTransferLink: (
        params: GenerateTransferLinkParams,
    ) => Promise<string>;
    getSwapExactInQuote: (
        params: GetSwapExactInQuoteParams,
    ) => Promise<GetSwapExactInQuoteReturnType>;
    getSwapQuote: (
        params: GetSwapExactInQuoteParams,
    ) => Promise<GetSwapExactInQuoteReturnType>;
    swap: (params: SwapExactInParams) => Promise<`0x${string}`>;
    swapExactIn: (params: SwapExactInParams) => Promise<`0x${string}`>;
    sweep: (params: SweepParams) => Promise<TransferReturnType>;
    transfer: (params: TransferParams) => Promise<TransferReturnType>;
}
An object containing the bound action functions.
- drainFrom: (params: SweepParams) => Promise<TransferReturnType>
  See sweep action
- generateTransferLink: (params: GenerateTransferLinkParams) => Promise<string>
  See generateTransferLink action
- getSwapExactInQuote: (params: GetSwapExactInQuoteParams) => Promise<GetSwapExactInQuoteReturnType>
  See getSwapExactInQuote action
- getSwapQuote: (params: GetSwapExactInQuoteParams) => Promise<GetSwapExactInQuoteReturnType>
  See getSwapExactInQuote action
- swap: (params: SwapExactInParams) => Promise<`0x${string}`>
  See swapExactIn action
- swapExactIn: (params: SwapExactInParams) => Promise<`0x${string}`>
  See swapExactIn action
- sweep: (params: SweepParams) => Promise<TransferReturnType>
  See sweep action
- transfer: (params: TransferParams) => Promise<TransferReturnType>
  See transfer action
- Defined in src/actions/index.ts:66

Function actions

Parameters

drainFrom: (params: SweepParams) => Promise<TransferReturnType>

generateTransferLink: (params: GenerateTransferLinkParams) => Promise<string>

getSwapExactInQuote: (params: GetSwapExactInQuoteParams) => Promise<GetSwapExactInQuoteReturnType>

getSwapQuote: (params: GetSwapExactInQuoteParams) => Promise<GetSwapExactInQuoteReturnType>

swap: (params: SwapExactInParams) => Promise<`0x${string}`>

swapExactIn: (params: SwapExactInParams) => Promise<`0x${string}`>

sweep: (params: SweepParams) => Promise<TransferReturnType>

transfer: (params: TransferParams) => Promise<TransferReturnType>

Settings