Repository navigation
Add a Wallet Engine tab - #31
Merged
Merged
Conversation
`@kaleidorg/wallet-engine` appeared on the docs site only as prose in
introduction/architecture/glossary — no quickstart, no concepts, no API
surface. A developer who hasn't already found the repo has nowhere to land.
Adds four pages under a new tab, placed after SDK so the two developer
surfaces sit together:
- introduction — the problem, the four primitives, protocol/maturity table
- getting-started — the offline tour first, then install, peer deps, first wallet
- concepts — contract, manifest, router, unified receive, disclosure,
ports, swaps
- adding-a-protocol — the three files a new protocol touches, and nothing else
Two things are documented as the code actually behaves rather than as the
design intent reads: `KaleidoswapSwap.executeSwap` binds on rfqId + exact
amounts + an expiry check (there is no client-side slippage bound), and
platform-storage absence is handled two ways — the Boltz chain-swap store
throws NO_PLATFORM rather than hand out an unpersisted derivation index,
while Spark sent-token records fall back to an in-memory map.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
- drop receiverAddress/receiverAddressFormat from the executeSwap example — neither exists on Quote and KaleidoswapSwap never reads them; note that payout settles to the bound account - fix IOnchainOperations and ISparkOperations descriptions and add the omitted ISimplicityOperations group - remove the desktop-agent consumer claim (desktop drives an RLN node directly, not wallet-engine) - note @kaleidorg/swap-sdk as a peer of the /swap subpath's Boltz venue Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…nto the en nav Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
@kaleidorg/wallet-engineappears on the docs site only as prose inintroduction,architectureandglossary— no quickstart, no concepts, no API surface. A developer who hasn't already found the GitHub repo has nowhere to land, even though the package is public, MIT, and powers the extension,rateand the desktop agent.What's here
Four pages under a new Wallet Engine tab, placed after SDK so the two developer surfaces sit together (21-line
docs.jsoninsertion, no other nav change):introductiongetting-startedconceptsadding-a-protocolAccuracy
Two things are documented as the code actually behaves rather than as the design intent reads. Both were drafted the other way first and corrected against source:
KaleidoswapSwap.executeSwapbinds onrfqId+ exact amounts + an expiry check. There is no client-side slippage bound insrc/swap/— the onlyslippageBpsin the engine is inlib/orchestra-client.ts, a different path.NO_PLATFORMrather than hand out a derivation index it cannot persist, while Spark sent-token records fall back to an in-memory map.Depends on nothing, but reads best alongside kaleidoswap/wallet-engine#66, which adds the
npm run example:tourthatgetting-startedopens with.🤖 Generated with Claude Code