Skip to content

Commit

Permalink
deploy: 12882ec
Browse files Browse the repository at this point in the history
  • Loading branch information
oeggert committed Jan 9, 2024
1 parent efcc847 commit 68a1792
Show file tree
Hide file tree
Showing 517 changed files with 2,375 additions and 2,350 deletions.
2 changes: 1 addition & 1 deletion pr-preview/did-docs/amm.html
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ <h3 id="auction-slot-object">Auction Slot Object<a aria-hidden="true" class="hov
<td style="text-align: left;">String</td>
<td style="text-align: left;">UInt32</td>
<td style="text-align: left;">Yes</td>
<td style="text-align: left;">The trading fee to be charged to the auction owner, in the same format as <code>TradingFee</code>. By default this is 0, meaning that the auction owner can trade at no fee instead of the standard fee for this AMM.</td>
<td style="text-align: left;">The trading fee to be charged to the auction owner, in the same format as <code>TradingFee</code>. Normally, this is 1/10 of the normal fee for this AMM.</td>
</tr>
<tr>
<td style="text-align: left;"><code>Price</code></td>
Expand Down
2 changes: 1 addition & 1 deletion pr-preview/did-docs/amm_info.html
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,7 @@ <h3 id="auction-slot-object">Auction Slot Object<a aria-hidden="true" class="hov
<tr>
<td><code>discounted_fee</code></td>
<td>Number</td>
<td>The discounted trading fee that applies to the auction slot holder, and any eligible accounts, when trading against this AMM. This is always 0.</td>
<td>The discounted trading fee that applies to the auction slot holder, and any eligible accounts, when trading against this AMM. This is 1/10 of the AMM's normal trading fee.</td>
</tr>
<tr>
<td><code>expiration</code></td>
Expand Down
1 change: 1 addition & 0 deletions pr-preview/did-docs/assets/img/logos/typescript.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion pr-preview/did-docs/automated-market-makers.html
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ <h2 id="trading-fees">Trading Fees<a aria-hidden="true" class="hover_anchor" hre
<p>Liquidity providers can vote to set the fee from 0% to 1%, in increments of 0.001%. Liquidity providers have an incentive to set trading fees at an appropriate rate: if fees are too high, trades will use order books to get a better rate instead; if fees are too low, liquidity providers don't get any benefit for contributing to the pool. <!-- STYLE_OVERRIDE: will --> Each AMM gives its liquidity providers the power to vote on its fees, in proportion to the amount of LP Tokens those liquidity providers hold.</p>
<p>To vote, a liquidity provider sends an <a href="ammvote.html">AMMVote transaction</a>. Whenever anyone places a new vote, the AMM recalculates its fee to be an average of the latest votes weighted by how many LP Tokens those voters hold. Up to 8 liquidity providers' votes can be counted this way; if more liquidity providers try to vote then only the top 8 votes (by most LP Tokens held) are counted. Even though liquidity providers' share of LP Tokens can shift rapidly for many reasons (such as trading those tokens using <a href="offers.html">Offers</a>), the trading fees are only recalculated whenever someone places a new vote (even if that vote is not one of the top 8).</p>
<h3 id="auction-slot">Auction Slot<a aria-hidden="true" class="hover_anchor" href="#auction-slot"><i class="fa fa-link"></i></a></h3>
<p>Unlike any previous Automated Market Makers, the XRP Ledger's AMM design has an <em>auction slot</em> that a liquidity provider can bid on to get a discount on the trading fee for a 24-hour period. The bid must be paid in LP Tokens, which are returned to the AMM. No more than one account can hold the auction slot at a time, but the bidder can name up to 4 more accounts to also receive the discount. There is no minimum bid, but if the slot is currently occupied then you must outbid the current slot holder to displace them. If someone displaces you, you get part of your bid back depending on how much time remains. As long as you hold an active auction slot, you pay a discounted trading fee of 0% when making trades against that AMM.</p>
<p>Unlike any previous Automated Market Makers, the XRP Ledger's AMM design has an <em>auction slot</em> that a liquidity provider can bid on to get a discount on the trading fee for a 24-hour period. The bid must be paid in LP Tokens, which are returned to the AMM. No more than one account can hold the auction slot at a time, but the bidder can name up to 4 more accounts to also receive the discount. There is no minimum bid, but if the slot is currently occupied then you must outbid the current slot holder to displace them. If someone displaces you, you get part of your bid back depending on how much time remains. As long as you hold an active auction slot, you pay a discounted trading fee equal to 1/10 (one tenth) of the normal trading fee when making trades against that AMM.</p>
<p>With any AMM, when the price of its assets shifts significantly in external markets, traders can use arbitrage to profit off the AMM, which results in a loss for liquidity providers. The auction mechanism is intended to return more of that value to liquidity providers and more quickly bring the AMM's prices back into balance with external markets.</p>
<h2 id="representation-in-the-ledger">Representation in the Ledger<a aria-hidden="true" class="hover_anchor" href="#representation-in-the-ledger"><i class="fa fa-link"></i></a></h2>
<p>In the ledger's state data, an AMM consists of multiple <a href="ledger-object-types.html">ledger entries</a>:</p>
Expand Down
14 changes: 14 additions & 0 deletions pr-preview/did-docs/client-libraries.html
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,20 @@ <h1 id="client-libraries">Client Libraries<a aria-hidden="true" class="hover_anc
<td><a class="external-link" href="https://github.com/XRPLF/xrpl.js" target="_blank">Repo <i aria-hidden="true" class="fa fa-external-link"></i></a></td>
</tr>
<tr>
<td><strong>JavaScript</strong> / <strong>TypeScript</strong></td>
<td><code>xrpl-client</code></td>
<td><a class="external-link" href="https://jsfiddle.net/WietseWind/35az6p1b/" target="_blank">Get Started <i aria-hidden="true" class="fa fa-external-link"></i></a></td>
<td><a class="external-link" href="https://www.npmjs.com/package/xrpl-client" target="_blank">NPM Reference <i aria-hidden="true" class="fa fa-external-link"></i></a></td>
<td><a class="external-link" href="https://github.com/XRPL-Labs/xrpl-client" target="_blank">Repo <i aria-hidden="true" class="fa fa-external-link"></i></a></td>
</tr>
<tr>
<td><strong>JavaScript</strong> / <strong>TypeScript</strong></td>
<td><code>xrpl-accountlib</code></td>
<td><a class="external-link" href="https://jsfiddle.net/WietseWind/gkefpnu0/" target="_blank">Get Started <i aria-hidden="true" class="fa fa-external-link"></i></a></td>
<td><a class="external-link" href="https://www.npmjs.com/package/xrpl-accountlib" target="_blank">NPM Reference <i aria-hidden="true" class="fa fa-external-link"></i></a></td>
<td><a class="external-link" href="https://github.com/WietseWind/xrpl-accountlib" target="_blank">Repo <i aria-hidden="true" class="fa fa-external-link"></i></a></td>
</tr>
<tr>
<td><strong>C++</strong></td>
<td><code>rippled</code> Signing Library</td>
<td><a class="external-link" href="https://github.com/XRPLF/rippled/tree/develop/Builds/linux#signing-library" target="_blank">Get Started <i aria-hidden="true" class="fa fa-external-link"></i></a></td>
Expand Down
7 changes: 6 additions & 1 deletion pr-preview/did-docs/code-samples.html
Original file line number Diff line number Diff line change
Expand Up @@ -339,9 +339,10 @@ <h4 class="card-title h5">Build a Wallet</h4>
</div>
<div class="card-footer">&nbsp;</div>
</a>
<a class="card cardtest col-12 col-lg-5 lang_js " href="https://github.com/XRPLF/xrpl-dev-portal/tree/did-docs/content/_code-samples/create-amm">
<a class="card cardtest col-12 col-lg-5 lang_js lang_ts " href="https://github.com/XRPLF/xrpl-dev-portal/tree/did-docs/content/_code-samples/create-amm">
<div class="card-header">
<span class="circled-logo"><img alt="js" src="assets/img/logos/javascript.svg" /></span>
<span class="circled-logo"><img alt="ts" src="assets/img/logos/typescript.svg" /></span>
</div>
<div class="card-body">
<h4 class="card-title h5">Create AMM</h4>
Expand Down Expand Up @@ -3548,6 +3549,10 @@ <h6 class="eyebrow mb-20">Help the XRPL community by submitting your<br> own cod
<input type="radio" name="langs" id="input_cli" value="cli">
<label for="input_cli">CLI</label>
</div>
<div class="single_lang">
<input type="radio" name="langs" id="input_ts" value="ts">
<label for="input_ts"></label>
</div>
<div class="single_lang">
<input type="radio" name="langs" id="input_php" value="php">
<label for="input_php"></label>
Expand Down
2 changes: 1 addition & 1 deletion pr-preview/did-docs/create-an-automated-market-maker.html
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ <h3 id="2-get-credentials">2. Get credentials<a aria-hidden="true" class="hover_
</div><!--/.interactive-block-inner-->
</div>
<p class="devportal-callout caution"><strong>Caution:</strong> Ripple provides the <a href="parallel-networks.html">Testnet and Devnet</a> for testing purposes only, and sometimes resets the state of these test networks along with all balances. As a precaution, <strong>do not</strong> use the same addresses on Testnet/Devnet and Mainnet.</p>
<p>When you're <a href="production-readiness.html">building production-ready software</a>, you should use an existing account, and manage your keys using a <a href="set-up-secure-signing.html">secure signing configuration</a>. The following code shows how to get a <code>Wallet</code> instance using either the faucet or a seed provided by environment variable:</p>
<p>When you're building production-ready software, you should use an existing account, and manage your keys using a <a href="set-up-secure-signing.html">secure signing configuration</a>. The following code shows how to get a <code>Wallet</code> instance using either the faucet or a seed provided by environment variable:</p>
<div class="multicode" id="code-1"><ul class="codetabs"><li><a class="javascript" href="#code-1-0">JavaScript</a></li></ul>

