@storacha/client
Version:
Client for the storacha.network w3up api
34 lines • 2.18 kB
TypeScript
/**
* Client for interacting with the `filecoin/*` capabilities.
*/
export class FilecoinClient extends Base {
/**
* Offer a Filecoin "piece" to the resource.
*
* Required delegated capabilities:
* - `filecoin/offer`
*
* @param {import('multiformats').UnknownLink} content
* @param {import('@storacha/capabilities/types').PieceLink} piece
* @param {object} [options]
* @param {string} [options.nonce]
*/
offer(content: import("multiformats").UnknownLink, piece: import("@storacha/capabilities/types").PieceLink, options?: {
nonce?: string | undefined;
}): Promise<import("@ucanto/interface").Receipt<import("@storacha/capabilities/types").FilecoinOfferSuccess, import("@ucanto/interface").HandlerNotFound | import("@ucanto/interface").HandlerExecutionError | import("@ucanto/interface").InvalidAudience | import("@ucanto/interface").Unauthorized | import("@storacha/capabilities/types").FilecoinOfferFailure, import("@ucanto/interface").Invocation<import("@ipld/dag-ucan").Capability<import("@ipld/dag-ucan").Ability, `${string}:${string}`, unknown>>, import("@ipld/dag-ucan").SigAlg>>;
/**
* Request info about a content piece in Filecoin deals
*
* Required delegated capabilities:
* - `filecoin/info`
*
* @param {import('@storacha/capabilities/types').PieceLink} piece
* @param {object} [options]
* @param {string} [options.nonce]
*/
info(piece: import("@storacha/capabilities/types").PieceLink, options?: {
nonce?: string | undefined;
}): Promise<import("@ucanto/interface").Receipt<import("@storacha/capabilities/types").FilecoinInfoSuccess, import("@ucanto/interface").HandlerNotFound | import("@ucanto/interface").HandlerExecutionError | import("@ucanto/interface").InvalidAudience | import("@ucanto/interface").Unauthorized | import("@storacha/capabilities/types").FilecoinInfoFailure, import("@ucanto/interface").Invocation<import("@ipld/dag-ucan").Capability<import("@ipld/dag-ucan").Ability, `${string}:${string}`, unknown>>, import("@ipld/dag-ucan").SigAlg>>;
}
import { Base } from '../base.js';
//# sourceMappingURL=filecoin.d.ts.map