> For the complete documentation index, see [llms.txt](https://emeditweb.gitbook.io/pulsar-stellar-sdk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://emeditweb.gitbook.io/pulsar-stellar-sdk/sdk-reference.md). # SDK Reference Every public export of `@pulsar-stellar/sdk`, grouped by the module it comes from. The surface is deliberately small and fixed: anything not listed here is internal and can change without a major version. Each signature below traces to the shipped source. Types are inferred from Zod schemas, so a schema and the type it produces never drift apart. ## Pages * [Client](/pulsar-stellar-sdk/sdk-reference/client.md). `PulsarClient` and its methods: the indexer path. * [Live RPC](/pulsar-stellar-sdk/sdk-reference/rpc.md). `fetchLiveEvents`, `liveEventStream`, and their query types: the RPC path. * [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md). `buildContractCall`, the `as*Event` helpers, `parseTopics`, and `scValToNative`. * [Decoding](/pulsar-stellar-sdk/sdk-reference/decoding.md). `decodeScVal`, `decodeTopics`, `eventNameFromTopics`, and the decoded-value schemas. * [Errors](/pulsar-stellar-sdk/sdk-reference/errors.md). The `PulsarError` hierarchy and `findPulsarError`. * [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md). The Zod schemas, the inferred types, and the exported constants. ## Every export at a glance | Export | Kind | Page | | ------------------------------ | -------------------- | --------------------------------------------------------------------------- | | `PulsarClient` | class | [Client](/pulsar-stellar-sdk/sdk-reference/client.md) | | `fetchLiveEvents` | function | [Live RPC](/pulsar-stellar-sdk/sdk-reference/rpc.md) | | `liveEventStream` | function | [Live RPC](/pulsar-stellar-sdk/sdk-reference/rpc.md) | | `LiveEventFilterSchema` | schema | [Live RPC](/pulsar-stellar-sdk/sdk-reference/rpc.md) | | `LiveEventQuerySchema` | schema | [Live RPC](/pulsar-stellar-sdk/sdk-reference/rpc.md) | | `RPC_ID_PREFIX` | constant | [Live RPC](/pulsar-stellar-sdk/sdk-reference/rpc.md) | | `DEFAULT_POLL_INTERVAL_MS` | constant | [Live RPC](/pulsar-stellar-sdk/sdk-reference/rpc.md) | | `buildContractCall` | function | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `asInitializeEvent` | function | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `asDepositEvent` | function | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `asWithdrawEvent` | function | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `asTransferEvent` | function | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `asAdminChangeEvent` | function | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `asEmitCustomEvent` | function | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `parseTopics` | function | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `scValToNative` | function (re-export) | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `DEFAULT_CALL_TIMEOUT_SECONDS` | constant | [Contracts and bindings](/pulsar-stellar-sdk/sdk-reference/contracts.md) | | `decodeScVal` | function | [Decoding](/pulsar-stellar-sdk/sdk-reference/decoding.md) | | `decodeTopics` | function | [Decoding](/pulsar-stellar-sdk/sdk-reference/decoding.md) | | `eventNameFromTopics` | function | [Decoding](/pulsar-stellar-sdk/sdk-reference/decoding.md) | | `DecodedValueSchema` | schema | [Decoding](/pulsar-stellar-sdk/sdk-reference/decoding.md) | | `DecodedMapEntrySchema` | schema | [Decoding](/pulsar-stellar-sdk/sdk-reference/decoding.md) | | `PulsarError` | class (abstract) | [Errors](/pulsar-stellar-sdk/sdk-reference/errors.md) | | `PulsarNetworkError` | class | [Errors](/pulsar-stellar-sdk/sdk-reference/errors.md) | | `PulsarValidationError` | class | [Errors](/pulsar-stellar-sdk/sdk-reference/errors.md) | | `findPulsarError` | function | [Errors](/pulsar-stellar-sdk/sdk-reference/errors.md) | | `ContractIdSchema` | schema | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `EventIdSchema` | schema | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `ContractStatusSchema` | schema | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `ContractInfoSchema` | schema | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `DecodedEventSchema` | schema | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `EventQuerySchema` | schema | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `PulsarConfigSchema` | schema | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `PulsarNetworkSchema` | schema | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `DEFAULT_TIMEOUT_MS` | constant | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `EVENT_QUERY_MAX_LIMIT` | constant | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | | `EVENT_QUERY_DEFAULT_LIMIT` | constant | [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) | That is the full runtime surface, 37 exports. The package also ships the inferred TypeScript types (`DecodedEvent`, `ContractInfo`, `PulsarConfig`, and the rest), documented alongside the schema each is inferred from on the [Schemas and types](/pulsar-stellar-sdk/sdk-reference/schemas-and-types.md) page. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://emeditweb.gitbook.io/pulsar-stellar-sdk/sdk-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.