From 6ed671c41b2a7247bcd72989d6a54569e5b7dd87 Mon Sep 17 00:00:00 2001 From: ddawson Date: Tue, 13 Dec 2022 16:53:36 -0800 Subject: [PATCH] Fleshing out Use Cases --- .../tokens}/become-an-xrp-ledger-gateway.md | 2 +- .../xrpl}/list-xrp-as-an-exchange.ja.md | 0 .../xrpl}/list-xrp-as-an-exchange.md | 0 content/use-cases/defi/amm-uc.md | 10 + content/use-cases/defi/moneychanger-uc.md | 12 ++ .../interoperability/sidechains-uc.md | 15 ++ .../interoperability/xrpl-hooks-uc.md | 10 + .../payments/cross-currency-payments-uc.md | 10 + content/use-cases/payments/escrow-uc.md | 16 ++ content/use-cases/payments/index.md | 20 ++ .../use-cases/payments/payment-channels-uc.md | 3 + content/use-cases/payments/xrp-to-xrp-uc.md | 10 + content/use-cases/tokenization.md | 74 +++++++ .../tokenization/authorized-minter.md | 8 + .../use-cases/tokenization/digital-artist.md | 12 ++ content/use-cases/tokenization/index.md | 27 +++ .../tokenization/nftoken-marketplace.md | 14 ++ .../tokenization/stablecoin-issuer.md | 18 ++ dactyl-config.yml | 202 +++++++++++++----- 19 files changed, 412 insertions(+), 51 deletions(-) rename content/{use-cases/xrp-ledger-businesses => concepts/tokens}/become-an-xrp-ledger-gateway.md (99%) rename content/{use-cases/xrp-ledger-businesses => concepts/xrpl}/list-xrp-as-an-exchange.ja.md (100%) rename content/{use-cases/xrp-ledger-businesses => concepts/xrpl}/list-xrp-as-an-exchange.md (100%) create mode 100644 content/use-cases/defi/amm-uc.md create mode 100644 content/use-cases/defi/moneychanger-uc.md create mode 100644 content/use-cases/interoperability/sidechains-uc.md create mode 100644 content/use-cases/interoperability/xrpl-hooks-uc.md create mode 100644 content/use-cases/payments/cross-currency-payments-uc.md create mode 100644 content/use-cases/payments/escrow-uc.md create mode 100644 content/use-cases/payments/index.md create mode 100644 content/use-cases/payments/payment-channels-uc.md create mode 100644 content/use-cases/payments/xrp-to-xrp-uc.md create mode 100644 content/use-cases/tokenization.md create mode 100644 content/use-cases/tokenization/authorized-minter.md create mode 100644 content/use-cases/tokenization/digital-artist.md create mode 100644 content/use-cases/tokenization/index.md create mode 100644 content/use-cases/tokenization/nftoken-marketplace.md create mode 100644 content/use-cases/tokenization/stablecoin-issuer.md diff --git a/content/use-cases/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md b/content/concepts/tokens/become-an-xrp-ledger-gateway.md similarity index 99% rename from content/use-cases/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md rename to content/concepts/tokens/become-an-xrp-ledger-gateway.md index a1d9ab35a9..0f1d8468be 100644 --- a/content/use-cases/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md +++ b/content/concepts/tokens/become-an-xrp-ledger-gateway.md @@ -1,6 +1,6 @@ --- html: become-an-xrp-ledger-gateway.html -parent: xrp-ledger-businesses.html +parent: tokens.html blurb: Stablecoin issuers link tokens in the XRP Ledger to assets in the outside world. labels: - Tokens diff --git a/content/use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md b/content/concepts/xrpl/list-xrp-as-an-exchange.ja.md similarity index 100% rename from content/use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md rename to content/concepts/xrpl/list-xrp-as-an-exchange.ja.md diff --git a/content/use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.md b/content/concepts/xrpl/list-xrp-as-an-exchange.md similarity index 100% rename from content/use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.md rename to content/concepts/xrpl/list-xrp-as-an-exchange.md diff --git a/content/use-cases/defi/amm-uc.md b/content/use-cases/defi/amm-uc.md new file mode 100644 index 0000000000..5bd1f91f87 --- /dev/null +++ b/content/use-cases/defi/amm-uc.md @@ -0,0 +1,10 @@ +--- +html: amm-uc.html +parent: defi-uc.html +blurb: Exchange . +labels: + - Transactions +--- +# Automated Market Maker + +The Automated Market Maker (AMM)... \ No newline at end of file diff --git a/content/use-cases/defi/moneychanger-uc.md b/content/use-cases/defi/moneychanger-uc.md new file mode 100644 index 0000000000..7236a2e1fe --- /dev/null +++ b/content/use-cases/defi/moneychanger-uc.md @@ -0,0 +1,12 @@ +--- +html: moneychanger-uc.html +parent: defi-uc.html +blurb: The XRP Ledger's decentralized exchange consists of an unlimited number of currency pairs, tracked on-demand when users make trades. +labels: + - Transactions +--- +# Decentralized Exchange + +The XRP Ledger's decentralized exchange consists of an unlimited number of currency pairs, tracked on-demand when users make trades. A currency pair can consist of XRP and a token or two different tokens; tokens are always identified by the combination of an issuer and a currency code. Therefore, it is possible to trade between two tokens with the same currency code and different issuers, or the same issuer and different currency codes. + +Get started by following the steps in [Trade in the Decentralized Exchange](trade-in-the-decentralized-exchange.html). \ No newline at end of file diff --git a/content/use-cases/interoperability/sidechains-uc.md b/content/use-cases/interoperability/sidechains-uc.md new file mode 100644 index 0000000000..4f3c659a53 --- /dev/null +++ b/content/use-cases/interoperability/sidechains-uc.md @@ -0,0 +1,15 @@ +--- +html: sidechains-uc.html +parent: interoperability-uc.html +blurb: Transfer XRP between accounts. +labels: + - Transactions +--- + +# Sidechains (Beta) + +A sidechain is an independent ledger with its own consensus algorithm and transaction types and rules. It acts as its own blockchain. Federation enables value in the form of XRP and other tokens to move efficiently between a sidechain and an XRP Ledger mainchain. + +For more information, see [Federated Sidechains](https://xrpl.org/federated-sidechains.html?_ga=2.208834706.1673393542.1670970919-696076472.1670970919#federated-sidechains) + +To get started creating your own sidechain, see [XRPL Hooks](https://hooks-testnet-v2.xrpl-labs.com/) \ No newline at end of file diff --git a/content/use-cases/interoperability/xrpl-hooks-uc.md b/content/use-cases/interoperability/xrpl-hooks-uc.md new file mode 100644 index 0000000000..925d81c78b --- /dev/null +++ b/content/use-cases/interoperability/xrpl-hooks-uc.md @@ -0,0 +1,10 @@ +--- +html: xrpl-hooks-uc.html +parent: interoperability-uc.html +blurb: Exchange . +labels: + - Transactions +--- +# XRPL Hooks + +Hooks allow you to customize transactions by adding code snippets before, after, or both when you send a transaction to the XRP Ledger. \ No newline at end of file diff --git a/content/use-cases/payments/cross-currency-payments-uc.md b/content/use-cases/payments/cross-currency-payments-uc.md new file mode 100644 index 0000000000..1f51eaeb95 --- /dev/null +++ b/content/use-cases/payments/cross-currency-payments-uc.md @@ -0,0 +1,10 @@ +--- +html: cross-currency-payments-uc.html +parent: payments-uc.html +blurb: Escrow holds funds and deliver them when specified conditions are met. +labels: + - Transactions +--- +# Cross-currency Payments + +Placeholder for cross-currency payments use case. \ No newline at end of file diff --git a/content/use-cases/payments/escrow-uc.md b/content/use-cases/payments/escrow-uc.md new file mode 100644 index 0000000000..9c056fc23b --- /dev/null +++ b/content/use-cases/payments/escrow-uc.md @@ -0,0 +1,16 @@ +--- +html: escrow-uc.html +parent: payments-uc.html +blurb: Transactions allow accounts to modify the XRP Ledger. +labels: + - Ledgers +--- +# Escrow + +A traditional escrow is a contract between two parties to facilitate risky financial transactions. Funds are held by an impartial third party, guaranteeing its availability. The funds are only released to their intended recipients when conditions specified by the contract are met. This method ensures both parties meet their obligations. + +The XRP Ledger takes escrow a step further, replacing the third party with an automated system built into the ledger. An escrow locks up XRP, which cannot be used or destroyed until conditions are met. + +To try out the capabilities of time-based escrows, see [Create Time-based Escrows](time-escrows.html). + +Read more about escrows in [Escrow](escrow.html). \ No newline at end of file diff --git a/content/use-cases/payments/index.md b/content/use-cases/payments/index.md new file mode 100644 index 0000000000..46ca8ed1d6 --- /dev/null +++ b/content/use-cases/payments/index.md @@ -0,0 +1,20 @@ +--- +title: XRP Ledger Use Cases +--- +import { XRPLCardDeck, DeckCard } from "_components/XRPLCardDeck"; + +# Payments + +These use cases focus on payment capabilities of the XRP Ledger. + + + + As an individual buying items in bulk, I want to set up a payment channel to send "asynchronous" XRP payments to a vendor, such that the payment can be divided into very small increments and settled later. + + + As an individual buyer, I want to set up a payment channel to send cross-currency payments that exchange tokens, XRP, or both. + + + As an individual making a payment for a physical asset, I want to set up an escrow (conditional payments) and set aside XRP, then deliver the XRP later when certain conditions are met. + + \ No newline at end of file diff --git a/content/use-cases/payments/payment-channels-uc.md b/content/use-cases/payments/payment-channels-uc.md new file mode 100644 index 0000000000..61b4624183 --- /dev/null +++ b/content/use-cases/payments/payment-channels-uc.md @@ -0,0 +1,3 @@ +# Payment Channels + +Placeholder for payment channels use case. \ No newline at end of file diff --git a/content/use-cases/payments/xrp-to-xrp-uc.md b/content/use-cases/payments/xrp-to-xrp-uc.md new file mode 100644 index 0000000000..77ae267a23 --- /dev/null +++ b/content/use-cases/payments/xrp-to-xrp-uc.md @@ -0,0 +1,10 @@ +--- +html: xrp-to-xrp-uc.html +parent: payments-uc.html +blurb: Transfer XRP between accounts. +labels: + - Transactions +--- +# XRP-to-XRP Use Cases + +Transfer XRP \ No newline at end of file diff --git a/content/use-cases/tokenization.md b/content/use-cases/tokenization.md new file mode 100644 index 0000000000..36d284630f --- /dev/null +++ b/content/use-cases/tokenization.md @@ -0,0 +1,74 @@ +# Tokenization Use Cases + ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +

