CrestFi
  • 🫐CrestFi
  • 🚀Getting Started
    • ☃️How to get started?
    • 🤑Benefits of Using CrestFi
    • 💵Deposit
    • ⏳Start Streaming
    • 💰Withdraw Funds
  • 🔒Safe
    • 🗝️Create Safe
    • 💵Deposit in Safe
    • 💸Sending a Transaction
    • ⚧Signing a Transaction
  • CrestFi Evm
    • 📦CrestFi Evm Sdk
      • CrestFi Stream Client
        • Creating Clients
        • Whitelisting Tokens
        • Deposit into Crest Wallet
        • Withdraw from Crest Wallet
        • Initiating a Stream
        • Pause/Resume/Cancel Stream
        • Updating a Stream
        • Withdraw Streamed Tokens
        • Getting Stream Details
      • CrestFi Bulk Client
        • Bulk Instant Transfer
      • CrestFi Multisig Stream
        • NFT
Powered by GitBook
On this page
Export as PDF
  1. CrestFi Evm
  2. CrestFi Evm Sdk

CrestFi Stream Client

PreviousCrestFi Evm SdkNextCreating Clients

Last updated 4 months ago

CrestFiStreamClient is a client library that provides an interface to interact with the CrestFi Stream smart contract. It allows you to perform various operations such as initiating streams, withdrawing tokens, updating streams, and more.

Installation

To use the CrestFiStreamClient library, you need to have the crest-bnb-sdk package installed in your project. You can install them using npm:

npm install @crestfi/crest-bnb-sdk

Environment Setup

To Setup the environment checkout the .env.example at .

VariablesDescriptionValues

CHAIN_ID

Chain Ids

56, 22222(Nautilus), 5, 97

SDK_ENV

Environment to work on : "production" or "test"

"production" if you are working on mainnet and "test" for testnets

Test Code

The can also serve as a reference for how to use the CrestFiStreamClient class in practice.

📦
https://github.com/CrestFi/crest-bnb-sdk
test code