@storacha/client
Version:
Client for the storacha.network w3up api
59 lines • 2.25 kB
TypeScript
/**
* Client for interacting with the `space/*` capabilities.
*/
export class SpaceClient extends Base {
/**
* Get information about a space.
*
* Required delegated capabilities:
* - `space/info`
*
* @param {import('../types.js').DID} space - DID of the space to retrieve info about.
* @param {object} [options]
* @param {string} [options.nonce]
*/
info(space: import("../types.js").DID, options?: {
nonce?: string | undefined;
}): Promise<import("@storacha/access").SpaceInfoResult>;
/**
* Record egress data for a served resource.
* It will execute the capability invocation to find the customer and then record the egress data for the resource.
*
* Required delegated capabilities:
* - `space/content/serve/egress/record`
*
* @param {object} egressData
* @param {import('../types.js').SpaceDID} egressData.space
* @param {API.UnknownLink} egressData.resource
* @param {number} egressData.bytes
* @param {string} egressData.servedAt
* @param {object} [options]
* @param {string} [options.nonce]
* @param {API.Delegation[]} [options.proofs]
* @returns {Promise<API.EgressRecordSuccess>}
*/
egressRecord(egressData: {
space: import("../types.js").SpaceDID;
resource: API.UnknownLink;
bytes: number;
servedAt: string;
}, options?: {
nonce?: string | undefined;
proofs?: API.Delegation<API.Capabilities>[] | undefined;
}): Promise<API.EgressRecordSuccess>;
}
export function egressRecord({ agent }: {
agent: API.Agent;
}, { space, resource, bytes, servedAt }: {
space: API.SpaceDID;
resource: API.UnknownLink;
bytes: number;
servedAt: string;
}, { nonce, proofs }: {
nonce?: string | undefined;
proofs?: API.Delegation<API.Capabilities>[] | undefined;
}): Promise<SpaceCapabilities.Store.Schema.Result<{}, SpaceCapabilities.Store.Schema.Error | API.HandlerNotFound | API.HandlerExecutionError | API.InvalidAudience | API.Unauthorized>>;
import { Base } from '../base.js';
import * as API from '../types.js';
import { Space as SpaceCapabilities } from '@storacha/capabilities';
//# sourceMappingURL=space.d.ts.map