Skip to content

simpleXRPL docs - #224

Draft
oeggert wants to merge 24 commits into
mainfrom
simplexrpl-docs
Draft

simpleXRPL docs#224
oeggert wants to merge 24 commits into
mainfrom
simplexrpl-docs

Conversation

@oeggert

@oeggert oeggert commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

This PR adds these simpleXRPL SDK docs:

  • Landing Concept
  • Get Started
  • Tutorials for workflows
  • References (verticals, connector routing table)
  • Minor adjustments to site config

Comment thread docs/simpleXRPL/index.md Outdated
Comment thread docs/simpleXRPL/get-started.md Outdated
Comment thread docs/simpleXRPL/get-started.md Outdated

// Palisade — authenticates via OAuth client credentials and acts on a
// specific vault/wallet.
const palisade = await PalisadeCustody.create({

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just confirming that it's correct that we have no url for ripple custody but we do for palisade? @pdp2121

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that's correct afaik. Cant tag Cybele here to confirm

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just added her to review team, tagging @cybele-ripple

Comment thread docs/simpleXRPL/get-started.md Outdated
Comment thread docs/simpleXRPL/tutorials/issue-rwa-as-mpt.md Outdated
Comment thread docs/simpleXRPL/tutorials/issue-rwa-as-mpt.md Outdated
Comment thread docs/simpleXRPL/tutorials/issue-rwa-as-mpt.md
Comment thread docs/simpleXRPL/tutorials/issue-and-distribute-iou.md Outdated
Comment thread docs/simpleXRPL/tutorials/external-signer.md
Comment thread docs/simpleXRPL/tutorials/external-signer.md Outdated
Comment thread docs/simpleXRPL/references/index.md Outdated

@maria-robobug maria-robobug left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added mostly some style and formatting comments.

One thing to note, I think the use of "Token" for MPTs is confusing, but I get that this is how it's been implemented. It would be good if we could keep some of the terminology consistent with xrpl.org to avoid confusion.

Comment thread docs/simpleXRPL/get-started.md Outdated
Comment thread docs/simpleXRPL/index.md Outdated
Comment thread _code-samples/simplexrpl/getStarted.ts
Comment thread docs/simpleXRPL/get-started.md Outdated
Comment thread docs/simpleXRPL/get-started.md Outdated
Comment thread docs/simpleXRPL/references/verticals/token/unlock.md Outdated
Comment thread docs/simpleXRPL/references/verticals/token/unlock.md Outdated
Comment thread docs/simpleXRPL/references/verticals/xrp/transfer.md Outdated
Comment thread docs/simpleXRPL/references/verticals/xrp/transfer.md Outdated
Comment thread docs/simpleXRPL/references/index.md Outdated
Comment thread docs/simpleXRPL/tutorials/issue-rwa-as-mpt.md
Comment thread docs/simpleXRPL/references/index.md Outdated
brianstohl87-cpu

This comment was marked as spam.

oeggert and others added 6 commits July 27, 2026 11:49
Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com>
Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com>
Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com>
Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com>
## Example

```ts
const { address, seed } = client.account.create()

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update code sample to not be reached off client.


[[Source]](https://github.com/ripple/simpleXRPL/blob/50619258cf753008e8a185eaeb3ceca489e5998a/src/verticals/account.ts#L72)

Generate a new XRPL keypair locally and register it so it can be funded and used right away. Use this only to mint an additional account outside of `SimpleXRPL.init`.

@oeggert oeggert Jul 28, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add note: only meant for local connectors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants