Files
xrpl-dev-portal/content/tutorials/quickstart/xrpl-quickstart.md
Amarantha Kulkarni 845422da7f Add words from new features such as NFTs to the spell checker (#1615)
* Add words from new features such as NFTs to the spell checker

* Add more proper nouns and general purpose words

* Add more proper nouns and general purpose words

* Update to use backticks

* Update proper nouns and generic words

* Fix style for words based on style checker report

* Style/spelling fixes

* Fix links broken by style/spelling updates

* More edits for style

* Finish updates to get style checker to pass

Co-authored-by: mDuo13 <mduo13@gmail.com>
2022-12-15 14:29:32 -08:00

3.5 KiB

html, parent, blurb, labels
html parent blurb labels
xrpl-quickstart.html tutorials.html Use a JavaScript test harness to send XRP, trade currencies, and mint and trade NFTokens.
Accounts
Cross-Currency
Non-fungible Tokens, NFTs
Payments
Quickstart
Tokens
XRP

XRPL Quickstart

The XRP Ledger (XRPL) is a robust, secure, customizable service. You can create your own interface to try out the capabilities and support your specific business needs.

This quickstart describes a test harness interface you can build to try out the XRP Ledger. The test harness displays multiple accounts, so that you can transfer tokens from one account to the other and see the results in real time. The image below shows the Token Test Harness at the completion of step 4.

Quickstart Tutorial Window

That is a lot of fields and buttons, all working together to perform some significant practical tasks. But getting started with the XRP Ledger is not that complicated. When you eat the elephant a bite at a time, none of the tasks are difficult to consume.

Typically, the example functions for interacting with the XRP Ledger involve four steps.

  1. Connect to the XRP Ledger and instantiate your wallet.
  2. Make changes to the XRP Ledger using transactions.
  3. Get the state of accounts and tokens on the XRP Ledger using requests.
  4. Disconnect from the XRP Ledger.

Each lesson shows you how to build the Token Test Harness one section at a time. Each module lets you try out meaningful interactions with the test ledger, with complete JavaScript and HTML code samples and a code walkthrough. There is also a link to the complete source code for each section that can be modified with a text editor and run in a browser. If you cannot wait, you can follow the prerequisites below, then jump to lesson 4, Transfer NFTokens, and try out the complete test harness right away.

This quickstart tutorial introduces you to the API used to implement features and explore the capabilities of XRP Ledger. It does not represent all of the capabilities of the API and this example is not intended for production or secure payment use.

Much of this is “brute force” code that sacrifices conciseness for readability. Each example builds on the previous step, adding a new JavaScript file and the supporting UI. We expect the applications you build to greatly improve upon these examples. Your feedback and contributions are most welcome.

In this quickstart, you can:

  1. Create Accounts and Send XRP
  2. Create Trust Line and Send Currency.
  3. Mint and Burn NFTokens.
  4. Transfer NFTokens.

There are also expanded lessons demonstrating how to Broker a NFToken Sale, Assign an Authorized Minter, and Batch Mint NFTokens.

Prerequisites

To get started, create a new folder on your local disk and install the JavaScript library using npm.

    npm install xrpl

Download and expand the Quickstart Samples{.github-code-download} archive.


Previous Next
1. Create Accounts and Send XRP → >