mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 11:45:50 +00:00
Add create AMM tutorial
Add an interactive tutorial for creating an automated market maker, updated with the latest changes from the Ripple Open Source site.
This commit is contained in:
mDuo13
3
content/_code-samples/create-amm/README.md
Normal file
3
content/_code-samples/create-amm/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Create AMM
|
||||
|
||||
Code samples for the [Create an Automated Market Maker tutorial](TODO), showing how to make set up a new AMM.
|
||||
18
content/_code-samples/create-amm/js/connect.js
Normal file
18
content/_code-samples/create-amm/js/connect.js
Normal file
@@ -0,0 +1,18 @@
|
||||
// In browsers, use a <script> tag. In Node.js, uncomment the following line:
|
||||
// const xrpl = require('xrpl')
|
||||
|
||||
const WS_URL = 'wss://amm.devnet.rippletest.net:51233/'
|
||||
const EXPLORER = 'amm-devnet.xrpl.org' // Optional, for linking
|
||||
|
||||
async function main() {
|
||||
// Define the network client
|
||||
const client = new xrpl.Client(WS_URL)
|
||||
await client.connect()
|
||||
|
||||
// ... custom code goes here
|
||||
|
||||
// Disconnect when done (If you omit this, Node.js won't end the process)
|
||||
await client.disconnect()
|
||||
}
|
||||
|
||||
main()
|
||||
231
content/_code-samples/create-amm/js/create-amm.js
Normal file
231
content/_code-samples/create-amm/js/create-amm.js
Normal file
@@ -0,0 +1,231 @@
|
||||
'use strict'
|
||||
// Code to set up an AMM instance between
|
||||
// "TST.rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd" and novel "FOO" tokens.
|
||||
|
||||
// Dependencies for Node.js; this if statement lets the code run unmodified
|
||||
// in browsers, as long as you provide a <script> tag (see example demo.html),
|
||||
// as well as in Node.js.
|
||||
if (typeof module !== "undefined") {
|
||||
// Use var here because const/let are block-scoped to the if statement.
|
||||
var xrpl = require('xrpl')
|
||||
// Configure console.log to print deeper into nested objects so you can
|
||||
// better see properties of the AMM:
|
||||
require('util').inspect.defaultOptions.depth = 5
|
||||
}
|
||||
|
||||
// Connect to the network -----------------------------------------------------
|
||||
const WS_URL = 'wss://amm.devnet.rippletest.net:51233'
|
||||
const EXPLORER = 'https://amm-devnet.xrpl.org'
|
||||
|
||||
async function main() {
|
||||
const client = new xrpl.Client(WS_URL);
|
||||
await client.connect()
|
||||
|
||||
// Get credentials from the Faucet -------------------------------------------
|
||||
console.log("Requesting address from the faucet...")
|
||||
const wallet = (await client.fundWallet()).wallet
|
||||
|
||||
// To use an existing account, use code such as the following:
|
||||
// const wallet = xrpl.Wallet.fromSeed(process.env['USE_SEED'])
|
||||
|
||||
// Acquire tokens ------------------------------------------------------------
|
||||
const offer_result = await client.submitAndWait({
|
||||
"TransactionType": "OfferCreate",
|
||||
"Account": wallet.address,
|
||||
"TakerPays": {
|
||||
currency: "TST",
|
||||
issuer: "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd",
|
||||
value: "25"
|
||||
},
|
||||
"TakerGets": xrpl.xrpToDrops(25*10*1.16)
|
||||
}, {autofill: true, wallet: wallet})
|
||||
if (offer_result.result.meta.TransactionResult == "tesSUCCESS") {
|
||||
console.log(`TST offer placed: ${EXPLORER}/transactions/${offer_result.result.hash}`)
|
||||
const balance_changes = xrpl.getBalanceChanges(offer_result.result.meta)
|
||||
for (const bc of balance_changes) {
|
||||
if (bc.account != wallet.address) {continue}
|
||||
for (const bal of bc.balances) {
|
||||
if (bal.currency == "TST") {
|
||||
console.log(`Got ${bal.value} ${bal.currency}.${bal.issuer}.`)
|
||||
break
|
||||
}
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
} else {
|
||||
throw `Error sending transaction: ${offer_result}`
|
||||
}
|
||||
// Successfully placing the offer doesn't necessarily mean that you have TST,
|
||||
// but for now, let's assume it matched existing Offers on ledger so you do.
|
||||
|
||||
// Call helper function to set up a new "FOO" issuer, create a trust line
|
||||
// to them, and receive 1000 FOO from them.
|
||||
const foo_amount = await get_new_token(client, wallet, "FOO", "1000")
|
||||
|
||||
// Check if AMM already exists ----------------------------------------------
|
||||
const amm_info_request = {
|
||||
"command": "amm_info",
|
||||
"asset": {
|
||||
"currency": "TST",
|
||||
"issuer": "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd",
|
||||
},
|
||||
"asset2": {
|
||||
"currency": foo_amount.currency,
|
||||
"issuer": foo_amount.issuer
|
||||
},
|
||||
"ledger_index": "validated"
|
||||
}
|
||||
try {
|
||||
const amm_info_result = await client.request(amm_info_request)
|
||||
console.log(amm_info_result)
|
||||
} catch(err) {
|
||||
if (err.data.error === 'actNotFound') {
|
||||
console.log(`No AMM exists yet for the pair
|
||||
${foo_amount.currency}.${foo_amount.issuer} /
|
||||
TST.rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd.
|
||||
(This is probably as expected.)`)
|
||||
} else {
|
||||
throw(err)
|
||||
}
|
||||
}
|
||||
|
||||
// Look up AMM transaction cost ---------------------------------------------
|
||||
// AMMCreate requires burning one owner reserve. We can look up that amount
|
||||
// (in drops) on the current network using server_state:
|
||||
const ss = await client.request({"command": "server_state"})
|
||||
const amm_fee_drops = ss.result.state.validated_ledger.reserve_inc.toString()
|
||||
console.log(`Current AMMCreate transaction cost:
|
||||
${xrpl.dropsToXrp(amm_fee_drops)} XRP`)
|
||||
|
||||
|
||||
// Create AMM ---------------------------------------------------------------
|
||||
// This example assumes that 15 TST ≈ 100 FOO in value.
|
||||
const ammcreate_result = await client.submitAndWait({
|
||||
"TransactionType": "AMMCreate",
|
||||
"Account": wallet.address,
|
||||
"Amount": {
|
||||
currency: "TST",
|
||||
issuer: "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd",
|
||||
value: "15"
|
||||
},
|
||||
"Amount2": {
|
||||
"currency": foo_amount.currency,
|
||||
"issuer": foo_amount.issuer,
|
||||
"value": "100"
|
||||
},
|
||||
"TradingFee": 500, // 0.5%
|
||||
"Fee": amm_fee_drops
|
||||
}, {autofill: true, wallet: wallet, fail_hard: true})
|
||||
// Use fail_hard so you don't waste the tx cost if you mess up
|
||||
if (ammcreate_result.result.meta.TransactionResult == "tesSUCCESS") {
|
||||
console.log(`AMM created: ${EXPLORER}/transactions/${ammcreate_result.result.hash}`)
|
||||
} else {
|
||||
throw `Error sending transaction: ${ammcreate_result}`
|
||||
}
|
||||
|
||||
// Confirm that AMM exists --------------------------------------------------
|
||||
// Make the same amm_info request as earlier, but this time it should succeed
|
||||
const amm_info_result2 = await client.request(amm_info_request)
|
||||
console.log(amm_info_result2)
|
||||
const lp_token = amm_info_result2.result.amm.lp_token
|
||||
const amount = amm_info_result2.result.amm.amount
|
||||
const amount2 = amm_info_result2.result.amm.amount2
|
||||
console.log(`The AMM account ${lp_token.issuer} has ${lp_token.value} total
|
||||
LP tokens outstanding, and uses the currency code ${lp_token.currency}.`)
|
||||
console.log(`In its pool, the AMM holds ${amount.value} ${amount.currency}.${amount.issuer}
|
||||
and ${amount2.value} ${amount2.currency}.${amount2.issuer}`)
|
||||
|
||||
// Check token balances
|
||||
const account_lines_result = await client.request({
|
||||
"command": "account_lines",
|
||||
"account": wallet.address,
|
||||
// Tip: To look up only the new AMM's LP Tokens, uncomment:
|
||||
// "peer": lp_token.issuer,
|
||||
"ledger_index": "validated"
|
||||
})
|
||||
console.log(account_lines_result)
|
||||
|
||||
// Disconnect when done -----------------------------------------------------
|
||||
await client.disconnect()
|
||||
}
|
||||
main()
|
||||
|
||||
|
||||
/* Issue tokens ---------------------------------------------------------------
|
||||
* Fund a new issuer using the faucet, and issue some fungible tokens
|
||||
* to the specified address. In production, you would not do this; instead,
|
||||
* you would acquire tokens from an existing issuer (for example, you might
|
||||
* buy them in the DEX, or make an off-ledger deposit at a stablecoin issuer).
|
||||
* For a more thorough explanation of this process, see
|
||||
* "Issue a Fungible Token": https://xrpl.org/issue-a-fungible-token.html
|
||||
* Params:
|
||||
* client: an xrpl.Client instance that is already connected to the network
|
||||
* wallet: an xrpl.Wallet instance that should hold the new tokens
|
||||
* currency_code: string currency code (3-char ISO-like or hex code)
|
||||
* issue_quantity: string number of tokens to issue. Arbitrarily capped
|
||||
* at "10000000000"
|
||||
* Resolves to: an "Amount"-type JSON object, such as:
|
||||
* {
|
||||
* "currency": "TST",
|
||||
* "issuer": "rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd",
|
||||
* "value": "123.456"
|
||||
* }
|
||||
*/
|
||||
async function get_new_token(client, wallet, currency_code, issue_quantity) {
|
||||
// Get credentials from the Testnet Faucet -----------------------------------
|
||||
console.log("Funding an issuer address with the faucet...")
|
||||
const issuer = (await client.fundWallet()).wallet
|
||||
console.log(`Got issuer address ${issuer.address}.`)
|
||||
|
||||
// Enable issuer DefaultRipple ----------------------------------------------
|
||||
const issuer_setup_result = await client.submitAndWait({
|
||||
"TransactionType": "AccountSet",
|
||||
"Account": issuer.address,
|
||||
"SetFlag": xrpl.AccountSetAsfFlags.asfDefaultRipple
|
||||
}, {autofill: true, wallet: issuer} )
|
||||
if (issuer_setup_result.result.meta.TransactionResult == "tesSUCCESS") {
|
||||
console.log(`Issuer DefaultRipple enabled: ${EXPLORER}/transactions/${issuer_setup_result.result.hash}`)
|
||||
} else {
|
||||
throw `Error sending transaction: ${issuer_setup_result}`
|
||||
}
|
||||
|
||||
// Create trust line to issuer ----------------------------------------------
|
||||
const trust_result = await client.submitAndWait({
|
||||
"TransactionType": "TrustSet",
|
||||
"Account": wallet.address,
|
||||
"LimitAmount": {
|
||||
"currency": currency_code,
|
||||
"issuer": issuer.address,
|
||||
"value": "10000000000" // Large limit, arbitrarily chosen
|
||||
}
|
||||
}, {autofill: true, wallet: wallet})
|
||||
if (trust_result.result.meta.TransactionResult == "tesSUCCESS") {
|
||||
console.log(`Trust line created: ${EXPLORER}/transactions/${trust_result.result.hash}`)
|
||||
} else {
|
||||
throw `Error sending transaction: ${trust_result}`
|
||||
}
|
||||
|
||||
// Issue tokens -------------------------------------------------------------
|
||||
const issue_result = await client.submitAndWait({
|
||||
"TransactionType": "Payment",
|
||||
"Account": issuer.address,
|
||||
"Amount": {
|
||||
"currency": currency_code,
|
||||
"value": issue_quantity,
|
||||
"issuer": issuer.address
|
||||
},
|
||||
"Destination": wallet.address
|
||||
}, {autofill: true, wallet: issuer})
|
||||
if (issue_result.result.meta.TransactionResult == "tesSUCCESS") {
|
||||
console.log(`Tokens issued: ${EXPLORER}/transactions/${issue_result.result.hash}`)
|
||||
} else {
|
||||
throw `Error sending transaction: ${issue_result}`
|
||||
}
|
||||
|
||||
return {
|
||||
"currency": currency_code,
|
||||
"value": issue_quantity,
|
||||
"issuer": issuer.address
|
||||
}
|
||||
}
|
||||
5
content/_code-samples/create-amm/js/package.json
Normal file
5
content/_code-samples/create-amm/js/package.json
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"dependencies": {
|
||||
"xrpl": "2.8.0-beta.0"
|
||||
}
|
||||
}
|
||||
273
content/tutorials/use-tokens/create-an-automated-market-maker.md
Normal file
273
content/tutorials/use-tokens/create-an-automated-market-maker.md
Normal file
@@ -0,0 +1,273 @@
|
||||
---
|
||||
parent: use-tokens.html
|
||||
blurb: Set up an Automated Market Maker (AMM)
|
||||
embed_xrpl_js: true
|
||||
status: not_enabled
|
||||
filters:
|
||||
- interactive_steps
|
||||
labels:
|
||||
- Decentralized Exchange
|
||||
- Tokens
|
||||
- AMM
|
||||
---
|
||||
# Create an Automated Market Maker
|
||||
_(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 the AMM for a given asset pair.
|
||||
|
||||
<!-- Source for this specific tutorial's interactive bits: -->
|
||||
<script type="application/javascript" src="assets/js/tutorials/create-amm.js"></script>
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- You must have an XRP Ledger address and some XRP. For testing, you can get these from a [Faucet](xrp-testnet-faucet.html).
|
||||
- You should be familiar with the Getting Started instructions for your preferred client library. This page provides examples for the following:
|
||||
- **JavaScript** with the [xrpl.js library](https://github.com/XRPLF/xrpl.js/) **version 2.8.0-beta.0 or later**. See [Get Started Using JavaScript](get-started-using-javascript.html) for setup steps.
|
||||
- You can also read along and use the interactive steps in your browser without any setup.
|
||||
- You should have a basic understanding of how [tokens](tokens.html) work in the XRP Ledger.
|
||||
- You may want to read about [Automated Market Makers in the XRP Ledger](automated-market-makers.html) first.
|
||||
|
||||
|
||||
## Example Code
|
||||
|
||||
Complete sample code for all of the steps of these tutorials is available under the [MIT license](https://github.com/XRPLF/xrpl-dev-portal/blob/master/LICENSE).
|
||||
|
||||
- See [Code Samples: Create an AMM](https://github.com/XRPLF/xrpl-dev-portal/tree/master/content/_code-samples/create-amm/) in the source repository for this website.
|
||||
|
||||
|
||||
## Steps
|
||||
{% set n = cycler(* range(1,99)) %}
|
||||
{% set use_network = "AMM-Devnet" %}
|
||||
|
||||
### {{n.next()}}. Connect to the network
|
||||
|
||||
You must be connected to the network to query it and submit transactions. The following code shows how to connect to a public {{use_network}} server using a supported [client library](client-libraries.html):
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
_JavaScript_
|
||||
|
||||
{{ include_code("_code-samples/create-amm/js/connect.js", language="js") }}
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
For this tutorial, click the following button to connect:
|
||||
|
||||
{% include '_snippets/interactive-tutorials/connect-step.md' %}
|
||||
|
||||
### {{n.next()}}. Get credentials
|
||||
|
||||
To transact on the XRP Ledger, you need an address and secret key, and some XRP. For development purposes, you can get these on the [{{use_network}}](parallel-networks.html) using the following interface:
|
||||
|
||||
{% include '_snippets/interactive-tutorials/generate-step.md' %}
|
||||
|
||||
When you're [building production-ready software](production-readiness.html), you should use an existing account, and manage your keys using a [secure signing configuration](set-up-secure-signing.html). The following code shows how to get a `Wallet` instance using either the faucet or a seed provided by environment variable:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
_JavaScript_
|
||||
|
||||
{{ include_code("_code-samples/create-amm/js/create-amm.js", language="js", start_with="// Get credentials", end_before="// Acquire tokens") }}
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
|
||||
### {{n.next()}}. Select and acquire assets
|
||||
|
||||
As the creator of an AMM, you are also the first liquidity provider and you have to supply it with a starting pool of assets. Other users of the XRP Ledger can also become liquidity providers by supplying assets after the AMM exists. It's important to choose assets especially carefully because, as a liquidity provider for an AMM, you are supplying some amounts of both for users to swap between. If one of the AMM's assets becomes worthless, other users can use the AMM to trade for the other asset, leaving the AMM (and thus, its liquidity providers including you) holding only the worthless one. Technically, the AMM always holds some positive amount of both assets, but the amounts can be very small.
|
||||
|
||||
You can choose any pair of fungible assets in the XRP Ledger, including XRP or tokens, including LP Tokens from another AMM. If you use a token, you must hold some amount of that token. (If a token's issuer uses, [authorized trust lines](authorized-trust-lines.html), that means you have to be authorized first.)
|
||||
|
||||
For each of the two assets, you need to know its currency code and issuer; as an exception, XRP has no issuer. For each of the assets, you must hold a balance of the asset (or _be_ the issuer). The following sample code acquires two assets, "TST" (which it buys using XRP) and "FOO" (which it receives from the issuer).
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
_JavaScript_
|
||||
|
||||
{{ include_code("_code-samples/create-amm/js/create-amm.js", language="js", start_with="// Acquire tokens", end_before="// Check if AMM already exists") }}
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
This tutorial includes some example code to issue FOO tokens from a second test address. This is not realistic for a production scenario, because tokens do not inherently have value, but it makes it possible to demonstrate creating a new AMM for a unique currency pair. In production, you would acquire a second token in some other way, such as making an off-ledger deposit with the [stablecoin issuer](stablecoin-issuer.html), or buying it in the [decentralized exchange](decentralized-exchange.html).
|
||||
|
||||
The helper function for issuing follows an abbreviated version of the steps in the [Issue a Fungible Token](issue-a-fungible-token.html) tutorial:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
_JavaScript_
|
||||
|
||||
{{ include_code("_code-samples/create-amm/js/create-amm.js", language="js", start_with="/* Issue tokens") }}
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
{{ start_step("Acquire tokens") }}
|
||||
<button id="buy-tst" class="btn btn-primary previous-steps-required">Buy TST</button>
|
||||
<button id="get-foo" class="btn btn-primary previous-steps-required">Get FOO</button>
|
||||
<div class="loader collapse"><img class="throbber" src="assets/img/xrp-loader-96.png">Working...</div>
|
||||
<div class="output-area"></div>
|
||||
{{ end_step() }}
|
||||
|
||||
### {{n.next()}}. Check if the AMM exists
|
||||
|
||||
Since there can only be one AMM for a specific pair of assets, it's best to check first before trying to create one. Use the [amm_info method][] to check whether the AMM already exists. For the request, you specify the two assets. The response should be an `actNotFound` error if the AMM does not exist.
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
_JavaScript_
|
||||
|
||||
{{ include_code("_code-samples/create-amm/js/create-amm.js", language="js", start_with="// Check if AMM already exists", end_before="// Look up AMM transaction cost") }}
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
If the AMM does already exist, you should double-check that you specified the right pair of assets; if so, someone else has already created this AMM, but you can still deposit to it instead. <!-- TODO: link to a tutorial about depositing to and withdrawing from an AMM when one exists -->
|
||||
|
||||
{{ start_step("Check for AMM") }}
|
||||
<button id="check-for-amm" class="btn btn-primary previous-steps-required">Check AMM</button>
|
||||
<div class="loader collapse"><img class="throbber" src="assets/img/xrp-loader-96.png">Sending...</div>
|
||||
<div class="output-area"></div>
|
||||
{{ end_step() }}
|
||||
|
||||
### {{n.next()}}. Look up the AMMCreate transaction cost
|
||||
|
||||
Creating an AMM has a special [transaction cost][] to prevent spam: since it creates objects in the ledger that no one owns, you must burn at least one [owner reserve increment](reserves.html) of XRP to send the AMMCreate transaction. The exact value can change due to [fee voting](https://xrpl.org/fee-voting.html), so you should look up the current incremental reserve value using the [server_state method][].
|
||||
|
||||
It is also a good practice to display this value and give a human operator a chance to stop before you send the transaction. Burning an owner reserve is typically a much higher cost than sending a normal transaction, so you don't want it to be a surprise. (Currently, on both Mainnet and AMM-Devnet, the cost of sending a typical transaction is 0.000010 XRP but the cost of AMMCreate is 2 XRP.)
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
_JavaScript_
|
||||
|
||||
{{ include_code("_code-samples/create-amm/js/create-amm.js", language="js", start_with="// Look up AMM transaction cost", end_before="// Create AMM") }}
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
{{ start_step("Look up AMMCreate cost") }}
|
||||
<button id="look-up-ammcreate-cost" class="btn btn-primary previous-steps-required">Check cost</button>
|
||||
<div class="loader collapse"><img class="throbber" src="assets/img/xrp-loader-96.png">Sending...</div>
|
||||
<div class="output-area"></div>
|
||||
{{ end_step() }}
|
||||
|
||||
|
||||
### {{n.next()}}. Send AMMCreate transaction
|
||||
|
||||
Send an [AMMCreate transaction][] to create the AMM. Important aspects of this transaction include:
|
||||
|
||||
| Field | Value | Description |
|
||||
|-------|--------|-------------|
|
||||
| `Asset` | [Currency Amount][] | Starting amount of one asset to deposit in the AMM. |
|
||||
| `Asset2` | [Currency Amount][] | Starting amount of the other asset to deposit in the AMM. |
|
||||
| `TradingFee` | Number | The fee to charge when trading against this AMM instance. The maximum value is `1000`, meaning a 1% fee; the minimum value is `0`. If you set this too high, it may be too expensive for users to trade against the AMM; but the lower you set it, the more you expose yourself to currency risk from the AMM's assets changing in value relative to one another. |
|
||||
| `Fee` | String - XRP Amount | The transaction cost you looked up in a previous step. Client libraries may require that you add a special exception or reconfigure a setting to specify a `Fee` value this high. |
|
||||
|
||||
For the two starting assets, it does not matter which is `Asset` and which is `Asset2`, but you should specify amounts that are about equal in total value, because otherwise other users can profit at your expense by trading against the AMM.
|
||||
|
||||
**Tip:** Use `fail_hard` when submitting this transaction, so you don't have to pay the high transaction cost if the transaction initially fails. (It's still _possible_ that the transaction could tentatively succeed, and then fail and still burn the transaction cost, but this protects you from burning XRP on many of types of failures.)
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
_JavaScript_
|
||||
|
||||
{{ include_code("_code-samples/create-amm/js/create-amm.js", language="js", start_with="// Create AMM", end_before="// Confirm that AMM exists") }}
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
{{ start_step("Create AMM") }}
|
||||
<form>
|
||||
<div class="form-group row">
|
||||
<label for="trading-fee" class="col-form-label col-sm-3">Trading Fee</label>
|
||||
<div class="input-group col">
|
||||
<input type="number" class="form-control" id="trading-fee" value="0.5" step="0.001" min="0" max="1" />
|
||||
<div class="input-group-append">
|
||||
<div class="input-group-text">%</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="form-group row">
|
||||
<label for="asset-amount" class="col-form-label col-sm-3">Amount</label>
|
||||
<div class="input-group col">
|
||||
<input type="number" class="form-control" id="asset-amount" value="15" step="any" min="0" />
|
||||
<div class="input-group-append">
|
||||
<div class="input-group-text">TST.rP9jPyP5kyvFRb6ZiRghAGw5u8SGAmU4bd</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="form-group row">
|
||||
<label for="asset2-amount" class="col-form-label col-sm-3">Amount2</label>
|
||||
<div class="input-group col">
|
||||
<input type="number" class="form-control" id="asset2-amount" value="100" step="any" min="0" />
|
||||
<div class="input-group-append">
|
||||
<div class="input-group-text">FOO.<span class="foo-issuer">(issuer)</span></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</form>
|
||||
<button id="create-amm" class="btn btn-primary previous-steps-required">Create AMM</button>
|
||||
<div class="loader collapse"><img class="throbber" src="assets/img/xrp-loader-96.png">Sending...</div>
|
||||
<div class="output-area"></div>
|
||||
{{ end_step() }}
|
||||
|
||||
### {{n.next()}}. Check AMM info
|
||||
|
||||
If the AMMCreate transaction succeeded, it creates the AMM and related objects in the ledger. You _could_ check the metadata of the AMMCreate transaction, but it is often easier to call the [amm_info method][] again to get the status of the newly-created AMM.
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
_JavaScript_
|
||||
|
||||
{{ include_code("_code-samples/create-amm/js/create-amm.js", language="js", start_with="// Confirm that AMM exists", end_before="// Check token balances") }}
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
In the result, the `amm` object's `lp_token` field is particularly useful because it includes the issuer and currency code of the AMM's LP Tokens, which you need to know for many other AMM-related transactions. LP Tokens always have a hex currency code starting with `03`, and the rest of the code is derived from the issuers and currency codes of the tokens in the AMM's pool. The issuer of the LP Tokens is the AMM address, which is randomly chosen when you create an AMM.
|
||||
|
||||
Initially, the AMM's total outstanding LP Tokens, reported in the `lp_token` field of the `amm_info` response, match the tokens you hold as its first liquidity provider. However, after other accounts deposit liquidity to the same AMM, the amount shown in `amm_info` updates to reflect the total issued to all liquidity providers. Since others can deposit at any time, even potentially in the same ledger version where the AMM was created, you shouldn't assume that this amount represents your personal LP Tokens balance.
|
||||
|
||||
{{ start_step("Check AMM info") }}
|
||||
<button id="check-amm-info" class="btn btn-primary previous-steps-required">Check AMM</button>
|
||||
<div class="loader collapse"><img class="throbber" src="assets/img/xrp-loader-96.png">Sending...</div>
|
||||
<div class="output-area"></div>
|
||||
{{ end_step() }}
|
||||
|
||||
### {{n.next()}}. Check trust lines
|
||||
|
||||
You can also use the [account_lines method][] to get an updated view of your token balances. Your balances should be decreased by the amounts you deposited, but you now have a balance of LP Tokens that you received from the AMM.
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
_JavaScript_
|
||||
|
||||
{{ include_code("_code-samples/create-amm/js/create-amm.js", language="js", start_with="// Check token balances", end_before="// Disconnect") }}
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
The `account_lines` response shows only the tokens held by the account you looked up (probably yours). If you have a lot of tokens, you may want to specify the AMM address as the `peer` in the request so you don't have to [paginate](markers-and-pagination.html) over multiple requests to find the AMM's LP Tokens. In this tutorial, your account probably only holds the three different tokens, so you can see all three in the same response.
|
||||
|
||||
**Tip:** If one of the assets in the AMM's pool is XRP, you need to call the [account_info method][] on your account to see the difference in your balance (the `Balance` field of the account object).
|
||||
|
||||
{{ start_step("Check trust lines") }}
|
||||
<button id="check-trust-lines" class="btn btn-primary previous-steps-required">Check trust lines</button>
|
||||
<div class="loader collapse"><img class="throbber" src="assets/img/xrp-loader-96.png">Sending...</div>
|
||||
<div class="output-area"></div>
|
||||
{{ end_step() }}
|
||||
|
||||
|
||||
## Next Steps
|
||||
|
||||
At this point the AMM is up and running, and [trades in the DEX](trade-in-the-decentralized-exchange.html) automatically use this AMM in combination with Offers to achieve the best exchange rate possible between the two assets in the AMM's pool. If the flow of funds between the two assets is relatively balanced and there are no major shifts in the value of one asset compared to the other, this can become a source of passive income for you and anyone else who deposits liquidity into the AMM's pool.
|
||||
|
||||
When you want to withdraw liquidity from the AMM, you can use [AMMDeposit][] to cash in your LP Tokens to receive a share of the AMM's assets. You can also use LP Tokens like any other tokens in the XRP Ledger, which means you can trade them, use them in payments, or even deposit them in another AMM.
|
||||
|
||||
However, you should keep an eye on market conditions, and use tools like [AMMBid][] and [AMMVote][] to insulate yourself from losses due to changes in the relative value of the two assets in the pool.
|
||||
|
||||
|
||||
<!-- MD: reusable link definitions: -->
|
||||
[account_info method]: account_info.html
|
||||
[amm_info method]: amm_info.html
|
||||
[account_lines method]: account_lines.html
|
||||
[server_state method]: server_state.html
|
||||
[Currency Amount]: basic-data-types.html#specifying-currency-amounts
|
||||
[transaction cost]: transaction-cost.html
|
||||
[AMMCreate transaction]: ammcreate.html
|
||||
[AMMBid]: ammbid.html
|
||||
[AMMDeposit]: ammdeposit.html
|
||||
[AMMVote]: ammvote.html
|
||||
Reference in New Issue
Block a user