Class CaravanClient

constructor

• new CaravanClient(options: CaravanClientOptions): CaravanClient

  Parameters

  • options: CaravanClientOptions

  Returns CaravanClient

Readonlyendpoints

Readonlytransport

attest

• attest(
      attestation: Attestation,
      signer: AttestationSigner,
      signal?: AbortSignal,
  ): Promise<AttestationResponse>

  Parameters

  • attestation: Attestation
  • signer: AttestationSigner
  • Optionalsignal: AbortSignal

  Returns Promise<AttestationResponse>

checkCapacity

• checkCapacity(
      endpoint: string,
      options?: CapacityConformanceOptions,
      signal?: AbortSignal,
  ): Promise<CapacityConformanceResult>

  Parameters

  • endpoint: string
  • options: CapacityConformanceOptions = {}
  • Optionalsignal: AbortSignal

  Returns Promise<CapacityConformanceResult>

checkPools

• checkPools(intentId: string, signal?: AbortSignal): Promise<CheckPoolsResult>

  Parameters

  • intentId: string
  • Optionalsignal: AbortSignal

  Returns Promise<CheckPoolsResult>

commit

• commit(input: CommitInput): Promise<CommitResult>

  Parameters

  • input: CommitInput

  Returns Promise<CommitResult>

deployBond

• deployBond(
      input: DeployBondInput,
      signal?: AbortSignal,
  ): Promise<BondDeployment>

  Parameters

  • input: DeployBondInput
  • Optionalsignal: AbortSignal

  Returns Promise<BondDeployment>

depositBond

• depositBond(
      input: DepositBondInput,
      signal?: AbortSignal,
  ): Promise<BondTransaction>

  Parameters

  • input: DepositBondInput
  • Optionalsignal: AbortSignal

  Returns Promise<BondTransaction>

finalizeIntent

• finalizeIntent(
      intentId: string,
      signal?: AbortSignal,
  ): Promise<FailedIntentResult>

  Explicitly make an owner-scoped, still-pending no-match intent terminal.

  Parameters

  • intentId: string
  • Optionalsignal: AbortSignal

  Returns Promise<FailedIntentResult>

getDisclosure

• getDisclosure(
      agentId: string,
      signal?: AbortSignal,
  ): Promise<DisclosureProjection>

  Parameters

  • agentId: string
  • Optionalsignal: AbortSignal

  Returns Promise<DisclosureProjection>

getManifest

• getManifest(input: GetManifestInput): Promise<ManifestResult>

  Parameters

  • input: GetManifestInput

  Returns Promise<ManifestResult>

getMatchResult

• getMatchResult(
      intentId: string,
      options?: MatchPollingOptions,
  ): Promise<MatchedIntentResult | FailedIntentResult>

  Parameters

  • intentId: string
  • options: MatchPollingOptions = {}

  Returns Promise<MatchedIntentResult | FailedIntentResult>

getPriceHistory

• getPriceHistory(
      query: PriceHistoryQuery,
      signal?: AbortSignal,
  ): Promise<ClearingPriceHistoryResponse>

  Parameters

  • query: PriceHistoryQuery
  • Optionalsignal: AbortSignal

  Returns Promise<ClearingPriceHistoryResponse>

onboardAgentCard

• onboardAgentCard(
      card: AgentCardEnvelope,
      signal?: AbortSignal,
  ): Promise<AgentCardOnboardingResult>

  Parameters

  • card: AgentCardEnvelope
  • Optionalsignal: AbortSignal

  Returns Promise<AgentCardOnboardingResult>

onboardSeller

• onboardSeller(input: SellerOnboardingInput): Promise<SellerOnboardingResult>

  Parameters

  • input: SellerOnboardingInput

  Returns Promise<SellerOnboardingResult>

payReveal

• payReveal(input: RevealInput): Promise<RevealResult>

  Parameters

  • input: RevealInput

  Returns Promise<RevealResult>

postIntent

• postIntent(
      intent: IntentInput,
      options?: IntentSubmissionOptions,
  ): Promise<AcceptedIntent>

  Parameters

  • intent: IntentInput
  • options: IntentSubmissionOptions = {}

  Returns Promise<AcceptedIntent>

postOffer

• postOffer(offer: OfferInput, signal?: AbortSignal): Promise<AcceptedOffer>

  Parameters

  • offer: OfferInput
  • Optionalsignal: AbortSignal

  Returns Promise<AcceptedOffer>

proveDomain

• proveDomain(origin: string, signal?: AbortSignal): Promise<DomainProofResult>

  Parameters

  • origin: string
  • Optionalsignal: AbortSignal

  Returns Promise<DomainProofResult>

settleBond

• settleBond(
      input: SettleBondInput,
      signal?: AbortSignal,
  ): Promise<BondTransaction>

  Parameters

  • input: SettleBondInput
  • Optionalsignal: AbortSignal

  Returns Promise<BondTransaction>