bitpro가 원문에서 글자만 모은 내용이에요. 표·그림·수식은 빠지거나 깨질 수 있어요. 전체 28쪽 중 1쪽
Contribute to the Protocol
Have you identified gaps, edge cases, or improvements through real-world use? Contribute code or proposals and help shape the future of XRPL at the protocol level.
Contribute Now
## /
Documentation
Access the documentation you need to get started working with the XRPL.
Documentation
## /develop
SDKs & Libraries
Access everything you need to get started on the XRPL.
Access Here
## /resources/code-samples
Start Building with Example Code
Code Samples
Browse sample code for building common use cases on the XRP Ledger
Introductory Code Samples
Connect to the XRP Ledger and query it for data.
Quickstart Samples
Create a test harness for XRPL features using JavaScript or Python.
Account Configurator
Create accounts on Testnet or Devnet and try different configuration settings. You can also get account configuration settings for live accounts on Mainnet.
Address Encoding
Encode XRP Ledger addresses in base58. (This reference implementation is equivalent to the ones included in most client libraries.)
AMM CLOB Demo
Simulate how offers interact with each other and AMMs on the XRPL DEX.
Assign a Regular Key Pair
Generate a regular key pair and associate it with your account.
Batch
Code samples showing how to create and submit a Batch transaction .
Build a Browser Wallet
Implement a non-custodial wallet application that runs in a web browser and can check an account's balances, send XRP, and notify when the account receives incoming transactions.
Build a Wallet
Implement a non-custodial wallet application that runs on a desktop and can check an account's balances, send XRP, and notify when the account receives incoming transactions.
Calculate Reserves
Look up and calculate an account's reserve requirements.
Clawback
Create, configure, and execute a Clawback transaction to reclaim issued tokens from a trust line on the XRPL.
Confidential Transfers
Issue a Multi-Purpose Token (MPT) that supports confidential transfers, send confidential payments between holders, and claw back a holder's confidential balance.
Create AMM
Code samples for the Create an Automated Market Maker tutorial , showing how to make set up a new AMM.
Create and Claim a Payment Channel
Create, claim and verify a Payment Channel.
Create, Update, and Delete Decentralized Identifiers (DIDs)
Create, update, and delete decentralized identifiers (DIDs). A Decentralized Identifier (DID) is a new type of identifier defined by the World Wide Web Consortium (W3C) that enables verifiable, digital identities.
Create, Update, and Delete Price Oracles
Create, update, and delete Price Oracles. A price oracle is a mechanism that feeds external data, such as asset prices, and exchange rates, onto the XRPLedger.
Credential
Create, accept, and delete a credential on the XRPL using dedicated transactions between issuer and subject wallets.
Credential Issuing Service
This sample code shows how to issue credentials to XRPL users using a basic API service.
Cryptographic Key Derivation
Derive secp256k1 or Ed25519 key pairs from seeds in any of the XRP Ledger's encodings and formats. (This implementation is equivalent to the ones included in most client libraries.)
Delegate
Example delegating payment permission to an account and executing on behalf the delegator.
Delegate Permissions
Delegate permissions to another account, so that the account can send transactions on your behalf.
Delete Account
Delete an account from the XRP Ledger, removing its data and sending its XRP to another account.
DepositPreauth
Example of DepositPreauth transaction demonstrating how deposit permissions can be managed.
Disable Master Key Pair
Disable the master key pair that is connected to an account by default. WARNING: This can blackhole the account, making it so no one can use it or access its funds anymore.
Escrows
Create, finish, and cancel Escrows using conditional or time-based release.
Freezes
Freeze and unfreeze issued tokens, check freeze status, or give up the ability to freeze tokens.
Get a Transaction on the Ledger
Retrieve and display a transaction on the ledger.
Implement Reliable Transaction Submission
Send a transaction and see its validation response. For the implementation in this example, we have made the following decisions:
Issue a Fungible Token
Configure issuer settings and issue fungible tokens to another account.
Issue an MPT with Metadata
Shows how to issue a Multi-Purpose Token (MPT) with metadata encoded according to the XLS-89 schema, then update its mutable properties and declare a property immutable, as defined by XLS-94D.
Lending Protocol Examples
Code samples showing how to create a loan broker, claw back first-loss capital, deposit and withdraw first-loss capital, create a loan, manage a loan, and repay a loan.
Manage Permissioned Domains
Create a permissioned domain to restrict access to financial services that meet compliance requirements, update it with new credentials, or delete a domain you own.
Markers and Pagination
Iterate over a ledger_data method request that requires multiple calls.
Monitor Incoming Payments with WebSocket
Use the WebSocket protocol to watch for incoming payments to an XRP Ledger address, without using a client library.
Multisign a transaction.
Create and submit a SignerListSet and multisign a transaction.
NFT Examples
Various NFT-related actions. Also see the Quickstart Samples for more code related to NFT tutorials.
Normalize Currency Codes
Convert from a string from either the XRP Ledger's "standard" 3-character or "non-standard" 40-character hexadecimal format into a string for humans to read.
Remove Regular Key Pair
Remove the regular key pair assigned to an account.
Require Destination Tags
Require incoming payments to specify a Destination Tag so you know whom to credit.
Secure Signing
Sign transactions from the security of your own machine.
Send an MPT Examples
Send a Multi-Purpose Token (MPT) payment between two accounts and compare balances before and after to confirm the transfer.
Send Partial Payments
Send a partial payment, which delivers less than the amount specified. Partial payments are useful for deducting fees and exchange rates from the amount delivered instead of adding them to the amount sent, but they can also lead to exploits if an integration incorrectly assumes a successful payment delivered the whole amount.
Send XRP
Send a direct XRP payment to another account in the XRP Ledger.
Single Asset Vault Examples
Shows how to create, deposit into, and withdraw from single asset vaults on the XRP Ledger.
Sponsored Fees and Reserves
Shows how one account can pay the transaction fees and reserve requirements of another account, using the co-signed and pre-funded sponsorship flows. Also shows how to manage a sponsorship pool and transfer a reserve sponsorship.
Submit and Verify
Demonstrates how to submit a signed transaction blob to the XRP Ledger and wait for a final result.
Trade in the Decentralized Exchange
Look up Offers in the Decentralized Exchange and buy a fungible token by spending XRP.
Transaction Serialization
Convert transactions and other XRPL data from JSON to their canonical binary format for signing or cryptographic verification. (This reference implementation is equivalent to the ones included in most client libraries.)
Use AMM Auction Slot to Save on Fees
Estimate the fees that would be paid for trading through an AMM and use the auction slot to save on fees if applicable.
Use Checks
Create, cash, and cancel Checks for exact or flexible amounts.
Use Paths
Extract paths from RipplePathFind and send a payment using paths.
Use Tickets
Create a batch of Tickets and use one to send a transaction outside the normal Sequence order.
Verify Credential
Check whether a specific account holds a specific credential, and the credential is currently valid.
Walk Owner Directory
Iterate over an account's owner directory and display how many ledger entries are in each page. In cases of highly active accounts, this can demonstrate the extent of "fragmentation" with skipped page numbers and non-full pages.
Contribute Code Samples
Help the XRPL community by submitting your own code samples
Fork and clone
Fork the
xrpl-dev-portal repo
. Using git, clone the fork to your computer.
Add to folder
Add your sample code to the
content/_code-samples/
folder. Be sure to include a
README.md
that summarizes what it does and anything else people should know about it.
Commit and push
Commit your changes and push them to your fork on GitHub.
Open a pull request
Open a pull request to the original repo. Maintainers will review your submission and suggest changes if necessary. If the code sample is helpful, it'll be merged and added to XRPL.org!
## /docs/references
References
Copy
The XRP Ledger References provides reference documentation for the XRP Ledger protocol, API methods, and more.
Client Libraries
Use these libraries to access the XRP Ledger from your programming language of choice.
JavaScript / TypeScript
xrpl.js - a JavaScript/TypeScript library
Python
xrpl.py - a pure Python library
Go
xrpl.go - a pure Go library
Java
xrpl4j - a pure Java library
See more...
XRP Ledger Protocol Reference
Basic Data Types
Format and meaning of fundamental data types.
Ledger Data Formats
Learn about individual entries that comprise the XRP Ledger's shared state data.
Transaction Reference
Definitions for all the protocol's transaction types and their results.
Binary Format
Conversion between JSON and canonical binary format for XRP Ledger transactions and other objects.
HTTP / WebSocket APIs
API Conventions
Describes data types and formats of the HTTP APIs (JSON-RPC and WebSocket) as implemented in the xrpld server.
Public API Methods
Public API methods for use by any client attached to the server.
Admin API Methods
Admin methods for trusted personnel in charge of keeping the xrpld server operational.
Peer Port Methods
Special API methods for sharing network topology and status metrics, served on the XRPL Peer Protocol port.
xrp-ledger.toml File
The xrp-ledger.toml file provides machine-readable information about your usage of the XRP Ledger to other XRP Ledger users.
Serving the File
Contents
CORS Setup
Domain Verification
Account Verification
## /docs/tutorials
Crypto Wallet and Blockchain Development Tutorials
Tutorials
Public Servers
Mainnet
WebSocket
wss://xrplcluster.com
JSON-RPC
https://xrplcluster.com
Testnet
WebSocket
wss://s.altnet.rippletest.net:51233
JSON-RPC
https://s.altnet.rippletest.net:51234
View all servers
→
Get Test XRP
→
What's New
Recently added/updated tutorials to help you build on the XRP Ledger.
Create Trust Line and Send Currency Using JavaScript
Create Trust Lines and send currency.
Create Trust Line and Send Currency Using Python
Create trust lines and send currency.
Use Payment Channels
Payment Channels are an advanced feature for sending "asynchronous" XRP payments that can be divided into very small increments and settled later. This tutorial walks through the entire process of using a payment channel, with examples using the JSON-RPC API of a local xrpld server.
Get Started with SDKs
These tutorials walk you through the basics of building a very simple XRP Ledger-connected application using your favorite programming language.
Get Started Using JavaScript Library
Using the xrpl.js client library.
Get Started Using TypeScript Library
Using xrpl.js with TypeScript's built-in type checking.
Get Started Using Python Library
Using xrpl.py, a pure Python library.
Get Started Using Go Library
Using xrpl-go, a pure Go library.
Get Started Using Java Library
Using xrpl4j, a pure Java library.
Get Started Using PHP Library
Using the XRPL_PHP client library.
Get Started Using HTTP / WebSocket APIs
Access the XRP Ledger directly through the APIs of its core server.
Tokens
Create and manage tokens on the XRP Ledger.
Issue a Multi-Purpose Token (MPT)
Issue new tokens using the v2 fungible token standard.
Issue a Fungible Token
Issue new tokens using the v1 fungible token standard.
Mint and Burn NFTs Using JavaScript
Create new NFTs, retrieve existing tokens, and burn the ones you no longer need.
Claw Back Confidential Balances
Claw back a holder's entire confidential Multi-Purpose Token (MPT) balance as the issuer, then verify the result as the holder, the issuer, and the auditor.
Issue an MPT for Confidential Transfers
Issue a Multi-Purpose Token (MPT) that supports confidential transfers, register the issuer and auditor encryption keys, and mint confidential tokens.
Enable No Freeze
Permanently give up your account's ability to freeze tokens it issues.
Explore more
→
Payments
Transfer XRP and issued currencies using various payment types.
Send XRP
Learn how to send test payments right from your browser.
Send a Multi-Purpose Token (MPT)
Send a direct payment of a Multi-Purpose Token (MPT) on the XRP Ledger.
Create Trust Line and Send Currency Using JavaScript
Create Trust Lines and send currency.
Send a Conditional Escrow
Create an escrow whose release is based on a condition being fulfilled.
Send a Timed Escrow
Send an escrow whose only condition for release is that a specific time has passed.
Create Trust Line and Send Currency Using Python
Create trust lines and send currency.
Explore more
→
DeFi
Trade, provide liquidity, and lend using native XRP Ledger DeFi features.
Create an Automated Market Maker
Set up an Automated Market Maker (AMM)
Trade in the Decentralized Exchange
Buy or sell fungible tokens for each other or for XRP in the decentralized exchange.
Create a Loan
Create a loan on the XRP Ledger using the Lending Protocol.
Create a Single Asset Vault
Create a single asset vault on the XRP Ledger.
Manage a Loan
Impair and default a loan on the XRP Ledger.
Deposit into a Vault
Deposit assets into a vault and receive shares.
Explore more
→
Best Practices
Learn recommended patterns for building reliable, secure applications on the XRP Ledger.
API Usage
Best practices for efficiently and reliably interacting with the XRP Ledger API, including pagination, data handling, and performance optimization.
Manage a Sponsorship Pool
Create, spend, top up, and delete a pre-funded sponsorship pool on the XRP Ledger.
Sponsor a Transaction by Co-Signing
Cover another account's transaction fee and reserve requirement by co-signing a single transaction.
Sponsor a Transaction with a Pre-funded Pool
Create a sponsorship pool that lets a sponsee submit sponsored transactions without the sponsor co-signing each one.
Transfer a Reserve Sponsorship
Create, reassign, or end the reserve sponsorship on an existing ledger entry.
Offline Account Setup Tutorial
Set up an XRP Ledger account using an air-gapped, offline machine to store its cryptographic keys.
Explore more
→
Compliance
Implement compliance controls like destination tags, credentials, and permissioned domains.
Manage Permissioned Domains
Create and manage a permissioned domain to restrict access to financial services that meet compliance requirements.
Require Destination Tags
Require users to specify a destination tag when sending to your address.
Manage Credentials
Issue, accept, and delete a credential on the XRP Ledger.
Verify Credentials
Verify that an account holds a valid credential on the XRP Ledger.
Programmability
Set up cross-chain bridges and submit interoperability transactions.
Set Up an XRP-XRP Bridge
Steps to create an XRP-XRP bridge with a new sidechain.
Submit Cross-chain Transactions
Steps to submit a cross-chain transaction, using a bridge.
Set Up an IOU-IOU Bridge
Steps to set up an IOU-IOU bridge.
Advanced Developer Topics
Explore advanced topics like WebSocket monitoring and testing Devnet features.
Monitor Incoming Payments with WebSocket
Use the WebSocket API to actively monitor for new XRP payments (and more).
Test Pre-Release Transaction Types
Guide on using pre-release transaction types on the XRP Ledger for developers.
Sample Apps
xrpl.org
5
Community
2
Build complete, end-to-end applications like wallets and credential services.
Build a Browser Wallet in JavaScript
Build a graphical browser wallet for the XRPL using Javascript.
Build a Desktop Wallet in JavaScript
Build a graphical desktop wallet for the XRPL using JavaScript.
Build a Desktop Wallet in Python
Build a graphical desktop wallet for the XRPL in Python.
Build a Credential Issuing Service in Javascript
Build a credential issuing microservice with Javascript and Node.js.
Build a Credential Issuing Service in Python
Build a credential issuing microservice in Python.
## /docs/concepts
Concepts
Copy
Learn the "what" and "why" behind fundamental aspects of the XRP Ledger.
Networks and Servers
xrpld is the core peer-to-peer server that manages the XRP Ledger.
Consensus Protocol
Consensus is how new blocks of transactions get confirmed by the XRP Ledger blockchain.
Ledgers
Ledgers are the data structure that holds data in the shared XRP Ledger network. A chain of ledgers records the history of transactions and state changes.
Transactions
Transactions are the only way to change the XRP Ledger. Understand what forms they take and how to use them.
Point-to-Point & Specialized Ledger Payment Types
While XRP Ledger supports point-to-point XRP payments, it's also compatible with more specialized payment types. Discover which ledger payment methods here.
Tokens
Anyone can make tokens representing digital value on the XRP Ledger. Learn about types of tokens and how they are used.
Accounts
Learn about accounts in the XRP Ledger. Accounts can send transactions and hold XRP.
XRPL Sidechains
An XRPL sidechain is an independent ledger with its own consensus algorithm, transaction types, and rules.
Decentralized Storage
## /docs/infrastructure
Infrastructure
Copy
Install, configure, and manage the software that powers the XRP Ledger.
Commandline Usage
Commandline usage options for the xrpld server.
Installation
Install and update XRP Ledger servers including the core server, xrpld, and API server, Clio.
Configuration
Customize the configuration of an XRP Ledger server.
Testing and Auditing
For new features and experiments, you can use Stand-Alone Mode to test features with a full network.
Troubleshooting
Troubleshoot all kinds of problems with the xrpld server.
## /docs/references/client-libraries
Client Libraries
Copy
These client libraries simplify some of the common work of accessing and processing XRP Ledger data, and present it in a form that matches with the native conventions of their respective programming languages.
To stay up-to-date on JavaScript/TypeScript and Python library updates, join the
xrpl-announce mailing list
.
For other programming languages, you can access the XRP Ledger through the
HTTP APIs
.
Language
Library Name
Get Started
API Reference
Source Code
Python
xrpl-py
Get Started Using Python
API Reference
Repo
Go
xrpl-go
Get Started Using Go
API Reference
Repo
JavaScript
/
TypeScript
xrpl.js
Get Started
API Reference
Repo
JavaScript
/
TypeScript
xrpl-client
Get Started
NPM Reference
Repo
JavaScript
/
TypeScript
xrpl-accountlib
Get Started
NPM Reference
Repo
C++
libxrpl
Get Started
(Part of
rippled
)
Java
xrpl4j
Get Started Using Java
API Reference
Repo
PHP
XRPL_PHP
Get Started Using PHP
XRPL_PHP Docs
Repo
Ruby
XRPB
XRPB Docs
Repo
## /docs/tutorials/get-started/get-started-javascript
Environment
:
Node
Web
Get Started Using JavaScript Library
Copy
This tutorial guides you through the basics of building an XRP Ledger-connected application in JavaScript using the
xrpl.js
client library in either Node.js or web browsers.
Goals
In this tutorial, you'll learn:
The basic building blocks of XRP Ledger-based applications.
How to connect to the XRP Ledger using
xrpl.js
.
How to get an account on the
Testnet
using
xrpl.js
.
How to use the
xrpl.js
library to look up information about an account on the XRP Ledger.
How to put these steps together to create a JavaScript app or web-app.
Prerequisites
To complete this tutorial, you should meet the fol프로젝트로 돌아가기