Merge pull request #2215 from XRPLF/place_indexes

Add index md files
This commit is contained in:
Rome Reginelli
2023-10-18 13:44:23 -07:00
committed by GitHub
105 changed files with 1007 additions and 503 deletions

View File

@@ -0,0 +1,9 @@
---
html: concepts.html
parent: docs.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# コンセプト
XRP Ledgerの基本的な部分の背景に「何があるか」、「なぜなのか」を学びましょう。

View File

@@ -0,0 +1,9 @@
---
html: payment-types.html
parent: concepts.html
template: pagetype-category.html.jinja
blurb: XRP LedgerはポイントツーポイントのXRPペイメントのほかに、より専門的な支払いタイプをサポートしています。
---
# 支払いのタイプ
XRP LedgerはポイントツーポイントのXRPペイメントのほかに、より専門的な支払いタイプをサポートしています。

View File

@@ -3,6 +3,7 @@ html: report-a-scam.html
parent: contribute.html parent: contribute.html
--- ---
# 詐欺の報告 # 詐欺の報告
発展する業界において、信頼とセキュリティは非常に重要ですが、詐欺はクリプトとブロックチェーンの進歩を妨げ続けています。Xrplorer forensicsチームのようなXRP Ledgerコミュニティ全体の個人やチームは、詐欺を報告するための無料ツールを提供することで、これらの詐欺行為を抑制する手助けをしています。 発展する業界において、信頼とセキュリティは非常に重要ですが、詐欺はクリプトとブロックチェーンの進歩を妨げ続けています。Xrplorer forensicsチームのようなXRP Ledgerコミュニティ全体の個人やチームは、詐欺を報告するための無料ツールを提供することで、これらの詐欺行為を抑制する手助けをしています。
## 報告する ## 報告する

View File

@@ -0,0 +1,9 @@
---
html: configure-rippled.html
parent: infrastructure.html
template: pagetype-category.html.jinja
blurb: rippledサーバーの構成をカスタマイズします。
---
# rippledの設定
rippledサーバーの構成をカスタマイズします。

View File

@@ -0,0 +1,9 @@
---
html: infrastructure.html
parent: docs.html
template: pagetype-category.html.jinja
top_nav_grouping: カテゴリ
---
# インフラストラクチャ
XRP Ledgerを動かすソフトウェアのインストール、設定、管理。

View File

@@ -0,0 +1,9 @@
---
html: install-rippled.html
parent: infrastructure.html
template: pagetype-category.html.jinja
blurb: rippledサーバーをインストールして更新します。
---
# rippledのインストール
rippledサーバーをインストールして更新します。

View File

@@ -0,0 +1,9 @@
---
html: use-stand-alone-mode.html
parent: infrastructure.html
template: pagetype-category.html.jinja
blurb: 新機能や実験用に、スタンドアロンモードを使用してフルネットワークで機能をテストできます。
---
# スタンドアロンモードでrippledをテスト
新機能や実験用に、スタンドアロンモードを使用してフルネットワークで機能をテストできます。

View File

@@ -0,0 +1,9 @@
---
html: troubleshoot-the-rippled-server.html
parent: infrastructure.html
template: pagetype-category.html.jinja
blurb: rippledサーバーのあらゆる種類の問題をトラブルシューティングします。
---
# rippledのトラブルシューティング
rippledサーバーのあらゆる種類の問題をトラブルシューティングします。

View File

@@ -0,0 +1,9 @@
---
html: introduction.html
parent: docs.html
template: pagetype-category.html.jinja
top_nav_grouping: カテゴリ
---
# 基本
XRP Ledger(XRPL)の主要な機能を簡単に紹介します。これを読んでXRPLのハイレベルな理解を深め、その後、特に興味のある分野についての詳細を読むことができます。XRP Ledgerは、アカウント間のトークンのデジタルトランザクションを永続的に記録するブロックチェーンです。以下のセクションは、その文章で紹介された概念を拡張するものです。

View File

@@ -0,0 +1,8 @@
---
html: key-generation-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# キー生成メソッド
以下のメソッドを使用してキーを生成および管理することができます。

View File

