Re-level non-docs content to top of repo and rename content→docs

static/js/tutorials/use-tickets.js

@@ -0,0 +1,216 @@
+// 1. Generate
+// 2. Connect
+// The code for these steps is handled by interactive-tutorial.js
+window.onRouteChange(() => {
+  const LLS_OFFSET = 75 // Expire unconfirmed transactions after about ~5 min
+
+// 3. Check Sequence Number
+$("#check-sequence").click( async function(event) {
+  const block = $(event.target).closest(".interactive-block")
+  const address = get_address(event)
+  if (!address) {return}
+
+  // Wipe previous output
+  block.find(".output-area").html("")
+  block.find(".loader").show()
+  const account_info = await api.request({
+    "command": "account_info", "account": address
+  })
+  block.find(".loader").hide()
+
+  block.find(".output-area").append(
+    `<p>Current sequence:
+    <code id="current_sequence">${account_info.result.account_data.Sequence}</code>
+    </p>`)
+
+  complete_step("Check Sequence")
+})
+
+// 4. Prepare and Sign TicketCreate --------------------------------------------
+$("#prepare-and-sign").click( async function(event) {
+  const block = $(event.target).closest(".interactive-block")
+  const wallet = get_wallet(event)
+  if (!wallet) {return}
+  let current_sequence
+  try {
+    current_sequence = parseInt($("#current_sequence").text())
+  } catch (e) {
+    current_sequence = null
+  }
+
+  // Wipe previous output
+  block.find(".output-area").html("")
+
+  if (!current_sequence) {
+    show_error(block,
+      `Couldn't get a valid sequence value. Check that the
+      previous steps were completed successfully.`)
+    return;
+  }
+
+  const vli = await api.getLedgerIndex()
+  const prepared = await api.autofill({
+    "TransactionType": "TicketCreate",
+    "Account": wallet.address,
+    "TicketCount": 10,
+    "Sequence": current_sequence,
+    "LastLedgerSequence": vli+LLS_OFFSET
+  })
+
+  block.find(".output-area").append(
+    `<p>Prepared transaction:</p>
+    <pre><code>${pretty_print(prepared)}</code></pre>`)
+
+  const {tx_blob, hash} = wallet.sign(prepared)
+  block.find(".output-area").append(
+    `<p>Transaction hash: <code id="tx_id">${hash}</code></p>`)
+  block.find(".output-area").append(
+    `<p>Signed blob:</p><pre class="tx-blob"><code id="tx_blob">${tx_blob}</code></pre>`)
+
+  complete_step("Prepare & Sign")
+
+})
+
+// 5. Submit TicketCreate ------------------------------------------------------
+$("#ticketcreate-submit").click( submit_handler )
+
+// 6. Wait for Validation: handled by interactive-tutorial.js and by the
+// generic submit handler in the previous step. --------------------------------
+
+// Intermission ----------------------------------------------------------------
+async function intermission_submit(event, tx_json) {
+  const block = $(event.target).closest(".interactive-block")
+  const wallet = get_wallet(event)
+  if (!wallet) {return}
+  const prepared = await api.autofill(tx_json)
+  const {tx_blob, hash} = wallet.sign(prepared)
+  const prelim = await api.request({
+    "command": "submit",
+    "tx_blob": tx_blob
+  })
+
+  block.find(".output-area").append(`<p>${prepared.TransactionType}
+    ${prepared.Sequence}:
+    <a href="https://devnet.xrpl.org/transactions/${hash}"
+    target="_blank">${prelim.result.engine_result}</a></p>`)
+}
+
+$("#intermission-payment").click( async function(event) {
+  const address = get_address(event)
+  if (!address) {return}
+
+  intermission_submit(event, {
+    "TransactionType": "Payment",
+    "Account": address,
+    "Destination": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe", // Testnet Faucet
+    "Amount": xrpl.xrpToDrops("201")
+  })
+
+  complete_step("Intermission")
+})
+
+$("#intermission-escrowcreate").click( async function(event) {
+  const address = get_address(event)
+  if (!address) {return}
+
+  intermission_submit(event, {
+    "TransactionType": "EscrowCreate",
+    "Account": address,
+    "Destination": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh", // Genesis acct
+    "Amount": xrpl.xrpToDrops("0.13"), // Arbitrary amount
+    "FinishAfter": xrpl.isoTimeToRippleTime(Date()) + 30 // 30 seconds from now
+  })
+
+  complete_step("Intermission")
+})
+
+$("#intermission-accountset").click( async function(event) {
+  const address = get_address(event)
+  if (!address) {return}
+
+  intermission_submit(event, {
+    "TransactionType": "AccountSet",
+    "Account": address
+  })
+
+  complete_step("Intermission")
+})
+
+// 7. Check Available Tickets --------------------------------------------------
+$("#check-tickets").click( async function(event) {
+  const block = $(event.target).closest(".interactive-block")
+  const address = get_address(event)
+  if (!address) {return}
+  // Wipe previous output
+  block.find(".output-area").html("")
+  block.find(".loader").show()
+
+  let response = await api.request({
+      "command": "account_objects",
+      "account": address,
+      "type": "ticket"
+    })
+  block.find(".output-area").html(
+    `<pre><code>${pretty_print(response)}</code></pre>`)
+
+  block.find(".loader").hide()
+
+  // Reset the next step's form & add these tickets
+  $("#ticket-selector .form-area").html("")
+  response.result.account_objects.forEach((ticket, i) => {
+      $("#ticket-selector .form-area").append(
+        `<div class="form-check form-check-inline">
+        <input class="form-check-input" type="radio" id="ticket${i}"
+        name="ticket-radio-set" value="${ticket.TicketSequence}">
+        <label class="form-check-label"
+        for="ticket${i}">${ticket.TicketSequence}</label></div>`)
+    })
+
+  complete_step("Check Tickets")
+})
+
+// 8. Prepare Ticketed Transaction ---------------------------------------------
+$("#prepare-ticketed-tx").click(async function(event) {
+  const wallet = get_wallet(event)
+  if (!wallet) {return}
+
+  const block = $(event.target).closest(".interactive-block")
+  block.find(".output-area").html("")
+  const use_ticket = parseInt($('input[name="ticket-radio-set"]:checked').val())
+  if (!use_ticket) {
+    show_error(block, "You must choose a ticket first.")
+    return
+  }
+  const vli = await api.getLedgerIndex()
+
+  const prepared_t = await api.autofill({
+    "TransactionType": "AccountSet",
+    "Account": wallet.address,
+    "TicketSequence": use_ticket,
+    "Sequence": 0,
+    "LastLedgerSequence": vli+LLS_OFFSET
+  })
+
+  block.find(".output-area").append(
+    `<p>Prepared transaction:</p>
+    <pre><code>${pretty_print(prepared_t)}</code></pre>`)
+
+  const {tx_blob, hash} = wallet.sign(prepared_t)
+  block.find(".output-area").append(
+    `<p>Transaction hash: <code id="tx_id_t">${hash}</code></p>`)
+
+  block.find(".output-area").append(
+    `<pre style="visibility: none">
+    <code id="tx_blob_t">${tx_blob}</code></pre>`)
+
+  // Update breadcrumbs & activate next step
+  complete_step("Prepare Ticketed Tx")
+})
+
+// 9. Submit Ticketed Transaction ----------------------------------------------
+$("#ticketedtx-submit").click( submit_handler )
+
+// 10. Wait for Validation (Again): handled by interactive-tutorial.js and by
+// the generic submit handler in the previous step. --------------------------------
+
+})