<div class="code_sample javascript" id="code-1-0" style="position: static;"><div class="codehilite"><div aria-label="Code Buttons" class="btn-group" role="group"><button alt="Copy to clipboard" class="btn btn-outline-secondary clipboard-btn" data-clipboard-target="#codeblock-1" id="codeblock-1button"><i class="fa fa-clipboard"></i></button></div><pre><span></span><code id="codeblock-1"><span class="c1">// Get credentials from the Faucet -------------------------------------------</span>
Expand Down
2 changes: 1 addition & 1 deletion pr-preview/did-docs/decentralized-identifiers.html
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ <h2 id="did-documents">DID Documents<a aria-hidden="true" class="hover_anchor" h
<ol>
<li>Store a reference to the document in the <code>URI</code> field of the <code>DID</code> object, which points to a document stored on another decentralized storage network, such as IPFS or STORJ.</li>
<li>Store a minimal DID document in the <code>DIDDocument</code> field of the <code>DID</code> object.</li>
<li>Specify a minimal <em>implicit</em> DID document generated from the DID and other available public information.
<li>Use a minimal <em>implicit</em> DID document generated from the DID and other available public information.
<strong>Note:</strong> Simpler use cases may only need signatures and simple authorization tokens. In cases where there isn't explicitly a DID document on the ledger, an implicit document is used instead. For example, the implicit DID Document of <code>did:xrpl:1:0330E7FC9D56BB25D6893BA3F317AE5BCF33B3291BD63DB32654A313222F7FD020</code> enables only a single key <code>0330E7FC9D56BB25D6893BA3F317AE5BCF33B3291BD63DB32654A313222F7FD020</code> to authorize changes on the DID document or sign credentials in the name of the DID.</li>
</ol>
<h3 id="sample-xrpl-did-document">Sample XRPL DID Document<a aria-hidden="true" class="hover_anchor" href="#sample-xrpl-did-document"><i class="fa fa-link"></i></a></h3>
Expand Down
2 changes: 1 addition & 1 deletion pr-preview/did-docs/enable-no-freeze.html
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ <h3 id="1-get-credentials">1. Get Credentials<a aria-hidden="true" class="hover_
</div><!--/.interactive-block-inner-->
</div>
<p class="devportal-callout caution"><strong>Caution:</strong> Ripple provides the <a href="parallel-networks.html">Testnet and Devnet</a> for testing purposes only, and sometimes resets the state of these test networks along with all balances. As a precaution, <strong>do not</strong> use the same addresses on Testnet/Devnet and Mainnet.</p>
<p>When you're <a href="production-readiness.html">building production-ready software</a>, you should use an existing account, and manage your keys using a <a href="secure-signing.html">secure signing configuration</a>.</p>
<p>When you're building production-ready software, you should use an existing account, and manage your keys using a <a href="secure-signing.html">secure signing configuration</a>.</p>
<h3 id="2-connect-to-the-network">2. Connect to the Network<a aria-hidden="true" class="hover_anchor" href="#2-connect-to-the-network"><i class="fa fa-link"></i></a></h3>
<p>You must be connected to the network to submit transactions to it. The following code shows how to connect to a public XRP Ledger Testnet server a supported <a href="client-libraries.html">client library</a>:</p>
<div class="multicode" id="code-0"><ul class="codetabs"><li><a class="javascript" href="#code-0-0">JavaScript</a></li></ul>
Expand Down
2 changes: 1 addition & 1 deletion pr-preview/did-docs/enact-global-freeze.html
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ <h3 id="1-get-credentials">1. Get Credentials<a aria-hidden="true" class="hover_
</div><!--/.interactive-block-inner-->
</div>
<p class="devportal-callout caution"><strong>Caution:</strong> Ripple provides the <a href="parallel-networks.html">Testnet and Devnet</a> for testing purposes only, and sometimes resets the state of these test networks along with all balances. As a precaution, <strong>do not</strong> use the same addresses on Testnet/Devnet and Mainnet.</p>
<p>When you're <a href="production-readiness.html">building production-ready software</a>, you should use an existing account, and manage your keys using a <a href="secure-signing.html">secure signing configuration</a>.</p>
<p>When you're building production-ready software, you should use an existing account, and manage your keys using a <a href="secure-signing.html">secure signing configuration</a>.</p>
<h3 id="2-connect-to-the-network">2. Connect to the Network<a aria-hidden="true" class="hover_anchor" href="#2-connect-to-the-network"><i class="fa fa-link"></i></a></h3>
<p>You must be connected to the network to submit transactions to it. The following code shows how to connect to a public XRP Ledger Testnet server a supported <a href="client-libraries.html">client library</a>:</p>
<div class="multicode" id="code-0"><ul class="codetabs"><li><a class="javascript" href="#code-0-0">JavaScript</a></li></ul>
Expand Down
24 changes: 12 additions & 12 deletions pr-preview/did-docs/events.html
Original file line number Diff line number Diff line change
Expand Up @@ -329,18 +329,6 @@ <h6 class="mb-3">Filter By:</h6>
</div>