@@ -0,0 +1,8 @@
---
html: logging-and-data-management-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# ログとデータの管理メソッド
以下のメソッドを使用して、ログレベルや台帳などのデータを管理することができます。

View File

@@ -0,0 +1,8 @@
---
html: peer-management-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# ピア管理メソッド
以下のメソッドを使用して、サーバーのピアツーピア接続を管理することができます。

View File

@@ -0,0 +1,8 @@
---
html: server-control-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# サーバ操作メソッド
以下のメソッドを使用して、rippledサーバーを管理することができます。

View File

@@ -0,0 +1,8 @@
---
html: signing-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# 署名メソッド
以下のメソッドを使用して、トランザクションを扱うことができます。

View File

@@ -0,0 +1,8 @@
---
html: status-and-debugging-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# ステータスとデバッグのメソッド
以下のメソッドを使用して、ネットワークとサーバーのステータスを確認することができます。

View File

@@ -0,0 +1,8 @@
---
html: http-websocket-apis.html
parent: references.html
template: pagetype-category.html.jinja
---
# HTTP / WebSocket API リファレンス
XRP Ledgerを管理するコアのピアツーピアサーバーであるrippledと直接通信します。

View File

@@ -0,0 +1,8 @@
---
html: peer-port-methods.html
parent: http-websocket-apis.html
template: pagetype-category.html.jinja
---
# ピアポートメソッド
ネットワークトポロジーやステータスメトリクスを共有するための特別なAPIメソッドです。

View File

@@ -0,0 +1,8 @@
---
html: account-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Accountメソッド
XRP Ledgerのアカウントとは、XRPの保有者とトランザクションの送信者を意味します。以下のメソッドを使用して、アカウント情報を処理することができます。

View File

@@ -0,0 +1,8 @@
---
html: clio-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Clio Serverメソッド
以下のメソッドを使用して、ClioサーバーのAPIから情報を取得することができます。

View File

@@ -0,0 +1,8 @@
---
html: ledger-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Ledgerメソッド
レジャーバージョンには、ヘッダー、トランザクションツリー、状態ツリーが含まれ、さらにその中にアカウント設定、トラストライン、残高、トランザクション、その他のデータが含まれます。以下のメソッドを使用して、レジャー情報を取得することができます。

View File

@@ -0,0 +1,8 @@
---
html: path-and-order-book-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# PathおよびOrderBookのメソッド
パスは、支払いが送信者から受信者に届くまでに中間ステップでたどる道筋を定義します。パスは、送信者と受信者をオーダーブックを介してつなぐことで、複数通貨間の支払いを可能にします。パスと他のオーダーブックに関しては、以下のメソッドを使用します。

View File

@@ -0,0 +1,8 @@
---
html: payment-channel-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Payment Channelメソッド
Payment Channelは、2者間で繰り返される一方向の支払いや一時的な与信を可能にするためのツールです。これらのメソッドを使用して、Payment Channelを使用することができます。

View File

@@ -0,0 +1,8 @@
---
html: server-info-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Server Infoメソッド
以下のメソッドを使用して、rippledサーバーの現在の状態についての情報を取得することができます。

View File

@@ -0,0 +1,8 @@
---
html: subscription-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Subscriptionメソッド
以下のメソッドを使用して、さまざまなイベントが発生したときに更新情報をサーバーからクライアントにプッシュできるようになるため、即座に情報を取得することができます。WebSocket APIのみ対応しています。

View File

@@ -0,0 +1,8 @@
---
html: transaction-methods.html # watch for clashes w/ this filename
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Transactionメソッド
トランザクションだけが、XRP Ledgerの共有されている状態を変更できます。XRP Ledgerに対するすべてのビジネスはトランザクションの形態をとります。以下のメソッドを使用して、トランザクションを処理します。

View File

@@ -0,0 +1,8 @@
---
html: utility-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# ユーティリティメソッド
以下のメソッドを使用して、Pingや乱数生成などの便利な処理を行うことができます。

View File

