Class Client

constructor

• new Client(agentData, options?): Client

• Parameters

  • agentData: AgentData

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

    • receiptsEndpoint: undefined | URL

    • serviceConf: undefined | ServiceConf

  Returns Client

capability

coupon

accounts

• accounts(): Record<`did:mailto:${string}:${string}`, Account.Account>

• List all accounts that agent has stored access to. Returns a dictionary of accounts keyed by their did:mailto identifier.

  Returns Record<`did:mailto:${string}:${string}`, Account.Account>

addProof

• addProof(proof): Promise<void>

• Add a proof to the agent. Proofs are delegations with an audience matching the agent DID.

  Parameters

  • proof: Delegation<Capabilities>

  Returns Promise<void>

addSpace

• addSpace(proof): Promise<SharedSpace>

• Add a space from a received proof.

  Parameters

  • proof: Delegation<Capabilities>

  Returns Promise<SharedSpace>

authorize

• authorize(email, options?): Promise<void>

• Parameters

  • email: `${string}@${string}`

  • Optional options: {
        capabilities: undefined | Iterable<{
            can: Ability;
        }>;
        signal: undefined | AbortSignal;
    }

    • capabilities: undefined | Iterable<{
          can: Ability;
      }>

    • signal: undefined | AbortSignal

  Returns Promise<void>

  Deprecated

  • Use client.login instead.

  Authorize the current agent to use capabilities granted to the passed email account.

createDelegation

• createDelegation(audience, abilities, options?): Promise<Delegation<Capabilities>>

• Create a delegation to the passed audience for the given abilities with the current space as the resource.

  Parameters

  • audience: Principal<`did:${string}:${string}`>

  • abilities: ("*" | "provider/add" | "space/*" | "space/info" | "store/add" | "store/remove" | "store/list" | "upload/add" | "upload/remove" | "upload/list" | "upload/*" | "upload/get" | "store/*" | "store/get" | "access/*" | "access/authorize" | "ucan/attest" | "ucan/conclude" | "customer/get" | "consumer/has" | "consumer/get" | "subscription/get" | "subscription/list" | "rate-limit/add" | "rate-limit/remove" | "rate-limit/list" | "filecoin/offer" | "filecoin/submit" | "filecoin/accept" | "filecoin/info" | "piece/offer" | "piece/accept" | "aggregate/offer" | "aggregate/accept" | "deal/info" | "admin/*" | "admin/upload/inspect" | "admin/store/inspect" | "plan/get" | "usage/*" | "usage/report" | "blob/*" | "blob/add" | "blob/remove" | "blob/list" | "web3.storage/blob/*" | "web3.storage/blob/allocate" | "web3.storage/blob/accept" | "http/put" | "index/*" | "index/add")[]

  • Optional options: Omit<UCANOptions, "audience"> & {
        audienceMeta?: AgentMeta;
    } = {}

  Returns Promise<Delegation<Capabilities>>

createSpace

• createSpace(name): Promise<OwnedSpace>

• Create a new space with a given name.

  Parameters

  • name: string

  Returns Promise<OwnedSpace>

currentSpace

• currentSpace(): undefined | Space

• The current space.

  Returns undefined | Space

defaultProvider

• defaultProvider(): `did:${string}:${string}`

• Return the default provider.

  Returns `did:${string}:${string}`

delegations

• delegations(caps?): Delegation<Capabilities>[]

• Get delegations created by the agent for others.

  Parameters

  • Optional caps: Capability<Ability, `${string}:${string}`, any>[]

    Capabilities to filter by. Empty or undefined caps with return all the delegations.

  Returns Delegation<Capabilities>[]

did

• did(): `did:key:${string}`

• Returns `did:key:${string}`

getReceipt

• getReceipt(taskCid): Promise<undefined | Receipt<{}, {}, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>

• Get a receipt for an executed task by its CID.

  Parameters

  • taskCid: UnknownLink

  Returns Promise<undefined | Receipt<{}, {}, Invocation<Capability<Ability, `${string}:${string}`, unknown>>, SigAlg>>

login

• login(email, options?): Promise<Account.Account>

• Parameters

  • email: `${string}@${string}`

  • Optional options: {
        signal: undefined | AbortSignal;
    } = {}

    • signal: undefined | AbortSignal

  Returns Promise<Account.Account>

proofs

• proofs(caps?): Delegation<Capabilities>[]

• Get all the proofs matching the capabilities.

  Proofs are delegations with an audience matching the agent DID.

  Parameters

  • Optional caps: Capability<Ability, `${string}:${string}`, any>[]

    Capabilities to filter by. Empty or undefined caps with return all the proofs.

  Returns Delegation<Capabilities>[]

remove

• remove(contentCID, options?): Promise<void>

• Removes association of a content CID with the space. Optionally, also removes association of CAR shards with space.

  ⚠️ If shards option is true all shards will be deleted even if there is another upload(s) that reference same shards, which in turn could corrupt those uploads.

  Parameters

  • contentCID: UnknownLink

  • Optional options: {
        shards: undefined | boolean;
    } = {}

    • shards: undefined | boolean

  Returns Promise<void>

revokeDelegation

• revokeDelegation(delegationCID, options?): Promise<Result<{}, Failure | HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized>>

• Revoke a delegation by CID.

  If the delegation was issued by this agent (and therefore is stored in the delegation store) you can just pass the CID. If not, or if the current agent's delegation store no longer contains the delegation, you MUST pass a chain of proofs that proves your authority to revoke this delegation as options.proofs.

  Parameters

  • delegationCID: Link<Capabilities, MulticodecCode<number, string>, SigAlg>

  • Optional options: {
        proofs: undefined | Delegation<Capabilities>[];
    } = {}

    • proofs: undefined | Delegation<Capabilities>[]

  Returns Promise<Result<{}, Failure | HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized>>

setCurrentSpace

• setCurrentSpace(did): Promise<void>

• Use a specific space.

  Parameters

  • did: `did:${string}:${string}`

  Returns Promise<void>

spaces

• spaces(): Space[]

• Spaces available to this agent.

  Returns Space[]

uploadCAR

• uploadCAR(car, options?): Promise<AnyLink>

• Uploads a CAR file to the service.

  The difference between this function and capability.store.add is that the CAR file is automatically sharded and an "upload" is registered, linking the individual shards (see capability.upload.add).

  Use the onShardStored callback to obtain the CIDs of the CAR file shards.

  Parameters

  • car: BlobLike

    CAR file.

  • Optional options: UploadOptions = {}

  Returns Promise<AnyLink>

uploadDirectory

• uploadDirectory(files, options?): Promise<AnyLink>

• Uploads a directory of files to the service and returns the root data CID for the generated DAG. All files are added to a container directory, with paths in file names preserved.

  Parameters

  • files: FileLike[]

    File data.

  • Optional options: UploadDirectoryOptions = {}

  Returns Promise<AnyLink>

uploadFile

• uploadFile(file, options?): Promise<AnyLink>

• Uploads a file to the service and returns the root data CID for the generated DAG.

  Parameters

  • file: BlobLike

    File data.

  • Optional options: UploadOptions = {}

  Returns Promise<AnyLink>