Class GenericStreamClient<T>

constructor

• new GenericStreamClient<T extends IChain>(
      options: StreamClientOptions<T>,
  ): GenericStreamClient<T>

  Type Parameters

  • T extends IChain

  Parameters

  • options: StreamClientOptions<T>

  Returns GenericStreamClient<T>

chain

nativeStreamClient

cancel

• cancel(
      cancelData: IInteractData,
      chainSpecificParams?: ChainSpecificParams<StreamClientType<T>>,
  ): Promise<ITransactionResult>

  Attempts canceling the specified stream.

  Parameters

  • cancelData: IInteractData
  • OptionalchainSpecificParams: ChainSpecificParams<StreamClientType<T>>

  Returns Promise<ITransactionResult>

create

• create(
      streamData: ICreateStreamData,
      chainSpecificParams?: ChainSpecificParams<StreamClientType<T>>,
  ): Promise<ICreateResult>

  Creates a new stream/vesting contract.

  Parameters

  • streamData: ICreateStreamData
  • OptionalchainSpecificParams: ChainSpecificParams<StreamClientType<T>>

  Returns Promise<ICreateResult>

createMultiple

• createMultiple(
      multipleStreamData: ICreateMultipleStreamData,
      chainSpecificParams?: ChainSpecificParams<StreamClientType<T>>,
  ): Promise<IMultiTransactionResult>

  Creates multiple stream/vesting contracts.

  Parameters

  • multipleStreamData: ICreateMultipleStreamData
  • OptionalchainSpecificParams: ChainSpecificParams<StreamClientType<T>>

  Returns Promise<IMultiTransactionResult>

get

• get(getAllData: IGetAllData): Promise<[string, Stream][]>

  Fetch streams by sender or recipient address.

  Parameters

  • getAllData: IGetAllData

  Returns Promise<[string, Stream][]>

getDefaultStreamflowFee

• getDefaultStreamflowFee(): Promise<number>

  Returns default Streamflow Fee in %

  Returns Promise<number>

getFees

• getFees(getFeesData: IGetFeesData): Promise<IFees>

  Returns streamflow and partner fees for the specific wallet in %

  Parameters

  • getFeesData: IGetFeesData

  Returns Promise<IFees>

getOne

• getOne(getOneData: IInteractData): Promise<Stream>

  Fetch stream data by its id (address).

  Parameters

  • getOneData: IInteractData

  Returns Promise<Stream>

topup

• topup(
      topupData: ITopUpData,
      chainSpecificParams?: ChainSpecificParams<StreamClientType<T>>,
  ): Promise<ITransactionResult>

  Tops up stream account with specified amount.

  Parameters

  • topupData: ITopUpData
  • OptionalchainSpecificParams: ChainSpecificParams<StreamClientType<T>>

  Returns Promise<ITransactionResult>

transfer

• transfer(
      transferData: ITransferData,
      chainSpecificParams?: ChainSpecificParams<StreamClientType<T>>,
  ): Promise<ITransactionResult>

  Attempts changing the stream/vesting contract's recipient (effectively transferring the stream/vesting contract).

  Parameters

  • transferData: ITransferData
  • OptionalchainSpecificParams: ChainSpecificParams<StreamClientType<T>>

  Returns Promise<ITransactionResult>

update

• update(
      updateData: IUpdateData,
      chainSpecificParams?: ChainSpecificParams<StreamClientType<T>>,
  ): Promise<ITransactionResult>

  Attempts updating the stream auto withdrawal params and amount per period

  Parameters

  • updateData: IUpdateData
  • OptionalchainSpecificParams: ChainSpecificParams<StreamClientType<T>>

  Returns Promise<ITransactionResult>

withdraw

• withdraw(
      __namedParameters: IWithdrawData,
      chainSpecificParams?: ChainSpecificParams<StreamClientType<T>>,
  ): Promise<ITransactionResult>

  Attempts withdrawing from the specified stream.

  Parameters

  • __namedParameters: IWithdrawData
  • OptionalchainSpecificParams: ChainSpecificParams<StreamClientType<T>>

  Returns Promise<ITransactionResult>