https://github.com/fuellabs/fuel-streams-js

Official data streaming Typescript libraries and tools for the Fuel Network.
https://github.com/fuellabs/fuel-streams-js
Last synced: 3 months ago
JSON representation
Official data streaming Typescript libraries and tools for the Fuel Network.
Host: GitHub
URL: https://github.com/fuellabs/fuel-streams-js
Owner: FuelLabs
License: apache-2.0
Created: 2024-09-20T19:49:21.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2025-11-21T18:05:12.000Z (7 months ago)
Last Synced: 2026-02-02T07:49:38.950Z (4 months ago)
Language: TypeScript
Homepage: https://streams.fuel.network
Size: 942 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project

README

          


    

        

    

    Fuel Streams TypeScript SDK

    

        A TypeScript SDK for working with streams of Fuel blockchain data

    

    

        

            

        

        

            

        

    

    

        📚 Documentation

         

        🐛 Report Bug

         

        ✨ Request Feature

    



## 📝 About The Project

> [!WARNING]

> This project is currently under development and is not yet ready for production use.

The Fuel Streams TypeScript SDK provides a simple and robust way to interact with Fuel blockchain data streams through WebSocket connections, enabling real-time data access with type-safe interactions and convenient utilities for developers.

## 🚀 Features

- **WebSocket-Based Streaming:** Real-time data streaming using WebSocket connections

- **Typed Data Structures:** Full TypeScript support with typed data structures

- **Multiple Stream Types:** Support for blocks, transactions, receipts, inputs, outputs, and logs

- **Flexible Delivery Policies:** Control how you receive data with options like `new` and `fromBlock`

- **Error Handling:** Comprehensive error handling and reporting

## 🛠 Installation

Install the SDK using npm, yarn, or pnpm:

```bash

npm install @fuels/streams

# or

yarn add @fuels/streams

# or

pnpm add @fuels/streams

# or

bun install @fuels/streams

```

## 📊 Usage

Here are some examples to get you started with the Fuel Streams TypeScript SDK:

### Connecting to WebSocket Server

```typescript

import { Client, FuelNetwork } from "@fuels/streams";

async function main() {

  const connection = await Client.connect(FuelNetwork.Mainnet, "your-api-key");

  console.log("Connected to WebSocket server");

}

main().catch(console.error);

```

### Subscribing to Blocks

```typescript

import {

  BlocksSubject,

  Client,

  DeliverPolicy,

  FuelNetwork,

} from "@fuels/streams";

async function main() {

  const connection = await Client.connect(FuelNetwork.Mainnet, "your-api-key");

  // Create a subject for all blocks

  const subject = BlocksSubject.build();

  // Subscribe to new blocks

  const stream = await connection.subscribe(subject, DeliverPolicy.new());

  for await (const message of stream) {

    console.log("Block:", message.data);

  }

}

main().catch(console.error);

```

### Filtered Transaction Streams

```typescript

import {

  Client,

  DeliverPolicy,

  FuelNetwork,

  TransactionType,

  TransactionStatus,

  TransactionsSubject,

} from "@fuels/streams";

async function main() {

  const connection = await Client.connect(FuelNetwork.Mainnet, "your-api-key");

  // Create a filtered subject for successful script transactions

  const subject = TransactionsSubject.build({

    txType: TransactionType.Script,

    txStatus: TransactionStatus.Success,

  });

  // Subscribe from a specific block height

  const deliverPolicy = DeliverPolicy.fromBlock(1000000);

  const stream = await connection.subscribe(subject, deliverPolicy);

  for await (const message of stream) {

    console.log("Transaction:", message.data);

  }

}

main().catch(console.error);

```

## ⚙️ Delivery Policies

The SDK supports different delivery policies for controlling how you receive data:

- `DeliverPolicy.new()`: Receive only new data from the point of subscription

- `DeliverPolicy.fromBlock(blockNumber)`: Receive data starting from a specific block height

## ⚙️ Filters

### Block

#### `BlocksSubject`

- `producer (String)`

	- The address of the producer that created the block

- `da_height (String)`

	- The height of the DA block as unsigned 64 bit integer

- `height (Number)`

	- The height of the block as unsigned 64 bit integer

### Transaction

#### `TransactionsSubject`

- `block_height (Number)`

	- The height of the block containing this transaction

