@ecp.eth/sdk

@ecp.eth/sdk / indexer / FetchChannelsOptions

type FetchChannelsOptions = {
  apiUrl?: string;
  chainId: number | number[];
  cursor?: Hex;
  limit?: number;
  owner?: Hex;
  retries?: number;
  signal?: AbortSignal;
  sort?: IndexerAPISortSchemaType;
};

Defined in: packages/sdk/src/indexer/api.ts:729

The options for fetchChannels()

Properties

apiUrl?

optional apiUrl: string;

Defined in: packages/sdk/src/indexer/api.ts:735

URL on which /api/channels endpoint will be called

Default

"https://api.ethcomments.xyz"

chainId

chainId: number | number[];

Defined in: packages/sdk/src/indexer/api.ts:743

Filter channels by chain ID(s)

cursor?

optional cursor: Hex;

Defined in: packages/sdk/src/indexer/api.ts:753

The cursor to fetch channels from

limit?

optional limit: number;

Defined in: packages/sdk/src/indexer/api.ts:765

The number of channels to fetch

Default

50

owner?

optional owner: Hex;

Defined in: packages/sdk/src/indexer/api.ts:739

Filter channels by owner

retries?

optional retries: number;

Defined in: packages/sdk/src/indexer/api.ts:749

Number of times to retry the signing operation in case of failure.

Default

3

signal?

optional signal: AbortSignal;

Defined in: packages/sdk/src/indexer/api.ts:766

sort?

optional sort: IndexerAPISortSchemaType;

Defined in: packages/sdk/src/indexer/api.ts:759

The sort order, either asc or desc

Default

"desc"