mirror of
				https://github.com/XRPLF/xrpl-dev-portal.git
				synced 2025-11-04 11:55:50 +00:00 
			
		
		
		
	* Update look up escrows to remove redundant info about lookups via sender/destination. Modify cancel expired escrow for brevity. * Cancel escrow: fix notes * Add draft of updated cancel-escrow.js. * Update intro to escrows. * Add Escrow Tutorial * Minor corrections * Fix headings, add HTML * Update escrow docs This commit re-createsf205a92db2with some adjustments: - Omit the accidentally-created dir full of junk - Fix some typos and one mistake in the Escrow limitations section - Add a table to the EscrowCreate ref to clarify valid combos of fields. * Concept info from send-a-time-held-escrow added to escrow.md * IA: Move "Consensus Network" files This re-creates some work from the original commit56fffe0b9f* Rewrite escrows article (re-created) This commit re-creates relevant work from the following commits:9a4a588f2bUpdate escrow.md context infoe1b017dc83Remove references to using escrow for interledger payments. * IA: Move "XRPL servers" files This re-creates some work from original commit7611979abf* IA: move "production readiness" files. Re-creates work from the following commit:692438693aMove tutorials to concepts * New intro articles Original commit:56fffe0b9f* IA: Reorg account concepts Re-creates some work from original commit56fffe0b9f* IA: reorg transaction concepts Original commits:9d4eff9940WIP - reorg accounts7611979abfWIP dir. reorg * IA: reorg consensus concepts Original commit:56fffe0b9f* IA: Reorg ledger docs Original commit:56fffe0b9f- Rephrased some details of the section * IA: rename issuing/operational addresses page Original commit:56fffe0b9f* Moving use cases * Fleshing out Use Cases Note, the dactyl-config.yml file has not been fully updated. * Clean up checks conceptual info. * Remove redundant checks use case section Original commit:3c29e9c05e* IA: move Dex under tokens Original commit:d08b3ba7d7* Touch up stablecoin issuer use case (#1856) * Consolidate stablecoin use case * Stablecoin issuer: cleanup progress through sending * Stablecoin issuer: reorg second half (Note: the dactyl-config.yml is not fully reconciled yet) * Move rippled and clio tutorials into infrastructure * Remove link to checks amendement. * Add note to account_objects.md about commandline interface type field. * Merge expiration case with lifecycle section. * Interoperability Use Cases * Add graphics to intro * Move escrow use cases to dedicated page. * Update use case page intros and corresponding concept info. * Clarify meaning of direct XRP payments. * Intro link updates * Payment use cases * Remove some unnecessary links in transactions section Original commit:e6fcf4a4dc* Link cleanup in Tokens section Original commit:9588dd5e70* Touch up 'Configure Peering' section Original commit:fc8f0990b8* Clean up links in accounts section Original commit:3da5fde7a8* Add NFT mkt use case * p2p payments: edits to Wallets * Clean up payments use cases * Refine history description * IA: use case cleanup * IA: reconcile servers, ledgers sections * IA: reconcile payment types, tx, tokens * IA: reconcile accounts section * IA: reconcile infra * IA: Fix most broken links * Full Docs Index: omit from sidebar * IA: fix up most broken links * fix Absolute path link to internal content * Quick updates to Software Ecosystem * Remove some absolute links to internal resources * Fix remaining broken links in JA target * Contributing: tweak formatting * Tutorials: fix some minor issues * remove interop use cases * remove intro image and personal references to dennis * alphabetize-transaction-nav * Remove unused files * Add QS escrow tutorials * IA: move ledgers, consensus protocol files around * IA: update nav for new page hierarchy * reordering of topics under new networks and servers top-nav * Move "Naming" to "What is XRP?" * Update dactyl-config.yml Remove xrp.md from the TOC. * Update list-xrp-as-an-exchange.md Update link to what-is-xrp * Update list-xrp-as-an-exchange.ja.md Change link to what-is-xrp * Update currency-formats.md Change link to what-is-xrp * Update currency-formats.ja.md Change link to what-is-xrp * Update cancel-an-expired-escrow.md Change link to what-is-xrp * Update paymentchannelfund.md Change link to what-is-xml * Update look-up-escrows.md Change link to what-is-xrp * Update tokens.md change link to what-is-xrp * Update use-payment-channels.md * Update send-a-time-held-escrow.md Update link to what-is-xml * fix broken links * Update parallel-networks.md Change link to what-is-xml * Update parallel-networks.ja.md * Update invariant-checking.md Remove link to xrp.html * Update invariant-checking.ja.md Remove link to xrp.html * Update transaction-cost.md Change link to what-is-xrp * Update transaction-cost.ja.md Change link to what-is-xrp * Update send-a-conditionally-held-escrow.md Change link to what-is-xrp * Update stablecoin-issuer.md Change link to what-is-xrp * Update tokens.ja.md Change link to what-is-xml * Update autobridging.ja.md Change link to what-is-xrp * Update currency-formats.md update text * reorganize infrastructure nav section * Update currency-formats.md Try removing link altogether. * Update currency-formats.ja.md Remove link to what-is-xrp.html * move commandline usage topic to infrastructure * initial intro rewrite * minor update to language * IA.v3: rm Production Readiness * Delete xrp.md * Update xrp link in snippet * Add redirect for old xrp.html URL * Small edits to 'What is XRP?' article * Add missing imgs * XRP - copy edit per @DennisDawson * restructure tutorials nav and pages * fix broken links * more broken link fixes * Algo trading: 1st draft * Algo trading: notes on taxes * Algo trading: edits per review * algo trading: fix broken link * Ledger structure: rewrite for accuracy and clarity * Update links to removed 'tree format' header * Ledger Structure: Update diagrams * Re-gen CSS for ledger structure changes * Ledger structure: edits per review * IA.v3: fix broken NFT links introduced by rebase * Desktop Wallet (py): update little stuff * Update some capacity/storage details * contribute doc nav update * fix image link in create diagram page * IAv3: Fix 'Ledgers' blurb * Update full history requirements with details from community members * add reviewer suggestions * Edits per @trippled review * Apply suggestions from peer review Co-authored-by: oeggert <117319296+oeggert@users.noreply.github.com> * FH: reword file size limit note per review * Update software ecosystem * updates per review * Minor tweaks to graphics * fixTypos * Update content/concepts/introduction/software-ecosystem.md Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com> * Update content/concepts/introduction/software-ecosystem.md Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com> * [JA] update AccountDelete cost * custom transactors doc * add doc to dactyl config * [JA] fix NonFungibleTokensV1_1 amendment status * [JA] update NFTokenOffer page * Remove old, unused XRP article (#2039) * add reviewer suggestions * Add tooling to check for file/nav consistency - From the repo top, run tool/check_file_consistency.py to look for Markdown files that exist in the "content/" directory but aren't used in the documentation. - New "enforce_filenames" filter prints a warning to console when building, if a file's path and filename don't match expectations based on its place in the nav and top heading. * File consistency checker: correctly handle filenames starting in _ * Remove unused old 'get started' and associated code * Create Resources section & reorg some files - Rename some files/folders based on their place in the nav - Move a bunch of non-documentation stuff, and docs on contributing code and/or docs to the new "Resources" section. - Known issue: nav spills into a second row on page widths between 993px-1110px. To be fixed in a later CSS update, maybe along with making the Resources dropdown multi-column. * Fix #2078 code tab bug CSS not built yet, to reduce merge conflicts. Won't have any effect until that happens. * fix Transaction JSON * [JA] translate contributing contents * fix contributing-to-documentation parent * fix contribute-code blurb * Top nav: add cols for Resources, fix broken links * CSS: fix top nav overflows * Fix broken link from redirect not in JA target * Top nav: add Infra to article types * Update contrib info & rename intro file * [ja] Update link to suggested first page to translate * [ja] fix contribute docs organization * Run private network with docker tutorial (#2065) * [NO-ISSUE] Run private network with docker tutorial Adds a tutorial page in the Infrastructure section on how to run a private XRPL network with Docker. Please let me know if you think this is a useful page to include for developers, whether the steps are clear or not, and if you have suggestions on what can be added to it. * Add minor link fixes and Japanese target * Apply suggestions from code review Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com> * Add link to ripple-docker-testnet setup scripts in See Also section * Update repo URL --------- Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com> * add intro gfx (#2036) * add intro gfx * Move graphic up * Update some graphics with their revised versions * Add updated version of the custodial vs non-custodial graphic --------- Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com> Co-authored-by: Amarantha Kulkarni <akulkarni@ripple.com> * Update to reflect current UNL publishers * [ja] update contributing Co-authored-by: tequ <git@tequ.dev> * Incorporate feedback on "What is XRP" page. (#2099) * Add trademark info for XRP * Revert section to previous state * Fix broken link (#2101) --------- Co-authored-by: Oliver Eggert <oeggert@ripple.com> Co-authored-by: ddawson <dennis.s.dawson@gmail.com> Co-authored-by: Maria Shodunke <mshodunke@ripple.com> Co-authored-by: tequ <git@tequ.dev> Co-authored-by: oeggert <117319296+oeggert@users.noreply.github.com> Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com> Co-authored-by: develoQ <develoQ.jp@gmail.com> Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com> Co-authored-by: Amarantha Kulkarni <akulkarni@ripple.com>
		
			
				
	
	
		
			251 lines
		
	
	
		
			7.5 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			251 lines
		
	
	
		
			7.5 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
<!--{# Links within the dev portal #}-->
 | 
						|
[Address]: basic-data-types.html#addresses
 | 
						|
[アドレス]: basic-data-types.html#アドレス
 | 
						|
[admin command]: admin-api-methods.html
 | 
						|
[base58]: base58-encodings.html
 | 
						|
[common fields]: transaction-common-fields.html
 | 
						|
[共通フィールド]: transaction-common-fields.html
 | 
						|
[Currency Amount]: basic-data-types.html#specifying-currency-amounts
 | 
						|
[通貨額]: basic-data-types.html#通貨額の指定
 | 
						|
[通貨額の指定]: basic-data-types.html#通貨額の指定
 | 
						|
[Currency Code]: currency-formats.html#currency-codes
 | 
						|
[通貨コード]: currency-formats.html#通貨コード
 | 
						|
[drops of XRP]: basic-data-types.html#specifying-currency-amounts
 | 
						|
[fee levels]: transaction-cost.html#fee-levels
 | 
						|
[XRPのdrop数]: basic-data-types.html#通貨額の指定
 | 
						|
[Hash]: basic-data-types.html#hashes
 | 
						|
[ハッシュ]: basic-data-types.html#ハッシュ
 | 
						|
[identifying hash]: transactions.html#identifying-transactions
 | 
						|
[識別用ハッシュ]: transactions.html#トランザクションの識別
 | 
						|
[Internal Type]: serialization.html
 | 
						|
[内部の型]: serialization.html
 | 
						|
[Ledger Index]: basic-data-types.html#ledger-index
 | 
						|
[ledger index]: basic-data-types.html#ledger-index
 | 
						|
[レジャーインデックス]: basic-data-types.html#レジャーインデックス
 | 
						|
[ledger format]: ledger-object-types.html
 | 
						|
[レジャーフォーマット]: ledger-data-formats.html
 | 
						|
[Marker]: markers-and-pagination.html
 | 
						|
[マーカー]: markers-and-pagination.html
 | 
						|
[node public key]: peer-protocol.html#node-key-pair
 | 
						|
[ノード公開鍵]: peer-protocol.html#ノードキーペア
 | 
						|
[node key pair]: peer-protocol.html#node-key-pair
 | 
						|
[ノードキーペア]: peer-protocol.html#ノードキーペア
 | 
						|
[peer reservation]: peer-protocol.html#fixed-peers-and-peer-reservations
 | 
						|
[peer reservations]: peer-protocol.html#fixed-peers-and-peer-reservations
 | 
						|
[ピアリザベーション]: peer-protocol.html#固定ピアとピアリザベーション
 | 
						|
[public servers]: public-servers.html
 | 
						|
[公開サーバー]: public-servers.html
 | 
						|
[result code]: transaction-results.html
 | 
						|
[seconds since the Ripple Epoch]: basic-data-types.html#specifying-time
 | 
						|
[Reporting Mode]: rippled-server-modes.html#reporting-mode
 | 
						|
[Rippleエポック以降の経過秒数]: basic-data-types.html#時間の指定
 | 
						|
[Sequence Number]: basic-data-types.html#account-sequence
 | 
						|
[シーケンス番号]: basic-data-types.html#アカウントシーケンス
 | 
						|
[SHA-512Half]: basic-data-types.html#hashes
 | 
						|
[SHA-512ハーフ]: basic-data-types.html#ハッシュ
 | 
						|
[Specifying Currency Amounts]: basic-data-types.html#specifying-currency-amounts
 | 
						|
[Specifying Ledgers]: basic-data-types.html#specifying-ledgers
 | 
						|
[レジャーの指定]: basic-data-types.html#レジャーの指定
 | 
						|
[Specifying Time]: basic-data-types.html#specifying-time
 | 
						|
[時間の指定]: basic-data-types.html#時間の指定
 | 
						|
[stand-alone mode]: rippled-server-modes.html#stand-alone-mode
 | 
						|
[standard format]: response-formatting.html
 | 
						|
[標準フォーマット]: response-formatting.html
 | 
						|
[Transaction Cost]: transaction-cost.html
 | 
						|
[transaction cost]: transaction-cost.html
 | 
						|
[トランザクションコスト]: transaction-cost.html
 | 
						|
[universal error types]: error-formatting.html#universal-errors
 | 
						|
[汎用エラータイプ]: error-formatting.html#汎用エラー
 | 
						|
[XRP, in drops]: basic-data-types.html#specifying-currency-amounts
 | 
						|
[XRP、drop単位]: basic-data-types.html#通貨額の指定
 | 
						|
[NFToken]: nftoken.html
 | 
						|
 | 
						|
<!-- API object types -->
 | 
						|
{% set ledger_entries = [
 | 
						|
  "AccountRoot",
 | 
						|
  "Amendments",
 | 
						|
  "AMM",
 | 
						|
  "Check",
 | 
						|
  "DepositPreauth",
 | 
						|
  "DirectoryNode",
 | 
						|
  "Escrow",
 | 
						|
  "FeeSettings",
 | 
						|
  "LedgerHashes",
 | 
						|
  "NegativeUNL",
 | 
						|
  "NFTokenOffer",
 | 
						|
  "NFTokenPage",
 | 
						|
  "Offer",
 | 
						|
  "PayChannel",
 | 
						|
  "RippleState",
 | 
						|
  "SignerList",
 | 
						|
  "Ticket"
 | 
						|
] %}
 | 
						|
 | 
						|
{% for ledger_entry in ledger_entries %}
 | 
						|
{% if ledger_entry in ["amendments", "depositpreauth", "escrow"] %}
 | 
						|
  {# objects where the naive URL is already taken #}
 | 
						|
[{{ledger_entry}} object]: {{ledger_entry|lower}}-object.html
 | 
						|
  {% if target.lang == "ja" %}
 | 
						|
[{{ledger_entry}}オブジェクト]: {{ledger_entry|lower}}-object.html
 | 
						|
[{{ledger_entry}} オブジェクト]: {{ledger_entry|lower}}-object.html
 | 
						|
  {% endif %}
 | 
						|
{% else %}
 | 
						|
[{{ledger_entry}} object]: {{ledger_entry|lower}}.html
 | 
						|
  {% if target.lang == "ja" %}
 | 
						|
[{{ledger_entry}}オブジェクト]: {{ledger_entry|lower}}.html
 | 
						|
[{{ledger_entry}} オブジェクト]: {{ledger_entry|lower}}.html
 | 
						|
  {% endif %}
 | 
						|
{% endif %}
 | 
						|
{% endfor %}
 | 
						|
 | 
						|
 | 
						|
<!--{# Links to external sites #}-->
 | 
						|
[crypto-condition]: https://tools.ietf.org/html/draft-thomas-crypto-conditions-04
 | 
						|
[crypto-conditions]: https://tools.ietf.org/html/draft-thomas-crypto-conditions-04
 | 
						|
[Crypto-Conditions Specification]: https://tools.ietf.org/html/draft-thomas-crypto-conditions-04
 | 
						|
[hexadecimal]: https://en.wikipedia.org/wiki/Hexadecimal
 | 
						|
[Interledger Protocol]: https://interledger.org/
 | 
						|
[RFC-1751]: https://tools.ietf.org/html/rfc1751
 | 
						|
[ripple-lib]: https://github.com/XRPLF/xrpl.js
 | 
						|
 | 
						|
<!--{# rippled API methods #}-->
 | 
						|
{% set api_methods = [
 | 
						|
  "account_channels",
 | 
						|
  "account_currencies",
 | 
						|
  "account_info",
 | 
						|
  "account_lines",
 | 
						|
  "account_nfts",
 | 
						|
  "account_objects",
 | 
						|
  "account_offers",
 | 
						|
  "account_tx",
 | 
						|
  "amm_info",
 | 
						|
  "book_offers",
 | 
						|
  "can_delete",
 | 
						|
  "channel_authorize",
 | 
						|
  "channel_verify",
 | 
						|
  "connect",
 | 
						|
  "consensus_info",
 | 
						|
  "crawl_shards",
 | 
						|
  "deposit_authorized",
 | 
						|
  "download_shard",
 | 
						|
  "feature",
 | 
						|
  "fee",
 | 
						|
  "fetch_info",
 | 
						|
  "gateway_balances",
 | 
						|
  "get_counts",
 | 
						|
  "json",
 | 
						|
  "ledger",
 | 
						|
  "ledger_accept",
 | 
						|
  "ledger_cleaner",
 | 
						|
  "ledger_closed",
 | 
						|
  "ledger_current",
 | 
						|
  "ledger_data",
 | 
						|
  "ledger_entry",
 | 
						|
  "ledger_request",
 | 
						|
  "log_level",
 | 
						|
  "logrotate",
 | 
						|
  "manifest",
 | 
						|
  "nft_buy_offers",
 | 
						|
  "nft_info",
 | 
						|
  "nft_sell_offers",
 | 
						|
  "noripple_check",
 | 
						|
  "path_find",
 | 
						|
  "peer_reservations_add",
 | 
						|
  "peer_reservations_del",
 | 
						|
  "peer_reservations_list",
 | 
						|
  "peers",
 | 
						|
  "ping",
 | 
						|
  "print",
 | 
						|
  "random",
 | 
						|
  "ripple_path_find",
 | 
						|
  "server_info",
 | 
						|
  "server_state",
 | 
						|
  "sign",
 | 
						|
  "sign_for",
 | 
						|
  "stop",
 | 
						|
  "submit",
 | 
						|
  "submit_multisigned",
 | 
						|
  "subscribe",
 | 
						|
  "transaction_entry",
 | 
						|
  "tx",
 | 
						|
  "tx_history",
 | 
						|
  "unsubscribe",
 | 
						|
  "validation_create",
 | 
						|
  "validation_seed",
 | 
						|
  "validator_info",
 | 
						|
  "validator_list_sites",
 | 
						|
  "validators",
 | 
						|
  "wallet_propose"
 | 
						|
] %}
 | 
						|
 | 
						|
{% for method in api_methods %}
 | 
						|
[{{method}} method]: {{method|lower}}.html
 | 
						|
[{{method}} command]: {{method|lower}}.html
 | 
						|
{% if target.lang == "ja" %}
 | 
						|
[{{method}}メソッド]: {{method|lower}}.html
 | 
						|
[{{method}} メソッド]: {{method|lower}}.html
 | 
						|
{% endif %}
 | 
						|
{% endfor %}
 | 
						|
 | 
						|
<!--{# Amendment links #}-->
 | 
						|
{% set amendment_names = [
 | 
						|
  "Checks",
 | 
						|
  "CheckCashMakesTrustLine",
 | 
						|
  "CryptoConditions",
 | 
						|
  "CryptoConditionsSuite",
 | 
						|
  "DeletableAccounts",
 | 
						|
  "DepositAuth",
 | 
						|
  "DepositPreauth",
 | 
						|
  "DisallowIncoming",
 | 
						|
  "EnforceInvariants",
 | 
						|
  "Escrow",
 | 
						|
  "ExpandedSignerList",
 | 
						|
  "FeeEscalation",
 | 
						|
  "fix1201",
 | 
						|
  "fix1368",
 | 
						|
  "fix1373",
 | 
						|
  "fix1512",
 | 
						|
  "fix1513",
 | 
						|
  "fix1515",
 | 
						|
  "fix1523",
 | 
						|
  "fix1528",
 | 
						|
  "fix1543",
 | 
						|
  "fix1571",
 | 
						|
  "fix1578",
 | 
						|
  "fix1623",
 | 
						|
  "fixCheckThreading",
 | 
						|
  "fixMasterKeyAsRegularKey",
 | 
						|
  "fixNFTokenDirV1",
 | 
						|
  "fixNFTokenRemint",
 | 
						|
  "fixPayChanRecipientOwnerDir",
 | 
						|
  "fixRemoveNFTokenAutoTrustLine",
 | 
						|
  "fixQualityUpperBound",
 | 
						|
  "fixTakerDryOfferRemoval",
 | 
						|
  "fixTrustLinesToSelf",
 | 
						|
  "Flow",
 | 
						|
  "FlowCross",
 | 
						|
  "FlowV2",
 | 
						|
  "ImmediateOfferKilled",
 | 
						|
  "MultiSign",
 | 
						|
  "MultiSignReserve",
 | 
						|
  "NegativeUNL",
 | 
						|
  "NonFungibleTokensV1",
 | 
						|
  "NonFungibleTokensV1_1",
 | 
						|
  "OwnerPaysFee",
 | 
						|
  "PayChan",
 | 
						|
  "RequireFullyCanonicalSig",
 | 
						|
  "SHAMapV2",
 | 
						|
  "SortedDirectories",
 | 
						|
  "SusPay",
 | 
						|
  "TicketBatch",
 | 
						|
  "Tickets",
 | 
						|
  "TickSize",
 | 
						|
  "TrustSetAuth",
 | 
						|
  "XRPFees"
 | 
						|
] %}
 | 
						|
 | 
						|
{% for amd in amendment_names %}
 | 
						|
[{{amd}} amendment]: known-amendments.html#{{amd|lower}}
 | 
						|
[{{amd}}の修正]: known-amendments.html#{{amd|lower}}
 | 
						|
{% endfor %}
 |