Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Reference — Core SDK: Funds · Boson Protocol
Skip to content

Funds mixin

Class: FundsMixin

Source: packages/core-sdk/src/funds/mixin.ts

Methods (5)

depositFunds, getFunds, getFundsById, withdrawAllAvailableFunds, withdrawFunds

Signatures

depositFunds (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async depositFunds(
    entityId: BigNumberish,
    fundsAmount: BigNumberish,
    fundsTokenAddress: string,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async depositFunds(
    entityId: BigNumberish,
    fundsAmount: BigNumberish,
    fundsTokenAddress?: string,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async depositFunds(
    entityId: BigNumberish,
    fundsAmount: BigNumberish,
    fundsTokenAddress: string = AddressZero,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

getFunds (1 signature)

Returns funds entities from subgraph.

public async getFunds(
    queryVars?: subgraph.GetFundsQueryVariables
  ): Promise<subgraph.FundsEntityFieldsFragment[]>

getFundsById (1 signature)

Returns funds entity from subgraph.

public async getFundsById(
    fundsId: BigNumberish,
    queryVars?: subgraph.GetFundsByIdQueryVariables
  ): Promise<subgraph.FundsEntityFieldsFragment>

withdrawAllAvailableFunds (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async withdrawAllAvailableFunds(
    entityId: BigNumberish,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async withdrawAllAvailableFunds(
    entityId: BigNumberish,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async withdrawAllAvailableFunds(
    entityId: BigNumberish,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

withdrawFunds (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async withdrawFunds(
    entityId: BigNumberish,
    tokensToWithdraw: Array<string>,
    amountsToWithdraw: Array<BigNumberish>,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async withdrawFunds(
    entityId: BigNumberish,
    tokensToWithdraw: Array<string>,
    amountsToWithdraw: Array<BigNumberish>,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async withdrawFunds(
    entityId: BigNumberish,
    tokensToWithdraw: Array<string>,
    amountsToWithdraw: Array<BigNumberish>,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

Related