Class BulletinClient

Ergonomic entry point for Bulletin Chain operations.

Bundles a typed Bulletin API (from chain-client) and an IPFS gateway URL so callers don't need to re-pass them on every call.

Both upload and query paths auto-resolve based on the environment:

Uploads — inside a host container the host preimage API signs and submits automatically; standalone falls back to a dev signer.
Queries (fetchBytes/fetchJson) — inside a host container the host preimage lookup (with caching) is used; standalone falls back to direct IPFS gateway HTTP fetch.

Example

const bulletin = await BulletinClient.create("paseo");
// Auto-resolved signer (preimage in host, dev signer standalone):
const result = await bulletin.upload(fileBytes);
// Auto-resolved query (host lookup in container, gateway standalone):
const metadata = await bulletin.fetchJson<Metadata>(result.cid);

Index

Properties

api gateway

Methods

batchUpload checkAuthorization cidExists fetchBytes fetchJson gatewayUrl upload computeCid create from hashToCid

Properties

`Readonly`api

api: BulletinApi

`Readonly`gateway

gateway: string

Methods

batchUpload

batchUpload(
    items: BatchUploadItem[],
    signer?: PolkadotSigner,
    options?: Omit<BatchUploadOptions, "gateway">,
): Promise<BatchUploadResult[]>
Upload multiple items sequentially.
Parameters
- items: BatchUploadItem[]
  Array of items to upload, each with data and a label.
- Optionalsigner: PolkadotSigner
  Optional signer. When omitted, auto-resolved.
- Optionaloptions: Omit<BatchUploadOptions, "gateway">
  Batch upload options (timeout, progress callback).
Returns Promise<BatchUploadResult[]>
- Defined in bulletin/src/client.ts:119

checkAuthorization

checkAuthorization(address: string): Promise<AuthorizationStatus>
Check whether an account is authorized to store data on the Bulletin Chain.

Use as a pre-flight check before upload to provide clear UX instead of letting the transaction fail mid-execution.
Parameters
- address: string
  SS58-encoded account address to check.
Returns Promise<AuthorizationStatus>
Authorization status with remaining quota.

See
checkAuthorization for the standalone function equivalent.
- Defined in bulletin/src/client.ts:169

cidExists

cidExists(cid: string): Promise<boolean>
Check if a CID exists on the gateway.
Parameters
- cid: string
Returns Promise<boolean>
- Defined in bulletin/src/client.ts:149

fetchBytes

fetchBytes(
cid: string,
options?: QueryOptions,
): Promise<Uint8Array<ArrayBufferLike>>
Fetch raw bytes by CID.

Auto-resolves query path: host preimage lookup inside a container, direct IPFS gateway fetch standalone.
Parameters
- cid: string
- Optionaloptions: QueryOptions
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in bulletin/src/client.ts:133

fetchJson

fetchJson<T>(cid: string, options?: QueryOptions): Promise<T>
Fetch and parse JSON by CID.

Auto-resolves query path (same as fetchBytes).
Type Parameters
- T
Parameters
- cid: string
- Optionaloptions: QueryOptions
Returns Promise<T>
- Defined in bulletin/src/client.ts:143

gatewayUrl

gatewayUrl(cid: string): string
Build the full gateway URL for a CID.
Parameters
- cid: string
Returns string
- Defined in bulletin/src/client.ts:154

upload

upload(
    data: Uint8Array,
    signer?: PolkadotSigner,
    options?: Omit<UploadOptions, "gateway">,
): Promise<UploadResult>
Upload data to the Bulletin Chain.
Parameters
- data: Uint8Array
  Raw bytes to store.
- Optionalsigner: PolkadotSigner
  Optional signer. When omitted, auto-resolved (preimage in host, dev signer standalone).
- Optionaloptions: Omit<UploadOptions, "gateway">
  Upload options (timeout, waitFor, status callback).
Returns Promise<UploadResult>
- Defined in bulletin/src/client.ts:104

`Static`computeCid

computeCid(data: Uint8Array): string
Compute CID without uploading. Static — no instance needed.
Parameters
- data: Uint8Array
Returns string
- Defined in bulletin/src/client.ts:81

`Static`create

create(env: Environment): Promise<BulletinClient>
Create from an environment — resolves API via chain-client, gateway from known list.
Parameters
- env: Environment
Returns Promise<BulletinClient>
- Defined in bulletin/src/client.ts:70

`Static`from

from(api: BulletinApi, gateway: string): BulletinClient
Create from an explicit API and gateway (custom setups, testing).
Parameters
- api: BulletinApi
- gateway: string
Returns BulletinClient
- Defined in bulletin/src/client.ts:76

`Static`hashToCid

hashToCid(
    hexHash: `0x${string}`,
    hashCode?: HashAlgorithm,
    codec?: CidCodec,
): string
Reconstruct a CID from a 0x-prefixed hex hash. Static — no instance needed.

Useful for converting on-chain hashes back to CIDs for IPFS gateway lookups. Pass optional hash algorithm and codec to match the on-chain CID configuration.
Parameters
- hexHash: `0x${string}`
- OptionalhashCode: HashAlgorithm
- Optionalcodec: CidCodec
Returns string
See
hashToCid for full documentation.
- Defined in bulletin/src/client.ts:93

Class BulletinClient

Example

Index

Properties

Methods

Properties

Readonlyapi

Readonlygateway

Methods

batchUpload

Parameters

Returns Promise<BatchUploadResult[]>

checkAuthorization

Parameters

Returns Promise<AuthorizationStatus>

See

cidExists

Parameters

Returns Promise<boolean>

fetchBytes

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

fetchJson

Type Parameters

Parameters

Returns Promise<T>

gatewayUrl

Parameters

Returns string

upload

Parameters

Returns Promise<UploadResult>

StaticcomputeCid

Parameters

Returns string

Staticcreate

Parameters

Returns Promise<BulletinClient>

Staticfrom

Parameters

Returns BulletinClient

StatichashToCid

Parameters

Returns string

See

Settings

On This Page

`Readonly`api

`Readonly`gateway

`Static`computeCid

`Static`create

`Static`from

`Static`hashToCid