<div class="mt-2 row row-cols-1 row-cols-lg-3 card-deck">
<a class="event-card hackathon-upcoming" href="https://newhorizon.devpost.com/" style="" target="_blank">
<div class="event-card-header" style="background: no-repeat url(assets/img/events/Hackathons.png);">
<div class="event-card-title">New Horizon: Innovate Without Limits: New Horizons Await</div>
</div>
<div class="event-card-body">
<p>Join our EVM-compatible chain launch for a chance to win $50,000 in prizes! Unleash your creativity in DeFi and NFTs, with judging criteria focused on novelty, impact, and community engagement.</p>
</div>
<div class="mt-lg-auto event-card-footer d-flex flex-column">
<span class="mb-2 d-flex icon icon-location">Virtual</span>
<span class="d-flex icon icon-date">October 19, 2023 - December 22, 2023</span>
</div>
</a>
<a class="event-card conference-upcoming" href="https://www.parisblockchainweek.com/" style="" target="_blank">
<div class="event-card-header" style="background: no-repeat url(assets/img/events/Conference.png);">
<div class="event-card-title">Paris Blockchain Week</div>
Expand Down Expand Up @@ -457,6 +445,18 @@ <h6 class="mb-3">Filter By:</h6>
<span class="d-flex icon icon-date">November 28, 7pm - 9pm</span>
</div>
</a>
<a class="event-card hackathon-past" href="https://newhorizon.devpost.com/" target="_blank">
<div class="event-card-header" style="background: no-repeat url(assets/img/events/Hackathons.png); ">
<div class="event-card-title">New Horizon: Innovate Without Limits: New Horizons Await</div>
</div>
<div class="event-card-body">
<p>Join our EVM-compatible chain launch for a chance to win $50,000 in prizes! Unleash your creativity in DeFi and NFTs, with judging criteria focused on novelty, impact, and community engagement.</p>
</div>
<div class="mt-lg-auto event-card-footer d-flex flex-column">
<span class="mb-2 d-flex icon icon-location">Virtual</span>
<span class="d-flex icon icon-date">October 19, 2023 - December 22, 2023</span>
</div>
</a>
<a class="event-card meetup-past" href="https://www.eventbrite.co.uk/e/xrpl-demo-day-tickets-740650023157?aff=oddtdtcreator" target="_blank">
<div class="event-card-header" style="background: no-repeat url(assets/img/events/singapore.png); ">
<div class="event-card-title">XRPL Accelerator Demo Day</div>
Expand Down
2 changes: 1 addition & 1 deletion pr-preview/did-docs/issue-a-fungible-token.html
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ <h3 id="1-get-credentials">1. Get Credentials<a aria-hidden="true" class="hover_
</div><!--/.interactive-block-inner-->
</div>
<p class="devportal-callout caution"><strong>Caution:</strong> Ripple provides the <a href="parallel-networks.html">Testnet and Devnet</a> for testing purposes only, and sometimes resets the state of these test networks along with all balances. As a precaution, <strong>do not</strong> use the same addresses on Testnet/Devnet and Mainnet.</p>
<p>When you're <a href="production-readiness.html">building production-ready software</a>, you should use an existing account, and manage your keys using a <a href="secure-signing.html">secure signing configuration</a>.</p>
<p>When you're building production-ready software, you should use an existing account, and manage your keys using a <a href="secure-signing.html">secure signing configuration</a>.</p>
<h3 id="2-connect-to-the-network">2. Connect to the Network<a aria-hidden="true" class="hover_anchor" href="#2-connect-to-the-network"><i class="fa fa-link"></i></a></h3>
<p>You must be connected to the network to submit transactions to it. The following code shows how to connect to a public XRP Ledger Testnet server with a supported <a href="client-libraries.html">client library</a>:</p>
<div class="multicode" id="code-0"><ul class="codetabs"><li><a class="javascript" href="#code-0-0">JavaScript</a></li><li><a class="python" href="#code-0-1">Python</a></li><li><a class="java" href="#code-0-2">Java</a></li></ul>
Expand Down
Loading

0 comments on commit 68a1792

Please sign in to comment.