Compare commits

..

1 Commits

Author SHA1 Message Date
akcodez
09b1a8401d sort by start date oppose to end date 2025-10-08 13:43:18 -07:00
128 changed files with 461 additions and 636 deletions

View File

@@ -4,7 +4,7 @@ parent: ledger-entry-types.html
seo:
description: NFTを売買するオファーを作成する。
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFTokenOffer

View File

@@ -4,7 +4,7 @@ parent: ledger-entry-types.html
seo:
description: NFTokenを記録するためのレジャー構造。
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFTokenPage

View File

@@ -326,7 +326,7 @@ export function AmendmentDisclaimer(props: {
) : (
<>
{translate("component.amendment-status.updates.1", "The ")}{link()}
{translate("component.amendment-status.updates.2", " updates this.")}
{translate("component.amendment-status.updates.2", "updates this.")}
{" "}
<AmendmentBadge amendment={amendmentStatus} />
</>

View File

@@ -1,8 +1,6 @@
import * as React from 'react';
import dynamicReact from '@markdoc/markdoc/dist/react'
import { useThemeHooks } from '@redocly/theme/core/hooks'
import { Link } from '@redocly/theme/components/Link/Link'
import { NotEnabled } from '@theme/markdoc/components';
import dynamicReact from '@markdoc/markdoc/dist/react';
import { Link } from '@redocly/theme/components/Link/Link';
export interface XRPLCardProps {
title: string,
@@ -32,74 +30,6 @@ export function XRPLCard(props: XRPLCardProps) {
)
}
export function LabelGrid(props: {
category: string
}) {
const { usePageSharedData } = useThemeHooks()
const data = usePageSharedData('index-page-items') as any[]
const matchingPages = data.filter((page) => {return page.category === props.category})
const labelsInCategory = []
const unlabeled = []
for (const page of matchingPages) {
if (page.labels) {
for (const label of page.labels) {
if (!labelsInCategory.includes(label)) {
labelsInCategory.push(label)
}
}
} else {
unlabeled.push(page)
}
}
labelsInCategory.sort()
return (
<div className="card-grid card-grid-2xN">
{labelsInCategory.map( (label) => (
RawNavCard(label, matchingPages.filter((page) => {return page.labels?.includes(label)})
) )
)}
{ unlabeled.length ? (
RawNavCard("Unlabeled", unlabeled)
) : ""}
</div>
)
}
function RawNavCard(label: string, pages: any[]) {
return (
<div className="card nav-card" key={label}>
<h3 className="card-title">{label}</h3>
<ul className="nav">
{pages?.map((page: any) => (
<li className="nav-item" key={page.slug}>
<Link className="nav-link" to={page.slug}>{
page.status === "not_enabled" ? (<>
<NotEnabled />
{" "}
</>) : ""
}{page.title}</Link>
{
// To add page descriptions to the cards, uncomment:
//<p className="blurb child-blurb">{page.seo?.description}</p>
}
</li>
))}
</ul>
</div>
)
}
export function NavCard(props: {
label: string
}) {
const { usePageSharedData } = useThemeHooks()
const data = usePageSharedData('index-page-items') as any[]
const matchingPages = data.filter((page) => {return page.labels?.includes(props.label)})
return RawNavCard(props.label, matchingPages)
}
export function CardGrid(props) {
const gridClass = `card-grid card-grid-${props.layout}`
return (

View File

@@ -8,7 +8,7 @@ import { idify } from '../helpers'
import { Button } from '@redocly/theme/components/Button/Button'
export { default as XRPLoader } from '../components/XRPLoader'
export { XRPLCard, CardGrid, NavCard, LabelGrid } from '../components/XRPLCard'
export { XRPLCard, CardGrid } from '../components/XRPLCard'
export { AmendmentsTable, AmendmentDisclaimer, Badge } from '../components/Amendments'
export function IndexPageItems() {
@@ -140,7 +140,7 @@ export function TxExample(props: {
} else if (props.server == 'testnet') {
use_server = "&server=wss%3A%2F%2Fs.altnet.rippletest.net%3A51233%2F"
}
const ws_req = `req=%7B%22id%22%3A%22example_tx_lookup%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22${props.txid}%22%2C%22binary%22%3Afalse%2C%22api_version%22%3A2%7D`
const to_path = `/resources/dev-tools/websocket-api-tool?${ws_req}${use_server}`
return (

View File

@@ -182,30 +182,6 @@ export const cardGrid: Schema & { tagName: string } = {
render: 'CardGrid'
}
export const navCard: Schema & { tagName: string } = {
tagName: 'nav-card',
attributes: {
label: {
type: 'String',
required: true
}
},
render: 'NavCard',
selfClosing: true
}
export const labelGrid: Schema & { tagName: string } = {
tagName: 'label-grid',
attributes: {
category: {
type: 'String',
required: true
}
},
render: 'LabelGrid',
selfClosing: true
}
export const tryIt: Schema & { tagName: string } = {
tagName: 'try-it',
attributes: {

View File

@@ -3,19 +3,20 @@ const { app, BrowserWindow } = require('electron')
const path = require('path')
/**
* Main function: create application window, preload the code to communicate
* between the renderer Process and the main Process, load a layout,
* and perform the main logic.
* This is our main function, it creates our application window, preloads the code we will need to communicate
* between the renderer Process and the main Process, loads a layout and performs the main logic
*/
const createWindow = () => {
// Create the application window
// Creates the application window
const appWindow = new BrowserWindow({
width: 1024,
height: 768
})
// Load a layout
// Loads a layout
appWindow.loadFile(path.join(__dirname, 'view', 'template.html'))
return appWindow
}

View File

@@ -1,37 +1,40 @@
const { app, BrowserWindow } = require('electron')
const path = require('path')
// Ledger index code additions - start
const xrpl = require('xrpl')
const xrpl = require("xrpl")
const TESTNET_URL = 'wss://s.altnet.rippletest.net:51233'
const TESTNET_URL = "wss://s.altnet.rippletest.net:51233"
/**
* Create a WebSocket client, connect to the XRPL, and fetch the latest ledger index.
* This function creates a WebService client, which connects to the XRPL and fetches the latest ledger index.
*
* @returns {Promise<number>}
*/
const getValidatedLedgerIndex = async () => {
const client = new xrpl.Client(TESTNET_URL)
await client.connect()
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger
// Reference: https://xrpl.org/ledger.html#ledger
const ledgerRequest = {
"command": "ledger",
"ledger_index": "validated"
}
const ledgerResponse = await client.request(ledgerRequest)
await client.disconnect()
return ledgerResponse.result.ledger_index
}
// Ledger index code additions - end
/**
* Main function: create application window, preload the code to communicate
* between the renderer Process and the main Process, load a layout,
* and perform the main logic.
* This is our main function, it creates our application window, preloads the code we will need to communicate
* between the renderer Process and the main Process, loads a layout and performs the main logic
*/
const createWindow = () => {
// Create the application window
// Creates the application window
const appWindow = new BrowserWindow({
width: 1024,
height: 768,
@@ -40,8 +43,9 @@ const createWindow = () => {
},
})
// Load a layout
// Loads a layout
appWindow.loadFile(path.join(__dirname, 'view', 'template.html'))
return appWindow
}

View File

@@ -24,10 +24,9 @@ const createWindow = () => {
return appWindow
}
// Step 2 changes - main whenReady function - start
/**
* Create an XRPL client, subscribe to 'ledger' events, and broadcast those by
* dispatching an 'update-ledger-data' event to the frontend.
* This function creates a XRPL client, subscribes to 'ledger' events from the XRPL and broadcasts those by
* dispatching the 'update-ledger-data' event which will be picked up by the frontend
*
* @returns {Promise<void>}
*/
@@ -39,7 +38,7 @@ const main = async () => {
await client.connect()
// Subscribe client to 'ledger' events
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe
// Reference: https://xrpl.org/subscribe.html
await client.request({
"command": "subscribe",
"streams": ["ledger"]
@@ -52,4 +51,3 @@ const main = async () => {
}
app.whenReady().then(main)
// Step 2 changes - main whenReady function - end

View File

@@ -29,30 +29,30 @@ const main = async () => {
await client.connect()
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe
// Reference: https://xrpl.org/subscribe.html
await client.request({
"command": "subscribe",
"streams": ["ledger"],
"accounts": [address]
})
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe#ledger-stream
// Reference: https://xrpl.org/subscribe.html#ledger-stream
client.on("ledgerClosed", async (rawLedgerData) => {
const ledger = prepareLedgerData(rawLedgerData)
appWindow.webContents.send('update-ledger-data', ledger)
})
// Initial Ledger Request -> Get account details on startup
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger
// Reference: https://xrpl.org/ledger.html
const ledgerResponse = await client.request({
"command": "ledger"
})
const initialLedgerData = prepareLedgerData(ledgerResponse.result.closed.ledger)
appWindow.webContents.send('update-ledger-data', initialLedgerData)
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe#transaction-streams
// Reference: https://xrpl.org/subscribe.html#transaction-streams
client.on("transaction", async (transaction) => {
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info
// Reference: https://xrpl.org/account_info.html
const accountInfoRequest = {
"command": "account_info",
"account": address,
@@ -64,7 +64,7 @@ const main = async () => {
})
// Initial Account Request -> Get account details on startup
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info
// Reference: https://xrpl.org/account_info.html
const accountInfoResponse = await client.request({
"command": "account_info",
"account": address,

View File

@@ -30,14 +30,14 @@ const main = async () => {
await client.connect()
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe
// Reference: https://xrpl.org/subscribe.html
await client.request({
"command": "subscribe",
"streams": ["ledger"],
"accounts": [address]
})
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe#ledger-stream
// Reference: https://xrpl.org/subscribe.html#ledger-stream
client.on("ledgerClosed", async (rawLedgerData) => {
const ledger = prepareLedgerData(rawLedgerData)
appWindow.webContents.send('update-ledger-data', ledger)
@@ -45,7 +45,7 @@ const main = async () => {
// Wait for transaction on subscribed account and re-request account data
client.on("transaction", async (transaction) => {
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info
// Reference: https://xrpl.org/account_info.html
const accountInfoRequest = {
"command": "account_info",
"account": address,
@@ -61,7 +61,7 @@ const main = async () => {
})
// Initial Account Request -> Get account details on startup
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info
// Reference: https://xrpl.org/account_info.html
const accountInfoResponse = await client.request({
"command": "account_info",
"account": address,
@@ -71,7 +71,7 @@ const main = async () => {
appWindow.webContents.send('update-account-data', accountData)
// Initial Transaction Request -> List account transactions on startup
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx
// Reference: https://xrpl.org/account_tx.html
const txResponse = await client.request({
"command": "account_tx",
"account": address

View File

@@ -23,7 +23,6 @@ const createWindow = () => {
return appWindow
}
// Step 5 - new main function - start
const main = async () => {
const appWindow = createWindow()
@@ -52,9 +51,6 @@ const main = async () => {
}
const wallet = xrpl.Wallet.fromSeed(seed)
// For compatibility with seeds generated using secp256k1
// (the old default algorithm), use the following instead:
// const wallet = xrpl.Wallet.fromSeed(seed, {algorithm: "secp256k1"})
const client = new xrpl.Client(TESTNET_URL)
@@ -84,6 +80,5 @@ const main = async () => {
}
})
}
// Step 5 - new main function - end
app.whenReady().then(main)

View File

@@ -2,7 +2,7 @@
Build a non-custodial XRP Ledger wallet application in JavaScript that runs on the desktop using Electron.
For the full documentation, refer to the [Build a Desktop Wallet in JavaScript tutorial](https://xrpl.org/docs/tutorials/javascript/build-apps/build-a-desktop-wallet-in-javascript).
For the full documentation, refer to the [Build a Wallet in JavaScript tutorial](https://xrpl.org/build-a-wallet-in-javascript.html).
## TL;DR

View File

@@ -3,7 +3,7 @@ const xrpl = require("xrpl");
// The rippled server and its APIs represent time as an unsigned integer.
// This number measures the number of seconds since the "Ripple Epoch" of
// January 1, 2000 (00:00 UTC). This is like the way the Unix epoch works,
// Reference: https://xrpl.org/docs/references/protocol/data-types/basic-data-types#specifying-time
// Reference: https://xrpl.org/basic-data-types.html
const RIPPLE_EPOCH = 946684800;
const prepareAccountData = (rawAccountData) => {

View File

@@ -14,7 +14,7 @@ const fernet = require("fernet");
* @returns {Promise<void>}
*/
const initialize = async (client, wallet, appWindow) => {
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info
// Reference: https://xrpl.org/account_info.html
const accountInfoResponse = await client.request({
"command": "account_info",
"account": wallet.address,
@@ -23,7 +23,7 @@ const initialize = async (client, wallet, appWindow) => {
const accountData = prepareAccountData(accountInfoResponse.result.account_data)
appWindow.webContents.send('update-account-data', accountData)
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx
// Reference: https://xrpl.org/account_tx.html
const txResponse = await client.request({
"command": "account_tx",
"account": wallet.address
@@ -42,14 +42,14 @@ const initialize = async (client, wallet, appWindow) => {
*/
const subscribe = async (client, wallet, appWindow) => {
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe
// Reference: https://xrpl.org/subscribe.html
await client.request({
"command": "subscribe",
"streams": ["ledger"],
"accounts": [wallet.address]
})
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe#ledger-stream
// Reference: https://xrpl.org/subscribe.html#ledger-stream
client.on("ledgerClosed", async (rawLedgerData) => {
const ledger = prepareLedgerData(rawLedgerData)
appWindow.webContents.send('update-ledger-data', ledger)
@@ -57,7 +57,7 @@ const subscribe = async (client, wallet, appWindow) => {
// Wait for transaction on subscribed account and re-request account data
client.on("transaction", async (transaction) => {
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info
// Reference: https://xrpl.org/account_info.html
const accountInfoRequest = {
"command": "account_info",
"account": wallet.address,

View File

@@ -9,7 +9,7 @@ const xrpl = require("xrpl");
* @returns {Promise<*>}
*/
const sendXrp = async (paymentData, client, wallet) => {
// Reference: https://xrpl.org/docs/references/protocol/transactions/types/payment
// Reference: https://xrpl.org/submit.html#request-format-1
const paymentTx = {
"TransactionType": "Payment",
"Account": wallet.address,

View File

@@ -39,7 +39,7 @@ async function checkDestination(accountData) {
/**
* Verify an account using a xrp-ledger.toml file.
* https://xrpl.org/docs/references/xrp-ledger-toml
* https://xrpl.org/xrp-ledger-toml.html#xrp-ledgertoml-file
*
* @param accountData
* @returns {Promise<{domain: string, verified: boolean}>}
@@ -89,7 +89,7 @@ async function verifyAccountDomain(accountData) {
* @returns {Promise<{domain: string, verified: boolean}>}
*/
async function verify(accountAddress, client) {
// Reference: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info
// Reference: https://xrpl.org/account_info.html
const request = {
"command": "account_info",
"account": accountAddress,

View File

@@ -1,6 +1,6 @@
{
"name": "xrpl-javascript-desktop-wallet",
"version": "1.1.0",
"version": "1.0.0",
"license": "MIT",
"scripts": {
"hello": "electron 0-hello/index.js",
@@ -14,15 +14,15 @@
"domain-verification": "electron 8-domain-verification/index.js"
},
"dependencies": {
"async": "^3.2.6",
"async": "^3.2.4",
"fernet": "=0.3.3",
"node-fetch": "^2.7.0",
"pbkdf2-hmac": "^1.2.1",
"node-fetch": "^2.6.9",
"pbkdf2-hmac": "^1.1.0",
"open": "^8.4.0",
"toml": "^3.0.0",
"xrpl": "^4.4.2"
"xrpl": "^4.3.0"
},
"devDependencies": {
"electron": "38.2.0"
"electron": "28.3.2"
}
}

View File

@@ -17,7 +17,6 @@ const infoSession4 = require("../static/img/events/xrpl-builder-office-hours-04.
const decarb = require('../static/img/events/xrpl-decarb.png')
const townHall = require('../static/img/events/town-hall-meetup.png')
const devBootcamp = require('../static/img/events/dev-bootcamp.png')
const italyHackathon = require("../static/img/events/italy-hackathon.png");
export const frontmatter = {
seo: {
title: "Events",
@@ -27,8 +26,8 @@ export const frontmatter = {
};
export const sortEvents = (arr, asc = true) => {
return arr.sort((a, b) => {
const dateA = moment(a.end_date, "MMMM D, YYYY");
const dateB = moment(b.end_date, "MMMM D, YYYY");
const dateA = moment(a.date, "MMMM D, YYYY");
const dateB = moment(b.date, "MMMM D, YYYY");
return asc ? dateB.diff(dateA) : dateA.diff(dateB); // Returns a negative value if dateA is before dateB, positive if after, and 0 if the same
});
};
@@ -1276,36 +1275,14 @@ const events = [
{
name: "Vega House Hackathon",
description:
"Vega House Hackathon: Compete in two XRPL tracks—Ledger Track to build MVP financial services using payments, tokenization, RLUSD, or AMM/DEX flows, and Exploration Track to create innovative apps leveraging XRPL features and upcoming amendments. Prizes total $25,000, including track awards and bounties for best use of new XRPL features.",
"The Vega House XRPL Hackathon is calling all developers, designers, and innovators to create incredible solutions on the XRP Ledger (XRPL).",
type: "hackathon",
link: "https://xrpl.vegahacks.xyz/",
location: "Virtual",
date: "Oct 01 - Nov 14, 2025",
image: italyHackathon,
date: "October 01, 2025",
image: hackathon,
end_date: "November 14, 2025",
},
{
name: "XRPL Town Hall Meeting #5",
description:
"Join Us for the 5th XRPL Town Hall Meeting!",
type: "info",
link: "https://luma.com/wo0g0fpv",
location: "Virtual",
date: "October 16, 2025",
image: require("../static/img/events/townhall-5.png"),
end_date: "October 16, 2025",
},
{
name: "XRPL Aquarium Residency Demo Day #7",
description:
"The Aquarium Residency is a 12-week program for entrepreneurs & developers building on the XRP Ledger blockchain. Join us at our Paris HQ to connect with our 11 residents, discover their projects focused on DeFi II, and engage with the XRPL community.",
type: "meetup",
link: "https://luma.com/mnby11vr",
location: "Paris, France",
image: require("../static/img/events/aquarium-residency.png"),
date: "December 10, 2025",
end_date: "December 10, 2025",
},
];

View File

@@ -20,7 +20,6 @@ const brazil = require("../static/img/events/event-meetup-brazil.png");
const infoSession2 = require("../static/img/events/xrpl-builder-office-hours-02.png");
const infoSession3 = require("../static/img/events/xrpl-builder-office-hours-03.png");
const infoSession4 = require("../static/img/events/xrpl-builder-office-hours-04.png");
const italyHackathon = require("../static/img/events/italy-hackathon.png");
const events = [
{
name: "New Horizon: Innovate Without Limits: New Horizons Await",
@@ -378,18 +377,18 @@ const events = [
link: "https://luma.com/llwjrmcx",
location: "Rome, Italy",
date: "November 07, 2025",
image: italyHackathon,
image: hackathon,
end_date: "November 08, 2025",
start_date: "November 07, 2025",
},
{
name: "Vega House Hackathon",
description:
"Vega House Hackathon: Compete in two XRPL tracks—Ledger Track to build MVP financial services using payments, tokenization, RLUSD, or AMM/DEX flows, and Exploration Track to create innovative apps leveraging XRPL features and upcoming amendments. Prizes total $25,000, including track awards and bounties for best use of new XRPL features.",
"The Vega House XRPL Hackathon is calling all developers, designers, and innovators to create incredible solutions on the XRP Ledger (XRPL).",
type: "hackathon",
link: "https://xrpl.vegahacks.xyz/",
location: "Virtual",
date: "October 01 - November 14, 2025",
date: "October 01, 2025",
image: hackathon,
end_date: "November 14, 2025",
start_date: "October 01, 2025",

View File

@@ -1,4 +1,6 @@
---
html: escrow.html
parent: payment-types.html
seo:
description: Escrow holds funds until specified conditions are met.
labels:
@@ -10,45 +12,27 @@ Traditionally, an escrow is a contract between two parties to facilitate financi
The XRP Ledger takes escrow a step further, replacing the third party with an automated system built into the ledger. An escrow locks up XRP or fungible tokens, which can't be used or destroyed until conditions are met.
{% amendment-disclaimer name="TokenEscrow" mode="updated" /%}
## Token Escrow
The [TokenEscrow amendment][] extends escrow functionality to fungible tokens, which means [Trust Line Tokens](../../concepts/tokens/fungible-tokens/trust-line-tokens.md) and [Multi-Purpose Tokens (MPTs)](../../concepts/tokens/fungible-tokens/multi-purpose-tokens.md#transferability-controls) can be held in escrow.
For Trust Line Tokens to be held in escrow, the issuing account must have the **Allow Trust Line Locking** flag enabled, which allows tokens issued by the account to be held in escrow. For MPTs, the issuer needs to enable the **Can Escrow** and **Can Transfer** flags when creating the token issuance, so that the tokens can be held in escrow and transferred.
While issuers can't create escrows with their own issued tokens, they can serve as recipients. When an issuer receives escrowed tokens, the process works the same way as a direct payment.
If a token requires authorization, the sender must be pre-authorized by the issuer before creating an escrow and must also be authorized to receive the tokens back when an expired escrow is canceled, regardless of who submits the cancellation transaction. The recipient must be pre-authorized before the escrow can be finished.
## Types of Escrow
The XRP Ledger supports three types of escrow:
- **Time-based Escrow:** Funds only become available after a certain amount of time passes.
- **Conditional Escrow:** This escrow is created with a corresponding condition and fulfillment. The condition serves as a lock on the funds and won't release until the correct fulfillment key is provided.
- **Combination Escrow:** This escrow combines the features of time-based and conditional escrow. The escrow is completely inaccessible until the specified time passes, after which the funds can be released by providing the correct fulfillment.
- **Combination Escrow:** This escrow combines the features of time-based and conditional escrow. The escrow is completely inaccessible until the specified time passes, after which the funds can be release by providing the correct fulfillment.
## Escrow Lifecycle
The lifecycle of an escrow is as follows:
1. The sender creates an escrow using the `EscrowCreate` transaction. This transaction defines:
- An amount of XRP or fungible tokens to lock up.
- The conditions to release the funds.
- For **XRP escrows** this can include a time when the escrow can complete, a cryptographic condition that must be fulfilled, and optionally a time when the escrow expires.
- For **token escrows** similar conditions apply, but an expiration time is _mandatory_.
- The recipient of the funds. Any applicable transfer rates or fees are captured at creation time and will apply when the escrow completes, ensuring predictability for the recipient.
- An number of XRP or fungible tokens to lock up.
- The conditions to release the XRP or fungible tokens.
- The recipient of the XRP or fungible tokens.
2. When the transaction is processed successfully, the XRP Ledger creates an `Escrow` object that holds the escrowed funds.
2. When the transaction is processed, the XRP Ledger creates an `Escrow` object that holds the escrowed XRP or fungible token.
3. The recipient sends an `EscrowFinish` transaction to deliver the funds. If the conditions are met, this destroys the `Escrow` object and delivers the funds to the recipient. Additionally, any missing trust lines or MPT entries may be auto-created for recipients if authorization isn't required.
3. The recipient sends an `EscrowFinish` transaction to deliver the XRP or fungible tokens. If the conditions have been met, this destroys the `Escrow` object and delivers the XRP or fungible tokens to the recipient.
{% admonition type="info" name="Note" %}
If the escrow has an expiration time and isn't successfully finished before then, the escrow becomes expired. An expired escrow remains in the ledger until an `EscrowCancel` transaction cancels it, returning the escrowed funds to the sender.
{% /admonition %}
{% admonition type="info" name="Note" %}If the escrow has an expiration time and isn't successfully finished before then, the escrow becomes expired. An expired escrow remains in the ledger until an `EscrowCancel` transaction cancels it, destroying the `Escrow` object and returning the escrowed XRP or fungible tokens to the sender.{% /admonition %}
## Escrow States
@@ -58,16 +42,13 @@ The following diagram shows the states an Escrow can progress through:
The diagram shows three different cases for three possible combinations of the escrow's "finish-after" time (`FinishAfter` field), crypto-condition (`Condition` field), and expiration time (`CancelAfter` field):
{% admonition type="info" name="Note" %}
While XRP escrows can sometimes exist without an expiration time, token escrows must **always** have an expiration time (`CancelAfter` field).
{% /admonition %}
- **Time-based Escrow (left):** With only a finish-after time, the escrow is created in the **Held** state. After the specified time has passed, it becomes **Ready** and anyone can finish it. If the escrow has an expiration time and no one finishes it before that time passes, then the escrow becomes **Expired**. In the expired state, an escrow cannot be finished, and anyone can cancel it. If the escrow does not have a `CancelAfter` field, it never expires and cannot be canceled.
- **Combination Escrow (center):** If the escrow specifies both a crypto-condition (`Condition` field) _and_ a "finish-after" time (`FinishAfter` field), the escrow is **Held** until its finish-after time has passed. Then it becomes **Conditionally Ready**, and can finish it if they supply the correct fulfillment to the crypto-condition. If the escrow has an expiration time (`CancelAfter` field), and no one finishes it before that time passes, then the escrow becomes **Expired**. In the expired state, an escrow cannot be finished, and anyone can cancel it. If the escrow does not have a `CancelAfter` field, it never expires and cannot be canceled.
- **Conditional Escrow (right):** If the escrow specifies a crypto-condition (`Condition` field) and not a finish-after time, the escrow becomes **Conditionally Ready** immediately when it is created. During this time, anyone can finish the escrow, but only if they supply the correct fulfillment to the crypto-condition. If no one finishes the escrow before its expiration time (`CancelAfter` field), the escrow becomes **Expired**. (An escrow without a finish-after time _must_ have an expiration time.) In the expired state, the escrow can no longer be finished, and anyone can cancel it.
## Limitations
- The costs can make it infeasible for small amounts.
@@ -76,9 +57,7 @@ While XRP escrows can sometimes exist without an expiration time, token escrows
- You can't create an escrow with past time values.
- Timed releases and expirations resolve according to [ledger close times](../ledgers/ledger-close-times.md). In practice, actual release and expiration times can vary by about five seconds as ledgers close.
- The only supported crypto-condition type is PREIMAGE-SHA-256.
- If a token holder is deep frozen (Trust Line Tokens) or locked (MPTs), they cannot finish an escrow to receive tokens, but they can still cancel an escrow to return tokens to the sender. Individual or global freezes for Trust Line Tokens don't prevent escrow completion.
- For tokens requiring authorization, both sender and recipient must be pre-authorized by the issuer before creating or finishing the escrow, respectively. Authorization cannot be granted during the escrow completion process.
## EscrowFinish Transaction Cost
@@ -86,7 +65,7 @@ When using crypto-conditions, the EscrowFinish transaction must pay a [higher tr
The additional transaction cost required is proportional to the size of the fulfillment. If the transaction is [multi-signed](../accounts/multi-signing.md), the cost of multi-signing is added to the cost of the fulfillment.
Currently, an EscrowFinish with a fulfillment requires a minimum transaction cost of **330 [drops of XRP](../../references/protocol/data-types/basic-data-types.md#specifying-currency-amounts)** plus 10 drops per 16 bytes in the size of the fulfillment.
Currently, an EscrowFinish with a fulfillment requires a minimum transaction cost of **330 [drops of XRP](../../references/protocol/data-types/basic-data-types.md#specifying-currency-amounts)** plus 10 drops per 16 bytes in the size of the fulfillment**.
{% admonition type="info" name="Note" %}The above formula is based on the assumption that the reference cost of a transaction is 10 drops of XRP.{% /admonition %}

View File

@@ -1,22 +1,22 @@
---
seo:
description: Payment Channels enable fast, asynchronous XRP payments that can be divided into very small increments and settled later.
description: Payment Channels enable fast, asynchronous payments that can be divided into very small increments and settled later.
labels:
- Payment Channels
- Smart Contracts
---
# Payment Channels
Payment Channels are an advanced feature for sending "asynchronous" XRP payments that can be divided into very small increments and settled later.
Payment Channels are an advanced feature for sending "asynchronous" payments that can be divided into very small increments and settled later.
The XRP for a payment channel is set aside temporarily. The sender creates _Claims_ against the channel, which the recipient verifies without sending an XRP Ledger transaction or waiting for a new ledger version to be approved by [consensus](../consensus-protocol/index.md). (This is an _asynchronous_ process because it happens separate from the usual pattern of getting transactions approved by consensus.) At any time, the recipient can _redeem_ a Claim to receive an amount of XRP authorized by that Claim. Settling a Claim like this uses a standard XRP Ledger transaction, as part of the usual consensus process. This single transaction can encompass any number of transactions guaranteed by smaller Claims.
The XRP or fungible tokens for a payment channel are set aside temporarily. The sender creates _Claims_ against the channel, which the recipient verifies without sending an XRP Ledger transaction or waiting for a new ledger version to be approved by [consensus](../consensus-protocol/index.md). (This is an _asynchronous_ process because it happens separate from the usual pattern of getting transactions approved by consensus.) At any time, the recipient can _redeem_ a Claim to receive an amount of XRP or fungible tokens authorized by that Claim. Settling a Claim like this uses a standard XRP Ledger transaction, as part of the usual consensus process. This single transaction can encompass any number of transactions guaranteed by smaller Claims.
Because Claims can be verified individually but settled in bulk later, payment channels make it possible to conduct transactions at a rate only limited by the participants' ability to create and verify the digital signatures of those Claims. This limit is primarily based on the speed of the participants' hardware and the complexity of the signature algorithms. For maximum speed, use Ed25519 signatures, which are faster than the XRP Ledger's default secp256k1 ECDSA signatures. Research has [demonstrated the ability to create over Ed25519 100,000 signatures per second and to verify over 70,000 per second](https://ed25519.cr.yp.to/ed25519-20110926.pdf) on commodity hardware in 2011.
## Why Use Payment Channels
The process of using a payment channel always involves two parties, a payer and a payee. The payer is an individual person or institution using the XRP Ledger who is a customer of the payee. The payee is a person or business who receives XRP as payment for goods or services.
The process of using a payment channel always involves two parties, a payer and a payee. The payer is an individual person or institution using the XRP Ledger who is a customer of the payee. The payee is a person or business who receives XRP or fungible tokens as payment for goods or services.
Payment Channels do not intrinsically specify anything about what you can buy and sell with them. However, the types of goods and services that are a good fit for payment channels are:

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: You can assign another account to mint NFTs in your stead.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Authorizing Another Minter

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Minting NFTs in batches.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Batch Minting

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: You can mint NFTs as collections using the NFT Taxon field.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Minting NFTs into Collections

View File

@@ -2,7 +2,7 @@
seo:
description: Create NFTs with the option of changing the URI to update its referenced data object.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Dynamic Non-Fungible Tokens (dNFTs)

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Use a new account to mint a fixed number of NFTs, then black hole the account.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Guaranteeing a Fixed Supply of NFTs

View File

@@ -4,7 +4,7 @@ parent: tokens.html
seo:
description: Introduction to XRPL NFTs.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Non-Fungible Tokens

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Specialized APIs let you access useful NFT metadata.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFT APIs

View File

@@ -2,7 +2,7 @@
seo:
description: Create NFTs that can't be traded among users.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Non-Transferable Tokens

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Storage options for the payload of your NFT.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFT Payload Storage

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Understand reserve requirements for minting and holding NFTs.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFT Reserve Requirements

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: You can assign another account to mint NFTs in your stead.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Running an NFT Auction

View File

@@ -4,7 +4,7 @@ parent: non-fungible-tokens.html
seo:
description: Trading NFTs in direct or brokered mode.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# Trading NFTs

View File

@@ -4,7 +4,7 @@ seo:
status: not_enabled
labels:
- Blockchain
- Sidechains
- Interoperability
---
# Cross-Chain Bridges

View File

@@ -3,7 +3,7 @@ seo:
description: An XRPL sidechain is an independent ledger with its own consensus algorithm, transaction types, and rules.
labels:
- Blockchain
- Sidechains
- Interoperability
---
# XRPL Sidechains

View File

@@ -4,16 +4,16 @@ seo:
status: not_enabled
labels:
- Blockchain
- Sidechains
- Interoperability
---
# Witness Servers
[[Source]](https://github.com/seelabs/xbridge_witness "Source")
A _witness server_ acts as a neutral witness for transactions between a locking chain and an issuing chain. It listens to the door accounts on both sides of a bridge and signs attestations that confirm a transaction occurred. They are essentially acting as an oracle to “prove” that value was locked or burned on a source account, which allows the recipient to then claim (via minting or unlocking) the equivalent funds on the destination account.
The bridge between the locking chain and the issuing chain includes the following information in its configuration:
The bridge between the locking chain and the issuing chain includes the following information in its configuration:
* Witness servers that monitor transactions on the bridge. You can choose one or more witness servers.
* Witness servers that monitor transactions on the bridge. You can choose one or more witness servers.
* Fee for witness servers for their service.
Anyone can run a witness server. However, the burden is on the participants of the issuing chain to evaluate the reliability of witness servers. If you run a witness server, you must also run a `rippled` node and sync it to the chain the witness server needs access to.
@@ -92,7 +92,7 @@ The witness server takes a JSON configuration file, specified using the `--conf`
| [`IssuingChain`](#issuingchain-and-lockingchain-fields) | Object | Yes | The parameters for interacting with the issuing chain. |
| [`LockingChain`](#issuingchain-and-lockingchain-fields) | Object | Yes | The parameters for interacting with the locking chain. |
| `RPCEndpoint` | Object | Yes | The endpoint for RPC requests to the witness server. |
| `LogFile` | String | Yes | The location of the log file. |
| `LogFile` | String | Yes | The location of the log file. |
| `LogLevel` | String | Yes | The level of logs to store in the log file. The options are `All`, `Trace`, `Debug`, `Info`, `Warning`, `Error`, `Fatal`, `Disabled`, and `None`. |
| `DBDir` | String | Yes | The location of the directory where the databases are stored. |
| `SigningKeySeed` | String | Yes | The seed that the witness server should use to sign its attestations. |

View File

@@ -5,7 +5,7 @@ labels:
- Payment Channels
---
# account_channels
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountChannels.cpp "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountChannels.cpp "Source")
The `account_channels` method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. (A channel's "source" and "owner" are the same.) All information retrieved is relative to a particular version of the ledger.
@@ -57,11 +57,14 @@ The request includes the following parameters:
| Field | Type | Required? | Description |
|:----------------------|:---------------------|:----------|-------------|
| `account` | String - [Address][] | Yes | Look up channels where this account is the channel's owner/source. |
| `amount` | Object or String | No | The total amount allocated to this channel. |
| `balance` | Object or String | No | The total amount paid out from this channel, as of the ledger version used. (You can calculate the amount left in the channel by subtracting `balance` from `amount`). |
| `destination_account` | String - [Address][] | No | A second account; if provided, filter results to payment channels whose destination is this account. |
| `ledger_hash` | String | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | Number or String | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `limit` | Number | No | Limit the number of transactions to retrieve. Cannot be less than 10 or more than 400. Positive values outside this range are replaced with the closest valid option. The default is 200. |
| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. |
| `transfer_rate` | Number | No | The fee to charge when users make claims on a payment channel, initially set on the creation of a payment channel and updated on subsequent funding or claim transactions. |
## Response Format
@@ -172,6 +175,8 @@ Each Channel Object has the following fields:
| Field | Type | Description |
|:----------------------|:-----------------|:----------------------------------|
| `account` | String | The owner of the channel, as an [Address][]. |
| `amount` | Object or String | The total amount of [XRP, in drops][] or fungible tokens allocated to this channel. |
| `balance` | String | The total amount of [XRP, in drops][] or fungible tokens paid out from this channel, as of the ledger version used. (You can calculate the amount left in the channel by subtracting `balance` from `amount`.) |
| `channel_id` | String | A unique ID for this channel, as a 64-character hexadecimal string. This is also the [ID of the channel object](../../../protocol/ledger-data/ledger-entry-types/paychannel.md#paychannel-id-format) in the ledger's state data. |
| `destination_account` | String | The destination account of the channel, as an [Address][]. Only this account can receive the `amount` in the channel while it is open. |
| `settle_delay` | Unsigned Integer | The number of seconds the payment channel must stay open after the owner of the channel requests to close it. |

View File

@@ -65,6 +65,8 @@ The request accepts the following parameters:
| `limit` | Number | No | Limit the number of trust lines to retrieve. The server may return less than the specified limit, even if there are more pages of results. Must be within the inclusive range 10 to 400. Positive values outside this range are replaced with the closest valid option. The default is 200. |
| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. |
| `peer` | String - [Address][] | No | A second account; if provided, filter results to trust lines connecting the two accounts. |
| `locked_balance` | Object | No | The total amount locked in payment channels or escrow. |
| `lock_count` | Number | No | the total number of lock balances on a RippleState ledger object. |
The following parameters are deprecated and may be removed without further notice: `ledger` and `peer_index`.

View File

@@ -4,7 +4,7 @@ parent: account-methods.html
seo:
description: Get a list of all NFTs for an account.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# account_nfts
[[Source]](https://github.com/xrplf/rippled/blob/master/src/ripple/rpc/handlers/AccountObjects.cpp "Source")

View File

@@ -4,7 +4,7 @@ parent: clio-methods.html
seo:
description: Retrieve the history of ownership and transfers for the specified NFT using Clio server's `nft_history` API.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# nft_history

View File

@@ -4,7 +4,7 @@ parent: clio-methods.html
seo:
description: Retrieve information about the specified NFT using Clio server's `nft_info` API.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# nft_info
[[Source]](https://github.com/XRPLF/clio/blob/4a5cb962b6971872d150777881801ce27ae9ed1a/src/rpc/handlers/NFTInfo.cpp "Source")

View File

@@ -4,7 +4,7 @@ parent: clio-methods.html
seo:
description: Retrieve the history of ownership and transfers for the specified NFT using Clio server's `nft_history` API.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# nfts_by_issuer

View File

@@ -4,7 +4,7 @@ parent: path-and-order-book-methods.html
seo:
description: Get a list of all buy offers for a NFToken.
labels:
- NFTs, NFTokens
- Non-fungible Tokens, NFTs, NFTokens
---
# nft_buy_offers
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/NFTOffers.cpp "Source")

View File

@@ -4,7 +4,7 @@ parent: path-and-order-book-methods.html
seo:
description: Get a list of all sell offers for a NFToken.
labels:
- NFTs, NFTokens
- Non-fungible Tokens, NFTs, NFTokens
---
# nft_sell_offers
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/NFTOffers.cpp "Source")

View File

@@ -7,7 +7,7 @@ labels:
# channel_authorize
[[Source]](https://github.com/XRPLF/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L41 "Source")
The `channel_authorize` method creates a signature that can be used to redeem a specific amount of XRP from a payment channel.
The `channel_authorize` method creates a signature that can be used to redeem a specific amount of XRP or fungible tokens from a payment channel.
{% amendment-disclaimer name="PayChan" /%}
@@ -65,7 +65,7 @@ The request includes the following parameters:
| `seed_hex` | String | _(Optional)_ The secret seed to use to sign the claim. This must be the same key pair as the public key specified in the channel. Must be in hexadecimal format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `passphrase`. |
| `passphrase` | String | _(Optional)_ A string passphrase to use to sign the claim. This must be the same key pair as the public key specified in the channel. The [key derived from this passphrase](../../../../concepts/accounts/cryptographic-keys.md#key-derivation) must match the public key specified in the channel. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `seed_hex`. |
| `key_type` | String | _(Optional)_ The [signing algorithm](../../../../concepts/accounts/cryptographic-keys.md#signing-algorithms) of the cryptographic key pair provided. Valid types are `secp256k1` or `ed25519`. The default is `secp256k1`. |
| `amount` | String | Cumulative amount of XRP, in drops, to authorize. If the destination has already received a lesser amount from this channel, the signature created by this method can be redeemed for the difference. |
| `amount` | Object or String | Cumulative amount of XRP, in drops, or fungible tokens to authorize. If the destination has already received a lesser amount from this channel, the signature created by this method can be redeemed for the difference. |
The request **must** specify exactly one of `secret`, `seed`, `seed_hex`, or `passphrase`.

View File

@@ -9,7 +9,7 @@ labels:
# channel_verify
[[Source]](https://github.com/XRPLF/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L89 "Source")
The `channel_verify` method checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel.
The `channel_verify` method checks the validity of a signature that can be used to redeem a specific amount of XRP or fungible tokens from a payment channel.
{% amendment-disclaimer name="PayChan" /%}
@@ -58,7 +58,7 @@ The request includes the following parameters:
| Field | Type | Description |
|-------|------|-------------|
| `amount` | String | The amount of [XRP, in drops][], that the provided `signature` authorizes. |
| `amount` | Object or String | The amount of [XRP, in drops][], or fungible tokens the provided `signature` authorizes. |
| `channel_id` | String | The Channel ID of the channel that provides the amount. This is a 64-character hexadecimal string. |
| `public_key` | String | The public key of the channel and the key pair that was used to create the signature, in hexadecimal or the XRP Ledger's [base58][] format. {% badge href="https://github.com/XRPLF/rippled/releases/tag/0.90.0" %}Updated in: rippled 0.90.0{% /badge %} |
| `signature` | String | The signature to verify, in hexadecimal. |

View File

@@ -4,7 +4,7 @@ parent: basic-data-types.html
seo:
description: Introduction to XRPL NFTs.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFToken

View File

@@ -88,7 +88,6 @@ AccountRoot objects can have the following flags combined in the `Flags` field:
| Flag Name | Hex Value | Decimal Value | Corresponding [AccountSet Flag](../../transactions/types/accountset.md#accountset-flags) | Description |
|-----------------------------------|--------------|-------------------|-----------------------------------|----|
| `lsfAllowTrustLineClawback` | `0x80000000` | 2147483648 | `asfAllowTrustLineClawback` | Enable [Clawback](../../../../concepts/tokens/fungible-tokens/clawing-back-tokens.md) for this account. {% amendment-disclaimer name="Clawback" /%} |
| `lsfAllowTrustLineLocking` | `0x40000000` | 1073741824 | `asfAllowTrustLineLocking` | Enable [Escrow](../../../../concepts/payment-types/escrow.md) for Trust Line Tokens issued by this account. {% amendment-disclaimer name="TokenEscrow" /%} |
| `lsfDefaultRipple` | `0x00800000` | 8388608 | `asfDefaultRipple` | Enable [rippling](../../../../concepts/tokens/fungible-tokens/rippling.md) on this addresses's trust lines by default. Required for issuing addresses; discouraged for others. |
| `lsfDepositAuth` | `0x01000000` | 16777216 | `asfDepositAuth` | This account has [DepositAuth](../../../../concepts/accounts/depositauth.md) enabled, meaning it can only receive funds from transactions it sends, and from [preauthorized](../../../../concepts/accounts/depositauth.md#preauthorization) accounts. {% amendment-disclaimer name="DepositAuth" /%} |
| `lsfDisableMaster` | `0x00100000` | 1048576 | `asfDisableMaster` | Disallows use of the master key to sign transactions for this account. |

View File

@@ -1,8 +1,8 @@
---
seo:
description: A single cross-chain bridge that connects and enables value to move efficiently between two blockchains.
description: A single cross-chain bridge that connects and enables value to move efficiently between two blockchains.
labels:
- Sidechains
- Interoperability
status: not_enabled
---
# Bridge

View File

@@ -5,11 +5,11 @@ labels:
- Escrow
---
# Escrow
[[Source]](https://github.com/XRPLF/rippled/blob/master/include/xrpl/protocol/detail/ledger_entries.macro#L344-L359 "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/f64cf9187affd69650907d0d92e097eb29693945/include/xrpl/protocol/detail/ledger_entries.macro#L329-L342 "Source")
An `Escrow` ledger entry represents an [escrow](../../../../concepts/payment-types/escrow.md), which holds funds until specific conditions are met. You can create an escrow by sending an [EscrowCreate transaction][].
An `Escrow` ledger entry represents an [escrow](../../../../concepts/payment-types/escrow.md), which holds XRP until specific conditions are met. You can create an escrow by sending an [EscrowCreate transaction][].
{% amendment-disclaimer name="TokenEscrow" mode="updated" /%}
{% amendment-disclaimer name="Escrow" /%}
## Example {% $frontmatter.seo.title %} JSON
@@ -39,8 +39,8 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e
| Name | JSON Type | [Internal Type][] | Required? | Description |
|:--------------------|:----------|:------------------|:----------|:-----------------------|
| `Account` | String | AccountID | Yes | The address of the owner (sender) of this escrow. This is the account that provided the funds, and gets it back if the escrow is canceled. |
| `Amount` | Object or String | Amount | Yes | The amount to be delivered by the payment in escrow. The amount can be XRP, or with the TokenEscrow amendment, a fungible token. {% amendment-disclaimer name="TokenEscrow" mode="updated" /%} |
| `Account` | String | AccountID | Yes | The address of the owner (sender) of this escrow. This is the account that provided the XRP, and gets it back if the escrow is canceled. |
| `Amount` | Object or String | Amount | Yes | The amount to be delivered by the payment is escrow. |
| `CancelAfter` | Number | UInt32 | No | The escrow can be canceled if and only if this field is present _and_ the time it specifies has passed. Specifically, this is specified as [seconds since the Ripple Epoch][] and it "has passed" if it's earlier than the close time of the previous validated ledger. |
| `Condition` | String | Blob | No | A [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1), as hexadecimal. If present, the [EscrowFinish transaction][] must contain a fulfillment that satisfies this condition. |
| `Destination` | String | AccountID | Yes | The destination address where the XRP is paid if the escrow is successful. |
@@ -52,8 +52,7 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e
| `PreviousTxnID` | String | UInt256 | Yes | The identifying hash of the transaction that most recently modified this entry. |
| `PreviousTxnLgrSeq` | Number | UInt32 | Yes | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this entry. |
| `SourceTag` | Number | UInt32 | No | An arbitrary tag to further specify the source for this escrow, such as a hosted recipient at the owner's address. |
| `TransferRate` | Number | UInt32 | No | The transfer rate or fee to charge when users finish an escrow, locked at the creation of an escrow contract and used during settlement. Applicable to Trust Line Tokens and MPTs only. {% amendment-disclaimer name="TokenEscrow" /%} |
| `IssuerNode` | Number | UInt64 | No | The ledger index of the issuer's directory node associated with the `Escrow`. Used when the issuer is neither the source nor destination account. {% amendment-disclaimer name="TokenEscrow" /%} |
| `TransferRate` | Number | UInt32 | No | The fee to charge when users finish an escrow, initially set on the creation of an escrow contract and updated on subsequent finish transactions. |
## {% $frontmatter.seo.title %} Flags

View File

@@ -2,7 +2,7 @@
seo:
description: Multi-Purpose Tokens (MPT) of one issuance held by a specific account.
labels:
- MPTs, Tokens
- Multi-purpose Tokens, MPTs, Tokens
status: not_enabled
---
# MPToken

View File

@@ -2,7 +2,7 @@
seo:
description: Definition of a Multi-Purpose Token (MPT) issuance.
labels:
- MPTs, Tokens
- Multi-purpose Tokens, MPTs, Tokens
status: not_enabled
---
# MPTokenIssuance
@@ -41,7 +41,6 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e
| `AssetScale` | Number | UInt8 | Yes | Where to put the decimal place when displaying amounts of this MPT. More formally, the asset scale is a non-negative integer (0, 1, 2, …) such that one standard unit equals 10^(-scale) of a corresponding fractional unit. For example, if a US Dollar Stablecoin has an asset scale of _2_, then 1 unit of that MPT would equal 0.01 US Dollars. This indicates to how many decimal places the MPT can be subdivided. The default is `0`, meaning that the MPT cannot be divided into smaller than 1 unit. |
| `MaximumAmount` | String - Number | UInt64 | No | The maximum number of MPTs that can exist at one time. If omitted, the maximum is currently limited to 2<sup>63</sup>-1. |
| `OutstandingAmount` | String - Number | UInt64 | Yes | The total amount of MPTs of this issuance currently in circulation. This value increases when the issuer sends MPTs to a non-issuer, and decreases whenever the issuer receives MPTs. |
| `LockedAmount` | String - Number | UInt64 | No | The amount of tokens currently locked up (for example, in escrow). This amount is already included in the `OutstandingAmount`. {% amendment-disclaimer name="TokenEscrow" /%} |
| `TransferFee` | Number | UInt16 | Yes | This value specifies the fee, in tenths of a basis point, charged by the issuer for secondary sales of the token, if such sales are allowed at all. Valid values for this field are between 0 and 50,000 inclusive. A value of 1 is equivalent to 1/10 of a basis point or 0.001%, allowing transfer rates between 0% and 50%. A `TransferFee` of 50,000 corresponds to 50%. The default value for this field is 0. Any decimals in the transfer fee are rounded down. The fee can be rounded down to zero if the payment is small. Issuers should make sure that their MPT's `AssetScale` is large enough. |
| `MPTokenMetadata` | String - Hexadecimal | Blob | Yes | Arbitrary metadata about this issuance, in hex format. The limit for this field is 1024 bytes. |
| `OwnerNode` | String - Hexadecimal | UInt64 | Yes | A hint indicating which page of the owner directory links to this entry, in case the directory consists of multiple pages. |

View File

@@ -2,7 +2,7 @@
seo:
description: An offer to buy or sell an NFT.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFTokenOffer
[[Source]](https://github.com/XRPLF/rippled/blob/f64cf9187affd69650907d0d92e097eb29693945/include/xrpl/protocol/detail/ledger_entries.macro#L34-L44 "Source")

View File

@@ -2,7 +2,7 @@
seo:
description: A group of up to 32 NFTs, stored together for efficiency.
labels:
- NFTs
- Non-fungible Tokens, NFTs
---
# NFTokenPage
[[Source]](https://github.com/XRPLF/rippled/blob/f64cf9187affd69650907d0d92e097eb29693945/include/xrpl/protocol/detail/ledger_entries.macro#L97-L103 "Source")

View File

@@ -42,8 +42,8 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e
| Name | JSON Type | [Internal Type][] | Required? | Description |
|:--------------------|:----------|:------------------|:----------|:-----------------------|
| `Account` | String | AccountID | Yes | The source address that owns this payment channel. This comes from the sending address of the transaction that created the channel. |
| `Amount` | String | Amount | Yes | Total [XRP, in drops][], that have been allocated to this channel. This includes amounts that have been paid to the destination address. This is initially set by the transaction that created the channel and can be increased if the source address sends a `PaymentChannelFund` transaction. |
| `Balance` | String | Amount | Yes | Total [XRP, in drops][] already paid out by the channel. The difference between this value and the `Amount` field is how much can still be paid to the destination address with `PaymentChannelClaim` transactions. If the channel closes, the remaining difference is returned to the source address. |
| `Amount` | String | Amount | Yes | Total [XRP, in drops][] or tokens, that have been allocated to this channel. This includes amounts that have been paid to the destination address. This is initially set by the transaction that created the channel and can be increased if the source address sends a `PaymentChannelFund` transaction. |
| `Balance` | Object or String | Amount | Yes | Total already paid out by the channel. The difference between this value and the `Amount` field is how much can still be paid to the destination address with `PaymentChannelClaim` transactions. If the channel closes, the remaining difference is returned to the source address. |
| `CancelAfter` | Number | UInt32 | No | The immutable expiration time for this payment channel, in [seconds since the Ripple Epoch][]. This channel is expired if this value is present and smaller than the previous ledger's [`close_time` field](../ledger-header.md). This is optionally set by the transaction that created the channel, and cannot be changed. |
| `Destination` | String | AccountID | Yes | The destination address for this payment channel. While the payment channel is open, this address is the only one that can receive XRP from the channel. This comes from the `Destination` field of the transaction that created the channel. |
| `DestinationTag` | Number | UInt32 | No | An arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination address. |
@@ -56,6 +56,7 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e
| `PublicKey` | String | Blob | Yes | Public key, in hexadecimal, of the key pair that can be used to sign claims against this channel. This can be any valid secp256k1 or Ed25519 public key. This is set by the transaction that created the channel and must match the public key used in claims against the channel. The channel source address can also send XRP from this channel to the destination without signed claims. |
| `SettleDelay` | Number | UInt32 | Yes | Number of seconds the source address must wait to close the channel if it still has any XRP in it. Smaller values mean that the destination address has less time to redeem any outstanding claims after the source address requests to close the channel. Can be any value that fits in a 32-bit unsigned integer (0 to 2^32-1). This is set by the transaction that creates the channel. |
| `SourceTag` | Number | UInt32 | No | An arbitrary tag to further specify the source for this payment channel, such as a hosted recipient at the owner's address. |
| `TransferRate` | Number | UInt32 | No | The fee to charge when users make claims on a payment channel, initially set on the creation of a payment channel and updated on subsequent funding or claim transactions. |
## Channel Expiration

View File

@@ -58,6 +58,8 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e
| `HighQualityIn` | Number | UInt32 | No | The inbound quality set by the high account, as an integer in the implied ratio `HighQualityIn`:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value. |
| `HighQualityOut` | Number | UInt32 | No | The outbound quality set by the high account, as an integer in the implied ratio `HighQualityOut`:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value. |
| `LedgerEntryType` | String | UInt16 | Yes | The value `0x0072`, mapped to the string `RippleState`, indicates that this is a RippleState entry. |
| `LockCount` | Object or String | Amount | No | The total number of lock balances on a `RippleState` ledger object. |
| `LockedBalance` | Object or String | Amount | No | The total number of locked tokens on a `RippleState` ledger object. |
| `LowLimit` | Object | Amount | Yes | The limit that the low account has set on the trust line. The `issuer` is the address of the low account that set this limit. |
| `LowNode` | String | UInt64 | Yes | (Omitted in some historical ledgers) A hint indicating which page of the low account's owner directory links to this entry, in case the directory consists of multiple pages. |
| `LowQualityIn` | Number | UInt32 | No | The inbound quality set by the low account, as an integer in the implied ratio `LowQualityIn`:1,000,000,000. As a special case, the value 0 is equivalent to 1 billion, or face value. |

View File

@@ -1,8 +1,8 @@
---
seo:
description: A cross-chain transfer of value.
description: A cross-chain transfer of value.
labels:
- Sidechains
- Interoperability
status: not_enabled
---
# XChainOwnedClaimID

View File

@@ -1,8 +1,8 @@
---
seo:
description: A record of attestations for creating an account via a cross-chain transfer.
description: A record of attestations for creating an account via a cross-chain transfer.
labels:
- Sidechains
- Interoperability
status: not_enabled
---
# XChainOwnedCreateAccountClaimID

View File

@@ -3,7 +3,6 @@ seo:
description: Delete an account.
labels:
- Accounts
category: Settings
---
# AccountDelete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DeleteAccount.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Set options on an account.
labels:
- Accounts
category: Settings
---
# AccountSet
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetAccount.cpp "Source")
@@ -74,7 +73,6 @@ The available AccountSet flags are:
|:----------------------------------|:--------------|:--------------|
| `asfAccountTxnID` | 5 | Track the ID of this account's most recent transaction. Required for [`AccountTxnID`](../common-fields.md#accounttxnid) |
| `asfAllowTrustLineClawback` | 16 | Allow account to claw back tokens it has issued. _(Requires the Clawback amendment.)_ Can only be set if the account has an empty owner directory (no trust lines, offers, escrows, payment channels, checks, or signer lists). After you set this flag, it cannot be reverted. The account permanently gains the ability to claw back issued assets on trust lines. |
| `asfAllowTrustLineLocking` | 17 | Allow Trust Line tokens issued by this account to be held in [escrow](../../../../concepts/payment-types/escrow.md). If not enabled, tokens issued by this account can't be escrowed. After you enable this flag, it cannot be disabled. {% amendment-disclaimer name="TokenEscrow" /%} |
| `asfAuthorizedNFTokenMinter` | 10 | Enable to allow another account to mint non-fungible tokens (NFTokens) on this account's behalf. Specify the authorized account in the `NFTokenMinter` field of the [AccountRoot](../../ledger-data/ledger-entry-types/accountroot.md) object. To remove an authorized minter, enable this flag and omit the `NFTokenMinter` field. {% amendment-disclaimer name="NonFungibleTokensV1_1" /%} |
| `asfDefaultRipple` | 8 | Enable [rippling](../../../../concepts/tokens/fungible-tokens/rippling.md) on this account's trust lines by default. |
| `asfDepositAuth` | 9 | Enable [Deposit Authorization](../../../../concepts/accounts/depositauth.md) on this account. {% amendment-disclaimer name="DepositAuth" /%} |

View File

@@ -3,7 +3,6 @@ seo:
description: Bid on an Automated Market Maker's auction slot, which grants a discounted fee.
labels:
- AMM
category: Trading
---
# AMMBid
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMBid.cpp "Source")

View File

@@ -3,7 +3,7 @@ seo:
description: Claw back tokens from a holder who has deposited your issued tokens into an Automated Market Maker pool.
labels:
- AMM
category: Trading
- Tokens
---
# AMMClawback

View File

@@ -3,7 +3,6 @@ seo:
description: Create a new Automated Market Maker for trading a given pair of assets.
labels:
- AMM
category: Trading
---
# AMMCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMCreate.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Delete an Automated Market Maker with an empty asset pool.
labels:
- AMM
category: Trading
---
# AMMDelete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMDelete.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Deposit funds into an Automated Market Maker in exchange for LPTokens.
labels:
- AMM
category: Trading
---
# AMMDeposit
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMDeposit.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Vote on the trading fee for an Automated Market Maker.
labels:
- AMM
category: Trading
---
# AMMVote
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMVote.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Return LPTokens to an Automated Market Maker in exchange for a share of the assets the pool holds.
labels:
- AMM
category: Trading
---
# AMMWithdraw
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/AMMWithdraw.cpp "Source")

View File

@@ -4,7 +4,6 @@ seo:
labels:
- Transaction Sending
status: not_enabled
category: Other
---
# Batch
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Batch.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Cancel a check.
labels:
- Checks
category: Payments
---
# CheckCancel
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CancelCheck.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Redeem a check.
labels:
- Checks
category: Payments
---
# CheckCash
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CashCheck.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Create a check.
labels:
- Checks
category: Payments
---
# CheckCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateCheck.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Claw back tokens you've issued.
labels:
- Tokens
category: Payments
---
# Clawback
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Clawback.cpp "Source")

View File

@@ -1,9 +1,6 @@
---
seo:
description: Accept a credential provisionally issued to your account.
labels:
- Credentials
category: Settings
---
# CredentialAccept
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Credentials.cpp "Source")

View File

@@ -1,9 +1,6 @@
---
seo:
description: Provisionally issue a credential to a subject account.
labels:
- Credentials
category: Settings
---
# CredentialCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Credentials.cpp "Source")

View File

@@ -1,9 +1,6 @@
---
seo:
description: Remove a credential from the ledger, effectively revoking it.
labels:
- Credentials
category: Settings
---
# CredentialDelete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Credentials.cpp "Source")

View File

@@ -4,7 +4,7 @@ seo:
labels:
- Accounts
- Permissions
category: Settings
- Delegate
status: not_enabled
---
# DelegateSet

View File

@@ -2,8 +2,7 @@
seo:
description: Preauthorize an account to send payments to you.
labels:
- Permissions
category: Settings
- Security
---
# DepositPreauth
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DepositPreauth.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Delete a Decentralized Identifier.
labels:
- DID
category: Other
---
# DIDDelete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DID.cpp "Source")

View File

@@ -3,7 +3,6 @@ seo:
description: Create or update a Decentralized Identifier.
labels:
- DID
category: Other
---
# DIDSet
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DID.cpp "Source")

View File

@@ -3,13 +3,14 @@ seo:
description: Cancel an expired escrow, returning the funds to the sender.
labels:
- Escrow
category: Payments
---
# EscrowCancel
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source")
Return funds from an expired [escrow](../../../../concepts/payment-types/escrow.md) to its sender.
{% amendment-disclaimer name="Escrow" /%}
## Example {% $frontmatter.seo.title %} JSON
```json
@@ -36,17 +37,6 @@ Any account may submit an EscrowCancel transaction.
* If the corresponding [EscrowCreate transaction][] did not specify a `CancelAfter` time, the EscrowCancel transaction fails.
* Otherwise the EscrowCancel transaction fails if the `CancelAfter` time is after the close time of the most recently-closed ledger.
## Error Cases
Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} transactions can result in the following [transaction result codes](../transaction-results/index.md):
| Error Code | Description |
|:------------------------- |:------------|
| `tecNO_AUTH` | The transaction failed because authorization requirements were not met. For example, the issuer requires authorization and the sender is not authorized. |
| `tecNO_LINE` | The sender does not have a trust line with the issuer. For Trust Line Tokens only. |
| `tecNO_ENTRY` | The sender does not hold the MPT. |
| `tecINSUFFICIENT_RESERVE` | Unable to create a trust line or MPToken due to lack of reserves. |
## See Also
- [Escrow entry][]

View File

@@ -3,24 +3,13 @@ seo:
description: Escrow funds, which can be released to the destination after a specific time or condition.
labels:
- Escrow
category: Payments
---
# EscrowCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source")
Set aside funds in an [escrow](../../../../concepts/payment-types/escrow.md) that delivers them to a predetermined recipient when certain conditions are met. If the escrow has an expiration, the funds can also be returned to the sender after it expires.
{% admonition type="info" name="Note" %}
To escrow fungible tokens you must take note of the following:
- Trust Line Tokens must have the **Allow Trust Line Locking** flag enabled on their account.
- Multi-Purpose-Tokens (MPTs) must have both the **Can Escrow** and **Can Transfer** flags enabled.
- All token escrows must specify a **Cancel After** time.
- If the token requires **authorization**, both sender and recipient must be pre-authorized by the issuer.
{% /admonition %}
{% amendment-disclaimer name="TokenEscrow" mode="updated" /%}
{% amendment-disclaimer name="Escrow" /%}
## Example {% $frontmatter.seo.title %} JSON
@@ -45,41 +34,29 @@ To escrow fungible tokens you must take note of the following:
| Field | JSON Type | [Internal Type][] | Description |
|:-----------------|:----------|:------------------|:--------------------------|
| `Amount` | Object or String | Amount | Amount of XRP, in drops, or fungible tokens to deduct from the sender's balance and escrow. Once escrowed, the payment can either go to the `Destination` address (after the `FinishAfter` time) or be returned to the sender (after the `CancelAfter` time). {% amendment-disclaimer name="TokenEscrow" mode="updated" /%} |
| `Destination` | String | AccountID | Address to receive escrowed funds. |
| `CancelAfter` | Number | UInt32 | _(Optional for XRP escrows, but mandatory for token escrows)_ The time, in [seconds since the Ripple Epoch][], when this escrow expires. This value is immutable; the funds can only be returned to the sender after this time. |
| `FinishAfter` | Number | UInt32 | _(Optional)_ The time, in [seconds since the Ripple Epoch][], when the escrowed funds can be released to the recipient. This value is immutable, and the funds can't be accessed until this time. |
| `Condition` | String | Blob | _(Optional)_ Hex value representing a [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1). The funds can only be delivered to the recipient if this condition is fulfilled. If the condition is not fulfilled before the expiration time specified in the `CancelAfter` field, the funds can only revert to the sender. |
| `Amount` | Object or String | Amount | Amount of XRP or fungible tokens to deduct from the sender's balance and escrow. Once escrowed, the payment can either go to the `Destination` address (after the `FinishAfter` time) or be returned to the sender (after the `CancelAfter` time). |
| `Destination` | String | AccountID | Address to receive escrowed XRP. |
| `CancelAfter` | Number | UInt32 | _(Optional)_ The time, in [seconds since the Ripple Epoch][], when this escrow expires. This value is immutable; the funds can only be returned to the sender after this time. |
| `FinishAfter` | Number | UInt32 | _(Optional)_ The time, in [seconds since the Ripple Epoch][], when the escrowed XRP can be released to the recipient. This value is immutable, and the funds can't be accessed until this time. |
| `Condition` | String | Blob | _(Optional)_ Hex value representing a [PREIMAGE-SHA-256 crypto-condition](https://tools.ietf.org/html/draft-thomas-crypto-conditions-02#section-8.1). The funds can only be delivered to the recipient if this condition is fulfilled. If the condition is not fulfilled before the expiration time specified in the `CancelAfter` field, the XRP can only revert to the sender. |
| `DestinationTag` | Number | UInt32 | _(Optional)_ Arbitrary tag to further specify the destination for this escrowed payment, such as a hosted recipient at the destination address. |
You must specify one of the following combinations of fields:
| Summary | `FinishAfter` | `Condition` | `CancelAfter` |
|-----------------------------------|---------------|-------------|---------------|
| Time-based (XRP only) | ✅ | | |
| Time-based | ✅ | | |
| Time-based with expiration | ✅ | | ✅ |
| Timed conditional (XRP only) | ✅ | ✅ | |
| Timed conditional | ✅ | ✅ | |
| Timed conditional with expiration | ✅ | ✅ | ✅ |
| Conditional with expiration | | ✅ | ✅ |
It is not possible to create a conditional escrow with no expiration, but you can specify an expiration that is very far in the future.
{% admonition type="info" name="Note" %}
Before the [fix1571 amendment][] became enabled on 2018-06-19, it was possible to create an XRP escrow with `CancelAfter` only. These escrows could be finished by anyone at any time before the specified expiration.
Before the [fix1571 amendment][] became enabled on 2018-06-19, it was possible to create an escrow with `CancelAfter` only. These escrows could be finished by anyone at any time before the specified expiration.
{% /admonition %}
## Error Cases
Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} transactions can result in the following [transaction result codes](../transaction-results/index.md):
| Error Code | Description |
|:--------------------- |:---------------------------------------------|
| `tecNO_PERMISSION` | The transaction failed because the necessary permissions for token escrow are not in place. For example, the issuer hasn't enabled the Allow Trust Line Locking flag for a Trust Line Token.|
| `tecNO_AUTH` | The transaction failed because authorization requirements for the token were not met. For example, the sender lacks authorization when creating the escrow. |
| `tecUNFUNDED` | The sender lacks sufficient spendable balance. For Trust Line Tokens, this means the sender's trust line with the issuer has insufficient available balance. For XRP escrows, this means the sender doesn't have enough XRP. |
| `tecOBJECT_NOT_FOUND` | The sender does not hold the MPT. |
| `tecFROZEN` | The token is frozen (for Trust Line Tokens) or locked (for MPTs) for the sender. |
## See Also
- [Escrow entry][]

View File

@@ -3,13 +3,15 @@ seo:
description: Deliver escrowed funds to the intended recipient.
labels:
- Escrow
category: Payments
---
# EscrowFinish
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Escrow.cpp "Source")
Deliver funds from an [escrow](../../../../concepts/payment-types/escrow.md) to the recipient.
{% amendment-disclaimer name="Escrow" /%}
## Example {% $frontmatter.seo.title %} JSON
```json
@@ -46,18 +48,6 @@ Any account may submit an EscrowFinish transaction.
In [non-production networks](../../../../concepts/networks-and-servers/parallel-networks.md), it may be possible [to delete](../../../../concepts/accounts/deleting-accounts.md) the destination account of a pending escrow. In this case, an attempt to finish the escrow fails with the result `tecNO_TARGET`, but the escrow object remains unless it has expired normally. If another payment re-creates the destination account, the escrow can be finished successfully. The destination account of an escrow can only be deleted if the escrow was created before the [fix1523 amendment](/resources/known-amendments.md#fix1523) became enabled. No such escrows exist in the production XRP Ledger, so this edge case is not possible on the production XRP Ledger. This edge case is also not possible in test networks that enable both fix1523 and Escrow amendments at the same time, which is the default when you [start a new genesis ledger](../../../../infrastructure/testing-and-auditing/start-a-new-genesis-ledger-in-stand-alone-mode.md).
## Error Cases
Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} transactions can result in the following [transaction result codes](../transaction-results/index.md):
| Error Code | Description |
|:------------------------- |:------------|
| `tecNO_AUTH` | The transaction failed because authorization requirements were not met. For example, the issuer requires authorization and the destination is not authorized. |
| `tecNO_LINE` | The destination account does not have a trust line with the issuer. For Trust Line Tokens only. |
| `tecNO_ENTRY` | The destination account does not hold the MPT. |
| `tecINSUFFICIENT_RESERVE` | Unable to create a trust line or MPToken due to lack of reserves. |
| `tecFROZEN` | The token is deep frozen (Trust Line Tokens) or locked (for MPTs). |
## See Also
- [Escrow entry][]

View File

@@ -16,38 +16,5 @@ All transactions have certain fields in common:
Each transaction type has additional fields relevant to the type of action it causes.
## Payments
{% label-grid category="Payments" /%}
## Trading
{% label-grid category="Trading" /%}
## Tokens
{% label-grid category="Tokens" /%}
## Settings
{% label-grid category="Settings" /%}
## Other
{% label-grid category="Other" /%}
<!--
## Manual card grid below (ignore)
{% card-grid layout="2xN" %}
{% nav-card label="AMM" /%}
{% nav-card label="Credentials" /%}
{% nav-card label="Tokens" /%}
{% nav-card label="Transaction Sending" /%}
{% nav-card label="DID" /%}
{% nav-card label="MPTs" /%}
{% nav-card label="NFTs" /%}
{% nav-card label="Decentralized Exchange" /%}
{% nav-card label="Oracles" /%}
{% nav-card label="Sidechains" /%}
{% nav-card label="Permissioned Domains" /%}
{% /card-grid %}
## All Transaction Types Alphabetically
{% child-pages /%}
-->

View File

@@ -3,7 +3,7 @@ seo:
description: Repair corruptions to the XRP ledger's state data.
labels:
- Utilities
category: Other
- Troubleshooting
---
# LedgerStateFix
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/LedgerStateFix.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Set up your account to receive a specific MPT as a holder; or authorize a holder as an MPT issuer.
labels:
- MPTs
category: Tokens
- Multi-purpose Tokens, MPTs
---
# MPTokenAuthorize
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenAuthorize.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Define the properties of a new Multi-Purpose Token (MPT).
labels:
- MPTs
category: Tokens
- Multi-purpose Tokens, MPTs
---
# MPTokenIssuanceCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceCreate.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Delete a Multi-Purpose Token definition.
labels:
- MPTs
category: Tokens
- Multi-purpose Tokens, MPTs
---
# MPTokenIssuanceDestroy
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceDestroy.cpp "Source")
@@ -14,7 +13,7 @@ Delete a [Multi-purpose Token (MPT)](../../../../concepts/tokens/fungible-tokens
## Example MPTokenIssuanceDestroy JSON
```json
```json
{
"TransactionType": "MPTokenIssuanceDestroy",
"Fee": "10",

View File

@@ -2,8 +2,7 @@
seo:
description: Set mutable properties of a Multi-Purpose Token definition.
labels:
- MPTs
category: Tokens
- Multi-purpose Tokens, MPTs
---
# MPTokenIssuanceSet
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceSet.cpp "Source")
@@ -14,7 +13,7 @@ Update a mutable property of a [Multi-purpose Token (MPT)](../../../../concepts/
## Example
```json
```json
{
"TransactionType": "MPTokenIssuanceSet",
"Fee": "10",

View File

@@ -2,8 +2,7 @@
seo:
description: Accept an offer to buy or sell an NFT.
labels:
- NFTs
category: Trading
- NFTs, Non-fungible Tokens
---
# NFTokenAcceptOffer
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenAcceptOffer.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Permanently destroy an NFT.
labels:
- NFTs
category: Tokens
- Non-fungible Tokens, NFTs
---
# NFTokenBurn
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenBurn.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Cancel offers to buy or sell an NFT.
labels:
- NFTs
category: Trading
- NFTs, Non-fungible Tokens
---
# NFTokenCancelOffer
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCancelOffer.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Create an offer to buy or sell an NFT.
labels:
- NFTs
category: Trading
- Non-fungible Tokens, NFTs
---
# NFTokenCreateOffer
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenCreateOffer.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Mint a Non-Fungible Token (NFT).
labels:
- NFTs
category: Tokens
- Non-fungible Tokens, NFTs
---
# NFTokenMint
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenMint.cpp "Source")
@@ -63,7 +62,7 @@ Transactions of the NFTokenMint type support additional values in the [`Flags` f
| `tfOnlyXRP` | `0x00000002` | 2 | The minted `NFToken` can only be bought or sold for XRP. This can be desirable if the token has a transfer fee and the issuer does not want to receive fees in non-XRP currencies. |
| `tfTrustLine` | `0x00000004` | 4 | **DEPRECATED** Automatically create [trust lines](../../../../concepts/tokens/fungible-tokens/index.md) from the issuer to hold transfer fees received from transferring the minted `NFToken`. The [fixRemoveNFTokenAutoTrustLine amendment][] makes it invalid to set this flag. |
| `tfTransferable` | `0x00000008` | 8 | The minted `NFToken` can be transferred to others. If this flag is _not_ enabled, the token can still be transferred _from_ or _to_ the issuer, but a transfer to the issuer must be made based on a buy offer from the issuer and not a sell offer from the NFT holder. |
| `tfMutable` | `0x00000010` | 16 | The `URI` field of the minted `NFToken` can be updated using the `NFTokenModify` transaction. |
| `tfMutable` | `0x00000010` | 16 | The `URI` field of the minted `NFToken` can be updated using the `NFTokenModify` transaction. |
## Embedding additional information

View File

@@ -2,8 +2,7 @@
seo:
description: Modify a dynamic NFT.
labels:
- NFTs
category: Tokens
- Non-fungible Tokens, NFTs
---
# NFTokenModify
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/NFTokenModify.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Cancel an offer to trade in the decentralized exchange.
labels:
- Offers
category: Trading
- Decentralized Exchange
---
# OfferCancel

View File

@@ -2,8 +2,7 @@
seo:
description: Offer to trade currencies in the decentralized exchange; create a limit order.
labels:
- Offers
category: Trading
- Decentralized Exchange
---
# OfferCreate
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/CreateOffer.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Delete a price oracle.
labels:
- Oracles
category: Other
- Oracle
---
# OracleDelete
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/DeleteOracle.cpp "Source")

View File

@@ -2,8 +2,7 @@
seo:
description: Create or update a price oracle.
labels:
- Oracles
category: Other
- Oracle
---
# OracleSet
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/SetOracle.cpp "Source")

View File

@@ -3,8 +3,9 @@ seo:
description: Send funds to another account, convert between currencies, or create a new account by sending it XRP.
labels:
- Payments
- XRP
- Cross-Currency
- Tokens
category: Payments
---
# Payment
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Payment.cpp "Source")

Some files were not shown because too many files have changed in this diff Show More