@etherna/sdk-js/clients/bee/types.d.ts

Etherna SDKs for operations on the network

import type { RequestOptions } from "..";
import type { BATCH_ID_HEX_LENGTH, REFERENCE_HEX_LENGTH } from "./utils/contants";
export type EthAddress = `0x${string}`;
export type EnsAddress = `${string}.eth`;
type SyncSigner = (digest: string | Uint8Array) => string;
type AsyncSigner = (digest: string | Uint8Array) => Promise<string>;
export type Signer = {
    sign: SyncSigner | AsyncSigner;
    address: EthAddress;
};
export type FeedType = "sequence" | "epoch";
export type FeedInfo<T extends FeedType> = {
    topic: string;
    owner: string;
    type: T;
};
export type Index = number | Uint8Array | string;
export declare type HexString<Length = number> = string & {
    readonly length: Length;
};
export type BatchId = HexString<typeof BATCH_ID_HEX_LENGTH>;
export type PostageBatchBucketsData = {
    depth: number;
    bucketDepth: number;
    bucketUpperBound: number;
    buckets: PostageBatchBucket[];
};
export type PostageBatchBucket = {
    bucketID: number;
    collisions: number;
};
export type Reference = HexString<typeof REFERENCE_HEX_LENGTH>;
export type PostageBatch = {
    batchID: BatchId;
    utilization: number;
    usable: boolean;
    label: string;
    depth: number;
    amount: string;
    bucketDepth: number;
    blockNumber: number;
    immutableFlag: boolean;
    /**
     * The time (in seconds) remaining until the batch expires;
     * -1 signals that the batch never expires;
     * 0 signals that the batch has already expired.
     */
    batchTTL: number;
    exists: boolean;
};
export type Tag = {
    uid: number;
    startedAt: string;
    split: number;
    seen: number;
    stored: number;
    sent: number;
    synced: number;
};
export type FeedUpdateHeaders = {
    /**
     * The current feed's index
     */
    feedIndex: string;
    /**
     * The feed's index for next update.
     * Only set for the latest update. If update is fetched using previous index, then this is an empty string.
     */
    feedIndexNext: string;
};
export type ContentAddressedChunk = {
    readonly data: Uint8Array;
    /** span bytes (8) */
    span(): Uint8Array;
    /** payload bytes (1-4096) */
    payload(): Uint8Array;
    address(): Uint8Array;
};
export type SingleOwnerChunk = ContentAddressedChunk & {
    identifier(): Uint8Array;
    signature(): Uint8Array;
    owner(): Uint8Array;
};
export interface Data extends Uint8Array {
    /**
     * Converts the binary data using UTF-8 decoding into string.
     */
    text(): string;
    /**
     * Converts the binary data into hex-string.
     */
    hex(): HexString;
    /**
     * Converts the binary data into string which is then parsed into JSON.
     */
    json<T extends Record<string, unknown> | unknown[]>(): T;
}
export interface RequestUploadOptions extends RequestOptions {
    batchId: string;
    pin?: boolean;
    encrypt?: boolean;
    tag?: number | string;
    deferred?: boolean;
    /** Upload progress, ranging 0 to 100 */
    onUploadProgress?(completion: number): void;
}
export interface RequestDownloadOptions extends RequestOptions {
    /** Download progress, ranging 0 to 100 */
    onDownloadProgress?(completion: number): void;
}
export interface FileUploadOptions extends RequestUploadOptions {
    size?: number;
    contentType?: string;
    filename?: string;
}
export interface FileDownloadOptions extends RequestDownloadOptions {
    maxResponseSize?: number;
}
export interface FeedUpdateOptions extends RequestOptions {
    index?: string;
    at?: Date;
}
export interface FeedUploadOptions extends RequestUploadOptions {
    index?: string;
    at?: Date;
}
export interface AuthenticationOptions extends RequestOptions {
    role?: "maintainer" | "creator" | "auditor" | "consumer";
    expiry?: number;
}
export interface ReferenceResponse {
    reference: Reference;
}
export {};
//# sourceMappingURL=types.d.ts.map