Skip to content
Integra Agentic Connectors
API@integraledger/agentic-connectors

@integraledger/agentic-connectors

The exports of @integraledger/agentic-connectors.

Interfaces

Where the buyer pays the agreement step: the URL to place beside the carriers, its network, and its pairing.

Properties

PropertyType
networkstring
pairingstring
urlstring

AgreementView

The agreement step's leg of a record.

Properties

PropertyType
networkstring | null
state"required" | "settling" | "recorded"
transactionstring | null

Carriers

The carrier forms of this hash and link.

Properties

PropertyType
lcpstring
legal_contextobject
legal_context.legal_context_urlstring
legal_context.type"sha256"
legal_context.value`0x${string}`
legalContextobject
legalContext.legalContextUrlstring
legalContext.type"sha256"
legalContext.value`0x${string}`

ChannelView

A channel pairing's channel: until is the rail's deadline for the channel, or null when the rail gives none.

Properties

PropertyType
channelstring
closedboolean
networkstring
untilstring | null

ClaimDeclined

A pushed payment that landed and then failed the check: reported, never refused. atrHash is the hash the payment is bound to, or null when it is bound to none; code is the check's code; transaction is the landed transaction.

Properties

PropertyType
atrHash`0x${string}` | null
codestring
pairingstring
state"declined"
transactionstring | null

ClaimRequest

Properties

PropertyTypeDescription
chosenJson-
networkstring-
pairingstring-
paymentJson-
request?RequestCommitment-
resourcestring-
settleBy?numberUnix seconds, at most now + 604 800.

ClaimResponse

Properties

PropertyType
atrHash`0x${string}`
pairingstring
provesProves
state"settling"

ContentSlot

One content slot: strict RFC 4648 §4 base64 of the slot's exact bytes.

Properties

PropertyType
bytesstring
slotstring

IssueRequest

Properties

PropertyTypeDescription
content?ContentSlot[]0–56 slots.
lifetimeSecondsnumberInteger 1–604 800: the protocol's challenge lifetime.
mintRequestIdstring^[A-Za-z0-9._:-]{1,128}$: one state of one checkout.
offersOffer[]1–16, in the order the document will carry them.
request?RequestCommitmentRequired on an x402 surface.
resourcestringThe resource id declared through the admin door, 1–512 bytes.

IssueResponse

Properties

PropertyTypeDescription
agreement?AgreementLinkPresent exactly when the record requires the agreement step.
atrHash`0x${string}`-
carriersCarriers-
expiresAtstring-
linkstring-
mintRequestIdstring-
pairingsobject[]-

Offer

One payment option, as the challenge will carry it. pairing is a pairing id the LCP package registers.

Properties

PropertyType
optionJson
pairingstring

Proves

What a record proves: whether the claim read the hash from the payment, the pairing's pattern, and the evidence it was paid on.

Properties

PropertyTypeDescription
claimedboolean-
patternLcpPattern | null-
settledBy"read" | "facilitator" | "seller-report" | nullA read of the rail, the facilitator's settle answer, or the seller's report on a pairing with nothing to read; null while unpaid.

RecordView

Properties

PropertyTypeDescription
agreementAgreementView | nullNull when the record requires no agreement step.
atrHash`0x${string}`-
channelChannelView | null-
expiresAtstring-
provesProves-
settlement{ network?: string; pairing: string; reference?: string; } | null-
state"closed" | "settling" | "paid" | "issued"-

Refusal

Properties

PropertyType
codestring
correlationIdstring
sentencestring

ReportClosed

A channel pairing's close: the close transaction as reference.

Properties

PropertyType
atrHash`0x${string}`
chosen?Json
network?string
pairingstring
referencestring
state"closed"

ReportOutcome

A payment's outcome; reference: 1–256 characters, no control characters.

Properties

PropertyTypeDescription
atrHash`0x${string}`-
chosen?JsonOn a record with no claim: the option the payment paid, as issued, from which its read keys are taken.
network?string-
outcome"declined" | "paid"-
pairingstring-
receipt?JsonOn a confirm-only channel pairing's paid report: the receipt its opening answered, from which the channel is read.
reference?string-
request?RequestCommitmentWith chosen, on a surface whose issued options are tied to the request.

RequestCommitment

The request an x402 challenge answers.

Properties

PropertyType
bodyDigest`0x${string}`
methodstring
pathstring
querystring

Vector

One vector: requests to the door and the answers they must produce.

Properties

PropertyTypeDescription
fixedobject-
fixed.agreement?objectThe tenant's agreement step: the nominal payment's pairing, network, asset, payee, amount and time bound.
fixed.agreement.amountstring-
fixed.agreement.assetstring-
fixed.agreement.extra?object-
fixed.agreement.host?stringThe tenant host the agreement URL is on; required when hosts has more than one.
fixed.agreement.maxTimeoutSecondsnumber-
fixed.agreement.networkstring-
fixed.agreement.pairingstring-
fixed.agreement.payTostring-
fixed.atrIdsstring[]-
fixed.clocknumber-
fixed.credentialstring-
fixed.credentialDigeststring-
fixed.hosts?string[]The tenant's hosts: an agreement URL is on the agreement's host, or on the tenant's only host.
fixed.resourcesobject[]-
fixed.storageBasestring-
fixed.tenantstring-
namestring-
sourcestring-
stepsobject[]-

Type Aliases

ReportRequest

ReportRequest = ReportOutcome | ReportClosed

Variables

OPENAPI_BYTES

const OPENAPI_BYTES: Uint8Array

The bytes of openapi.json.

REFUSALS

const REFUSALS: Readonly<Record<string, number>>

The closed refusal table: each code and its status.

VECTORS

const VECTORS: Readonly<Record<string, Vector>>

The vector files, parsed, by name (CV1 …).

Last updated on

@integraledger/profile-facilitator

The facilitator's exports, HTTP API, reason codes, storage schema, bounds and logs.

@integraledger/profile-facilitator

The exports of @integraledger/profile-facilitator.

On this page

InterfacesAgreementLinkPropertiesAgreementViewPropertiesCarriersPropertiesChannelViewPropertiesClaimDeclinedPropertiesClaimRequestPropertiesClaimResponsePropertiesContentSlotPropertiesIssueRequestPropertiesIssueResponsePropertiesOfferPropertiesProvesPropertiesRecordViewPropertiesRefusalPropertiesReportClosedPropertiesReportOutcomePropertiesRequestCommitmentPropertiesVectorPropertiesType AliasesReportRequestVariablesOPENAPI_BYTESREFUSALSVECTORS