+Stablecoin Issuer +

+

+As a Stablecoin Issuer, I want to use the XRPL to issue my own stablecoin, taking advantage of the lower cost per transaction and decade-long stability of the XRPL. +

+


+ +		 + +

+Token Marketplace +

+

+In my NFToken Marketplace, I want to use the XRPL to create a marketplace site where I can arrange transfer of a curated selection of NFTokens to consumers, with the benefit that I can build a brand and earn broker fees based on sales. +

+ +
+ + + +
+ +

Authorized Minter

+

As an authorized minter, I want to mint tokens for a token issuer at an agreed upon rate and sell the tokens at a profit, with royalties returning to the issuer. +

+


+		 + +

Digital Artist

+

As a Digital Artist, I want to use the XRPL to create a NFToken of my work and sell it on the XRPL, because the XRPL is both cost efficient and carbon neutral. +

+


+
+ + + +
+ diff --git a/content/use-cases/tokenization/authorized-minter.md b/content/use-cases/tokenization/authorized-minter.md new file mode 100644 index 0000000000..7f33d6be37 --- /dev/null +++ b/content/use-cases/tokenization/authorized-minter.md @@ -0,0 +1,8 @@ +# Authorized Minter + +_As an authorized minter, I want to mint tokens for a token issuer at an agreed upon rate and sell the tokens at a profit, with royalties returning to the issuer._ + +You can act as an authorized minter for token issuers. When you do this, you own the NFToken, but royalties flow to the NFToken issuer. When you make a sale of that NFToken, the proceeds of the initial sale go to you. You can have an agreement with your issuer to pay them some or all of your portion of the initial sale amount. + +You can learn more in the tutorial [Assign an Authorized Minter](authorize-minter.html). + diff --git a/content/use-cases/tokenization/digital-artist.md b/content/use-cases/tokenization/digital-artist.md new file mode 100644 index 0000000000..9681b3e457 --- /dev/null +++ b/content/use-cases/tokenization/digital-artist.md @@ -0,0 +1,12 @@ +# Digital Artist + +_As a Digital Artist, I want to use the XRPL to create a NFToken of my work and sell it on the XRPL, because the XRPL is both cost efficient and carbon neutral._ + +--- + +When you create a NFToken, you create a unique token on the XRPL that is effectively a placeholder for an actual physical or digital asset. When you create the NFToken, you provide a URL to a digital file that is the item itself, such as a digital artwork, or a URL to a placeholder that represents an item in the physical world. + +You can create NFTokens using an app such as the [Xumm app](https://xumm.app). + +For a more hands-on experience, you can follow the steps in the [Quickstart Tutorial 3 - Mint and Burn NFTokens](mint-and-burn-nftokens.html). + diff --git a/content/use-cases/tokenization/index.md b/content/use-cases/tokenization/index.md new file mode 100644 index 0000000000..1e4be789d4 --- /dev/null +++ b/content/use-cases/tokenization/index.md @@ -0,0 +1,27 @@ +--- +title: XRP Ledger Use Cases +--- +import { XRPLCardDeck, DeckCard } from "../../../_components/XRPLCardDeck"; + +# Tokenization + +These use cases focus on capabilities on the XRP Ledger for working with tokens rather than native XRP. + + + + As a Stablecoin Issuer, I want to use the XRPL to issue my own stablecoin, taking + advantage of the lower cost per transaction and decade-long stability of the XRPL. + + + In my NFToken Marketplace, I want to use the XRPL to create a marketplace site where I + can arrange transfer of a curated selection of NFTokens to consumers, with the benefit + that I can build a brand and earn broker fees based on sales. + + + Convert tokens from one currency to another on the decentralized exchange. + + + As a Digital Artist, I want to use the XRPL to create a NFToken of my work and sell it + on the XRPL, because the XRPL is both cost efficient and carbon neutral. + + diff --git a/content/use-cases/tokenization/nftoken-marketplace.md b/content/use-cases/tokenization/nftoken-marketplace.md new file mode 100644 index 0000000000..9b8cdf230b --- /dev/null +++ b/content/use-cases/tokenization/nftoken-marketplace.md @@ -0,0 +1,14 @@ +# NFToken Marketplace + +_In my NFToken Marketplace, I want to use the XRPL to create a marketplace site where I can arrange transfer of a curated selection of NFTokens to consumers, with the benefit that I can build a brand and earn broker fees based on sales._ + +--- + +NFToken Marketplaces act as intermediaries between NFToken creators and collectors. As a marketplace curator, you seek out NFToken creators and assemble a collection of items to sale. Buyers come to your site to review your selections and post offers. You match the minimum prices set by the creators with the optimal offers from the buyers, complete the transaction, and collect a broker fee. + +You can learn more about brokered sales in the topic [Trading Tokens on the XRP Ledger](non-fungible-token-transfers.html). + +Learn more about token transfer fees in the topic [Transfer Fees](transfer-fees.html). + +You can get started building a brokered sales marketplace by following the steps in the [Broker a NFToken Sale](broker-sale.html). + diff --git a/content/use-cases/tokenization/stablecoin-issuer.md b/content/use-cases/tokenization/stablecoin-issuer.md new file mode 100644 index 0000000000..fd6ae93949 --- /dev/null +++ b/content/use-cases/tokenization/stablecoin-issuer.md @@ -0,0 +1,18 @@ +--- +html: Stablecoin Issuer.html +parent: tokenization.html +blurb: Issue your own stablecoin, based on assets of equal value outside of the XRP Ledger. +labels: + - Tokenization +--- +# Stablecoin Issuer + +_As a Stablecoin Issuer, I want to use the XRPL to issue my own stablecoin, taking advantage of the lower cost per transaction and decade-long stability of the XRPL._ + +--- + +You can issue a stablecoin by holding assets of equal value outside of the XRP Ledger, and issuing tokens representing that value on the ledger. The token can be considered a _stablecoin_ because — in theory — the exchange rate between the token and its off-ledger assets remain stable at 1:1. + +You can create your own stablecoin by following the steps in [Issue a Fungible Token](issue-a-fungible-token.html). + +For more information on how to run a gateway, see [Become a Stablecoin Issuer](become-an-xrp-ledger-gateway.html). diff --git a/dactyl-config.yml b/dactyl-config.yml index 79a44139b6..1915ba955c 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -413,6 +413,129 @@ pages: - en - ja +# Use Cases -------------------------------------------------------------------- + + - name: Use Cases + 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. + targets: + - en + + + - name: Payments + 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. + targets: + - en + - ja + + - md: use-cases/payments/xrp-to-xrp-uc.md + parent: payments-uc.html + targets: + - en + - ja + + - md: use-cases/payments/payment-channels-uc.md + parent: payments-uc.html + targets: + - en + - ja + + - md: use-cases/payments/cross-currency-payments-uc.md + parent: payments-uc.html + targets: + - en + - ja + + - md: use-cases/payments/escrow-uc.md + parent: payments-uc.html + targets: + - en + - ja + + - name: Tokenization + html: tokenization.html + parent: use-cases.html + top_nav_grouping: Article Types + template: pagetype-category.html.jinja + blurb: Work with a variety of tokens supported by the XRP Ledger. + targets: + - en + - ja + + - md: use-cases/tokenization/authorized-minter.md + parent: tokenization.html + targets: + - en + - ja + + - md: use-cases/tokenization/stablecoin-issuer.md + parent: tokenization.html + targets: + - en + - ja + + - md: use-cases/tokenization/nftoken-marketplace.md + parent: tokenization.html + targets: + - en + - ja + + - md: use-cases/tokenization/digital-artist.md + parent: tokenization.html + targets: + - en + - ja + + - name: Decentralized Finance + 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. + targets: + - en + - ja + + - md: use-cases/defi/moneychanger-uc.md + parent: defi-uc.html + targets: + - en + - ja + + - md: use-cases/defi/amm-uc.md + parent: defi-uc.html + targets: + - en + - ja + + - name: Interoperability + html: interoperability-uc.html + parent: use-cases.html + top_nav_grouping: Article Types + template: pagetype-category.html.jinja + blurb: Practical ways to connect the XRP Ledger to external chains. + targets: + - en + - ja + + - md: use-cases/interoperability/sidechains-uc.md + parent: interoperability-uc.html + targets: + - en + - ja + + - md: use-cases/interoperability/xrpl-hooks-uc.md + parent: interoperability-uc.html + targets: + - en + - ja # Concepts --------------------------------------------------------------------- - name: Concepts @@ -536,6 +659,16 @@ pages: - en - ja + - md: concepts/xrpl/list-xrp-as-an-exchange.md + parent: xrpl-servers.html + targets: + - en + + - md: concepts/xrpl/list-xrp-as-an-exchange.ja.md + parent: xrpl-servers.html + targets: + - ja + - md: concepts/transactions/transactions.md parent: concepts.html targets: @@ -768,19 +901,26 @@ pages: targets: - en - ja + - md: concepts/tokens/freezing-tokens.md parent: tokens.html targets: - en - ja - + - md: concepts/tokens/common-misunderstandings-about-freezes.md parent: freezing-tokens.html targets: - en - ja - + + - md: concepts/tokens/become-an-xrp-ledger-gateway.md + parent: tokens.html + targets: + - en + - ja + - md: concepts/tokens/non-fungible.md parent: token-types.html targets: @@ -847,46 +987,8 @@ pages: targets: - en - ja - -# Use Cases -------------------------------------------------------------------- - - - name: Use Cases - 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. - targets: - - en - - # TODO: translate - - md: use-cases/xrp-ledger-businesses/become-an-xrp-ledger-gateway.md - parent: use-cases.html - targets: - - en - - ja - - - md: use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.md - parent: use-cases.html - targets: - - en - - - md: use-cases/xrp-ledger-businesses/list-xrp-as-an-exchange.ja.md - parent: use-cases.html - targets: - - ja - - - md: use-cases/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.md - parent: use-cases.html - targets: - - en - - - md: use-cases/xrp-ledger-businesses/list-your-exchange-on-xrp-charts.ja.md - parent: use-cases.html - targets: - - ja - + # Tutorials -------------------------------------------------------------------- - name: Tutorials @@ -3862,15 +3964,15 @@ pages: parent: amendment-heading.html targets: - en - - - md: amendments/amendment-heading.ja.md - targets: - - ja - - - md: amendments/known-amendments.ja.md - parent: known-amendment-heading.ja.html - targets: - - ja +# +# - md: amendments/amendment-heading.ja.md +# targets: +# - ja +# +# - md: amendments/known-amendments.ja.md +# parent: known-amendment-heading.ja.html +# targets: +# - ja