@@ -0,0 +1,10 @@
---
html: protocol-reference.html
parent: references.html
template: pagetype-category.html.jinja
eyebrow_text: 特徴とルール
blurb: XRP Ledgerプロトコルの、利用方法に依存しない特徴やルールについて。
---
# XRP Ledgerプロトコルリファレンス
XRP Ledgerプロトコルの、利用方法に依存しない特徴やルールについて。

View File

@@ -0,0 +1,8 @@
---
html: resources.html
parent: index.html
template: pagetype-category.html.jinja
---
# リソース
XRP Ledgerの理解や開発ためのリソース。Other resources to help understand the XRPL and develop on it.

View File

@@ -0,0 +1,9 @@
---
html: http-websocket-apis-tutorials.html
parent: tutorials.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# HTTP / Websocket API
HTTP / Websocket APIのXRPLチュートリアルです。

View File

@@ -0,0 +1,9 @@
---
html: java.html
parent: tutorials.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# Java
JavaでのXRPLチュートリアルです。

View File

@@ -0,0 +1,9 @@
---
html: javascript.html
parent: tutorials.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# JavaScript
JavaScriptでのXRPLチュートリアルです。

View File

@@ -0,0 +1,9 @@
---
html: modular-tutorials-in-javascript.html
parent: javascript.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# JavaScriptのモジュール形式チュートリアル
JavaScriptによるモジュール式XRPLチュートリアルです。

View File

@@ -0,0 +1,9 @@
---
html: nfts-using-javascript.html
parent: modular-tutorials-in-javascript.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# JavaScriptを使ったNFT
XRP Ledger上でNFTのミントと販売を行います。

View File

@@ -0,0 +1,9 @@
---
html: python.html
parent: tutorials.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# Python
PythonでのXRPLチュートリアルです。

View File

@@ -0,0 +1,9 @@
---
html: modular-tutorials-in-python.html
parent: python.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# Pythonのモジュール形式チュートリアル
Pythonによるモジュール式XRPLチュートリアル。

View File

@@ -0,0 +1,9 @@
---
html: tasks.html
parent: tutorials.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# タスク
XRP Ledgerの代表的なタスクです。

View File

@@ -0,0 +1,8 @@
---
html: manage-account-settings.html
parent: tasks.html
template: pagetype-category.html.jinja
---
# アカウントの設定の利用
XRP Ledgerアカウントを設定して、思い通りの支払いをしましょう。

View File

@@ -0,0 +1,8 @@
---
html: use-specialized-payment-types.html
parent: tasks.html
template: pagetype-category.html.jinja
---
# 専門的な支払いタイプの使用
EscrowやPayment Channelなどの高度な機能を使用して、XRP Ledgerでスマートアプリケーションを構築しましょう。

View File

@@ -0,0 +1,8 @@
---
html: use-escrows.html
parent: use-specialized-payment-types.html
template: pagetype-category.html.jinja
---
# Escrowの使用
XRP Ledgerは、一定時間の経過後か暗号条件が満たされた場合にのみ実行されるEscrowをサポートします。Escrowが送金できるのはXRPのみで、発行済み通貨は送金できません。

View File

@@ -0,0 +1,8 @@
---
html: use-tokens.html
parent: tasks.html
template: pagetype-category.html.jinja
---
# トークンの利用
XRP Ledgerでトークン(代替型やそれ以外)を発行し、取引しましょう

View File

@@ -0,0 +1,10 @@
---
html: defi-uc.html
parent: use-cases.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
blurb: 中央機関を介さずに、高速で安全な金融トランザクションを可能にします。
---
# DeFi
中央機関を介さずに、高速で安全な金融トランザクションを可能にします。

View File

@@ -0,0 +1,9 @@
---
html: use-cases.html
parent: docs.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
---
# ユースケース
実践的なユースケースに基づいたドキュメントをご覧ください。

View File

@@ -0,0 +1,10 @@
---
html: payments-uc.html
parent: use-cases.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
blurb: XRP Ledgerで様々なタイプの支払いを利用するための実例を紹介します。
---
# Payment
XRP Ledgerで様々なタイプの支払いを利用するための実例を紹介します。

View File