- `tx_id (String)`

	- The ID of the transaction (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `status (String)`

	- The status of the transaction (success, failure, or submitted)

- `tx_type (String)`

	- The type of transaction (create, mint, script)

### Input

#### `InputsSubject`

- `input_type (String)`

	- The type of input (coin, contract, or message)

- `block_height (Number)`

	- The height of the block containing this input

- `tx_id (String)`

	- The ID of the transaction containing this input (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `input_index (String)`

	- The index of this input within the transaction

#### `InputsCoinSubject`

- `block_height (Number)`

	- The height of the block containing this coin input

- `tx_id (String)`

	- The ID of the transaction containing this coin input (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `input_index (String)`

	- The index of this input within the transaction

- `owner (String)`

	- The address of the coin owner (32 byte string prefixed by 0x)

- `asset (String)`

	- The asset ID of the coin (32 byte string prefixed by 0x)

#### `InputsContractSubject`

- `block_height (Number)`

	- The height of the block containing this contract input

- `tx_id (String)`

	- The ID of the transaction containing this contract input (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `input_index (String)`

	- The index of this input within the transaction

- `contract (String)`

	- The ID of the contract being called (32 byte string prefixed by 0x)

#### `InputsMessageSubject`

- `block_height (Number)`

	- The height of the block containing this message input

- `tx_id (String)`

	- The ID of the transaction containing this message input (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `input_index (String)`

	- The index of this input within the transaction

- `sender (String)`

	- The address that sent the message (32 byte string prefixed by 0x)

- `recipient (String)`

	- The address that will receive the message (32 byte string prefixed by 0x)

### Output

#### `OutputsSubject`

- `output_type (String)`

	- The type of output (coin, contract, change, variable, or contract_created)

- `block_height (Number)`

	- The height of the block containing this output

- `tx_id (String)`

	- The ID of the transaction containing this output (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `output_index (String)`

	- The index of this output within the transaction

#### `OutputsCoinSubject`

- `block_height (Number)`

	- The height of the block containing this coin output

- `tx_id (String)`

	- The ID of the transaction containing this coin output (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `output_index (String)`

	- The index of this output within the transaction

- `to (String)`

	- The recipient address of the coin output (32 byte string prefixed by 0x)

- `asset (String)`

	- The asset ID of the coin (32 byte string prefixed by 0x)

#### `OutputsContractSubject`

- `block_height (Number)`

	- The height of the block containing this contract output

- `tx_id (String)`

	- The ID of the transaction containing this contract output (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `output_index (String)`

	- The index of this output within the transaction

- `contract (String)`

	- The ID of the contract (32 byte string prefixed by 0x)

#### `OutputsChangeSubject`

- `block_height (Number)`

	- The height of the block containing this change output

- `tx_id (String)`

	- The ID of the transaction containing this change output (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `output_index (String)`

	- The index of this output within the transaction

- `to (String)`

	- The recipient address of the change output (32 byte string prefixed by 0x)

- `asset (String)`

	- The asset ID of the change output (32 byte string prefixed by 0x)

#### `OutputsVariableSubject`

- `block_height (Number)`

	- The height of the block containing this variable output

- `tx_id (String)`

	- The ID of the transaction containing this variable output (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `output_index (String)`

	- The index of this output within the transaction

- `to (String)`

	- The recipient address of the variable output (32 byte string prefixed by 0x)

- `asset (String)`

	- The asset ID of the variable output (32 byte string prefixed by 0x)

#### `OutputsContractCreatedSubject`

- `block_height (Number)`

	- The height of the block containing this contract creation output

- `tx_id (String)`

	- The ID of the transaction containing this contract creation output (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `output_index (String)`

	- The index of this output within the transaction

- `contract (String)`

	- The ID of the created contract (32 byte string prefixed by 0x)

### Predicate

#### `PredicatesSubject`

- `block_height (Number)`

	- The height of the block containing this predicate

- `tx_id (String)`

	- The ID of the transaction containing this predicate (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `input_index (String)`

	- The index of this input within the transaction that had this predicate

- `blob_id (String)`

	- The ID of the blob containing the predicate bytecode

- `predicate_address (String)`

	- The address of the predicate (32 byte string prefixed by 0x)

- `asset (String)`

	- The asset ID of the coin (32 byte string prefixed by 0x)

### Receipt

#### `ReceiptsSubject`

- `receipt_type (String)`

	- The type of receipt

- `block_height (Number)`

	- The height of the block containing this receipt

- `tx_id (String)`

	- The ID of the transaction containing this receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

#### `ReceiptsCallSubject`

- `block_height (Number)`

	- The height of the block containing this call receipt

- `tx_id (String)`

	- The ID of the transaction containing this call receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `from (String)`

	- The contract ID that initiated the call (32 byte string prefixed by 0x)

- `to (String)`

	- The contract ID that was called (32 byte string prefixed by 0x)

- `asset (String)`

	- The asset ID involved in the call (32 byte string prefixed by 0x)

#### `ReceiptsReturnSubject`

- `block_height (Number)`

	- The height of the block containing this return receipt

- `tx_id (String)`

	- The ID of the transaction containing this return receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `contract (String)`

	- The ID of the contract that returned (32 byte string prefixed by 0x)

#### `ReceiptsReturnDataSubject`

- `block_height (Number)`

	- The height of the block containing this return data receipt

- `tx_id (String)`

	- The ID of the transaction containing this return data receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `contract (String)`

	- The ID of the contract that returned data (32 byte string prefixed by 0x)

#### `ReceiptsPanicSubject`

- `block_height (Number)`

	- The height of the block containing this panic receipt

- `tx_id (String)`

	- The ID of the transaction containing this panic receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `contract (String)`

	- The ID of the contract that panicked (32 byte string prefixed by 0x)

#### `ReceiptsRevertSubject`

- `block_height (Number)`

	- The height of the block containing this revert receipt

- `tx_id (String)`

	- The ID of the transaction containing this revert receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `contract (String)`

	- The ID of the contract that reverted (32 byte string prefixed by 0x)

#### `ReceiptsLogSubject`

- `block_height (Number)`

	- The height of the block containing this log receipt

- `tx_id (String)`

	- The ID of the transaction containing this log receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `contract (String)`

	- The ID of the contract that emitted the log (32 byte string prefixed by 0x)

#### `ReceiptsLogDataSubject`

- `block_height (Number)`

	- The height of the block containing this log data receipt

- `tx_id (String)`

	- The ID of the transaction containing this log data receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `contract (String)`

	- The ID of the contract that emitted the log data (32 byte string prefixed by 0x)

#### `ReceiptsTransferSubject`

- `block_height (Number)`

	- The height of the block containing this transfer receipt

- `tx_id (String)`

	- The ID of the transaction containing this transfer receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `from (String)`

	- The contract ID that initiated the transfer (32 byte string prefixed by 0x)

- `to (String)`

	- The contract ID that received the transfer (32 byte string prefixed by 0x)

- `asset (String)`

	- The asset ID being transferred (32 byte string prefixed by 0x)

#### `ReceiptsTransferOutSubject`

- `block_height (Number)`

	- The height of the block containing this transfer out receipt

- `tx_id (String)`

	- The ID of the transaction containing this transfer out receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `from (String)`

	- The contract ID that initiated the transfer out (32 byte string prefixed by 0x)

- `to_address (String)`

	- The address that received the transfer (32 byte string prefixed by 0x)

- `asset (String)`

	- The asset ID being transferred (32 byte string prefixed by 0x)

#### `ReceiptsScriptResultSubject`

- `block_height (Number)`

	- The height of the block containing this script result receipt

- `tx_id (String)`

	- The ID of the transaction containing this script result receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

#### `ReceiptsMessageOutSubject`

- `block_height (Number)`

	- The height of the block containing this message out receipt

- `tx_id (String)`

	- The ID of the transaction containing this message out receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `sender (String)`

	- The address that sent the message (32 byte string prefixed by 0x)

- `recipient (String)`

	- The address that will receive the message (32 byte string prefixed by 0x)

#### `ReceiptsMintSubject`

- `block_height (Number)`

	- The height of the block containing this mint receipt

- `tx_id (String)`

	- The ID of the transaction containing this mint receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `contract (String)`

	- The ID of the contract that performed the mint (32 byte string prefixed by 0x)

- `sub_id (String)`

	- The sub identifier of the minted asset (32 byte string prefixed by 0x)

#### `ReceiptsBurnSubject`

- `block_height (Number)`

	- The height of the block containing this burn receipt

- `tx_id (String)`

	- The ID of the transaction containing this burn receipt (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `receipt_index (String)`

	- The index of this receipt within the transaction

- `contract (String)`

	- The ID of the contract that performed the burn (32 byte string prefixed by 0x)

- `sub_id (String)`

	- The sub identifier of the burned asset (32 byte string prefixed by 0x)

### Utxo

#### `UtxosSubject`

- `block_height (Number)`

	- The height of the block containing this UTXO

- `tx_id (String)`

	- The ID of the transaction containing this UTXO (32 byte string prefixed by 0x)

- `tx_index (String)`

	- The index of the transaction within the block

- `output_index (String)`

	- The index of the output within the transaction

- `utxo_type (String)`

	- The type of UTXO (coin, message, or contract)

- `asset_id (String)`

	- The ID of the asset associated with this UTXO

- `utxo_id (String)`

	- The unique identifier for this UTXO (32 byte string prefixed by 0x)

- `from (String)`

	- The address of the sender (32 byte string prefixed by 0x)

- `to (String)`

	- The address of the recipient (32 byte string prefixed by 0x)

- `contract_id (String)`

	- The ID of the contract that returned (32 byte string prefixed by 0x)

- `status (String)`

	- The status of the UTXO (unspent or spent)

### Message

#### `MessagesSubject`

- `message_type (String)`

	- The type of message (imported or consumed)

- `block_height (Number)`

	- The height of the block containing this message

- `message_index (String)`

	- The index of the message within the block

- `sender (String)`

	- The address that sent the message (32 byte string prefixed by 0x)

- `recipient (String)`

	- The address that will receive the message (32 byte string prefixed by 0x)

- `nonce (String)`

	- The nonce of the message (32 byte string prefixed by 0x)

## 🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For more information on contributing, please see our [Contributing Guidelines](CONTRIBUTING.md).

## 📜 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/fuellabs/fuel-streams-js

Awesome Lists containing this project

README

Fuel Streams TypeScript SDK
