Class FilecoinClient

Client for interacting with the filecoin/* capabilities.

Hierarchy

Base
- FilecoinClient

Index

Constructors

constructor

new FilecoinClient(agentData, options?): FilecoinClient
Parameters
- agentData: AgentData
- Optional options: {
  receiptsEndpoint: undefined | URL;
  serviceConf: undefined | ServiceConf;
  } = {}
  - receiptsEndpoint: undefined | URL
  - serviceConf: undefined | ServiceConf
Returns FilecoinClient
Inherited from Base.constructor
- Defined in packages/w3up-client/src/base.js:23

Properties

`Protected` _agent

_agent: Agent<Service>

_receiptsEndpoint

_receiptsEndpoint: string | URL

`Protected` _serviceConf

_serviceConf: ServiceConf

Accessors

agent

get agent(): Agent<Service>
The current user agent (this device).

Returns Agent<Service>
Inherited from Base.agent
- Defined in packages/w3up-client/src/base.js:39

Methods

`Protected` _invocationConfig

_invocationConfig(abilities): Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:key:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:key:${string}`;
}>
Protected
Parameters
- abilities: Ability[]
Returns Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:key:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:key:${string}`;
}>
Inherited from Base._invocationConfig
- Defined in packages/w3up-client/src/base.js:47

info

info(piece): Promise<Receipt<FilecoinInfoSuccess, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | FilecoinInfoFailure, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>
Request info about a content piece in Filecoin deals
Parameters
- piece: PieceLink
Returns Promise<Receipt<FilecoinInfoSuccess, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | FilecoinInfoFailure, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>
- Defined in packages/w3up-client/src/capability/filecoin.js:27

offer

offer(content, piece): Promise<Receipt<FilecoinOfferSuccess, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | FilecoinOfferFailure, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>
Offer a Filecoin "piece" to the resource.
Parameters
- content: UnknownLink
- piece: PieceLink
Returns Promise<Receipt<FilecoinOfferSuccess, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | FilecoinOfferFailure, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>
- Defined in packages/w3up-client/src/capability/filecoin.js:15

Class FilecoinClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

agentData: AgentData

`Optional` options: {
receiptsEndpoint: undefined | URL;
serviceConf: undefined | ServiceConf;
} = {}

receiptsEndpoint: undefined | URL

serviceConf: undefined | ServiceConf

Returns FilecoinClient

Properties

`Protected` _agent

_receiptsEndpoint

`Protected` _serviceConf

Accessors

agent

Returns Agent<Service>

Methods

`Protected` _invocationConfig

Parameters

abilities: Ability[]

Returns Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:key:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:key:${string}`;
}>

info

Parameters

piece: PieceLink

Returns Promise<Receipt<FilecoinInfoSuccess, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | FilecoinInfoFailure, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>

offer

Parameters

content: UnknownLink

piece: PieceLink

Returns Promise<Receipt<FilecoinOfferSuccess, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | FilecoinOfferFailure, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>

Settings

Member Visibility

Theme

On This Page

Class FilecoinClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

agentData: AgentData

Optional options: { receiptsEndpoint: undefined | URL; serviceConf: undefined | ServiceConf; } = {}

receiptsEndpoint: undefined | URL

serviceConf: undefined | ServiceConf

Returns FilecoinClient

Properties

Protected _agent

_receiptsEndpoint

Protected _serviceConf

Accessors

agent

Returns Agent<Service>

Methods

Protected _invocationConfig

Parameters

abilities: Ability[]

Returns Promise<{ audience: Principal<`did:${string}:${string}`>; issuer: Signer<`did:key:${string}`, SigAlg>; proofs: Delegation<Capabilities>[]; with: `did:key:${string}`; }>

info

Parameters

piece: PieceLink

Returns Promise<Receipt<FilecoinInfoSuccess, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | FilecoinInfoFailure, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>

offer

Parameters

content: UnknownLink

piece: PieceLink

Returns Promise<Receipt<FilecoinOfferSuccess, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | FilecoinOfferFailure, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>

Settings

Member Visibility

Theme

On This Page

`Optional` options: {
receiptsEndpoint: undefined | URL;
serviceConf: undefined | ServiceConf;
} = {}

`Protected` _agent

`Protected` _serviceConf

`Protected` _invocationConfig

Returns Promise<{
audience: Principal<`did:${string}:${string}`>;
issuer: Signer<`did:key:${string}`, SigAlg>;
proofs: Delegation<Capabilities>[];
with: `did:key:${string}`;
}>