docs(build-an-oracle): document the oracle-payments bundled plugin - #48
Open
youssefhany-ixo wants to merge 1 commit into
Open
docs(build-an-oracle): document the oracle-payments bundled plugin#48youssefhany-ixo wants to merge 1 commit into
youssefhany-ixo wants to merge 1 commit into
Conversation
Adds the reference page for `oracle-payments`, the plugin that lets an oracle sell services from a Matrix chat: publish an Agent Card, let users contract on-chain, reserve payment when work starts, and submit a work claim on delivery. Also corrects the bundled-plugin set across the section. `BUNDLED_PLUGINS` is now a 14-entry tuple; `credits`, `slack`, `calls`, and `flows` are opt-in and must be passed as instances in `plugins`, so their pages and every "N bundled plugins" claim have been updated to match. `for-ai-agents` was also missing `vfs` from its table.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents
oracle-payments, the bundled plugin that lets an oracle sell services from a Matrix chat.New page:
reference/bundled-plugins/oracle-payments.mdx— the concepts (Agent Card, contract, engagement, escrow, delivery, cancellation), how a user contracts, the six tools, the seven env vars, the Matrix component events the Portal renders, deployment prerequisites, and how it differs fromcredits(that plugin meters LLM usage; this one bills for delivered work — separate lanes).Also: the bundled-plugin set was out of date section-wide
BUNDLED_PLUGINSis now a 14-entry tuple.credits,slack,callsandflowsare not in it — they are opt-in and must be passed as instances inplugins. BecauseBundledFeatureNamederives from that tuple,features: { credits: true }no longer loads anything, so:for-ai-agents.mdxwas missingvfsfrom its plugin tableChecks
lint:mdx(eslint-mdx) — cleanlint:terminology— no banned aliasesmarkdownlint-cli2— 192 files, 0 errorsmint broken-links— 17 broken links, all pre-existing inarticles/andguides/users/; identical count before and after, none inbuild-an-oracle/Note for the reviewer
The plugin itself has not shipped yet — it is still unreleased in
ixo-oracles-boilerplate, and it needs two eval-engine changes (an oracle-facing contract lookup, and acceptance ofuseIntent: trueagent-work claims) before the paid-work path functions end to end. Discovery and contracting docs are accurate today; hold the merge if you would rather the docs land with the release.Separately:
reference/cli.mdxdoes not documentqiforge-cli agent-card, which is the only supported way to publish an Agent Card and setAGENT_CARD_PATH. Also missing there:dashboard-access,update-domain. Not fixed here.