From fd945a14ed2a4081eaa9fc182f1ecbe5c0b0c2c9 Mon Sep 17 00:00:00 2001 From: "Ryan G. Young" Date: Wed, 7 Apr 2021 13:43:50 -0700 Subject: [PATCH] add snippet for libraries --- content/_snippets/libs-snippet.md | 6 ++++++ .../rippled-api/api-conventions/serialization.md | 9 +-------- 2 files changed, 7 insertions(+), 8 deletions(-) create mode 100644 content/_snippets/libs-snippet.md diff --git a/content/_snippets/libs-snippet.md b/content/_snippets/libs-snippet.md new file mode 100644 index 0000000000..d24ee83201 --- /dev/null +++ b/content/_snippets/libs-snippet.md @@ -0,0 +1,6 @@ +| Language | Library Name | Get Started | API Reference | Source Code | +|----------|--------------|-------------|---------------|-------------| +| **Python** | `xrpl-py` | [Get Started](get-started-using-python.html) | [API Reference](https://xrpl-py.readthedocs.io/) | [Repo](https://github.com/XRPLF/xrpl-py) | +| **JavaScript** / **TypeScript** | `ripple-lib` | [Get Started](get-started-with-rippleapi-for-javascript.html) | [API Reference](rippleapi-reference.html) | [Repo](https://github.com/ripple/ripple-lib) | +| **C++** | `rippled` Signing Library | [Get Started](https://github.com/ripple/rippled/tree/develop/Builds/linux#signing-library) | | (Part of [`rippled`](https://github.com/ripple/rippled/)) | +| **Java** | `xrpl4j` | [README](https://github.com/XRPLF/xrpl4j#readme) | [API Reference](https://github.com/XRPLF/xrpl4j/tree/main/xrpl4j-integration-tests) | [Repo](https://github.com/XRPLF/xrpl4j) | \ No newline at end of file diff --git a/content/references/rippled-api/api-conventions/serialization.md b/content/references/rippled-api/api-conventions/serialization.md index 0ff2a8f479..e69eab2310 100644 --- a/content/references/rippled-api/api-conventions/serialization.md +++ b/content/references/rippled-api/api-conventions/serialization.md @@ -43,14 +43,7 @@ Both signed and unsigned transactions can be represented in both JSON and binary The serialization processes described here are implemented in multiple places and programming languages: -- **C++** - - [In the `rippled` code base](https://github.com/ripple/rippled/blob/develop/src/ripple/protocol/impl/STObject.cpp). -- **JavaScript** - - [In the `ripple-binary-codec` package](https://github.com/ripple/ripple-binary-codec/). -- **Python** - - [In the `xrpl-py` library](https://github.com/XRPLF/xrpl-py#serialize-and-sign-transactions). -- **Java** - - [In the `xrpl4j` library](https://github.com/XRPLF/xrpl4j). +{% include '_snippets/libs-snippet.md' %} These implementations are all provided with permissive open-source licenses, so you can import, use, or adapt the code for your needs in addition to using it alongside these documents for learning purposes.