mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 11:45:50 +00:00
some ui content files
This commit is contained in:
Jennifer Hasegawa
committed by
mDuo13
mDuo13
parent
7f3acbce3c
commit
dff42c9b88
26
content/dev-tools.md
Normal file
26
content/dev-tools.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# XRP Ledger Developer Tools
|
||||
We provide a set of developer tools to help you test, explore, and validate XRP Ledger API requests and behavior.
|
||||
|
||||
## [XRP Ledger Lookup Tool](x)
|
||||
Use this JSON-RPC-based debugging tool to print raw information about a XRP Ledger account, transaction, or ledger.
|
||||
|
||||
## [XRP Ledger Test Net](x)
|
||||
Use the WebSocket and JSON-RPC Test Net endpoints to test software built on the XRP Ledger without using real funds. Generate Test Net credentials and funds for testing purposes. The ledger and balances are reset on a regular basis.
|
||||
|
||||
For information about how to connect your `rippled` test server to the Test Net, see [XXXXX](x).
|
||||
|
||||
## [rippled API WebSocket Tool](x)
|
||||
Need to see the rippled API in action ASAP? Use this tool to send prepopulated sample requests and get responses. No setup required.
|
||||
<!--{# which methods are surfaced here -- is this all of them? #}-->
|
||||
|
||||
## [Data API v2 Tool](x)
|
||||
Need to see the Data API v2 in action ASAP? Use this tool to send prepopulated sample requests and get responses. No setup required.
|
||||
|
||||
## [rippled.txt Validator](x)
|
||||
Use this tool to verify that your `ripple.txt` is syntactically correct and deployed properly.
|
||||
|
||||
Have an idea for a tool not provided here? [Contact us](mailto:docs@ripple.com)
|
||||
|
||||
<!--stackedit_data:
|
||||
eyJoaXN0b3J5IjpbNjU2MDk5MDc3LC0xOTc1MDE3MTUwXX0=
|
||||
-->
|
||||
60
content/docs.md
Normal file
60
content/docs.md
Normal file
@@ -0,0 +1,60 @@
|
||||
# XRP Ledger Documentation
|
||||
|
||||
Dive into our documentation and start integrating with the XRP Ledger.
|
||||
|
||||
<!--{# primary promo modules #}-->
|
||||
## Concepts
|
||||
|
||||
Learn the "what" and "why" behind fundamental aspects of the XRP Ledger.
|
||||
|
||||
<!--{# content pulled in based on template #}-->
|
||||
|
||||
|
||||
## Tutorials
|
||||
|
||||
Get step-by-step guidance to perform common tasks with the XRP Ledger.
|
||||
|
||||
<!--{# content pulled in based on template #}-->
|
||||
|
||||
|
||||
## XRP References
|
||||
|
||||
Look up the ins-and-outs of our APIs, including sample requests and responses.
|
||||
|
||||
<!--{# content pulled in based on template #}-->
|
||||
|
||||
|
||||
------------------------------
|
||||
|
||||
|
||||
<!--{# secondary promo modules #}-->
|
||||
### Get Started
|
||||
|
||||
[Make a call to the rippled API](#)
|
||||
[Access the XRP Ledger Test Net](#)
|
||||
[Understand XRP Ledger Concepts](#)
|
||||
|
||||
|
||||
### Popular Docs
|
||||
<!--{# based on Google Analytics. will be more useful once content is more granular and in the new IA. update once we switchover. after that, check every couple of weeks, but should not change wildly after an initial recalibration based on new IA. #}-->
|
||||
|
||||
1. [rippled API Reference](#)
|
||||
2. [About the XRP Ledger Reserve](#)
|
||||
3. [Manage the `rippled` Server](#)
|
||||
4. [ripple-lib API for JavaScript](#)
|
||||
5. [About XRP Ledger Transactions](#)
|
||||
|
||||
|
||||
### Recently Updated
|
||||
<!--{# based on Google Analytics #}-->
|
||||
|
||||
- [Reliable Transaction Submission](#)
|
||||
- [How to Send a Check](#)
|
||||
- [Known Amendments](#)
|
||||
- [Capacity Planning in `rippled.cfg`](#)
|
||||
- [Stand
|
||||
-Alone Mode](#)
|
||||
<!--stackedit_data:
|
||||
eyJoaXN0b3J5IjpbMTk0NzU1MTE2MywtNjUwMzg5NjAsMjA0OD
|
||||
E3NjMwNiw0Nzg5NzQ3OTEsLTE4OTU5NzAxMjRdfQ==
|
||||
-->
|
||||
180
content/home.md
Normal file
180
content/home.md
Normal file
@@ -0,0 +1,180 @@
|
||||
# Learn. Experiment. Integrate. Contribute.
|
||||
|
||||
The [XRP Ledger](#) is built on rippled, an open-source technology that anyone can use. Use the tools provided here to integrate with and contribute to the open source platform.
|
||||
|
||||
<!--{# six primary promo modules #}-->
|
||||
# Take Me to the References
|
||||
|
||||
[rippled API](#)
|
||||
[ripple-lib for JavaScript](#)
|
||||
[Data API v2](#)
|
||||
|
||||
|
||||
# Get Started
|
||||
|
||||
[Make a call to the rippled API](#)
|
||||
[Access the XRP Ledger Test Net](#)
|
||||
[Understand XRP Ledger Concepts](#)
|
||||
|
||||
|
||||
# List XRP in Your exchange
|
||||
|
||||
Does your exchange want to list XRP?
|
||||
|
||||
[List XRP](x)
|
||||
|
||||
|
||||
# Run `rippled`
|
||||
|
||||
`rippled` is the core server of the XRP Ledger. Anyone can run one.
|
||||
|
||||
[Run `rippled`](x)
|
||||
|
||||
|
||||
# Contribute to `rippled`
|
||||
|
||||
Contribute code and bug reports to help improve `rippled`.
|
||||
|
||||
[Contribute Code](x)
|
||||
|
||||
|
||||
# Provide Liquidity in the XRP Ledger
|
||||
|
||||
Are you a market maker who wants to provide liquidity in the XRP Ledger?
|
||||
<!--{# this use case ID'd by SMEs is for a market maker providing liquidity - this is different from a gateway issuing currency, correct? Per SMEs, the gateway is for phase 2#}-->
|
||||
[Provide Liquidity](x)
|
||||
|
||||
|
||||
<!--{# two secondary promo modules #}-->
|
||||
# New and Updated Docs
|
||||
|
||||
[Reliable Transaction Submission](x)
|
||||
[`rippled` Capacity Planning](x)
|
||||
[How to Use Checks](x)
|
||||
|
||||
|
||||
# Known Amendments
|
||||
|
||||
Amendments provide a way to introduce new features to the decentralized XRP Ledger network without causing disruptions.
|
||||
|
||||
[View Known Amendments]()
|
||||
|
||||
|
||||
<!--{# XRP Ledger Intro #}-->
|
||||
# [XRP Ledger: A Decentralized Cryptographic Ledger](x)
|
||||
|
||||
The XRP Ledger is an open source, decentralized cryptographic ledger. It provides a distributed payment system enabling users to transfer value seamlessly around the world. XRP is the native digital asset of the XRP Ledger and is designed to bridge the many different currencies in use worldwide.
|
||||
|
||||
While there are many contributors, Ripple stewards the development of the XRP Ledger and advances XRP as a key contribution to the Internet of Value: a world in which money moves the way information does today.
|
||||
|
||||
[](img/image.png)
|
||||
|
||||
## [The Digital Asset for Payments](x)
|
||||
|
||||
XRP is a digital asset native to the XRP Ledger. Being an open source protocol, anyone with a cryptographic key and an internet connection can receive, hold, and send XRP to anyone else.
|
||||
|
||||
[](img/image.png)
|
||||
|
||||
## [Censorship-Resistant Transaction Processing](x)
|
||||
|
||||
No single party decides which XRP transactions succeed or fail, and no one can "roll back" a transaction after it completes.
|
||||
|
||||
|
||||
[](img/image.png)
|
||||
|
||||
## [Fast, Efficient Consensus Algorithm](x)
|
||||
|
||||
The XRP Ledger's consensus algorithm settles transactions in 3 to 5 seconds, processing at a throughput of 1,500 transactions per second.
|
||||
|
||||
|
||||
[](img/image.png)
|
||||
|
||||
## [Finite XRP Supply](x)
|
||||
|
||||
When the XRP Ledger began, 100 billion XRP were created, and no more XRP will ever be created. (Each XRP is subdivisible down to 6 decimal places.)
|
||||
|
||||
|
||||
[](img/image.png)
|
||||
|
||||
## [Responsible Software Governance](x)
|
||||
|
||||
A team of full-time, world-class developers at Ripple maintain and continually improve the XRP Ledger's underlying software.
|
||||
|
||||
|
||||
[](img/image.png)
|
||||
|
||||
## [Secure, Adaptable Cryptography](x)
|
||||
|
||||
The XRP Ledger relies on industry standard digital signature systems like ECDSA (the same scheme used by Bitcoin) but also supports modern algorithms like Ed25519.
|
||||
|
||||
|
||||
[](img/image.png)
|
||||
|
||||
## [Modern Features for Smart Contracts](x)
|
||||
|
||||
Features like Escrow, Checks, and Payment Channels support cutting-edge financial applications including the Interledger Protocol.
|
||||
|
||||
|
||||
[](img/image.png)
|
||||
|
||||
## [On-Ledger Centralized Exchange](x)
|
||||
|
||||
The XRP Ledger has a fully-functional accounting system for tracking and trading obligations denominated in any way users want, and an exchange built into the protocol.
|
||||
|
||||
[Learn More](x)
|
||||
|
||||
|
||||
<!--{# You're in Great Company -- still in review with Marcos, Warren, and Nik #}-->
|
||||
# Built on the XRP Ledger
|
||||
|
||||
Learn about just a few of the types of integrations developers have built on the XRP Ledger.
|
||||
|
||||
## Exchanges & Gateways
|
||||
|
||||
[](img/exchange.png)
|
||||
|
||||
Integrate your Exchange or Gateway with the XRP Ledger to enable your users to buy and sell XRP and issued currencies.
|
||||
|
||||
[Use Case](x)
|
||||
|
||||
## Market Makers
|
||||
|
||||
[](img/market-maker.png)
|
||||
|
||||
Integrate with the XRP Ledger to place offers algorithmically or through your own trading interface, providing liquidity between different gateways and their users.
|
||||
|
||||
[Use Case](x)
|
||||
|
||||
## Wallets
|
||||
|
||||
[](img/wallet.png)
|
||||
|
||||
Build a wallet app on the XRP Ledger to enable your users to send and trade XRP and other currencies issued by a gateway you trust.
|
||||
|
||||
_Use Case - Coming Soon_
|
||||
|
||||
Have an idea for a use case not listed here? [Contact us](projectlotus@ripple.com) <!--{# something like this - but these ideas should go to them, not to the doc team? #}-->
|
||||
|
||||
<!--{# Related Projects promo modules #}-->
|
||||
# Related Projects
|
||||
|
||||
Looking for other Ripple-related projects?
|
||||
|
||||
[](img/rcp-logo.png)
|
||||
|
||||
## [Ripple Client Portal](https://clients.ripple.com/) <!--{# open in new tab. display open in new tab icon. #}-->
|
||||
[](login required)](https://clients.ripple.com/)
|
||||
|
||||
For financial institutions using Ripple's proprietary solutions to send money globally.
|
||||
|
||||
|
||||
[](img/interledger-logo.png)
|
||||
|
||||
## [Interledger](https://interledger.org/) <!--{# open in new tab. display open in new tab icon. #}-->
|
||||
|
||||
Interledger is an open protocol suite for sending payments across different ledgers.
|
||||
<!--stackedit_data:
|
||||
eyJoaXN0b3J5IjpbLTE2NTk5MjUwLC0xNDY4MjgzMTE1LDEwMT
|
||||
k1OTYxOTMsLTE3MjUwOTAzNzcsNzYzNjk2NzQsLTM4OTM1NTIx
|
||||
NCw1MTEyNDE4NDMsLTIxMDQyOTczMzcsOTMwMDM0NDQzXX0=
|
||||
-->
|
||||
31
content/news.md
Normal file
31
content/news.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# XRP Ledger News and Releases
|
||||
|
||||
Get the latest XRP Ledger news and release information.
|
||||
|
||||
<!--{# area will eventually include a Network Health page #}-->
|
||||
|
||||
## Known Amendments
|
||||
|
||||
Amendments provide a way to introduce new features to the decentralized XRP Ledger network without causing disruptions. Get the comprehensive list of [all known amendments](x) and their statuses on the production XRP Ledger. <!--{# check with Nik. Not just NEW - changes to transaction processing for example #}-->
|
||||
|
||||
## Ripple Dev Blog
|
||||
|
||||
[Visit the Dev Blog](https://ripple.com/category/dev-blog/) <!--{# open link in new tab. display open in new tab icon #}--> for the latest news and stories about the XRP Ledger and `rippled`.
|
||||
|
||||
## Ripple Open Source Project Releases
|
||||
|
||||
[Visit the ripple GitHub repo](https://github.com/ripple) <!--{# open link in new tab. display open in new tab icon #}--> to access open source projects, including `rippled`, `ripple-lib`, and `ripple-libpp`.
|
||||
|
||||
## Interledger
|
||||
|
||||
[Learn about Interledger](https://interledger.org/)<!--{# open link in new tab. display open in new tab icon #}-->, an open protocol suite for sending payments across different ledgers. The open architecture and minimal protocol enable interoperability for any value transfer system.<!--{# grab from site #}-->
|
||||
|
||||
### Related Resources
|
||||
[rippled API Reference](x)
|
||||
[Manage a `rippled` Server](x)
|
||||
[XRP Test Net](x)
|
||||
|
||||
<!--stackedit_data:
|
||||
eyJoaXN0b3J5IjpbLTE5NTUwNzIzNDksMzk2Njc1MjA3LDEwMT
|
||||
U1OTE0MjhdfQ==
|
||||
-->
|
||||
45
content/references.md
Normal file
45
content/references.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# References
|
||||
|
||||
## [`rippled` API Reference](x)
|
||||
<!--{# provide link to PDF #}-->
|
||||
Use the `rippled` API to communicate with a rippled server, the core peer-to-peer server that manages the XRP Ledger.
|
||||
|
||||
### [Public `rippled` API Methods](x)
|
||||
Communicate directly with a `rippled` server using these public API methods.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [Admin `rippled` API Methods](x)
|
||||
Communicate directly with a `rippled` server using these admin-only API methods.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [Transaction Formats](x)
|
||||
A transaction is the only way to modify the XRP Ledger. Get details about its required format.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [Ledger Data Formats](x)
|
||||
Learn about the format of individual ledgers that make up the shared, global XRP Ledger.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [API Conventions](x)
|
||||
Get details about these common conventions used across the `rippled` API.
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
|
||||
## Other `rippled` API Interfaces
|
||||
Here are a couple of other ways to interface with the `rippled` API.
|
||||
|
||||
### [ripple-lib for JavaScript Reference](x)
|
||||
<!--{# provide link to PDF #}-->
|
||||
Official client library to the XRP Ledger. Available for JavaScript only.
|
||||
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
### [Data API v2 Reference](x)
|
||||
<!--{# provide link to PDF #}-->
|
||||
Access info about changes to the XRP Ledger, including transaction history and analytics.
|
||||
|
||||
<!--{# content populated based on hierarchy and template #}-->
|
||||
|
||||
<!--stackedit_data:
|
||||
eyJoaXN0b3J5IjpbNTk0MDQ2NzBdfQ==
|
||||
-->
|
||||
33
content/use-cases.md
Normal file
33
content/use-cases.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# XRP Ledger Use Cases
|
||||
|
||||
Use these roadmaps to walk you, task-by-task, through implementing your use case.
|
||||
|
||||
Here are some of our users' most popular use cases:
|
||||
|
||||
## [List XRP in My Exchange](x)
|
||||
|
||||
Integrate with the XRP Ledger to be able to list XRP in your exchange, enabling your users to deposit and withdraw XRP.
|
||||
|
||||
## [Provide Liquidity in the XRP Ledger](x)
|
||||
|
||||
Integrate with the XRP Ledger to place offers algorithmically or through your own custom trading interface, providing liquidity between different gateways and their users.
|
||||
|
||||
## [Contribute Code to `rippled`](x)
|
||||
|
||||
Help us improve the open source reference server implementation of `rippled`, the server that is the core of the XRP Ledger peer-to-peer network.
|
||||
|
||||
## [Maintain `rippled` Servers](x)
|
||||
|
||||
Learn how to install, run, and maintain a `rippled` server, whether you need a stock server, test server, or robust production validator. <!--{# sound okay? #}-->
|
||||
|
||||
Want to see a roadmap for a case not listed here? [Contact us](mailto:docs@ripple.com) <!--{# should we have a contact us icon just to make this call to engagement stand out a bit more? #}-->
|
||||
|
||||
### Related Resources
|
||||
[Access the XRP Ledger Test Net](x)
|
||||
[rippled API Reference](x)
|
||||
[ripple-lib for JavaScript Reference](x)
|
||||
|
||||
<!--stackedit_data:
|
||||
eyJoaXN0b3J5IjpbMTg5MDA4Mjk1MCwtOTE1NDI0MDcwLC0yMT
|
||||
Q3NjYwOTEsLTE1MzI4MzQ3MzAsLTU5MTU2MjMzOV19
|
||||
-->
|
||||
Reference in New Issue
Block a user