@@ -0,0 +1,10 @@
---
html: tokenization.html
parent: use-cases.html
top_nav_grouping: カテゴリ
template: pagetype-category.html.jinja
blurb: XRP Ledgerが対応する様々なトークンを使用できます。
---
# Tokenization
XRP Ledgerが対応する様々なトークンを使用できます。

View File

@@ -0,0 +1,9 @@
---
html: concepts.html
parent: docs.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# Concepts
Learn the "what" and "why" behind fundamental aspects of the XRP Ledger.

View File

@@ -0,0 +1,9 @@
---
html: payment-types.html
parent: concepts.html
template: pagetype-category.html.jinja
blurb: The XRP Ledger supports point-to-point XRP payments alongside other, more specialized payment types.
---
# Payment Types
The XRP Ledger supports point-to-point XRP payments alongside other, more specialized payment types.

View File

@@ -3,6 +3,7 @@ html: report-a-scam.html
parent: contribute.html parent: contribute.html
--- ---
# Report a Scam # Report a Scam
In an evolving industry where trust and security are critical, scams continue to impede progress in crypto and blockchain. Individuals and teams across the XRP Ledger community, like the Xrplorer forensics team, help mitigate these scammers by providing free tools to report scams. In an evolving industry where trust and security are critical, scams continue to impede progress in crypto and blockchain. Individuals and teams across the XRP Ledger community, like the Xrplorer forensics team, help mitigate these scammers by providing free tools to report scams.
## Take Action ## Take Action
@@ -12,7 +13,7 @@ If you think you've been scammed, make sure to collect as much information as yo
1. Submit the scammer's wallet address to [Xrplorer's forensics team](https://xrplorer.com/forensics/submit). 1. Submit the scammer's wallet address to [Xrplorer's forensics team](https://xrplorer.com/forensics/submit).
This helps to flag accounts used for illicit activity and include them in additional monitoring, auto-tracing, and warnings for other users, wallets, and exchanges. This helps to flag accounts used for illicit activity and include them in additional monitoring, auto-tracing, and warnings for other users, wallets, and exchanges.
2. Report your case to your local law enforcement. If the scammer is caught, you may be able to get your money back. 2. Report your case to your local law enforcement. If the scammer is caught, you may be able to get your money back.

View File

@@ -0,0 +1,9 @@
---
html: data-retention.html
parent: configure-rippled.html
template: pagetype-category.html.jinja
blurb: Control how much data your server should keep and when it should remove old data.
---
# Data Retention
Control how much data your server should keep and when it should remove old data, including old versions of the ledger state and past transactions.

View File

@@ -0,0 +1,9 @@
---
html: configure-rippled.html
parent: infrastructure.html
template: pagetype-category.html.jinja
blurb: Customize your rippled server configuration.
---
# Configure rippled
Customize your rippled server configuration.

View File

@@ -0,0 +1,9 @@
---
html: server-modes.html
parent: configure-rippled.html
template: pagetype-category.html.jinja
blurb: Information on how to run a core server in different modes specialized for different purposes.
---
# Server Modes
The core XRP Ledger server can run in different modes specialized for different purposes.

View File

@@ -0,0 +1,9 @@
---
html: infrastructure.html
parent: docs.html
template: pagetype-category.html.jinja
top_nav_grouping: Article Types
---
# Infrastructure
Install, configure, and manage the software that powers the XRP Ledger.

View File

@@ -0,0 +1,10 @@
---
html: install-rippled.html
parent: infrastructure.html
top_nav_name: Install & Configure
template: pagetype-category.html.jinja
blurb: Install and update the rippled server.
---
# Install rippled
Install and update the rippled server.

View File

@@ -0,0 +1,9 @@
---
html: use-stand-alone-mode.html
parent: infrastructure.html
template: pagetype-category.html.jinja
blurb: For new features and experiments, you can use Stand-Alone Mode to test features with a full network.
---
# Testing and Auditing
For new features and experiments, you can use Stand-Alone Mode to test features with a full network.

View File

@@ -0,0 +1,9 @@
---
html: troubleshoot-the-rippled-server.html
parent: infrastructure.html
template: pagetype-category.html.jinja
blurb: Troubleshoot all kinds of problems with the rippled server.
---
# Troubleshooting
Troubleshoot all kinds of problems with the rippled server.

View File

@@ -0,0 +1,9 @@
---
html: introduction.html
parent: docs.html
template: pagetype-category.html.jinja
top_nav_grouping: Article Types
---
# Introduction
This is a quick introduction to the principal features of the XRP Ledger (XRPL). Read this to get a high level understanding of the XRPL, then you can read more about areas of particular interest. The XRP Ledger is a blockchain that permanently records digital transactions of tokens between accounts. The sections below expand on the concepts introduced in that sentence.

View File

@@ -0,0 +1,8 @@
---
html: key-generation-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Key Generation Methods
Use these methods to generate and manage keys.

View File

@@ -0,0 +1,8 @@
---
html: logging-and-data-management-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Logging and Data Management Methods
Use these methods to manage log levels and other data, such as ledgers.

View File

@@ -0,0 +1,8 @@
---
html: peer-management-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Peer Management Methods
Use these methods to manage your server's peer-to-peer connections.

View File

@@ -0,0 +1,8 @@
---
html: server-control-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Server Control Methods
Use these methods to manage the rippled server.

View File

@@ -7,6 +7,7 @@ labels:
- Core Server - Core Server
--- ---
# validation_seed # validation_seed
[[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ValidationSeed.cpp "Source") [[Source]](https://github.com/XRPLF/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ValidationSeed.cpp "Source")
The `validation_seed` command temporarily sets the secret value that rippled uses to sign validations. This value resets based on the config file when you restart the server. [Disabled since: rippled 0.29.1](https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1 "BADGE_RED") The `validation_seed` command temporarily sets the secret value that rippled uses to sign validations. This value resets based on the config file when you restart the server. [Disabled since: rippled 0.29.1](https://github.com/XRPLF/rippled/releases/tag/0.29.1-rc1 "BADGE_RED")

View File

@@ -0,0 +1,8 @@
---
html: signing-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Signing Methods
Use these methods to work with transactions.

View File

@@ -0,0 +1,8 @@
---
html: status-and-debugging-methods.html
parent: admin-api-methods.html
template: pagetype-category.html.jinja
---
# Status and Debugging Methods
Use these methods to check the status of the network and server.

View File

@@ -0,0 +1,8 @@
---
html: http-websocket-apis.html
parent: references.html
template: pagetype-category.html.jinja
---
# HTTP / WebSocket APIs
Communicate directly with rippled, the core peer-to-peer server that manages the XRP Ledger.

View File

@@ -0,0 +1,11 @@
---
html: peer-port-methods.html
parent: http-websocket-apis.html
template: pagetype-category.html.jinja
blurb: Special API methods for sharing network topology and status metrics, served on the XRPL Peer Protocol port.
---
# Peer Port Methods
Separate from the [WebSocket / HTTP APIs](http-websocket-apis.html), `rippled` servers provide a few special API methods from the same port they use for XRP Ledger [peer protocol](peer-protocol.html) communications. These methods provide status information about the server itself and its connectivity to the peer-to-peer network, and are intended mainly for monitoring and administration.
**Security:** Most `rippled` servers use a self-signed TLS certificate to respond to peer port requests. By default, most tools (including web browsers) flag or block such responses for being untrusted. You must ignore the certificate checking (for example, if using cURL, add the `--insecure` flag) to display a response from those servers, or configure the server with a TLS certificate signed by a known Certificate Authority.

View File

@@ -0,0 +1,8 @@
---
html: account-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Account Methods
An account in the XRP Ledger represents a holder of XRP and a sender of transactions. Use these methods to work with account info.

View File

@@ -0,0 +1,8 @@
---
html: clio-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Clio Server
Use these methods to retrieve information using Clio server APIs.

View File

@@ -0,0 +1,8 @@
---
html: ledger-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Ledger Methods
A ledger version contains a header, a transaction tree, and a state tree, which contain account settings, trustlines, balances, transactions, and other data. Use these methods to retrieve ledger info.

View File

@@ -0,0 +1,8 @@
---
html: path-and-order-book-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Path and Order Book Methods
Paths define a way for payments to flow through intermediary steps on their way from sender to receiver. Paths enable cross-currency payments by connecting sender and receiver through order books. Use these methods to work with paths and other books.

View File

@@ -0,0 +1,8 @@
---
html: payment-channel-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Payment Channel Methods
Payment channels are a tool for facilitating repeated, unidirectional payments, or temporary credit between two parties. Use these methods to work with payment channels.

View File

@@ -0,0 +1,8 @@
---
html: server-info-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Server Info Methods
Use these methods to retrieve information about the current state of the rippled server.

View File

@@ -6,6 +6,7 @@ labels:
- Core Server - Core Server
--- ---
# server_state # server_state
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ServerState.cpp "Source") [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/ServerState.cpp "Source")
The `server_state` command asks the server for various machine-readable information about the `rippled` server's current state. The response is almost the same as the [server_info method][], but uses units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.) The `server_state` command asks the server for various machine-readable information about the `rippled` server's current state. The response is almost the same as the [server_info method][], but uses units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.)

View File

@@ -0,0 +1,8 @@
---
html: subscription-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Subscription Methods
Use these methods to enable the server to push updates to your client when various events happen, so that you can know and react right away. WebSocket API only.

View File

@@ -9,6 +9,7 @@ labels:
- Smart Contracts - Smart Contracts
--- ---
# unsubscribe # unsubscribe
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Unsubscribe.cpp "Source") [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Unsubscribe.cpp "Source")
The `unsubscribe` command tells the server to stop sending messages for a particular subscription or set of subscriptions. The `unsubscribe` command tells the server to stop sending messages for a particular subscription or set of subscriptions.

View File

@@ -0,0 +1,8 @@
---
html: transaction-methods.html # watch for clashes w/ this filename
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Transaction Methods
Transactions are the only thing that can modify the shared state of the XRP Ledger. All business on the XRP Ledger takes the form of transactions. Use these methods to work with transactions.

View File

@@ -7,6 +7,7 @@ labels:
- Payments - Payments
--- ---
# tx # tx
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Tx.cpp "Source") [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Tx.cpp "Source")
The `tx` method retrieves information on a single [transaction](transaction-formats.html), by its [identifying hash][]. The `tx` method retrieves information on a single [transaction](transaction-formats.html), by its [identifying hash][].

