Zebec Network
  • 💰Zebec Network
  • ➡️ZBC to ZBCN Migration Guide
  • 🗞️Zebec Network white Paper
  • 📈ZBCN Tokemonics
  • 🥳Getting Started
    • How to get started?
    • Benefits of Using Zebec Protocol
    • Deposit
    • Start Streaming
    • Withdraw Funds
  • 👾Safe
    • Create Safe
    • Deposit in Safe
    • Sending a Transaction
    • Zapps
    • Signing a Transaction
  • ZEBEC SOLANA
    • 🖥️Zebec Solana Sdk
      • 🖱️Streaming
        • Initialize Zebec Stream
        • Create Fee Vault
        • Update Fee Vault
        • Collect Fees
        • Deposit
        • Withdraw Deposited Token
        • Start Streaming
        • Pause Stream
        • Resume Stream
        • Cancel Stream
        • Withdraw Streamed Token
  • ZEBEC SILVER CARD
    • 💳Silver Card Sdk
      • 🔧Installation
      • 👨‍🚀Quick Start
      • ✉️Fetch Quote
      • ⚖️Configuration Parameters
      • 📦Recipient Fields
      • 🔁Responses
      • 🔢Environment Variables
      • 🌎Supported Countries
  • Zebec Bridge
    • Bridge Sdk
      • Creating clients
      • Initialize Proxy Account
      • Initialize Token Account
      • Deposit
        • Token Transfer
        • Deposit to Zebec
      • Withdraw Deposited
        • Withdraw From Zebec
        • Token Transfer
      • Init Stream
      • Pause/Resume Stream
      • Cancel Stream
      • Update Stream
  • Zebec Near
    • Zebec Near Sdk
      • Normal Stream
        • Initialize Near Stream
        • Initialize Token Stream
        • Pause/Resume Stream
        • Withdraw Stream
        • Update Stream
        • Cancel Stream
        • Claim Stream
        • View methods
      • Multisig Factory
        • Create Multisig Account
      • Multisig Stream
        • Initialize Near Stream
        • Initialize Token Stream
        • Pause/Resume Stream
        • Withdraw Stream
        • Update Stream
        • Cancel Stream
        • Claim Stream
        • View methods
  • ZEBEC EVM
    • Zebec Evm Sdk
      • Zebec Stream Client
        • Creating Clients
        • Whitelisting Tokens
        • Deposit into Zebec Wallet
        • Withdraw from Zebec Wallet
        • Initiating a Stream
        • Pause/Resume/Cancel Stream
        • Updating a Stream
        • Withdraw Streamed Tokens
        • Getting Stream Details
        • Whitelisted Tokens on BSC and Nautilus
      • Zebec Bulk Client
        • Bulk Instant Transfer
      • Zebec Multisig Stream
        • NFT
    • Zapps Compatible
Powered by GitBook
On this page
  1. ZEBEC EVM
  2. Zebec Evm Sdk
  3. Zebec Stream Client

Getting Stream Details

To get the details of a stream, use the getStreamDetails() method:

const streamBytes = await zebecClient.getLatestStreamBytes(sender.address); // gets the last stream bytes of "sender.address"
const streamDetails = await zebecClient.getStreamDetails(streamBytes);

console.log("Stream Details:", streamDetails);

For more details and methods, please refer to the source code or documentation of theZebecStreamClient class.

The getStreamDetails function returns an object containing the following stream details:

  • receiver (type: string): address of the receiver of the stream.

  • token (type: string): address of the token being streamed

  • startTime (type: BigNumber): The timestamp when the stream started.

  • endTime (type: BigNumber): The timestamp when the stream is scheduled to end.

  • amounts (type: Core.AmountStructOutput):

    An object containing various amounts associated with the stream. It is a type with the following sub-properties:

    • streamAmount (BigNumber): The total amount allocated to the stream.

    • releasedAmount (BigNumber): The amount that has been released to the recipient.

    • unlockedAmount (BigNumber): The amount that is currently unlocked and can be withdrawn.

    • pausedAmount (BigNumber): The amount that is currently paused and cannot be withdrawn.

  • pausedTime (type: BigNumber): The timestamp when the stream was paused, if it has been paused.

  • withdrawTime (type: BigNumber): The timestamp when the stream was withdrawn, if it has been withdrawn.

  • originZebecWallet (type: string): The wallet or address from which the stream originates.

  • canceled (type: boolean): A boolean value indicating whether the stream has been canceled (true) or not (false).

  • paused (type: boolean): A boolean value indicating whether the stream is currently paused (true) or not (false).

  • streamParam (type: number): A numeric value representing a parameter of the stream.

PreviousWithdraw Streamed TokensNextWhitelisted Tokens on BSC and Nautilus

Last updated 1 year ago