npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@zebec-protocol/stream

v1.8.0

Published

Zebec Protocol SDK - Stream

Downloads

56

Readme

Zebec Protocol SDK - Stream

Zebec Protocol SDK Stream provides an easy way to stream SOL using the Zebec Protocol onchain programs.

Usage

Initialize Zebec Stream

To create a Zebec Stream service, we would need to initialize the Anchor Provider and Fee Receiver.

let provider = initAnchorProvider(wallet, RPC_URL);

The wallet is the Wallet Adapter to pay or sign all transactions.

The RPC_URL is the endpoint to the Solana Cluster. We could use the endpoint provided by the Solana or any third-party service providers.

If RPC_URL is empty, endpoint is pointed to http://localhost:8899 (Local Testnet)

RPC_URL provided by the Solana:

  • Mainnet Beta: https://api.mainnet-beta.solana.com
  • Testnet: https://api.testnet.solana.com
  • Devnet: https://api.devnet.solana.com
let stream = new ZebecNativeStream(provider, feeReceiverAddress);

The feeReceiverAddress is the address to receive service fees for transactions. We need to create a fee vault before performing any transaction using the stream instance.

Start a Stream (SOL)

Before starting a stream, we need to deposit SOL to Zebec Wallet. We could also create a stream without even depositing SOL to the Zebec Wallet. In this scenario, the receiver will not be able to receive any funds and rather receive insufficient amount in sender's wallet.

In case of any failure, the data in response will be null.

call init method:
    let response = stream.init({
        sender: "sender_wallet_address",
        receiver: "receiver_wallet_address",
        start_time: unixtimestamp,
        end_time: unixtimestamp,
        amount: <amount in SOL>
    })
Response:
{
    status: either `success` or `error`,
    message: <string>,
    data: {
        transactionHash: TransactionSignature,
        pda: Escrow Account Address
    }
}

Pause Stream:

call pause method:
let response = stream.pause({
    sender: "sender_wallet_address",
    receiver: "receiver_wallet_address,
    escrow: "escrow_address"
})

The escrow address is the public key received as response after successfully starting a stream.

Resume Stream:

call resume method:
let response = stream.resume({
    sender: "sender_wallet_address",
    receiver: "receiver_wallet_address,
    escrow: "escrow_address"
})

Cancel Stream:

call cancel method:
let response = stream.cancel({

})

Withdraw SOL

The amount that is streamed can be withdrawn while streaming or after completion of the stream.

call withdraw method:
let response = stream.withdraw({

})