@circle-fin/usdckit - v0.23.2
    Preparing search index...

    Function actions

    • 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>;
          getTokenBalance: (
              params: GetTokenBalanceInput,
          ) => Promise<GetTokenBalanceReturnType>;
          permit: (params: PermitParams) => Promise<`0x${string}`>;
          signEIP2612Permit: (
              params: SignEIP2612PermitParams,
          ) => Promise<
              {
                  r: `0x${string}`;
                  s: `0x${string}`;
                  signature: `0x${string}`;
                  typedData: {
                      domain: {
                          chainId: bigint;
                          name: string;
                          verifyingContract: `0x${string}`;
                          version: string;
                      };
                      message: {
                          deadline: bigint;
                          nonce: bigint;
                          owner: `0x${string}`;
                          spender: `0x${string}`;
                          value: bigint;
                      };
                      primaryType: "Permit";
                      types: {
                          EIP712Domain: readonly [
                              { name: "name"; type: "string" },
                              { name: "version"; type: "string" },
                              { name: "chainId"; type: "uint256" },
                              { name: "verifyingContract"; type: "address" },
                          ];
                          Permit: readonly [
                              { name: "owner"; type: "address" },
                              { name: "spender"; type: "address" },
                              { name: "value"; type: "uint256" },
                              { name: "nonce"; type: "uint256" },
                              { name: "deadline"; type: "uint256" },
                          ];
                      };
                  };
                  v: number;
                  yParity: number;
              },
          >;
          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>
      • getSwapExactInQuote: (params: GetSwapExactInQuoteParams) => Promise<GetSwapExactInQuoteReturnType>
      • getSwapQuote: (params: GetSwapExactInQuoteParams) => Promise<GetSwapExactInQuoteReturnType>
      • getTokenBalance: (params: GetTokenBalanceInput) => Promise<GetTokenBalanceReturnType>

        See getTokenBalance action

      • permit: (params: PermitParams) => Promise<`0x${string}`>

        See permit action

      • signEIP2612Permit: (
            params: SignEIP2612PermitParams,
        ) => Promise<
            {
                r: `0x${string}`;
                s: `0x${string}`;
                signature: `0x${string}`;
                typedData: {
                    domain: {
                        chainId: bigint;
                        name: string;
                        verifyingContract: `0x${string}`;
                        version: string;
                    };
                    message: {
                        deadline: bigint;
                        nonce: bigint;
                        owner: `0x${string}`;
                        spender: `0x${string}`;
                        value: bigint;
                    };
                    primaryType: "Permit";
                    types: {
                        EIP712Domain: readonly [
                            { name: "name"; type: "string" },
                            { name: "version"; type: "string" },
                            { name: "chainId"; type: "uint256" },
                            { name: "verifyingContract"; type: "address" },
                        ];
                        Permit: readonly [
                            { name: "owner"; type: "address" },
                            { name: "spender"; type: "address" },
                            { name: "value"; type: "uint256" },
                            { name: "nonce"; type: "uint256" },
                            { name: "deadline"; type: "uint256" },
                        ];
                    };
                };
                v: number;
                yParity: number;
            },
        >

        See signEIP2612Permit 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