Skip to content
@pulsar-stellar

pulsar-stellar

Open source toolkit for Soroban contract events on Stellar. Ships a Rust decoder, a Go indexer, a TypeScript SDK and a web explorer.

npm version of @pulsar-stellar/sdk License: Apache-2.0 XERJ Corpus Hub contributor

Pulsar Stellar

Read Soroban contract events past the 7-day RPC retention window.

The problem

Stellar RPC keeps about seven days of contract events, so anything older is gone from getEvents. A project that needs its full history ends up writing the same plumbing every time: an XDR decoder, an indexer, and an API on top. Pulsar is that plumbing, built once: it stores every event a contract emits, decodes it into typed data, and serves it to your app or to a browser.

How it fits together

flowchart LR
    C["Soroban contracts"] -->|emit events| RPC["Stellar RPC<br/>about 7 days of history"]
    RPC -->|getEvents polling| IDX["Go indexer"]
    IDX --> DB[("SQLite or Postgres")]
    DB --> API["REST and GraphQL"]
    API -->|REST| SDK["TypeScript SDK"]
    API -->|GraphQL| WEB["Web explorer"]
    RPC -.->|live tail, no indexer needed| SDK
Loading

The indexer polls RPC, decodes each event, and keeps it for good. The SDK reads that history from the indexer, or tails new events straight from RPC when you don't run one. Both paths return the same event type.

Repositories

Repository What it holds
pulsar-app The TypeScript SDK, the Go indexer, and the Next.js explorer
pulsar-core The Rust event decoder and the reference contract whose events every part is tested against
pulsar-docs The documentation source, published at emeditweb.gitbook.io/pulsar-stellar-sdk

Get started

npm install @pulsar-stellar/sdk @stellar/stellar-sdk

@stellar/stellar-sdk is a required peer dependency. Read the documentation for usage.

Status

  • @pulsar-stellar/sdk 0.2.0 is on npm.
  • The indexer, the explorer, and the Rust decoder are built and tested. The decoder is not on crates.io yet.
  • The reference contract is deployed on Stellar testnet.
  • Public hosting of the indexer and explorer is in progress. Today you run them yourself.

Contributing

Contributions start in pulsar-app. Read its CONTRIBUTING.md before opening a pull request.

Popular repositories Loading

  1. pulsar-core pulsar-core Public

    The Rust half of Pulsar Stellar. Decoder crate that turns raw Soroban contract events into typed data, plus a reference contract exercising every event shape

    Rust 6 1

  2. pulsar-app pulsar-app Public

    The application layer of Pulsar Stellar. TypeScript SDK, Go indexer daemon, and Next.js web explorer for browsing decoded Soroban contract events on any tracked contract

    Go 3

  3. .github .github Public

Repositories

Showing 3 of 3 repositories

Top languages

Loading…

Most used topics

Loading…