View File

@@ -0,0 +1,8 @@
---
html: utility-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
---
# Utility Methods
Use these methods to perform convenient tasks, such as ping and random number generation.

View File

@@ -6,6 +6,7 @@ labels:
- Core Server - Core Server
--- ---
# random # random
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Random.cpp "Source") [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/Random.cpp "Source")
The `random` command provides a random number to be used as a source of entropy for random number generation by clients. The `random` command provides a random number to be used as a source of entropy for random number generation by clients.

View File

@@ -0,0 +1,10 @@
---
html: protocol-reference.html
parent: references.html
template: pagetype-category.html.jinja
eyebrow_text: Features and Rules
blurb: Features and rules of the XRP Ledger protocol, regardless of how you access it.
---
# XRP Ledger Protocol Reference
Features and rules of the XRP Ledger protocol, regardless of how you access it.

View File

@@ -6,6 +6,7 @@ labels:
- Security - Security
--- ---
# SignerListSet # SignerListSet
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/SetSignerList.cpp "Source") [[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/tx/impl/SetSignerList.cpp "Source")
The SignerListSet transaction creates, replaces, or removes a list of signers that can be used to [multi-sign](multi-signing.html) a transaction. This transaction type was introduced by the [MultiSign amendment][]. The SignerListSet transaction creates, replaces, or removes a list of signers that can be used to [multi-sign](multi-signing.html) a transaction. This transaction type was introduced by the [MultiSign amendment][].

View File

@@ -0,0 +1,8 @@
---
html: resources.html
parent: index.html
template: pagetype-category.html.jinja
---
# Resources
Other resources to help understand the XRP Ledger and develop on it.

View File

@@ -94,6 +94,7 @@ This method returns a [`Wallet` instance](https://xrpl-py.readthedocs.io/en/late
print(test_wallet) print(test_wallet)
# print output # print output
public_key:: 022FA613294CD13FFEA759D0185007DBE763331910509EF8F1635B4F84FA08AEE3 public_key:: 022FA613294CD13FFEA759D0185007DBE763331910509EF8F1635B4F84FA08AEE3
private_key:: -HIDDEN- private_key:: -HIDDEN-
classic_address: raaFKKmgf6CRZttTVABeTcsqzRQ51bNR6Q classic_address: raaFKKmgf6CRZttTVABeTcsqzRQ51bNR6Q

View File

@@ -0,0 +1,9 @@
---
html: http-websocket-apis-tutorials.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# HTTP / Websocket APIs
XRPL tutorials for HTTP / Websocket APIs.

View File

@@ -0,0 +1,9 @@
---
html: java.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# Java
XRPL tutorials in Java.

View File

@@ -0,0 +1,9 @@
---
html: javascript.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# JavaScript
XRPL tutorials in JavaScript.

View File

@@ -0,0 +1,9 @@
---
html: modular-tutorials-in-javascript.html
parent: javascript.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# Modular Tutorials in JavaScript
Modular XRPL tutorials in JavaScript.

View File

@@ -0,0 +1,9 @@
---
html: nfts-using-javascript.html
parent: modular-tutorials-in-javascript.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# NFTs Using JavaScript
Mint and sell NFTs on the XRP Ledger using JavaScript.

View File

@@ -0,0 +1,9 @@
---
html: python.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# Python
XRPL tutorials in Python.

View File

@@ -0,0 +1,10 @@
---
html: modular-tutorials-in-python.html
parent: python.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
blurb: Modular XRPL tutorials in Python.
---
# Modular Tutorials in Python
These tutorials take an incremental approach to implementing functionality, so you can reuse parts from the earlier tutorials on your way to making more advanced software.

View File

@@ -0,0 +1,10 @@
---
html: nfts-using-python.html
parent: modular-tutorials-in-python.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
blurb: Mint and sell NFTs on the XRP Ledger using Python.
---
# NFTs Using Python
Mint and sell NFTs on the XRP Ledger using Python.

View File

@@ -551,7 +551,7 @@ def standby_cancel_offer():
ent_standby_nft_offer_index.get() ent_standby_nft_offer_index.get()
) )
text_standby_results.delete("1.0", tk.END) text_standby_results.delete("1.0", tk.END)
text_standby_results.insert("1.0", json.dumps(results, indent=4)) text_standby_results.insert("1.0", json.dumps(results, indent=4))
def op_create_sell_offer(): def op_create_sell_offer():
results = create_sell_offer( results = create_sell_offer(
ent_operational_seed.get(), ent_operational_seed.get(),
@@ -579,7 +579,7 @@ def op_create_buy_offer():
ent_operational_destination.get() ent_operational_destination.get()
) )
text_operational_results.delete("1.0", tk.END) text_operational_results.delete("1.0", tk.END)
text_operational_results.insert("1.0", json.dumps(results, indent=4)) text_operational_results.insert("1.0", json.dumps(results, indent=4))
def op_accept_buy_offer(): def op_accept_buy_offer():
results = accept_buy_offer ( results = accept_buy_offer (
ent_operational_seed.get(), ent_operational_seed.get(),
@@ -597,7 +597,7 @@ def op_cancel_offer():
ent_operational_nft_offer_index.get() ent_operational_nft_offer_index.get()
) )
text_operational_results.delete("1.0", tk.END) text_operational_results.delete("1.0", tk.END)
text_operational_results.insert("1.0", json.dumps(results, indent=4)) text_operational_results.insert("1.0", json.dumps(results, indent=4))
# Module 3 Handlers # Module 3 Handlers
@@ -690,10 +690,10 @@ def operational_configure_account():
def get_balances(): def get_balances():
results = get_balance(ent_operational_account.get(), ent_standby_account.get()) results = get_balance(ent_operational_account.get(), ent_standby_account.get())
text_standby_results.delete("1.0", tk.END) text_standby_results.delete("1.0", tk.END)
text_standby_results.insert("1.0", json.dumps(results, indent=4)) text_standby_results.insert("1.0", json.dumps(results, indent=4))
results = get_balance(ent_standby_account.get(), ent_operational_account.get()) results = get_balance(ent_standby_account.get(), ent_operational_account.get())
text_operational_results.delete("1.0", tk.END) text_operational_results.delete("1.0", tk.END)
text_operational_results.insert("1.0", json.dumps(results, indent=4)) text_operational_results.insert("1.0", json.dumps(results, indent=4))
# Module 1 Handlers # Module 1 Handlers
def get_standby_account(): def get_standby_account():
@@ -996,7 +996,7 @@ btn_op_burn_token = tk.Button(master=frm_form, text="Burn NFT",
btn_op_burn_token.grid(row=10, column=3, sticky="nsew") btn_op_burn_token.grid(row=10, column=3, sticky="nsew")
``` ```
Add buttons for transferring NFTs. Add buttons for transferring NFTs.
```python ```python
btn_op_create_sell_offer = tk.Button(master=frm_form, text="Create Sell Offer", btn_op_create_sell_offer = tk.Button(master=frm_form, text="Create Sell Offer",

View File

@@ -0,0 +1,9 @@
---
html: tasks.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# Tasks
Common tasks on the XRP Ledger.

View File

@@ -0,0 +1,8 @@
---
html: manage-account-settings.html
parent: tasks.html
template: pagetype-category.html.jinja
---
# Manage Account Settings
Set up your XRP Ledger account to send and receive payments the way you want it to.

View File

@@ -0,0 +1,8 @@
---
html: use-specialized-payment-types.html
parent: tasks.html
template: pagetype-category.html.jinja
---
# Use Specialized Payment Types
Use advanced features like Escrow and Payment Channels to build smart applications on the XRP Ledger.

View File

@@ -0,0 +1,8 @@
---
html: use-escrows.html
parent: use-specialized-payment-types.html
template: pagetype-category.html.jinja
---
# Use Escrows
The XRP Ledger supports escrows that can be executed only after a certain time has passed or a cryptographic condition has been fulfilled. Escrows can only send XRP, not issued currencies.

View File

@@ -0,0 +1,8 @@
---
html: use-tokens.html
parent: tasks.html
template: pagetype-category.html.jinja
---
# Use Tokens
Create and trade tokens (fungible or otherwise) in the XRP Ledger.

View File

@@ -228,6 +228,6 @@ Response:
- [Escrow ledger object](escrow-object.html) - [Escrow ledger object](escrow-object.html)
<!--{# common link defs #}--> <!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %} {% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %} {% include '_snippets/rippled_versions.md' %}

View File

@@ -11,6 +11,7 @@ labels:
- AMM - AMM
--- ---
# Create an Automated Market Maker # Create an Automated Market Maker
_(Requires the [AMM amendment][] :not_enabled:)_ _(Requires the [AMM amendment][] :not_enabled:)_
An [Automated Market Maker (AMM)](automated-market-makers.html) can be an efficient way to facilitate exchanges between two assets while earning its liquidity providers passive income. This tutorial shows how to create an AMM for a given asset pair. An [Automated Market Maker (AMM)](automated-market-makers.html) can be an efficient way to facilitate exchanges between two assets while earning its liquidity providers passive income. This tutorial shows how to create an AMM for a given asset pair.

View File

@@ -0,0 +1,10 @@
---
html: defi-uc.html
parent: use-cases.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
blurb: Enabling fast, secure financial transactions without a central authority.
---
# Decentralized Finance
Decentralized Finance (DeFi) is about enabling fast, secure financial transactions without a central authority.

View File

@@ -0,0 +1,10 @@
---
html: use-cases.html
parent: docs.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
blurb: Browse the documentation based on practical use cases.
---
# Use Cases
Browse the documentation based on practical use cases.

View File

@@ -0,0 +1,10 @@
---
html: payments-uc.html
parent: use-cases.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
blurb: Practical examples for using different types of payment on the XRP Ledger.
---
# Payments
Practical examples for using different types of payment on the XRP Ledger.

Some files were not shown because too many files have changed in this diff Show More