ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-04 11:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

update content from v1 to v2

Browse Source
This commit is contained in:
Oliver Eggert
2024-11-04 14:17:30 -08:00
parent d093c69ae5
commit 27bcca71a9
20 changed files with 1025 additions and 899 deletions
Download Patch File Download Diff File Expand all files Collapse all files

227
_api-examples/tx/jsonrpc-response-ctid.json
View File

@@ -1,120 +1,115 @@
{ {
"result": { "result": {
"Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "tx_json": {
"Amount": { "Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"currency": "USD", "DeliverMax": {
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "currency": "USD",
"value": "1" "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
}, "value": "1"
"Destination": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", },
"Fee": "10", "Destination": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"Flags": 0, "Fee": "10",
"Paths": [ "Flags": 0,
[ "Paths": [
{ [{
"account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV", "account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"currency": "USD", "currency": "USD",
"issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV", "issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"type": 49 "type": 49
} }],
], [{
[ "account": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
{ "currency": "USD",
"account": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x", "issuer": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
"currency": "USD", "type": 49
"issuer": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x", }, {
"type": 49 "account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
}, "currency": "USD",
{ "issuer": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
"account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY", "type": 49
"currency": "USD", }, {
"issuer": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY", "account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"type": 49 "currency": "USD",
}, "issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
{ "type": 49
"account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV", }]
"currency": "USD", ],
"issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV", "SendMax": {
"type": 49 "currency": "USD",
} "issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
] "value": "1.01"
], },
"SendMax": { "Sequence": 88,
"currency": "USD", "SigningPubKey": "02EAE5DAB54DD8E1C49641D848D5B97D1B29149106174322EDF98A1B2CCE5D7F8E",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "TransactionType": "Payment",
"value": "1.01" "TxnSignature": "30440220791B6A3E036ECEFFE99E8D4957564E8C84D1548C8C3E80A87ED1AA646ECCFB16022037C5CAC97E34E3021EBB426479F2ACF3ACA75DB91DCC48D1BCFB4CF547CFEAA0",
}, "date": 416445410,
"Sequence": 88, "ledger_index": 348734
"SigningPubKey": "02EAE5DAB54DD8E1C49641D848D5B97D1B29149106174322EDF98A1B2CCE5D7F8E", },
"TransactionType": "Payment", "ctid": "C005523E00000000",
"TxnSignature": "30440220791B6A3E036ECEFFE99E8D4957564E8C84D1548C8C3E80A87ED1AA646ECCFB16022037C5CAC97E34E3021EBB426479F2ACF3ACA75DB91DCC48D1BCFB4CF547CFEAA0", "hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
"ctid": "C005523E00000000", "meta": {
"date": 416445410, "AffectedNodes": [{
"hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7", "ModifiedNode": {
"inLedger": 348734, "FinalFields": {
"ledger_index": 348734, "Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"meta": { "Balance": "59328999119",
"AffectedNodes": [ "Flags": 0,
{ "OwnerCount": 11,
"ModifiedNode": { "Sequence": 89
"FinalFields": { },
"Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "LedgerEntryType": "AccountRoot",
"Balance": "59328999119", "LedgerIndex": "E0D7BDE68B468FF0B8D948FD865576517DA987569833A05374ADB9A72E870A06",
"Flags": 0, "PreviousFields": {
"OwnerCount": 11, "Balance": "59328999129",
"Sequence": 89 "Sequence": 88
}, },
"LedgerEntryType": "AccountRoot", "PreviousTxnID": "C26AA6B4F7C3B9F55E17CD0D11F12032A1C7AD2757229FFD277C9447A8815E6E",
"LedgerIndex": "E0D7BDE68B468FF0B8D948FD865576517DA987569833A05374ADB9A72E870A06", "PreviousTxnLgrSeq": 348700
"PreviousFields": {
"Balance": "59328999129",
"Sequence": 88
},
"PreviousTxnID": "C26AA6B4F7C3B9F55E17CD0D11F12032A1C7AD2757229FFD277C9447A8815E6E",
"PreviousTxnLgrSeq": 348700
}
},
{
"ModifiedNode": {
"FinalFields": {
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "-1"
},
"Flags": 131072,
"HighLimit": {
"currency": "USD",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "100"
},
"HighNode": "0",
"LowLimit": {
"currency": "USD",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"value": "0"
},
"LowNode": "0"
},
"LedgerEntryType": "RippleState",
"LedgerIndex": "EA4BF03B4700123CDFFB6EB09DC1D6E28D5CEB7F680FB00FC24BC1C3BB2DB959",
"PreviousFields": {
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
} }
}, }, {
"PreviousTxnID": "53354D84BAE8FDFC3F4DA879D984D24B929E7FEB9100D2AD9EFCD2E126BCCDC8", "ModifiedNode": {
"PreviousTxnLgrSeq": 343570 "FinalFields": {
} "Balance": {
} "currency": "USD",
], "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"TransactionIndex": 0, "value": "-1"
"TransactionResult": "tesSUCCESS", },
"delivered_amount": "unavailable" "Flags": 131072,
}, "HighLimit": {
"status": "success", "currency": "USD",
"validated": true "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "100"
},
"HighNode": "0",
"LowLimit": {
"currency": "USD",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"value": "0"
},
"LowNode": "0"
},
"LedgerEntryType": "RippleState",
"LedgerIndex": "EA4BF03B4700123CDFFB6EB09DC1D6E28D5CEB7F680FB00FC24BC1C3BB2DB959",
"PreviousFields": {
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
}
},
"PreviousTxnID": "53354D84BAE8FDFC3F4DA879D984D24B929E7FEB9100D2AD9EFCD2E126BCCDC8",
"PreviousTxnLgrSeq": 343570
}
}],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS",
"delivered_amount": "unavailable"
},
"validated": true,
"ledger_index": 348734,
"ledger_hash": "195F62F34EB2CCFA4C5888BA20387E82EB353DDB4508BAE6A835AF19FB8B0C09",
"close_time_iso": "2013-03-12T23:16:50Z",
"status": "success"
} }
} }

220
_api-examples/tx/jsonrpc-response-hash.json
View File

@@ -1,118 +1,116 @@
{ {
"result": { "result": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM", "tx_json": {
"Fee": "12", "Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"Flags": 0, "Fee": "12",
"LastLedgerSequence": 56865248, "Flags": 0,
"OfferSequence": 5037708, "LastLedgerSequence": 56865248,
"Sequence": 5037710, "OfferSequence": 5037708,
"SigningPubKey": "03B51A3EDF70E4098DA7FB053A01C5A6A0A163A30ED1445F14F87C7C3295FCB3BE", "Sequence": 5037710,
"TakerGets": "15000000000", "SigningPubKey": "03B51A3EDF70E4098DA7FB053A01C5A6A0A163A30ED1445F14F87C7C3295FCB3BE",
"TakerPays": { "TakerGets": "15000000000",
"currency": "CNY", "TakerPays": {
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", "currency": "CNY",
"value": "20160.75" "issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"value": "20160.75"
},
"TransactionType": "OfferCreate",
"TxnSignature": "3045022100A5023A0E64923616FCDB6D664F569644C7C9D1895772F986CD6B981B515B02A00220530C973E9A8395BC6FE2484948D2751F6B030FC7FB8575D1BFB406368AD554D9",
"date": 648248020,
"ledger_index": 56865245
}, },
"TransactionType": "OfferCreate",
"TxnSignature": "3045022100A5023A0E64923616FCDB6D664F569644C7C9D1895772F986CD6B981B515B02A00220530C973E9A8395BC6FE2484948D2751F6B030FC7FB8575D1BFB406368AD554D9",
"ctid": "C363B1DD00000000", "ctid": "C363B1DD00000000",
"date": 648248020,
"hash": "C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9", "hash": "C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9",
"inLedger": 56865245,
"ledger_index": 56865245,
"meta": { "meta": {
"AffectedNodes": [ "AffectedNodes": [{
{ "ModifiedNode": {
"ModifiedNode": { "FinalFields": {
"FinalFields": { "ExchangeRate": "4f04c66806cf7400",
"ExchangeRate": "4f04c66806cf7400", "Flags": 0,
"Flags": 0, "RootIndex": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400",
"RootIndex": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400", "TakerGetsCurrency": "0000000000000000000000000000000000000000",
"TakerGetsCurrency": "0000000000000000000000000000000000000000", "TakerGetsIssuer": "0000000000000000000000000000000000000000",
"TakerGetsIssuer": "0000000000000000000000000000000000000000", "TakerPaysCurrency": "000000000000000000000000434E590000000000",
"TakerPaysCurrency": "000000000000000000000000434E590000000000", "TakerPaysIssuer": "CED6E99370D5C00EF4EBF72567DA99F5661BFB3A"
"TakerPaysIssuer": "CED6E99370D5C00EF4EBF72567DA99F5661BFB3A" },
}, "LedgerEntryType": "DirectoryNode",
"LedgerEntryType": "DirectoryNode", "LedgerIndex": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400"
"LedgerIndex": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400"
}
},
{
"ModifiedNode": {
"FinalFields": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"Balance": "10404767991",
"Flags": 0,
"OwnerCount": 3,
"Sequence": 5037711
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "1DECD9844E95FFBA273F1B94BA0BF2564DDF69F2804497A6D7837B52050174A2",
"PreviousFields": {
"Balance": "10404768003",
"Sequence": 5037710
},
"PreviousTxnID": "4DC47B246B5EB9CCE92ABA8C482479E3BF1F946CABBEF74CA4DE36521D5F9008",
"PreviousTxnLgrSeq": 56865244
}
},
{
"DeletedNode": {
"FinalFields": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"BookDirectory": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400",
"BookNode": "0",
"Flags": 0,
"OwnerNode": "0",
"PreviousTxnID": "8F5FF57B404827F12BDA7561876A13C3E3B3095CBF75334DBFB5F227391A660C",
"PreviousTxnLgrSeq": 56865244,
"Sequence": 5037708,
"TakerGets": "15000000000",
"TakerPays": {
"currency": "CNY",
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"value": "20160.75"
}
},
"LedgerEntryType": "Offer",
"LedgerIndex": "26AAE6CA8D29E28A47C92ADF22D5D96A0216F0551E16936856DDC8CB1AAEE93B"
}
},
{
"ModifiedNode": {
"FinalFields": {
"Flags": 0,
"IndexNext": "0",
"IndexPrevious": "0",
"Owner": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"RootIndex": "47FAF5D102D8CE655574F440CDB97AC67C5A11068BB3759E87C2B9745EE94548"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "47FAF5D102D8CE655574F440CDB97AC67C5A11068BB3759E87C2B9745EE94548"
}
},
{
"CreatedNode": {
"LedgerEntryType": "Offer",
"LedgerIndex": "8BAEE3C7DE04A568E96007420FA11ABD0BC9AE44D35932BB5640E9C3FB46BC9B",
"NewFields": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"BookDirectory": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400",
"Sequence": 5037710,
"TakerGets": "15000000000",
"TakerPays": {
"currency": "CNY",
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"value": "20160.75"
}
} }
} }, {
} "ModifiedNode": {
], "FinalFields": {
"TransactionIndex": 0, "Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"TransactionResult": "tesSUCCESS" "Balance": "10404767991",
"Flags": 0,
"OwnerCount": 3,
"Sequence": 5037711
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "1DECD9844E95FFBA273F1B94BA0BF2564DDF69F2804497A6D7837B52050174A2",
"PreviousFields": {
"Balance": "10404768003",
"Sequence": 5037710
},
"PreviousTxnID": "4DC47B246B5EB9CCE92ABA8C482479E3BF1F946CABBEF74CA4DE36521D5F9008",
"PreviousTxnLgrSeq": 56865244
}
}, {
"DeletedNode": {
"FinalFields": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"BookDirectory": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400",
"BookNode": "0",
"Flags": 0,
"OwnerNode": "0",
"PreviousTxnID": "8F5FF57B404827F12BDA7561876A13C3E3B3095CBF75334DBFB5F227391A660C",
"PreviousTxnLgrSeq": 56865244,
"Sequence": 5037708,
"TakerGets": "15000000000",
"TakerPays": {
"currency": "CNY",
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"value": "20160.75"
}
},
"LedgerEntryType": "Offer",
"LedgerIndex": "26AAE6CA8D29E28A47C92ADF22D5D96A0216F0551E16936856DDC8CB1AAEE93B"
}
}, {
"ModifiedNode": {
"FinalFields": {
"Flags": 0,
"IndexNext": "0",
"IndexPrevious": "0",
"Owner": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"RootIndex": "47FAF5D102D8CE655574F440CDB97AC67C5A11068BB3759E87C2B9745EE94548"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "47FAF5D102D8CE655574F440CDB97AC67C5A11068BB3759E87C2B9745EE94548"
}
}, {
"CreatedNode": {
"LedgerEntryType": "Offer",
"LedgerIndex": "8BAEE3C7DE04A568E96007420FA11ABD0BC9AE44D35932BB5640E9C3FB46BC9B",
"NewFields": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"BookDirectory": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400",
"Sequence": 5037710,
"TakerGets": "15000000000",
"TakerPays": {
"currency": "CNY",
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"value": "20160.75"
}
}
}
}],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS"
}, },
"status": "success", "validated": true,
"validated": true "ledger_index": 56865245,
} "ledger_hash": "793E56131D8D4ABFB27FA383BFC44F2978B046E023FF46C588D7E0C874C2472A",
} "close_time_iso": "2020-07-16T20:53:40Z",
"status": "success"
}
}

149
_api-examples/tx/ws-response-ctid.json
View File

@@ -1,8 +1,8 @@
{ {
"id": "CTID example", "result": {
"result": { "tx_json": {
"Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH", "Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"Amount": { "DeliverMax": {
"currency": "USD", "currency": "USD",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "1" "value": "1"
@@ -49,74 +49,79 @@
"SigningPubKey": "02EAE5DAB54DD8E1C49641D848D5B97D1B29149106174322EDF98A1B2CCE5D7F8E", "SigningPubKey": "02EAE5DAB54DD8E1C49641D848D5B97D1B29149106174322EDF98A1B2CCE5D7F8E",
"TransactionType": "Payment", "TransactionType": "Payment",
"TxnSignature": "30440220791B6A3E036ECEFFE99E8D4957564E8C84D1548C8C3E80A87ED1AA646ECCFB16022037C5CAC97E34E3021EBB426479F2ACF3ACA75DB91DCC48D1BCFB4CF547CFEAA0", "TxnSignature": "30440220791B6A3E036ECEFFE99E8D4957564E8C84D1548C8C3E80A87ED1AA646ECCFB16022037C5CAC97E34E3021EBB426479F2ACF3ACA75DB91DCC48D1BCFB4CF547CFEAA0",
"ctid": "C005523E00000000",
"date": 416445410, "date": 416445410,
"hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7", "ledger_index": 348734
"inLedger": 348734,
"ledger_index": 348734,
"meta": {
"AffectedNodes": [
{
"ModifiedNode": {
"FinalFields": {
"Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"Balance": "59328999119",
"Flags": 0,
"OwnerCount": 11,
"Sequence": 89
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "E0D7BDE68B468FF0B8D948FD865576517DA987569833A05374ADB9A72E870A06",
"PreviousFields": {
"Balance": "59328999129",
"Sequence": 88
},
"PreviousTxnID": "C26AA6B4F7C3B9F55E17CD0D11F12032A1C7AD2757229FFD277C9447A8815E6E",
"PreviousTxnLgrSeq": 348700
}
},
{
"ModifiedNode": {
"FinalFields": {
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "-1"
},
"Flags": 131072,
"HighLimit": {
"currency": "USD",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "100"
},
"HighNode": "0",
"LowLimit": {
"currency": "USD",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"value": "0"
},
"LowNode": "0"
},
"LedgerEntryType": "RippleState",
"LedgerIndex": "EA4BF03B4700123CDFFB6EB09DC1D6E28D5CEB7F680FB00FC24BC1C3BB2DB959",
"PreviousFields": {
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
}
},
"PreviousTxnID": "53354D84BAE8FDFC3F4DA879D984D24B929E7FEB9100D2AD9EFCD2E126BCCDC8",
"PreviousTxnLgrSeq": 343570
}
}
],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS",
"delivered_amount": "unavailable"
},
"validated": true
}, },
"status": "success", "ctid": "C005523E00000000",
"type": "response" "hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
} "meta": {
"AffectedNodes": [
{
"ModifiedNode": {
"FinalFields": {
"Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"Balance": "59328999119",
"Flags": 0,
"OwnerCount": 11,
"Sequence": 89
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "E0D7BDE68B468FF0B8D948FD865576517DA987569833A05374ADB9A72E870A06",
"PreviousFields": {
"Balance": "59328999129",
"Sequence": 88
},
"PreviousTxnID": "C26AA6B4F7C3B9F55E17CD0D11F12032A1C7AD2757229FFD277C9447A8815E6E",
"PreviousTxnLgrSeq": 348700
}
},
{
"ModifiedNode": {
"FinalFields": {
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "-1"
},
"Flags": 131072,
"HighLimit": {
"currency": "USD",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "100"
},
"HighNode": "0",
"LowLimit": {
"currency": "USD",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"value": "0"
},
"LowNode": "0"
},
"LedgerEntryType": "RippleState",
"LedgerIndex": "EA4BF03B4700123CDFFB6EB09DC1D6E28D5CEB7F680FB00FC24BC1C3BB2DB959",
"PreviousFields": {
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
}
},
"PreviousTxnID": "53354D84BAE8FDFC3F4DA879D984D24B929E7FEB9100D2AD9EFCD2E126BCCDC8",
"PreviousTxnLgrSeq": 343570
}
}
],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS",
"delivered_amount": "unavailable"
},
"validated": true,
"ledger_index": 348734,
"ledger_hash": "195F62F34EB2CCFA4C5888BA20387E82EB353DDB4508BAE6A835AF19FB8B0C09",
"close_time_iso": "2013-03-12T23:16:50Z"
},
"id": "CTID example",
"api_version": 2,
"status": "success",
"type": "response"
}

232
_api-examples/tx/ws-response-hash.json
View File

@@ -1,120 +1,126 @@
{ {
"id": 1, "result": {
"result": { "tx_json": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM", "Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"Fee": "12", "DeliverMax": {
"Flags": 0, "currency": "USD",
"LastLedgerSequence": 56865248, "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"OfferSequence": 5037708, "value": "1"
"Sequence": 5037710,
"SigningPubKey": "03B51A3EDF70E4098DA7FB053A01C5A6A0A163A30ED1445F14F87C7C3295FCB3BE",
"TakerGets": "15000000000",
"TakerPays": {
"currency": "CNY",
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"value": "20160.75"
}, },
"TransactionType": "OfferCreate", "Destination": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"TxnSignature": "3045022100A5023A0E64923616FCDB6D664F569644C7C9D1895772F986CD6B981B515B02A00220530C973E9A8395BC6FE2484948D2751F6B030FC7FB8575D1BFB406368AD554D9", "Fee": "10",
"ctid": "C363B1DD00000000", "Flags": 0,
"date": 648248020, "Paths": [
"hash": "C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9", [
"inLedger": 56865245,
"ledger_index": 56865245,
"meta": {
"AffectedNodes": [
{ {
"ModifiedNode": { "account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"FinalFields": { "currency": "USD",
"ExchangeRate": "4f04c66806cf7400", "issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"Flags": 0, "type": 49
"RootIndex": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400",
"TakerGetsCurrency": "0000000000000000000000000000000000000000",
"TakerGetsIssuer": "0000000000000000000000000000000000000000",
"TakerPaysCurrency": "000000000000000000000000434E590000000000",
"TakerPaysIssuer": "CED6E99370D5C00EF4EBF72567DA99F5661BFB3A"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400"
}
},
{
"ModifiedNode": {
"FinalFields": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"Balance": "10404767991",
"Flags": 0,
"OwnerCount": 3,
"Sequence": 5037711
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "1DECD9844E95FFBA273F1B94BA0BF2564DDF69F2804497A6D7837B52050174A2",
"PreviousFields": {
"Balance": "10404768003",
"Sequence": 5037710
},
"PreviousTxnID": "4DC47B246B5EB9CCE92ABA8C482479E3BF1F946CABBEF74CA4DE36521D5F9008",
"PreviousTxnLgrSeq": 56865244
}
},
{
"DeletedNode": {
"FinalFields": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"BookDirectory": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400",
"BookNode": "0",
"Flags": 0,
"OwnerNode": "0",
"PreviousTxnID": "8F5FF57B404827F12BDA7561876A13C3E3B3095CBF75334DBFB5F227391A660C",
"PreviousTxnLgrSeq": 56865244,
"Sequence": 5037708,
"TakerGets": "15000000000",
"TakerPays": {
"currency": "CNY",
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"value": "20160.75"
}
},
"LedgerEntryType": "Offer",
"LedgerIndex": "26AAE6CA8D29E28A47C92ADF22D5D96A0216F0551E16936856DDC8CB1AAEE93B"
}
},
{
"ModifiedNode": {
"FinalFields": {
"Flags": 0,
"IndexNext": "0",
"IndexPrevious": "0",
"Owner": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"RootIndex": "47FAF5D102D8CE655574F440CDB97AC67C5A11068BB3759E87C2B9745EE94548"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "47FAF5D102D8CE655574F440CDB97AC67C5A11068BB3759E87C2B9745EE94548"
}
},
{
"CreatedNode": {
"LedgerEntryType": "Offer",
"LedgerIndex": "8BAEE3C7DE04A568E96007420FA11ABD0BC9AE44D35932BB5640E9C3FB46BC9B",
"NewFields": {
"Account": "rhhh49pFH96roGyuC4E5P4CHaNjS1k8gzM",
"BookDirectory": "02BAAC1E67C1CE0E96F0FA2E8061020536CEDD043FEB0FF54F04C66806CF7400",
"Sequence": 5037710,
"TakerGets": "15000000000",
"TakerPays": {
"currency": "CNY",
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"value": "20160.75"
}
}
}
} }
], ],
"TransactionIndex": 0, [
"TransactionResult": "tesSUCCESS" {
"account": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
"currency": "USD",
"issuer": "rD1jovjQeEpvaDwn9wKaYokkXXrqo4D23x",
"type": 49
},
{
"account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
"currency": "USD",
"issuer": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
"type": 49
},
{
"account": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"currency": "USD",
"issuer": "r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV",
"type": 49
}
]
],
"SendMax": {
"currency": "USD",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"value": "1.01"
}, },
"validated": true "Sequence": 88,
"SigningPubKey": "02EAE5DAB54DD8E1C49641D848D5B97D1B29149106174322EDF98A1B2CCE5D7F8E",
"TransactionType": "Payment",
"TxnSignature": "30440220791B6A3E036ECEFFE99E8D4957564E8C84D1548C8C3E80A87ED1AA646ECCFB16022037C5CAC97E34E3021EBB426479F2ACF3ACA75DB91DCC48D1BCFB4CF547CFEAA0",
"date": 416445410,
"ledger_index": 348734
}, },
"status": "success", "ctid": "C005523E00000000",
"type": "response" "hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
} "meta": {
"AffectedNodes": [
{
"ModifiedNode": {
"FinalFields": {
"Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"Balance": "59328999119",
"Flags": 0,
"OwnerCount": 11,
"Sequence": 89
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "E0D7BDE68B468FF0B8D948FD865576517DA987569833A05374ADB9A72E870A06",
"PreviousFields": {
"Balance": "59328999129",
"Sequence": 88
},
"PreviousTxnID": "C26AA6B4F7C3B9F55E17CD0D11F12032A1C7AD2757229FFD277C9447A8815E6E",
"PreviousTxnLgrSeq": 348700
}
},
{
"ModifiedNode": {
"FinalFields": {
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "-1"
},
"Flags": 131072,
"HighLimit": {
"currency": "USD",
"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"value": "100"
},
"HighNode": "0",
"LowLimit": {
"currency": "USD",
"issuer": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
"value": "0"
},
"LowNode": "0"
},
"LedgerEntryType": "RippleState",
"LedgerIndex": "EA4BF03B4700123CDFFB6EB09DC1D6E28D5CEB7F680FB00FC24BC1C3BB2DB959",
"PreviousFields": {
"Balance": {
"currency": "USD",
"issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
"value": "0"
}
},
"PreviousTxnID": "53354D84BAE8FDFC3F4DA879D984D24B929E7FEB9100D2AD9EFCD2E126BCCDC8",
"PreviousTxnLgrSeq": 343570
}
}
],
"TransactionIndex": 0,
"TransactionResult": "tesSUCCESS",
"delivered_amount": "unavailable"
},
"validated": true,
"ledger_index": 348734,
"ledger_hash": "195F62F34EB2CCFA4C5888BA20387E82EB353DDB4508BAE6A835AF19FB8B0C09",
"close_time_iso": "2013-03-12T23:16:50Z"
},
"api_version": 2,
"status": "success",
"type": "response"
}

2
docs/concepts/payment-types/partial-payments.md
View File

@@ -9,6 +9,8 @@ labels:
--- ---
# Partial Payments # Partial Payments
{% admonition type="warning" name="Caution" %}This page describes the specifics of the `Amount` field that appears in `Payment` transactions and various API methods. While the contextual information regarding `Amount` and partial payments is still relevant, the field has been renamed to `DeliverMax` in `rippled` [API v2][]. This was done to make the field name more specific to its behavior and help prevent the misunderstandings and exploit described below.{% /admonition %}
The sender of any [Payment transaction][] can enable the ["Partial Payment" flag](../../references/protocol/transactions/types/payment.md#payment-flags) and send a payment which delivers less than the `Amount` field indicates. When processing any Payment, use the `delivered_amount` metadata field, not the `Amount` field. The `delivered_amount` is the amount a payment actually delivered. The sender of any [Payment transaction][] can enable the ["Partial Payment" flag](../../references/protocol/transactions/types/payment.md#payment-flags) and send a payment which delivers less than the `Amount` field indicates. When processing any Payment, use the `delivered_amount` metadata field, not the `Amount` field. The `delivered_amount` is the amount a payment actually delivered.
If a Payment does not enable the Partial Payment flag, the `Amount` field of a [Payment transaction][] in the XRP Ledger specifies the amount to deliver after charging for exchange rates and [transfer fees](../tokens/transfer-fees.md). The Partial Payment flag ([`tfPartialPayment`](../../references/protocol/transactions/types/payment.md#payment-flags)) allows a payment to succeed by reducing the amount received instead of increasing the amount sent. Partial payments are useful for [returning payments](bouncing-payments.md) without incurring additional costs to oneself. If a Payment does not enable the Partial Payment flag, the `Amount` field of a [Payment transaction][] in the XRP Ledger specifies the amount to deliver after charging for exchange rates and [transfer fees](../tokens/transfer-fees.md). The Partial Payment flag ([`tfPartialPayment`](../../references/protocol/transactions/types/payment.md#payment-flags)) allows a payment to succeed by reducing the amount received instead of increasing the amount sent. Partial payments are useful for [returning payments](bouncing-payments.md) without incurring additional costs to oneself.

15
docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign.md
View File

@@ -25,12 +25,13 @@ An example of the request format:
```json ```json
{ {
"id": 2, "id": 2,
"api_version": 2,
"command": "sign", "command": "sign",
"tx_json" : { "tx_json" : {
"TransactionType" : "Payment", "TransactionType" : "Payment",
"Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"Amount" : { "DeliverMax" : {
"currency" : "USD", "currency" : "USD",
"value" : "1", "value" : "1",
"issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
@@ -50,10 +51,11 @@ An example of the request format:
"params": [ "params": [
{ {
"offline": false, "offline": false,
"api_version": 2,
"secret": "s████████████████████████████", "secret": "s████████████████████████████",
"tx_json": { "tx_json": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Amount": { "DeliverMax": {
"currency": "USD", "currency": "USD",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"value": "1" "value": "1"
@@ -71,7 +73,7 @@ An example of the request format:
{% tab label="Commandline" %} {% tab label="Commandline" %}
```sh ```sh
#Syntax: sign secret tx_json [offline] #Syntax: sign secret tx_json [offline]
rippled sign s████████████████████████████ '{"TransactionType": "Payment", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "Amount": { "currency": "USD", "value": "1", "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" }, "Sequence": 360, "Fee": "10000"}' offline rippled sign s████████████████████████████ '{"TransactionType": "Payment", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "DeliverMax": { "currency": "USD", "value": "1", "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" }, "Sequence": 360, "Fee": "10000"}' offline
``` ```
{% /tab %} {% /tab %}
@@ -119,13 +121,14 @@ An example of a successful response:
```json ```json
{ {
"id": 2, "id": 2,
"api_version": 2,
"status": "success", "status": "success",
"type": "response", "type": "response",
"result": { "result": {
"tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754", "tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
"tx_json": { "tx_json": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Amount": { "DeliverMax": {
"currency": "USD", "currency": "USD",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"value": "1" "value": "1"
@@ -154,7 +157,7 @@ An example of a successful response:
"tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754", "tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
"tx_json": { "tx_json": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Amount": { "DeliverMax": {
"currency": "USD", "currency": "USD",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"value": "1" "value": "1"
@@ -184,7 +187,7 @@ Connecting to 127.0.0.1:5005
"tx_blob" : "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7447304502210094D24C795CFFA8E46FE338AF63421DA5CE5E171ED56F8E4CE70FFABA15D3CFA2022063994C52BF0393C8157EBFFCDE6A7E7EDC7B16A462CA53214F64CC8FCBB5E54A81144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754", "tx_blob" : "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7447304502210094D24C795CFFA8E46FE338AF63421DA5CE5E171ED56F8E4CE70FFABA15D3CFA2022063994C52BF0393C8157EBFFCDE6A7E7EDC7B16A462CA53214F64CC8FCBB5E54A81144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
"tx_json" : { "tx_json" : {
"Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Amount" : { "DeliverMax" : {
"currency" : "USD", "currency" : "USD",
"issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"value" : "1" "value" : "1"

40
docs/references/http-websocket-apis/api-conventions/request-formatting.md
View File

@@ -59,7 +59,7 @@ After you open a WebSocket to the `rippled` server, you can send commands as a [
|:--------------------|:----------|:-------------------------------------------| |:--------------------|:----------|:-------------------------------------------|
| `command` | String | The name of the [API method](../public-api-methods/index.md). | | `command` | String | The name of the [API method](../public-api-methods/index.md). |
| `id` | (Various) | _(Optional)_ A unique value to identify this request. The response to this request uses the same `id` field. This way, even if responses arrive out of order, you know which request prompted which response. | | `id` | (Various) | _(Optional)_ A unique value to identify this request. The response to this request uses the same `id` field. This way, even if responses arrive out of order, you know which request prompted which response. |
| `api_version` | Number | _(Optional)_ The API version to use. If omitted, use version 1. For details, see [API Versioning](#api-versioning). | | `api_version` | Number | _(Optional)_ The API version to use. If omitted, uses version 1. For details, see [API Versioning](#api-versioning). |
| (Method Parameters) | (Various) | Provide any parameters to the method at the top level. | | (Method Parameters) | (Various) | Provide any parameters to the method at the top level. |
See [Response Formatting](response-formatting.md) for the response from the server. See [Response Formatting](response-formatting.md) for the response from the server.
@@ -99,42 +99,4 @@ The commandline always uses the latest [API version](#api-versioning).
{% admonition type="warning" name="Caution" %}The commandline interface is intended for administrative purposes only and is _not a supported API_. New versions of `rippled` may introduce breaking changes to the commandline API without warning!{% /admonition %} {% admonition type="warning" name="Caution" %}The commandline interface is intended for administrative purposes only and is _not a supported API_. New versions of `rippled` may introduce breaking changes to the commandline API without warning!{% /admonition %}
## API Versioning
The `rippled` server uses a single integer to identify the API version to use. Currently, there are two API versions: `1` and `2` {% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}New in: rippled 2.0.0{% /badge %}. The server reports the range of supported API versions in the `version` API method. <!-- STYLE_OVERRIDE: will --> <!-- TODO: add a link when `version` method is documented. -->
Separate API requests can use different API versions even on the same persistent connection. For example, if you connect WebSocket to a server that supports API versions 1 and 2, you can make an `account_tx` request using API version 2 and then make another `account_tx` request using API version 1 from the same connection.
Future versions of `rippled` that introduce breaking changes will introduce a new API version 3.
### Breaking Changes
The following types of changes are **breaking changes**:
- Removing or renaming a field of a request or response.
- Changing the type of a field of a request or response.
- Changing the meaning of a field of a request or a response.
- Changing the order of positional parameters, or adding a new field before other positional parameters.
- Removing or renaming an API method.
- Changing the behavior of an API function visible to existing clients.
- The following types of breaking changes only apply to the gRPC API:
- Changing a `proto` field number.
- Removing or renaming an enum or enum value.
- Adding or removing fields from a `oneof`.
- Splitting or merging a `oneof`.
- Changing whether a message field is `optional`, `repeated`, or `required`.
- Changing the stream value of a request or response.
- Deleting or renaming a package or service.
Any time a full release introduces a breaking change, it introduces a new API version number. Pre-release, beta, and development versions may introduce breaking changes to the same API version number.
### Non-Breaking Changes
The following types of changes are **non-breaking changes** and may occur without a change of API version number:
- Adding a new field to a request or response, not including positional parameters.
- Adding a new API method.
{% raw-partial file="/docs/_snippets/common-links.md" /%} {% raw-partial file="/docs/_snippets/common-links.md" /%}

38
docs/references/http-websocket-apis/index.md
View File

@@ -6,7 +6,43 @@ metadata:
--- ---
# HTTP / WebSocket APIs # HTTP / WebSocket APIs
Communicate directly with rippled, the core peer-to-peer server that manages the XRP Ledger. You can communicate directly with the XRP Ledger by `rippled` servers through the publicly available APIs.
Currently, there are two API versions: `1` and `2` {% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}New in: rippled 2.0.0{% /badge %}. The server reports the range of supported API versions in the `version` API method. <!-- STYLE_OVERRIDE: will --> <!-- TODO: add a link when `version` method is documented. -->
Separate API requests can use different API versions even on the same persistent connection. For example, if you connect WebSocket to a server that supports API versions 1 and 2, you can make an `account_tx` request using API version 2 and then make another `account_tx` request using API version 1 from the same connection.
Future versions of `rippled` that introduce breaking changes will introduce a new API version 3.
### Breaking Changes
The following types of changes are **breaking changes**:
- Removing or renaming a field of a request or response.
- Changing the type of a field of a request or response.
- Changing the meaning of a field of a request or a response.
- Changing the order of positional parameters, or adding a new field before other positional parameters.
- Removing or renaming an API method.
- Changing the behavior of an API function visible to existing clients.
- The following types of breaking changes only apply to the gRPC API:
- Changing a `proto` field number.
- Removing or renaming an enum or enum value.
- Adding or removing fields from a `oneof`.
- Splitting or merging a `oneof`.
- Changing whether a message field is `optional`, `repeated`, or `required`.
- Changing the stream value of a request or response.
- Deleting or renaming a package or service.
Any time a full release introduces a breaking change, it introduces a new API version number. Pre-release, beta, and development versions may introduce breaking changes to the same API version number.
### Non-Breaking Changes
The following types of changes are **non-breaking changes** and may occur without a change of API version number:
- Adding a new field to a request or response, not including positional parameters.
- Adding a new API method.
{% raw-partial file="/docs/_snippets/common-links.md" /%}
{% child-pages /%} {% child-pages /%}

4
docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md
View File

@@ -64,7 +64,7 @@ The request contains the following parameters:
| `ledger_hash` | String | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | | `ledger_hash` | String | No | A 20-byte hex string for 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][]) | | `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][]) |
| `queue` | Boolean | No | If `true`, return stats about [queued transactions](../../../../concepts/transactions/transaction-queue.md) sent by this account. Can only be used when querying for the data from the current open ledger. Not available from servers in [Reporting Mode][]. | | `queue` | Boolean | No | If `true`, return stats about [queued transactions](../../../../concepts/transactions/transaction-queue.md) sent by this account. Can only be used when querying for the data from the current open ledger. Not available from servers in [Reporting Mode][]. |
| `signer_lists` | Boolean | No | [API v1][]: If `true`, return any [SignerList objects](../../../protocol/ledger-data/ledger-entry-types/signerlist.md) associated with this account.<br>[API v2][]: Identical to v1, but also returns an `invalidParams` error if you provide a non-boolean value. | | `signer_lists` | Boolean | No | If `true`, return any [SignerList objects](../../../protocol/ledger-data/ledger-entry-types/signerlist.md) associated with this account. |
The following fields are deprecated and should not be provided: `ident`, `ledger`, `strict`. The following fields are deprecated and should not be provided: `ident`, `ledger`, `strict`.
@@ -253,7 +253,7 @@ Each object in the `transactions` array of `queue_data`, if present, may contain
## Possible Errors ## Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. For example, the request specified `queue` as `true` but specified a `ledger_index` that is not the current open ledger. * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. For example, the request specified `queue` as `true` but specified a `ledger_index` that is not the current open ledger. In [API v1][], you won't receive this error when specifying a non-boolean value for `signer_lists`.
* `actNotFound` - The address specified in the `account` field of the request does not correspond to an account in the ledger. * `actNotFound` - The address specified in the `account` field of the request does not correspond to an account in the ledger.
* `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it. * `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it.

490
docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md
View File

@@ -28,7 +28,8 @@ An example of the request format:
"ledger_index_max": -1, "ledger_index_max": -1,
"binary": false, "binary": false,
"limit": 2, "limit": 2,
"forward": false "forward": false,
"api_version": 2
} }
``` ```
{% /tab %} {% /tab %}
@@ -44,7 +45,8 @@ An example of the request format:
"forward": false, "forward": false,
"ledger_index_max": -1, "ledger_index_max": -1,
"ledger_index_min": -1, "ledger_index_min": -1,
"limit": 2 "limit": 2,
"api_version": 2
} }
] ]
} }
@@ -69,12 +71,12 @@ The request includes the following parameters:
|:-------------------|:-------------------------------------------|:-----------| |:-------------------|:-------------------------------------------|:-----------|
| `account` | String | A unique identifier for the account, most commonly the account's address. | | `account` | String | A unique identifier for the account, most commonly the account's address. |
| `tx_type` | String | _(Optional)_ **Clio Only** Return only transactions of a specific type, such as "Clawback", "AccountSet", "AccountDelete", et al. Case-insensitive. See [Transaction Types](../../../../references//protocol/transactions/types/index.md#transaction-types). [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0.0 "BADGE_BLUE") [AMM support since: Clio v2.1.0](https://github.com/XRPLF/clio/releases/tag/2.1.0 "BADGE_GREEN") | | `tx_type` | String | _(Optional)_ **Clio Only** Return only transactions of a specific type, such as "Clawback", "AccountSet", "AccountDelete", et al. Case-insensitive. See [Transaction Types](../../../../references//protocol/transactions/types/index.md#transaction-types). [New in: Clio v2.0](https://github.com/XRPLF/clio/releases/tag/2.0.0 "BADGE_BLUE") [AMM support since: Clio v2.1.0](https://github.com/XRPLF/clio/releases/tag/2.1.0 "BADGE_GREEN") |
| `ledger_index_min` | Integer | [API v1][]: _(Optional)_ Use to specify the earliest ledger to include transactions from. A value of `-1` instructs the server to use the earliest validated ledger version available.<br>[API v2][]: Identical to v1, but also returns a `lgrIdxMalformed` error if a value is specified beyond the range of ledgers the server has. | | `ledger_index_min` | Integer | _(Optional)_ Use to specify the earliest ledger to include transactions from. A value of `-1` instructs the server to use the earliest validated ledger version available. |
| `ledger_index_max` | Integer | [API v1][]: _(Optional)_ Use to specify the most recent ledger to include transactions from. A value of `-1` instructs the server to use the most recent validated ledger version available.<br>[API v2][]: Identical to v1, but also returns a `lgrIdxMalformed` error if a value is specified beyond the range of ledgers the server has. | | `ledger_index_max` | Integer | _(Optional)_ Use to specify the most recent ledger to include transactions from. A value of `-1` instructs the server to use the most recent validated ledger version available. |
| `ledger_hash` | String | _(Optional)_ Use to look for transactions from a single ledger only. (See [Specifying Ledgers][].) | | `ledger_hash` | String | _(Optional)_ Use to look for transactions from a single ledger only. (See [Specifying Ledgers][].) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ Use to look for transactions from a single ledger only. (See [Specifying Ledgers][].) | | `ledger_index` | String or Unsigned Integer | _(Optional)_ Use to look for transactions from a single ledger only. (See [Specifying Ledgers][].) |
| `binary` | Boolean | [API v1][]: _(Optional)_ Defaults to `false`. If set to `true`, returns transactions as hex strings instead of JSON.<br>[API v2][]: Identical to v1, but also returns an `invalidParams` error if you provide a non-boolean value. | | `binary` | Boolean | _(Optional)_ Defaults to `false`. If set to `true`, returns transactions as hex strings instead of JSON. |
| `forward` | Boolean | [API v1][]: _(Optional)_ Defaults to `false`. If set to `true`, returns values indexed with the oldest ledger first. Otherwise, the results are indexed with the newest ledger first. (Each page of results may not be internally ordered, but the pages are overall ordered.)<br>[API v2][]: Identical to v1, but also returns an `invalidParams` error if you provide a non-boolean value. | | `forward` | Boolean | _(Optional)_ Defaults to `false`. If set to `true`, returns values indexed with the oldest ledger first. Otherwise, the results are indexed with the newest ledger first. (Each page of results may not be internally ordered, but the pages are overall ordered.) |
| `limit` | Integer | _(Optional)_ Default varies. Limit the number of transactions to retrieve. The server is not required to honor this value. | | `limit` | Integer | _(Optional)_ Default varies. Limit the number of transactions to retrieve. The server is not required to honor this value. |
| `marker` | [Marker][] | Value from a previous paginated response. Resume retrieving data where that response left off. This value is stable even if there is a change in the server's range of available ledgers. | | `marker` | [Marker][] | Value from a previous paginated response. Resume retrieving data where that response left off. This value is stable even if there is a change in the server's range of available ledgers. |
@@ -97,16 +99,10 @@ An example of a successful response:
{% tab label="WebSocket" %} {% tab label="WebSocket" %}
```json ```json
{ {
"id": 2,
"result": { "result": {
"account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w", "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"ledger_index_max": 57111999, "ledger_index_min": 32570,
"ledger_index_min": 55886305, "ledger_index_max": 91824401,
"limit": 2,
"marker": {
"ledger": 57111981,
"seq": 16
},
"transactions": [ "transactions": [
{ {
"meta": { "meta": {
@@ -114,62 +110,69 @@ An example of a successful response:
{ {
"ModifiedNode": { "ModifiedNode": {
"FinalFields": { "FinalFields": {
"Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Balance": "3732969177079", "AccountTxnID": "932CC7E9BAC1F7B9FA5381679F293EEC0A646E5E7F2F6D14C85FEE2102F0E66C",
"Flags": 131072, "Balance": "1086222646",
"OwnerCount": 0, "Domain": "6D64756F31332E636F6D",
"Sequence": 702817 "EmailHash": "98B4375E1D753E5B91627516F6D70977",
"Flags": 9568256,
"MessageKey": "0000000000000000000000070000000300",
"OwnerCount": 17,
"RegularKey": "rD9iJmieYHn8jTtPjwwkW2Wm9sVDvPXLoJ",
"Sequence": 393,
"TicketCount": 5,
"TransferRate": 4294967295
}, },
"LedgerEntryType": "AccountRoot", "LedgerEntryType": "AccountRoot",
"LedgerIndex": "140FA03FE8C39540CA8189BC7A7956795C712BC0A542C6409C041150703C8574", "LedgerIndex": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8",
"PreviousFields": { "PreviousFields": {
"Balance": "3713891690008" "Balance": "1086222601"
}, },
"PreviousTxnID": "D58864C16344ADCC15995C7986CFC607CB693E88F84D2E019F0A35FB29749202", "PreviousTxnID": "7E50969CDEF8E12B1AD26E64B338935813624A4D1CDDC4C9457832524F0FF74C",
"PreviousTxnLgrSeq": 57111994 "PreviousTxnLgrSeq": 89353048
} }
}, },
{ {
"ModifiedNode": { "ModifiedNode": {
"FinalFields": { "FinalFields": {
"Account": "rw2ciyaNshpHe7bCHo4bRWq6pqqynnWKQg", "Account": "rPJARH5nLWQisdmvDAbvzwS7N32Z1kusTZ",
"Balance": "40010160", "Balance": "55022190",
"Flags": 131072, "Flags": 0,
"OwnerCount": 0, "OwnerCount": 0,
"Sequence": 466334 "Sequence": 89113341
}, },
"LedgerEntryType": "AccountRoot", "LedgerEntryType": "AccountRoot",
"LedgerIndex": "CC20FEBEA6D2AF969EC46F2BD92684D9FBABC3F238E841B5E056FE4EBF4379A9", "LedgerIndex": "C0363F86E070B70E7DA129736C3B05E509261C8668F61A7E958C4C10F17EAB90",
"PreviousFields": { "PreviousFields": {
"Balance": "19117497271", "Balance": "55022245",
"Sequence": 466333 "Sequence": 89113340
}, },
"PreviousTxnID": "F6B8274D3D419A95A59681E5F55578084C395FF9051924360CA3EA745F5581E8", "PreviousTxnID": "60D0FE881F9B1457FB1711011C6E490C22532B1D495557D6488BE3A634167CEE",
"PreviousTxnLgrSeq": 57111993 "PreviousTxnLgrSeq": 90136515
} }
} }
], ],
"TransactionIndex": 25, "TransactionIndex": 2,
"TransactionResult": "tesSUCCESS", "TransactionResult": "tesSUCCESS",
"delivered_amount": "19077487071" "delivered_amount": "45"
}, },
"tx": { "tx_json": {
"Account": "rw2ciyaNshpHe7bCHo4bRWq6pqqynnWKQg", "Account": "rPJARH5nLWQisdmvDAbvzwS7N32Z1kusTZ",
"Amount": "19077487071", "DeliverMax": "45",
"Destination": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w", "Destination": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"DestinationTag": 1, "DestinationTag": 316562,
"Fee": "40", "Fee": "10",
"Flags": 2147483648, "Sequence": 89113340,
"LastLedgerSequence": 57112020, "SigningPubKey": "EDE21591E615E1D77C8C8A7F95372D001B3DF090AB47B99729CFCBC1E4E07D35F4",
"Sequence": 466333,
"SigningPubKey": "0381575032E254BF4D699C3D8D6EFDB63B3A71F97475C6F6885BC7DAEEE55D9A01",
"TransactionType": "Payment", "TransactionType": "Payment",
"TxnSignature": "3045022100CFC5FD057C7C685C690637AD1E639E2642BBC00EFD8E06E3F6C72FA924BC99D40220317D0708E814F69F874D641B6732E37A53B1220B493B2B8390D9EF51E8062515", "TxnSignature": "D229FEB6ED82367102AC12DE5045BE6D548CBB52E0CB8F037A23171910A6158FA3377F5118B6CEAFDB07D6D43F76FE29CC26BE1ACBC7A86C9D86E14043C66104",
"date": 649200260, "ledger_index": 90136515,
"hash": "46BF0B576677B0DEA2D94591424A57A2DE8E3D89383631E16F40D09A513C656C", "date": 777284672
"inLedger": 57111998,
"ledger_index": 57111998
}, },
"ledger_index": 90136515,
"hash": "894541402AC968C98C329A88D097170B14BF4DEB8B2A7DF377EE89DDD332E018",
"ledger_hash": "14110F60753176E1F6A71AA084B6AD8663CBB46193CCFCDFAC02561626AA6B75",
"close_time_iso": "2024-08-18T08:24:32Z",
"validated": true "validated": true
}, },
{ {
@@ -178,66 +181,80 @@ An example of a successful response:
{ {
"ModifiedNode": { "ModifiedNode": {
"FinalFields": { "FinalFields": {
"Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Balance": "3713891690008", "AccountTxnID": "932CC7E9BAC1F7B9FA5381679F293EEC0A646E5E7F2F6D14C85FEE2102F0E66C",
"Flags": 131072, "Balance": "1086222601",
"OwnerCount": 0, "Domain": "6D64756F31332E636F6D",
"Sequence": 702817 "EmailHash": "98B4375E1D753E5B91627516F6D70977",
"Flags": 9568256,
"MessageKey": "0000000000000000000000070000000300",
"OwnerCount": 17,
"RegularKey": "rD9iJmieYHn8jTtPjwwkW2Wm9sVDvPXLoJ",
"Sequence": 393,
"TicketCount": 5,
"TransferRate": 4294967295
}, },
"LedgerEntryType": "AccountRoot", "LedgerEntryType": "AccountRoot",
"LedgerIndex": "140FA03FE8C39540CA8189BC7A7956795C712BC0A542C6409C041150703C8574", "LedgerIndex": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8",
"PreviousFields": { "PreviousFields": {
"Balance": "3714441690048", "Balance": "1086222552"
"Sequence": 702816
}, },
"PreviousTxnID": "FDD5007913B39027BAF10B31144DBC1F7DC147528DF31FF048A06DC5D3108BD6", "PreviousTxnID": "EED9EB1880B951FAB3EE0DBBEB67B7ABEE3FA77F15782B6BD40342B3C23CFB75",
"PreviousTxnLgrSeq": 57111981 "PreviousTxnLgrSeq": 89343389
} }
}, },
{ {
"ModifiedNode": { "ModifiedNode": {
"FinalFields": { "FinalFields": {
"Account": "r9dU6Z7P2i7MrDi1VUZ7uyq6J77eg86YtB", "Account": "rPSDqHdMPsnkmyUX4BvBkY8rycQYwrhUqw",
"Balance": "2629998983", "Balance": "52611432",
"Flags": 0, "Flags": 0,
"OwnerCount": 0, "OwnerCount": 0,
"Sequence": 10 "Sequence": 89196186
}, },
"LedgerEntryType": "AccountRoot", "LedgerEntryType": "AccountRoot",
"LedgerIndex": "27B96FE681B33825CC95DA197358B30D3A1721F2125F2D76022D46B2418ABA0A", "LedgerIndex": "20761D2C37004C70318F7A3C5A1C35817A90A0AE56485F6E3281FB2B3F05B0C9",
"PreviousFields": { "PreviousFields": {
"Balance": "2079998983" "Balance": "52611491",
"Sequence": 89196185
}, },
"PreviousTxnID": "44A47AC04C0C7237C32BE9A532B578D07641705D3A59DB9B3C5B6225001E39B7", "PreviousTxnID": "BAF86C2776C08407E0FAF42D374874E10430CB8C23AD464D9D9097EA326ABE92",
"PreviousTxnLgrSeq": 56613857 "PreviousTxnLgrSeq": 89353024
} }
} }
], ],
"TransactionIndex": 16, "TransactionIndex": 4,
"TransactionResult": "tesSUCCESS", "TransactionResult": "tesSUCCESS",
"delivered_amount": "550000000" "delivered_amount": "49"
}, },
"tx": { "tx_json": {
"Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w", "Account": "rPSDqHdMPsnkmyUX4BvBkY8rycQYwrhUqw",
"Amount": "550000000", "DeliverMax": "49",
"Destination": "r9dU6Z7P2i7MrDi1VUZ7uyq6J77eg86YtB", "Destination": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Fee": "40", "DestinationTag": 342662134,
"Flags": 2147483648, "Fee": "10",
"LastLedgerSequence": 57112016, "Sequence": 89196185,
"Sequence": 702816, "SigningPubKey": "ED7E4A2970ADFCCE93D59D469322745E98CBEB3D7D5388728B3BB2268E71F30B0F",
"SigningPubKey": "020A46D8D02AC780C59853ACA309EAA92E7D8E02DD72A0B6AC315A7D18A6C3276A",
"TransactionType": "Payment", "TransactionType": "Payment",
"TxnSignature": "3045022100D589029EF63F9E528F6100C7A36D26AFFF84085EC9AC16DA8E30E11F390D4E87022011466E0FE4A90B89142EE47E535545EEA4A2D65E0BD234DFB447721218B59C9B", "TxnSignature": "8CE14FD18BD186694DED8C204C3FCC2A527CC24AD51C2E0B2B792D035C85D662BC1A1450A8DF04BBEC66821B362056311127C627056AC7779B385517FD3A9202",
"date": 649200241, "ledger_index": 89353048,
"hash": "D58864C16344ADCC15995C7986CFC607CB693E88F84D2E019F0A35FB29749202", "date": 774249571
"inLedger": 57111994,
"ledger_index": 57111994
}, },
"ledger_index": 89353048,
"hash": "7E50969CDEF8E12B1AD26E64B338935813624A4D1CDDC4C9457832524F0FF74C",
"ledger_hash": "ED54DA98F3E495C36C2B0D9A511565E04454A1F4503B9DEE3FD39301D7625865",
"close_time_iso": "2024-07-14T05:19:31Z",
"validated": true "validated": true
} }
], ],
"validated": true "validated": true,
"marker": {
"ledger": 89353048,
"seq": 4
},
"limit": 2
}, },
"api_version": 2,
"status": "success", "status": "success",
"type": "response" "type": "response"
} }
@@ -246,149 +263,130 @@ An example of a successful response:
{% tab label="JSON-RPC" %} {% tab label="JSON-RPC" %}
```json ```json
200 OK
{ {
"result": { "result": {
"account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w", "account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
"ledger_index_max": 57112019, "ledger_index_min": 32570,
"ledger_index_min": 56248229, "ledger_index_max": 91824423,
"limit": 2, "transactions": [{
"marker": { "meta": {
"ledger": 57112007, "AffectedNodes": [{
"seq": 13 "ModifiedNode": {
}, "FinalFields": {
"status": "success", "Account": "rLJmawLfNAFNyyYHFbNErTfCrfsbmRzrTc",
"transactions": [ "Balance": "77694521",
{ "Domain": "7872702D6C65646765722D746F6D6C2E68746D6C",
"meta": { "EmailHash": "CE29D0E8928E95C3FF5BDD8CFE82F445",
"AffectedNodes": [ "Flags": 8388608,
{ "MessageKey": "02000000000000000000000000A9E7611C8B9AFE2DEDA42039DBF09F3BFA185F76",
"ModifiedNode": { "OwnerCount": 26,
"FinalFields": { "RegularKey": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
"Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w", "Sequence": 62418073
"Balance": "3732290013101",
"Flags": 131072,
"OwnerCount": 0,
"Sequence": 702820
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "140FA03FE8C39540CA8189BC7A7956795C712BC0A542C6409C041150703C8574",
"PreviousFields": {
"Balance": "3732745656171",
"Sequence": 702819
},
"PreviousTxnID": "7C031FD5B710E3C048EEF31254089BEEC505900BCC9A842257A0319453333998",
"PreviousTxnLgrSeq": 57112010
}
}, },
{ "LedgerEntryType": "AccountRoot",
"ModifiedNode": { "LedgerIndex": "548E97B1F63273FC2F339CBEB8C202FBF9231C4C61BC1BA51A6239501A2F6FB9",
"FinalFields": { "PreviousFields": {
"Account": "raLPjTYeGezfdb6crXZzcC8RkLBEwbBHJ5", "Balance": "77694533",
"Balance": "4231510602153", "Sequence": 62418072
"Flags": 0, },
"OwnerCount": 0, "PreviousTxnID": "5FDB0B2ECE005EEA87DC35B33204424D0766AB37B764F1618A6C69C06BDDD511",
"Sequence": 96486 "PreviousTxnLgrSeq": 87319056
}, }
"LedgerEntryType": "AccountRoot", }],
"LedgerIndex": "39DC5D448DECEFC3CD20818788E3DA891CA943935E8D7B12FCB5B5871FCB1638", "TransactionIndex": 24,
"PreviousFields": { "TransactionResult": "tesSUCCESS"
"Balance": "4231054959123"
},
"PreviousTxnID": "33D2014C832610293730028CA37857AC183BFCE3E42B9979C491FB8B82B3E9DC",
"PreviousTxnLgrSeq": 57112004
}
}
],
"TransactionIndex": 12,
"TransactionResult": "tesSUCCESS",
"delivered_amount": "455643030"
},
"tx": {
"Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
"Amount": "455643030",
"Destination": "raLPjTYeGezfdb6crXZzcC8RkLBEwbBHJ5",
"DestinationTag": 18240312,
"Fee": "40",
"Flags": 2147483648,
"LastLedgerSequence": 57112037,
"Sequence": 702819,
"SigningPubKey": "020A46D8D02AC780C59853ACA309EAA92E7D8E02DD72A0B6AC315A7D18A6C3276A",
"TransactionType": "Payment",
"TxnSignature": "30450221008602B2E390C0C7B65182C6DBC86292052C1961B2BEFB79C2C8431722C0ADB911022024B74DCF910A4C8C95572CF662EB7F5FF67E1AC4D7B9B7BFE2A8EE851EC16576",
"date": 649200322,
"hash": "08EF5BDA2825D7A28099219621CDBECCDECB828FEA202DEB6C7ACD5222D36C2C",
"inLedger": 57112015,
"ledger_index": 57112015
},
"validated": true
}, },
{ "tx_json": {
"meta": { "Account": "rLJmawLfNAFNyyYHFbNErTfCrfsbmRzrTc",
"AffectedNodes": [ "Fee": "12",
{ "Flags": 131072,
"ModifiedNode": { "LastLedgerSequence": 88061884,
"FinalFields": { "LimitAmount": {
"Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w", "currency": "QNT",
"Balance": "3732745656171", "issuer": "rGPsXnzAkdv1FYKkhC59GRp3M42axDhE1d",
"Flags": 131072, "value": "500000000"
"OwnerCount": 0, },
"Sequence": 702819 "Sequence": 62418072,
}, "SigningPubKey": "023833AB55CD985EB4F7744DC2B02D34886A71ECC0177EE59749A0113ABEE8D64A",
"LedgerEntryType": "AccountRoot", "TransactionType": "TrustSet",
"LedgerIndex": "140FA03FE8C39540CA8189BC7A7956795C712BC0A542C6409C041150703C8574", "TxnSignature": "304402201B00F6D2D9C3B290B8EB3CBAB15612C16C7C06E1D5D8A8B55528D4E1762EB7110220565D2A7369884D84F324FB3CA521BA4EDAFF8F2DDDE48AF8992CF99DF0EEB3F0",
"PreviousFields": { "ledger_index": 88061876,
"Balance": "3732246155784" "date": 769309032
}, },
"PreviousTxnID": "CCBCCB528F602007C937C496F0828C118E073DF180084CCD3646EC1E414844E4", "ledger_index": 88061876,
"PreviousTxnLgrSeq": 57112007 "hash": "735E296F0F271382FF8FBBBD0058AC7330419B8A1C955388A7384E5E3D5B2FCB",
} "ledger_hash": "95B2DA521829572779128884B145DF921B4239CC74057C08EB570DD31641A8F5",
"close_time_iso": "2024-05-18T00:57:12Z",
"validated": true
}, {
"meta": {
"AffectedNodes": [{
"ModifiedNode": {
"FinalFields": {
"Account": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
"Balance": "8579705270",
"Flags": 131072,
"OwnerCount": 0,
"Sequence": 1152385
}, },
{ "LedgerEntryType": "AccountRoot",
"ModifiedNode": { "LedgerIndex": "140FA03FE8C39540CA8189BC7A7956795C712BC0A542C6409C041150703C8574",
"FinalFields": { "PreviousFields": {
"Account": "rw2ciyaNshpHe7bCHo4bRWq6pqqynnWKQg", "Balance": "8554705270"
"Balance": "236476361", },
"Flags": 131072, "PreviousTxnID": "DB31B6D0A304777F125CAD069E2D2C60829475BC30A5DB63376C425C10B85752",
"OwnerCount": 0, "PreviousTxnLgrSeq": 86879421
"Sequence": 466335 }
}, }, {
"LedgerEntryType": "AccountRoot", "ModifiedNode": {
"LedgerIndex": "CC20FEBEA6D2AF969EC46F2BD92684D9FBABC3F238E841B5E056FE4EBF4379A9", "FinalFields": {
"PreviousFields": { "Account": "rpKoCafrEz7FxQZ9FfktocuBGNZZyrz4KH",
"Balance": "735976788", "Balance": "802086263",
"Sequence": 466334 "Flags": 0,
}, "OwnerCount": 0,
"PreviousTxnID": "C528B32DD588EFAE2FE833E8AA92E6AE2DF2C8DB3DB8C6C4F334AD37B253D72A", "Sequence": 60818358
"PreviousTxnLgrSeq": 57112010 },
} "LedgerEntryType": "AccountRoot",
} "LedgerIndex": "481C0CDDC838688B61B960A1EE721F657BD8E501F64141A51E9A905A1D87A2C9",
], "PreviousFields": {
"TransactionIndex": 33, "Balance": "827086275",
"TransactionResult": "tesSUCCESS", "Sequence": 60818357
"delivered_amount": "499500387" },
}, "PreviousTxnID": "7C1671C63D75EBDDD87672D1DE9D5A9EAEAF34C37BDB29D1359301B85ECEF776",
"tx": { "PreviousTxnLgrSeq": 60818357
"Account": "rw2ciyaNshpHe7bCHo4bRWq6pqqynnWKQg", }
"Amount": "499500387", }],
"Destination": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w", "TransactionIndex": 39,
"DestinationTag": 1, "TransactionResult": "tesSUCCESS",
"Fee": "40", "delivered_amount": "25000000"
"Flags": 2147483648, },
"LastLedgerSequence": 57112032, "tx_json": {
"Sequence": 466334, "Account": "rpKoCafrEz7FxQZ9FfktocuBGNZZyrz4KH",
"SigningPubKey": "0381575032E254BF4D699C3D8D6EFDB63B3A71F97475C6F6885BC7DAEEE55D9A01", "DeliverMax": "25000000",
"TransactionType": "Payment", "Destination": "rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w",
"TxnSignature": "3045022100C7EA1701FE48C75508EEBADBC9864CD3FFEDCEB48AB99AEA960BFA360AE163ED0220453C9577502924C9E1A9A450D4B950A44016813BC70E1F16A65A402528D730B7", "DestinationTag": 997786069,
"date": 649200302, "Fee": "12",
"hash": "7C031FD5B710E3C048EEF31254089BEEC505900BCC9A842257A0319453333998", "LastLedgerSequence": 87598991,
"inLedger": 57112010, "Sequence": 60818357,
"ledger_index": 57112010 "SigningPubKey": "0229DA128237D9A63FBA95666C5B8794F455875D843EDF39F6C02DF07FD5B4720D",
}, "TransactionType": "Payment",
"validated": true "TxnSignature": "304402203B0048779085087566AABB4B878EF30EB41D3B29581937111F2708780EE4168702203E2D3B1B73F3F8B86EE009F818B226467E3BFC444B831AE851E0E0B0FB7F49C8",
} "ledger_index": 87598983,
], "date": 767543720
"validated": true },
"ledger_index": 87598983,
"hash": "16DFB8551F5301E3B7D1BCEAA8DB92E9AF5D783E6DCA7C0E11FD143D988E904A",
"ledger_hash": "2B363FD30EA376E2662777CEBDDDE22C035A87DA3CD3EA0E6125CBBC9D8A7873",
"close_time_iso": "2024-04-27T14:35:20Z",
"validated": true
}],
"validated": true,
"marker": {
"ledger": 87598983,
"seq": 39
},
"limit": 2,
"status": "success"
} }
} }
``` ```
@@ -431,6 +429,10 @@ An example of a successful response:
The response follows the [standard format][], with a successful result containing the following fields: The response follows the [standard format][], with a successful result containing the following fields:
{% tabs %}
{% tab label="API v2" %}
| `Field` | Type | Description | | `Field` | Type | Description |
|:-------------------|:---------------------------|:---------------------------| |:-------------------|:---------------------------|:---------------------------|
| `account` | String | Unique [Address][] identifying the related account | | `account` | String | Unique [Address][] identifying the related account |
@@ -438,6 +440,37 @@ The response follows the [standard format][], with a successful result containin
| `ledger_index_max` | Integer - [Ledger Index][] | The ledger index of the most recent ledger actually searched for transactions. | | `ledger_index_max` | Integer - [Ledger Index][] | The ledger index of the most recent ledger actually searched for transactions. |
| `limit` | Integer | The `limit` value used in the request. (This may differ from the actual limit value enforced by the server.) | | `limit` | Integer | The `limit` value used in the request. (This may differ from the actual limit value enforced by the server.) |
| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. | | `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. |
| `meta` | Object (JSON) | (JSON mode) The transaction results metadata in JSON. |
| `meta_blob` | String (Binary) | (Binary mode) The transaction results metadata as a hex string. |
| `transactions` | Array | Array of transactions matching the request's criteria, as explained below. |
| `validated` | Boolean | If included and set to `true`, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. |
{% admonition type="info" name="Note" %}The server may respond with different values of `ledger_index_min` and `ledger_index_max` than you provided in the request, for example if it did not have the versions you specified on hand.{% /admonition %}
Each transaction object includes the following fields, depending on whether it was requested in JSON or hex string (`"binary":true`) format.
| `Field` | Type | Description |
|:-----------------|:----------------|:-------------------------|
| `close_time_iso` | String | The ledger close time represented in ISO 8601 time format. |
| `hash` | String | The unique hash identifier of the transaction. |
| `ledger_hash` | String | A hex string of the ledger version that included this transaction. |
| `ledger_index` | Integer | The [ledger index][] of the ledger version that included this transaction. |
| `tx_json` | Object (JSON) | (JSON mode) JSON object defining the transaction. |
| `tx_blob` | String (Binary) | (Binary mode) A unique hex string defining the transaction. |
| `validated` | Boolean | Whether or not the transaction is included in a validated ledger. Any transaction not yet in a validated ledger is subject to change. |
{% /tab %}
{% tab label="API v1" %}
| `Field` | Type | Description |
|:-------------------|:---------------------------|:---------------------------|
| `account` | String | Unique [Address][] identifying the related account |
| `ledger_index_min` | Integer - [Ledger Index][] | The ledger index of the earliest ledger actually searched for transactions. |
| `ledger_index_max` | Integer - [Ledger Index][] | The ledger index of the most recent ledger actually searched for transactions. |
| `limit` | Integer | The `limit` value used in the request. (This may differ from the actual limit value enforced by the server.) |
| `marker` | [Marker][] | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. |
| `meta` | Object (JSON) or String (Binary) | If `binary` is `true`, then this is a hex string of the transaction results metadata. Otherwise, the transaction results metadata is included in JSON format. |
| `transactions` | Array | Array of transactions matching the request's criteria, as explained below. | | `transactions` | Array | Array of transactions matching the request's criteria, as explained below. |
| `validated` | Boolean | If included and set to `true`, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. | | `validated` | Boolean | If included and set to `true`, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change. |
@@ -448,17 +481,22 @@ Each transaction object includes the following fields, depending on whether it w
| `Field` | Type | Description | | `Field` | Type | Description |
|:---------------|:---------------------------------|:-------------------------| |:---------------|:---------------------------------|:-------------------------|
| `ledger_index` | Integer | The [ledger index][] of the ledger version that included this transaction. | | `ledger_index` | Integer | The [ledger index][] of the ledger version that included this transaction. |
| `meta` | Object (JSON) or String (Binary) | If `binary` is True, then this is a hex string of the transaction metadata. Otherwise, the transaction metadata is included in JSON format. | | `tx` | Object | (JSON mode) JSON object defining the transaction. |
| `tx` | Object | (JSON mode only) JSON object defining the transaction | | `tx_blob` | String | (Binary mode) Hex string representing the transaction. |
| `tx_blob` | String | (Binary mode only) Unique hashed String representing the transaction. |
| `validated` | Boolean | Whether or not the transaction is included in a validated ledger. Any transaction not yet in a validated ledger is subject to change. | | `validated` | Boolean | Whether or not the transaction is included in a validated ledger. Any transaction not yet in a validated ledger is subject to change. |
{% /tab %}
{% /tabs %}
## Possible Errors ## Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. In [API v1][], you won't receive this error if you specify:
* `ledger_index_min` or `ledger_index_max`, but also try to specify `ledger_index` or `ledger_hash`.
* A non-boolean value for the `binary` or `forward` fields.
* `actMalformed` - The [Address][] specified in the `account` field of the request is not formatted properly. * `actMalformed` - The [Address][] specified in the `account` field of the request is not formatted properly.
* `lgrIdxMalformed` - The ledger specified by the `ledger_index_min` or `ledger_index_max` does not exist, or if it does exist but the server does not have it. * `lgrIdxMalformed` - The ledger specified by the `ledger_index_min` or `ledger_index_max` does not exist, or if it does exist the server does not have it. In [API v1][], you won't receive this error if you specify a `ledger_index_min` or `ledger_index_max` value beyond the range of ledgers that the server has.
* `lgrIdxsInvalid` - Either the request specifies a `ledger_index_max` that is before the `ledger_index_min`, or the server does not have a validated ledger range because it is [not synced with the network](../../../../infrastructure/troubleshooting/server-doesnt-sync.md). * `lgrIdxsInvalid` - Either the request specifies a `ledger_index_max` that is before the `ledger_index_min`, or the server does not have a validated ledger range because it is [not synced with the network](../../../../infrastructure/troubleshooting/server-doesnt-sync.md).
{% raw-partial file="/docs/_snippets/common-links.md" /%} {% raw-partial file="/docs/_snippets/common-links.md" /%}

4
docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md
View File

@@ -59,7 +59,7 @@ The request includes the following parameters:
|:---------------|:---------------------------|:-------------------------------| |:---------------|:---------------------------|:-------------------------------|
| `account` | String | A unique identifier for the account, most commonly the account's address. | | `account` | String | A unique identifier for the account, most commonly the account's address. |
| `role` | String | Whether the address refers to a `gateway` or `user`. Recommendations depend on the role of the account. Issuers must have Default Ripple enabled and must disable No Ripple on all trust lines. Users should have Default Ripple disabled, and should enable No Ripple on all trust lines. | | `role` | String | Whether the address refers to a `gateway` or `user`. Recommendations depend on the role of the account. Issuers must have Default Ripple enabled and must disable No Ripple on all trust lines. Users should have Default Ripple disabled, and should enable No Ripple on all trust lines. |
| `transactions` | Boolean | [API v1][]: _(Optional)_ If `true`, include an array of suggested [transactions](../../../protocol/transactions/index.md), as JSON objects, that you can sign and submit to fix the problems. The default is `false`.<br>[API v2][]: Identical to v1, but also returns an `invalidParams` error if you use a non-boolean value. | | `transactions` | Boolean | _(Optional)_ If `true`, include an array of suggested [transactions](../../../protocol/transactions/index.md), as JSON objects, that you can sign and submit to fix the problems. The default is `false`. |
| `limit` | Unsigned Integer | _(Optional)_ The maximum number of trust line problems to include in the results. Defaults to 300. | | `limit` | Unsigned Integer | _(Optional)_ The maximum number of trust line problems to include in the results. Defaults to 300. |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) | | `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) | | `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
@@ -187,7 +187,7 @@ The response follows the [standard format][], with a successful result containin
## Possible Errors ## Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. In [API v1][], you won't receive this error if you specify a non-boolean value for the `transactions` field.
* `actNotFound` - The [Address][] specified in the `account` field of the request does not correspond to an account in the ledger. * `actNotFound` - The [Address][] specified in the `account` field of the request does not correspond to an account in the ledger.
* `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it. * `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it.

8
docs/references/http-websocket-apis/public-api-methods/index.md
View File

@@ -48,7 +48,6 @@ Transactions are the only thing that can modify the shared state of the XRP Ledg
* **[`submit_multisigned`](transaction-methods/submit_multisigned.md)** - Send a multi-signed transaction to the network. * **[`submit_multisigned`](transaction-methods/submit_multisigned.md)** - Send a multi-signed transaction to the network.
* **[`transaction_entry`](transaction-methods/transaction_entry.md)** - Retrieve info about a transaction from a particular ledger version. * **[`transaction_entry`](transaction-methods/transaction_entry.md)** - Retrieve info about a transaction from a particular ledger version.
* **[`tx`](transaction-methods/tx.md)** - Retrieve info about a transaction from all the ledgers on hand. * **[`tx`](transaction-methods/tx.md)** - Retrieve info about a transaction from all the ledgers on hand.
* **[`tx_history`](transaction-methods/tx_history.md)** - Retrieve info about all recent transactions.
By default, the following methods are [admin-only](../admin-api-methods/index.md). They can be used as public methods if the server admin has [enabled public signing](../../../infrastructure/configuration/enable-public-signing.md). By default, the following methods are [admin-only](../admin-api-methods/index.md). They can be used as public methods if the server admin has [enabled public signing](../../../infrastructure/configuration/enable-public-signing.md).
@@ -115,4 +114,9 @@ Use these methods to perform convenient tasks, such as ping and random number ge
## Deprecated Methods ## Deprecated Methods
The `owner_info` command is deprecated. Use [`account_objects`](account-methods/account_objects.md) instead. The following methods are deprecated and either have been removed, or may be removed without further notice:
* **`owner_info`** - Use [`account_objects`](account-methods/account_objects.md) instead.
* **[`tx_history`](transaction-methods/tx_history.md)** - Use either the [account_tx method][], or the [ledger method][] with the `transactions` field set to `true`.
{% raw-partial file="/docs/_snippets/common-links.md" /%}

395
docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md
View File

@@ -259,106 +259,101 @@ The `accounts_proposed` subscription works the same way, except it also includes
```json ```json
{ {
"status": "closed", "close_time_iso": "2024-11-01T23:59:01Z",
"type": "transaction",
"engine_result": "tesSUCCESS", "engine_result": "tesSUCCESS",
"engine_result_code": 0, "engine_result_code": 0,
"engine_result_message": "The transaction was applied.", "engine_result_message": "The transaction was applied. Only final in a validated ledger.",
"ledger_hash": "989AFBFD65D820C6BD85301B740F5D592F060668A90EEF5EC1815EBA27D58FE8", "hash": "6489E52A909208E371ACE82E19CAE59896C7F8BA40E7C36C5B8AA3C451914BED",
"ledger_index": 7125442, "ledger_hash": "0B6F44849E6D702D0CFB447FDBD7B603C269E9EEECE9176882EF376E0C9DFF6A",
"ledger_index": 1969852,
"meta": { "meta": {
"AffectedNodes": [ "AffectedNodes": [
{ {
"ModifiedNode": { "ModifiedNode": {
"FinalFields": { "FinalFields": {
"Account": "rH3PxjJPrrkvsATddBXkayjAyWR8xigaE8",
"Balance": "39999964",
"Flags": 0, "Flags": 0,
"IndexPrevious": "0000000000000000", "OwnerCount": 0,
"Owner": "rRh634Y6QtoqkwTTrGzX66UYoCAvgE6jL", "Sequence": 1969812
"RootIndex": "ABD8CE2D1205D0C062876E9E1F3CBDC902ED8EF4E8D3D071B962C7ED0E113E68"
}, },
"LedgerEntryType": "DirectoryNode", "LedgerEntryType": "AccountRoot",
"LedgerIndex": "0BBDEE7D0BE120F7BF27640B5245EBFE0C5FD5281988BA823C44477A70262A4D" "LedgerIndex": "EDE60B24659BCC06CCE1EA2804A4A202F1C88155CEAED9C140833C0C39100617",
} "PreviousFields": {
}, "Balance": "59999976",
{ "Sequence": 1969811
"DeletedNode": {
"FinalFields": {
"Account": "rRh634Y6QtoqkwTTrGzX66UYoCAvgE6jL",
"BookDirectory": "892E892DC63D8F70DCF5C9ECF29394FF7DD3DC6F47DB8EB34A03920BFC5E99BE",
"BookNode": "0000000000000000",
"Flags": 0,
"OwnerNode": "000000000000006E",
"PreviousTxnID": "58A17D95770F8D07E08B81A85896F4032A328B6C2BDCDEC0A00F3EF3914DCF0A",
"PreviousTxnLgrSeq": 7125330,
"Sequence": 540691,
"TakerGets": "4401967683",
"TakerPays": {
"currency": "BTC",
"issuer": "rNPRNzBB92BVpAhhZr4iXDTveCgV5Pofm9",
"value": "0.04424"
}
}, },
"LedgerEntryType": "Offer", "PreviousTxnID": "1DBC93373D47794A684A5013178D0EBE10E6641D7C262BF20151B0E19156FF79",
"LedgerIndex": "386B7803A9210747941B0D079BB408F31ACB1CB98832184D0287A1CBF4FE6D00" "PreviousTxnLgrSeq": 1969843
}
},
{
"DeletedNode": {
"FinalFields": {
"ExchangeRate": "4A03920BFC5E99BE",
"Flags": 0,
"RootIndex": "892E892DC63D8F70DCF5C9ECF29394FF7DD3DC6F47DB8EB34A03920BFC5E99BE",
"TakerGetsCurrency": "0000000000000000000000000000000000000000",
"TakerGetsIssuer": "0000000000000000000000000000000000000000",
"TakerPaysCurrency": "0000000000000000000000004254430000000000",
"TakerPaysIssuer": "92D705968936C419CE614BF264B5EEB1CEA47FF4"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "892E892DC63D8F70DCF5C9ECF29394FF7DD3DC6F47DB8EB34A03920BFC5E99BE"
} }
}, },
{ {
"ModifiedNode": { "ModifiedNode": {
"FinalFields": { "FinalFields": {
"Account": "rRh634Y6QtoqkwTTrGzX66UYoCAvgE6jL", "Account": "rfdGuuVnq9juqWDV4W3LoLiNcW8g2hAXhN",
"Balance": "11133297300", "Balance": "160000000",
"Flags": 0, "Flags": 0,
"OwnerCount": 9, "OwnerCount": 0,
"Sequence": 540706 "Sequence": 1969810
}, },
"LedgerEntryType": "AccountRoot", "LedgerEntryType": "AccountRoot",
"LedgerIndex": "A6C2532E1008A513B3F822A92B8E5214BD0D413DC20AD3631C1A39AD6B36CD07", "LedgerIndex": "F7D350FB54C5BBA734AE574EE6BF7A9294E11F9B75413972F98846AFC587C62C",
"PreviousFields": { "PreviousFields": {
"Balance": "11133297310", "Balance": "140000000"
"OwnerCount": 10,
"Sequence": 540705
}, },
"PreviousTxnID": "484D57DFC4E446DA83B4540305F0CE836D4E007361542EC12CC0FFB5F0A1BE3A", "PreviousTxnID": "1DBC93373D47794A684A5013178D0EBE10E6641D7C262BF20151B0E19156FF79",
"PreviousTxnLgrSeq": 7125358 "PreviousTxnLgrSeq": 1969843
} }
} }
], ],
"TransactionIndex": 1, "TransactionIndex": 4,
"TransactionResult": "tesSUCCESS" "TransactionResult": "tesSUCCESS",
"delivered_amount": "20000000"
}, },
"transaction": { "status": "closed",
"Account": "rRh634Y6QtoqkwTTrGzX66UYoCAvgE6jL", "tx_json": {
"Fee": "10", "Account": "rH3PxjJPrrkvsATddBXkayjAyWR8xigaE8",
"Flags": 2147483648, "DeliverMax": "20000000",
"OfferSequence": 540691, "Destination": "rfdGuuVnq9juqWDV4W3LoLiNcW8g2hAXhN",
"Sequence": 540705, "Fee": "12",
"SigningPubKey": "030BB49C591C9CD65C945D4B78332F27633D7771E6CF4D4B942D26BA40748BB8B4", "Flags": 0,
"TransactionType": "OfferCancel", "LastLedgerSequence": 1969870,
"TxnSignature": "30450221008223604A383F3AED25D53CE7C874700619893A6EEE4336508312217850A9722302205E0614366E174F2DFF78B879F310DB0B3F6DA1967E52A32F65E25DCEC622CD68", "Sequence": 1969811,
"date": 455751680, "SigningPubKey": "ED0761CDA5507784F6CEB445DE2343F861DD5EC7A869F75B08C7E8F29A947AD9FC",
"hash": "94CF924C774DFDBE474A2A7E40AEA70E7E15D130C8CBEF8AF1D2BE97A8269F14" "TransactionType": "Payment",
"TxnSignature": "20D5447ED7095BCCC3D42EA1955600D97D791811072E93D2A358AD9FB258C3A7F004974039D25708F5AE598C78F85B688DD586158F7E9C13AE0F30CC18E3390D",
"date": 783820741
}, },
"type": "transaction",
"validated": true "validated": true
} }
``` ```
Transaction stream messages have the following fields: Transaction stream messages have the following fields:
{% tabs %}
{% tab label="API v2" %}
| `Field` | Type | Description |
|:------------------------|:--------------------------|:-----------------------|
| `close_time_iso` | String | The ledger close time represented in ISO 8601 time format. |
| `type` | String | `transaction` indicates this is the notification of a transaction, which could come from several possible streams. |
| `engine_result` | String | String [Transaction result code](../../../protocol/transactions/transaction-results/index.md) |
| `engine_result_code` | Number | Numeric [transaction response code](../../../protocol/transactions/transaction-results/index.md), if applicable. |
| `engine_result_message` | String | Human-readable explanation for the transaction response |
| `hash` | String | The unique hash identifier of the transaction. |
| `ledger_current_index` | Number - [Ledger Index][] | _(Unvalidated transactions only)_ The ledger index of the current in-progress [ledger version](../../../../concepts/ledgers/index.md) for which this transaction is currently proposed. |
| `ledger_hash` | String - [Hash][] | _(Validated transactions only)_ The identifying hash of the ledger version that includes this transaction |
| `ledger_index` | Number - [Ledger Index][] | _(Validated transactions only)_ The ledger index of the ledger version that includes this transaction. |
| `meta` | Object | _(Validated transactions only)_ The [transaction metadata](../../../protocol/transactions/metadata.md), which shows the exact outcome of the transaction in detail. |
| `tx_json` | Object | The [definition of the transaction](../../../protocol/transactions/index.md) in JSON format. |
| `validated` | Boolean | If `true`, this transaction is included in a validated ledger and its outcome is final. Responses from the `transaction` stream should always be validated. |
{% /tab %}
{% tab label="API v1" %}
| `Field` | Type | Description | | `Field` | Type | Description |
|:------------------------|:--------------------------|:-----------------------| |:------------------------|:--------------------------|:-----------------------|
| `type` | String | `transaction` indicates this is the notification of a transaction, which could come from several possible streams. | | `type` | String | `transaction` indicates this is the notification of a transaction, which could come from several possible streams. |
@@ -369,9 +364,12 @@ Transaction stream messages have the following fields:
| `ledger_hash` | String - [Hash][] | _(Validated transactions only)_ The identifying hash of the ledger version that includes this transaction | | `ledger_hash` | String - [Hash][] | _(Validated transactions only)_ The identifying hash of the ledger version that includes this transaction |
| `ledger_index` | Number - [Ledger Index][] | _(Validated transactions only)_ The ledger index of the ledger version that includes this transaction. | | `ledger_index` | Number - [Ledger Index][] | _(Validated transactions only)_ The ledger index of the ledger version that includes this transaction. |
| `meta` | Object | _(Validated transactions only)_ The [transaction metadata](../../../protocol/transactions/metadata.md), which shows the exact outcome of the transaction in detail. | | `meta` | Object | _(Validated transactions only)_ The [transaction metadata](../../../protocol/transactions/metadata.md), which shows the exact outcome of the transaction in detail. |
| `transaction` | Object | The [definition of the transaction](../../../protocol/transactions/index.md) in JSON format | | `transaction` | Object | The [definition of the transaction](../../../protocol/transactions/index.md) in JSON format. |
| `validated` | Boolean | If `true`, this transaction is included in a validated ledger and its outcome is final. Responses from the `transaction` stream should always be validated. | | `validated` | Boolean | If `true`, this transaction is included in a validated ledger and its outcome is final. Responses from the `transaction` stream should always be validated. |
{% /tab %}
{% /tabs %}
## Peer Status Stream ## Peer Status Stream
@@ -423,126 +421,143 @@ Example order book stream message:
```json ```json
{ {
"engine_result": "tesSUCCESS", "tx_json": {
"engine_result_code": 0, "Account": "rBTwLga3i2gz3doX6Gva3MgEV8ZCD8jjah",
"engine_result_message": "The transaction was applied. Only final in a validated ledger.", "Fee": "20",
"ledger_hash": "08547DD866F099CCB3666F113116B7AA2DF520FA2E3011DD1FF9C9C04A6C7C3E", "Flags": 0,
"ledger_index": 18852105, "LastLedgerSequence": 91826205,
"meta": { "OfferSequence": 156917168,
"AffectedNodes": [{ "Sequence": 156917177,
"ModifiedNode": { "SigningPubKey": "0253C1DFDCF898FE85F16B71CCE80A5739F7223D54CC9EBA4749616593470298C5",
"FinalFields": { "TakerGets": "35992000000",
"Account": "rfCFLzNJYvvnoGHWQYACmJpTgkLUaugLEw", "TakerPays": {
"AccountTxnID": "D295E2BE50E3B78AED24790D7B9096996DAF43F095BF17DB83EEACC283D14050", "currency": "USD",
"Balance": "3070332374272", "issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq",
"Flags": 0, "value": "18570.025718376"
"OwnerCount": 23,
"RegularKey": "r9S56zu6QeJD5d8A7QMfLAeYavgB9dhaX4",
"Sequence": 12142921
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "2880A9B4FB90A306B576C2D532BFE390AB3904642647DCF739492AA244EF46D1",
"PreviousFields": {
"AccountTxnID": "3CA3422B0E42D76A7A677B0BA0BE72DFCD93676E0C80F8D2EB27C04BD8457A0F",
"Balance": "3070332385272",
"Sequence": 12142920
},
"PreviousTxnID": "3CA3422B0E42D76A7A677B0BA0BE72DFCD93676E0C80F8D2EB27C04BD8457A0F",
"PreviousTxnLgrSeq": 18852102
}
}, {
"ModifiedNode": {
"FinalFields": {
"Flags": 0,
"IndexPrevious": "00000000000022D2",
"Owner": "rfCFLzNJYvvnoGHWQYACmJpTgkLUaugLEw",
"RootIndex": "F435FBBEC9654204D7151A01E686BAA8CB325A472D7B61C7916EA58B59355767"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "29A543B6681AD7FC8AFBD1386DAE7385F02F9B8C4756A467DF6834AB54BBC9DB"
}
}, {
"ModifiedNode": {
"FinalFields": {
"ExchangeRate": "4C1BA999A513EF78",
"Flags": 0,
"RootIndex": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784C1BA999A513EF78",
"TakerGetsCurrency": "0000000000000000000000000000000000000000",
"TakerGetsIssuer": "0000000000000000000000000000000000000000",
"TakerPaysCurrency": "0000000000000000000000005553440000000000",
"TakerPaysIssuer": "2ADB0B3959D60A6E6991F729E1918B7163925230"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784C1BA999A513EF78"
}
}, {
"CreatedNode": {
"LedgerEntryType": "Offer",
"LedgerIndex": "92E235EE80D2B28A89BEE2C905D4545C2A004FD5D4097679C8A3FB25507FD9EB",
"NewFields": {
"Account": "rfCFLzNJYvvnoGHWQYACmJpTgkLUaugLEw",
"BookDirectory": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784C1BA999A513EF78",
"Expiration": 508543674,
"OwnerNode": "00000000000022F4",
"Sequence": 12142920,
"TakerGets": "6537121438",
"TakerPays": {
"currency": "USD",
"issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq",
"value": "50.9"
}
}
}
}, {
"DeletedNode": {
"FinalFields": {
"Account": "rfCFLzNJYvvnoGHWQYACmJpTgkLUaugLEw",
"BookDirectory": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784C1BA999A513EF78",
"BookNode": "0000000000000000",
"Expiration": 508543133,
"Flags": 0,
"OwnerNode": "00000000000022F4",
"PreviousTxnID": "58B3279C2D56AAC3D9B06106E637C01E3D911E9D31E2FE4EA0D886AC9F4DEE1E",
"PreviousTxnLgrSeq": 18851945,
"Sequence": 12142889,
"TakerGets": "6537121438",
"TakerPays": {
"currency": "USD",
"issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq",
"value": "50.9"
}
},
"LedgerEntryType": "Offer",
"LedgerIndex": "D3436CE21925E1CB12C5C444963B47D7EA0CD9A0E387926DC76B23FE5CD1C15F"
}
}],
"TransactionIndex": 26,
"TransactionResult": "tesSUCCESS"
}, },
"status": "closed", "TransactionType": "OfferCreate",
"transaction": { "TxnSignature": "30440220520439D8DDB6B6D0E4EA1504873D780ADE524E3961E02A5DD84B8B4C456BA3240220533CF99250737C13FD376C18F6D64149332BA1FE6EA04895442247BD29952193",
"Account": "rfCFLzNJYvvnoGHWQYACmJpTgkLUaugLEw", "date": 783819060,
"Expiration": 508543674, "owner_funds": "36054185999"
"Fee": "11000", },
"Flags": 2147483648, "meta": {
"LastLedgerSequence": 18852106, "AffectedNodes": [
"OfferSequence": 12142889, {
"Sequence": 12142920, "ModifiedNode": {
"SigningPubKey": "034841BF24BD72C7CC371EBD87CCBF258D8ADB05C18DE207130364A97D8A3EA524", "FinalFields": {
"TakerGets": "6537121438", "Flags": 0,
"TakerPays": { "IndexNext": "0",
"currency": "USD", "IndexPrevious": "0",
"issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq", "Owner": "rBTwLga3i2gz3doX6Gva3MgEV8ZCD8jjah",
"value": "50.9" "RootIndex": "0A2600D85F8309FE7F75A490C19613F1CE0C37483B856DB69B8140154C2335F3"
}, },
"TransactionType": "OfferCreate", "LedgerEntryType": "DirectoryNode",
"TxnSignature": "3045022100B9AD678A773FB61F8F9B565713C80CBF187A2F9EB8E9CE0DAC7B839CA6F4B04C02200613D173A0636CD9BE13F2E3EBD13A16932B5B7D8A96BB5F6D561CA5CDBC4AD3", "LedgerIndex": "0A2600D85F8309FE7F75A490C19613F1CE0C37483B856DB69B8140154C2335F3",
"date": 508543090, "PreviousTxnID": "73BBE254DDC97EAD6ECB2D9F7A7EB13DBA1A5B816C2727548FCFBC41B40604EF",
"hash": "D295E2BE50E3B78AED24790D7B9096996DAF43F095BF17DB83EEACC283D14050", "PreviousTxnLgrSeq": 91826203
"owner_funds": "3070197374272" }
}, },
"type": "transaction", {
"validated": true "ModifiedNode": {
"FinalFields": {
"Account": "rBTwLga3i2gz3doX6Gva3MgEV8ZCD8jjah",
"Balance": "36092186059",
"Flags": 0,
"OwnerCount": 14,
"Sequence": 156917178
},
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "1ED8DDFD80F275CB1CE7F18BB9D906655DE8029805D8B95FB9020B30425821EB",
"PreviousFields": {
"Balance": "36092186079",
"Sequence": 156917177
},
"PreviousTxnID": "73BBE254DDC97EAD6ECB2D9F7A7EB13DBA1A5B816C2727548FCFBC41B40604EF",
"PreviousTxnLgrSeq": 91826203
}
},
{
"CreatedNode": {
"LedgerEntryType": "Offer",
"LedgerIndex": "3B4D42B185D1FE4EBED70F7E35A8E8AEA39028FB6B16DCDFC175363EA38DED28",
"NewFields": {
"Account": "rBTwLga3i2gz3doX6Gva3MgEV8ZCD8jjah",
"BookDirectory": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784E125486AFA57980",
"Sequence": 156917177,
"TakerGets": "35992000000",
"TakerPays": {
"currency": "USD",
"issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq",
"value": "18570.025718376"
}
}
}
},
{
"DeletedNode": {
"FinalFields": {
"ExchangeRate": "4e12547b29376a80",
"Flags": 0,
"PreviousTxnID": "D4CB92E19CBADB14F82B0E0703B3F157338253EE1DD46DB91F6C98C93D01DA9C",
"PreviousTxnLgrSeq": 91826201,
"RootIndex": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784E12547B29376A80",
"TakerGetsCurrency": "0000000000000000000000000000000000000000",
"TakerGetsIssuer": "0000000000000000000000000000000000000000",
"TakerPaysCurrency": "0000000000000000000000005553440000000000",
"TakerPaysIssuer": "2ADB0B3959D60A6E6991F729E1918B7163925230"
},
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784E12547B29376A80"
}
},
{
"CreatedNode": {
"LedgerEntryType": "DirectoryNode",
"LedgerIndex": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784E125486AFA57980",
"NewFields": {
"ExchangeRate": "4e125486afa57980",
"RootIndex": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784E125486AFA57980",
"TakerPaysCurrency": "0000000000000000000000005553440000000000",
"TakerPaysIssuer": "2ADB0B3959D60A6E6991F729E1918B7163925230"
}
}
},
{
"DeletedNode": {
"FinalFields": {
"Account": "rBTwLga3i2gz3doX6Gva3MgEV8ZCD8jjah",
"BookDirectory": "79C54A4EBD69AB2EADCE313042F36092BE432423CC6A4F784E12547B29376A80",
"BookNode": "0",
"Flags": 0,
"OwnerNode": "0",
"PreviousTxnID": "D4CB92E19CBADB14F82B0E0703B3F157338253EE1DD46DB91F6C98C93D01DA9C",
"PreviousTxnLgrSeq": 91826201,
"Sequence": 156917168,
"TakerGets": "35992000000",
"TakerPays": {
"currency": "USD",
"issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq",
"value": "18569.847557976"
}
},
"LedgerEntryType": "Offer",
"LedgerIndex": "F72F9E5C9C81C6D2403C062365B34AA371D5D0BB13E1787622E936D0B8B4A499"
}
}
],
"TransactionIndex": 23,
"TransactionResult": "tesSUCCESS"
},
"type": "transaction",
"validated": true,
"status": "closed",
"close_time_iso": "2024-11-01T23:31:00Z",
"ledger_index": 91826203,
"ledger_hash": "746D115326E08B884D7EA5F0E379272774F1B41443C000044D5DF97781E0601D",
"hash": "2250BB2914AC7BC143AD62E7DD36F23A22F2BC50495FC29B36C6B0CA570BB4FA",
"engine_result_code": 0,
"engine_result": "tesSUCCESS",
"engine_result_message": "The transaction was applied. Only final in a validated ledger."
} }
``` ```
@@ -550,7 +565,7 @@ The format of an order book stream message is the same as that of [transaction s
| Field | Value | Description | | Field | Value | Description |
|:--------------------------|:-------|:----------------------------------------| |:--------------------------|:-------|:----------------------------------------|
| `transaction.owner_funds` | String | Numeric amount of the `TakerGets` currency that the `Account` sending this OfferCreate transaction has after executing this transaction. This does not check whether the currency amount is [frozen](../../../../concepts/tokens/fungible-tokens/freezes.md). | | `transaction.owner_funds` | String | Numeric amount of the `TakerGets` currency that the `Account` sending this OfferCreate transaction has after executing this transaction. This does not check whether the currency amount is [frozen](../../../../concepts/tokens/fungible-tokens/freezes.md).<br>[API v2][] Renamed to `tx_json.owner_funds`. |
## Book Changes Stream ## Book Changes Stream

15
docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md
View File

@@ -105,12 +105,13 @@ An example of the request format:
```json ```json
{ {
"id": 2, "id": 2,
"api_version": 2,
"command": "submit", "command": "submit",
"tx_json" : { "tx_json" : {
"TransactionType" : "Payment", "TransactionType" : "Payment",
"Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"Amount" : { "DeliverMax" : {
"currency" : "USD", "currency" : "USD",
"value" : "1", "value" : "1",
"issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
@@ -130,10 +131,11 @@ An example of the request format:
"params": [ "params": [
{ {
"offline": false, "offline": false,
"api_version": 2,
"secret": "s████████████████████████████", "secret": "s████████████████████████████",
"tx_json": { "tx_json": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Amount": { "DeliverMax": {
"currency": "USD", "currency": "USD",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"value": "1" "value": "1"
@@ -151,7 +153,7 @@ An example of the request format:
{% tab label="Commandline" %} {% tab label="Commandline" %}
```sh ```sh
#Syntax: submit secret json [offline] #Syntax: submit secret json [offline]
rippled submit s████████████████████████████ '{"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Amount": { "currency": "USD", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "value": "1" }, "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "TransactionType": "Payment", "Fee": "10000"}' rippled submit s████████████████████████████ '{"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "DeliverMax": { "currency": "USD", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "value": "1" }, "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "TransactionType": "Payment", "Fee": "10000"}'
``` ```
{% /tab %} {% /tab %}
@@ -169,6 +171,7 @@ An example of a successful response:
```json ```json
{ {
"id": 1, "id": 1,
"api_version": 2,
"status": "success", "status": "success",
"type": "response", "type": "response",
"result": { "result": {
@@ -186,7 +189,7 @@ An example of a successful response:
"tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754", "tx_blob": "1200002280000000240000016861D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7446304402200E5C2DD81FDF0BE9AB2A8D797885ED49E804DBF28E806604D878756410CA98B102203349581946B0DDA06B36B35DBC20EDA27552C1F167BCF5C6ECFF49C6A46F858081144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
"tx_json": { "tx_json": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Amount": { "DeliverMax": {
"currency": "USD", "currency": "USD",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"value": "1" "value": "1"
@@ -225,7 +228,7 @@ An example of a successful response:
"tx_blob": "1200002280000000240000016961D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB74473045022100A7CCD11455E47547FF617D5BFC15D120D9053DFD0536B044F10CA3631CD609E502203B61DEE4AC027C5743A1B56AF568D1E2B8E79BB9E9E14744AC87F38375C3C2F181144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754", "tx_blob": "1200002280000000240000016961D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB74473045022100A7CCD11455E47547FF617D5BFC15D120D9053DFD0536B044F10CA3631CD609E502203B61DEE4AC027C5743A1B56AF568D1E2B8E79BB9E9E14744AC87F38375C3C2F181144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
"tx_json": { "tx_json": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Amount": { "DeliverMax": {
"currency": "USD", "currency": "USD",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"value": "1" "value": "1"
@@ -267,7 +270,7 @@ Connecting to 127.0.0.1:5005
"tx_blob": "1200002280000000240000016961D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB74473045022100A7CCD11455E47547FF617D5BFC15D120D9053DFD0536B044F10CA3631CD609E502203B61DEE4AC027C5743A1B56AF568D1E2B8E79BB9E9E14744AC87F38375C3C2F181144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754", "tx_blob": "1200002280000000240000016961D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA9684000000000002710732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB74473045022100A7CCD11455E47547FF617D5BFC15D120D9053DFD0536B044F10CA3631CD609E502203B61DEE4AC027C5743A1B56AF568D1E2B8E79BB9E9E14744AC87F38375C3C2F181144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754",
"tx_json": { "tx_json": {
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Amount": { "DeliverMax": {
"currency": "USD", "currency": "USD",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"value": "1" "value": "1"

27
docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md
View File

@@ -76,7 +76,7 @@ An example of a successful response:
"result": { "result": {
"ledger_hash": "793E56131D8D4ABFB27FA383BFC44F2978B046E023FF46C588D7E0C874C2472A", "ledger_hash": "793E56131D8D4ABFB27FA383BFC44F2978B046E023FF46C588D7E0C874C2472A",
"ledger_index": 56865245, "ledger_index": 56865245,
"metadata": { "meta": {
"AffectedNodes": [ "AffectedNodes": [
{ {
"ModifiedNode": { "ModifiedNode": {
@@ -200,7 +200,7 @@ An example of a successful response:
"result": { "result": {
"ledger_hash": "793E56131D8D4ABFB27FA383BFC44F2978B046E023FF46C588D7E0C874C2472A", "ledger_hash": "793E56131D8D4ABFB27FA383BFC44F2978B046E023FF46C588D7E0C874C2472A",
"ledger_index": 56865245, "ledger_index": 56865245,
"metadata": { "meta": {
"AffectedNodes": [ "AffectedNodes": [
{ {
"ModifiedNode": { "ModifiedNode": {
@@ -323,7 +323,7 @@ An example of a successful response:
"result" : { "result" : {
"ledger_hash" : "793E56131D8D4ABFB27FA383BFC44F2978B046E023FF46C588D7E0C874C2472A", "ledger_hash" : "793E56131D8D4ABFB27FA383BFC44F2978B046E023FF46C588D7E0C874C2472A",
"ledger_index" : 56865245, "ledger_index" : 56865245,
"metadata" : { "meta" : {
"AffectedNodes" : [ "AffectedNodes" : [
{ {
"ModifiedNode" : { "ModifiedNode" : {
@@ -444,6 +444,23 @@ An example of a successful response:
The response follows the [standard format][], with a successful result containing the following fields: The response follows the [standard format][], with a successful result containing the following fields:
{% tabs %}
{% tab label="API v2" %}
| `Field` | Type | Description |
|:-----------------|:--------------------------|:--------------------------------|
| `close_time_iso` | String | The ledger close time represented in ISO 8601 time format. |
| `hash` | String | The unique hash identifier of the transaction. |
| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger version the transaction was found in; this is the same as the one from the request. |
| `ledger_hash` | String - [Hash][] | _(May be omitted)_ The identifying hash of the ledger version the transaction was found in; this is the same as the one from the request. |
| `meta` | Object | The [transaction metadata](../../../protocol/transactions/metadata.md), which shows the exact results of the transaction in detail. |
| `tx_json` | Object | JSON representation of the [Transaction object](../../../protocol/transactions/index.md) |
{% /tab %}
{% tab label="API v1" %}
| `Field` | Type | Description | | `Field` | Type | Description |
|:---------------|:--------------------------|:--------------------------------| |:---------------|:--------------------------|:--------------------------------|
| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger version the transaction was found in; this is the same as the one from the request. | | `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger version the transaction was found in; this is the same as the one from the request. |
@@ -451,6 +468,10 @@ The response follows the [standard format][], with a successful result containin
| `metadata` | Object | The [transaction metadata](../../../protocol/transactions/metadata.md), which shows the exact results of the transaction in detail. | | `metadata` | Object | The [transaction metadata](../../../protocol/transactions/metadata.md), which shows the exact results of the transaction in detail. |
| `tx_json` | Object | JSON representation of the [Transaction object](../../../protocol/transactions/index.md) | | `tx_json` | Object | JSON representation of the [Transaction object](../../../protocol/transactions/index.md) |
{% /tab %}
{% /tabs %}
There are a couple possible reasons the server may fail to find the transaction: There are a couple possible reasons the server may fail to find the transaction:
* The transaction does not exist * The transaction does not exist

40
docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md
View File

@@ -25,7 +25,8 @@ An example of the request format:
"id": 1, "id": 1,
"command": "tx", "command": "tx",
"transaction": "C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9", "transaction": "C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9",
"binary": false "binary": false,
"api_version": 2
} }
``` ```
{% /tab %} {% /tab %}
@@ -36,7 +37,8 @@ An example of the request format:
"id": "CTID example", "id": "CTID example",
"command": "tx", "command": "tx",
"ctid": "C005523E00000000", "ctid": "C005523E00000000",
"binary": false "binary": false,
"api_version": 2
} }
``` ```
{% /tab %} {% /tab %}
@@ -48,7 +50,8 @@ An example of the request format:
"params": [ "params": [
{ {
"transaction": "C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9", "transaction": "C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9",
"binary": false "binary": false,
"api_version": 2
} }
] ]
} }
@@ -62,7 +65,8 @@ An example of the request format:
"params": [ "params": [
{ {
"ctid": "C005523E00000000", "ctid": "C005523E00000000",
"binary": false "binary": false,
"api_version": 2
} }
] ]
} }
@@ -240,6 +244,29 @@ An example of a successful response:
{% /tabs %} {% /tabs %}
{% tabs %}
{% tab label="API v2" %}
The response follows the [standard format][], with a successful result containing the fields of the [Transaction object](../../../protocol/transactions/index.md) as well as the following additional fields:
| `Field` | Type | Description |
|:---------------|:---------------------------------|:-------------------------|
| `ctid` | String | The transaction's [compact transaction identifier](../../api-conventions/ctid.md). {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.12.0" %}New in: rippled 1.12.0{% /badge %} _(Not supported in Clio v2.0 and earlier.)_ |
| `date` | Number | The [close time](../../../../concepts/ledgers/ledger-close-times.md) of the ledger in which the transaction was applied, in [seconds since the Ripple Epoch][]. |
| `hash` | String | The unique [identifying hash][] of the transaction |
| `inLedger` | Number | _(Deprecated)_ Alias for `ledger_index`. |
| `ledger_index` | Number | The [ledger index][] of the ledger that includes this transaction. |
| `meta` | Object (JSON) | (JSON mode) [Transaction metadata](../../../protocol/transactions/metadata.md), which describes the results of the transaction. |
| `meta_blob` | String (binary) | (Binary mode) [Transaction metadata](../../../protocol/transactions/metadata.md), which describes the results of the transaction, represented as a hex string. |
| `tx_blob` | String (binary) | (Binary mode) The transaction data represented as a hex string. |
| `tx_json` | Object (JSON) | The transaction data represented in JSON. |
| `validated` | Boolean | If `true`, this data comes from a validated ledger version; if omitted or set to `false`, this data is not final. |
{% /tab %}
{% tab label="API v1" %}
The response follows the [standard format][], with a successful result containing the fields of the [Transaction object](../../../protocol/transactions/index.md) as well as the following additional fields: The response follows the [standard format][], with a successful result containing the fields of the [Transaction object](../../../protocol/transactions/index.md) as well as the following additional fields:
| `Field` | Type | Description | | `Field` | Type | Description |
@@ -250,9 +277,14 @@ The response follows the [standard format][], with a successful result containin
| `inLedger` | Number | _(Deprecated)_ Alias for `ledger_index`. | | `inLedger` | Number | _(Deprecated)_ Alias for `ledger_index`. |
| `ledger_index` | Number | The [ledger index][] of the ledger that includes this transaction. | | `ledger_index` | Number | The [ledger index][] of the ledger that includes this transaction. |
| `meta` | Object (JSON) or String (binary) | [Transaction metadata](../../../protocol/transactions/metadata.md), which describes the results of the transaction. | | `meta` | Object (JSON) or String (binary) | [Transaction metadata](../../../protocol/transactions/metadata.md), which describes the results of the transaction. |
| `tx` | String (binary) | (Binary mode) The transaction data represented as a hex string. |
| `validated` | Boolean | If `true`, this data comes from a validated ledger version; if omitted or set to `false`, this data is not final. | | `validated` | Boolean | If `true`, this data comes from a validated ledger version; if omitted or set to `false`, this data is not final. |
| (Various) | (Various) | Other fields from the [Transaction object](../../../protocol/transactions/index.md) | | (Various) | (Various) | Other fields from the [Transaction object](../../../protocol/transactions/index.md) |
{% /tab %}
{% /tabs %}
### Not Found Response ### Not Found Response

6
docs/references/protocol/transactions/types/payment.md
View File

@@ -23,7 +23,7 @@ Payments are also the only way to [create accounts](#creating-accounts).
"TransactionType" : "Payment", "TransactionType" : "Payment",
"Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Account" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "Destination" : "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"Amount" : { "DeliverMax" : {
"currency" : "USD", "currency" : "USD",
"value" : "1", "value" : "1",
"issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
@@ -42,8 +42,8 @@ Payments are also the only way to [create accounts](#creating-accounts).
| Field | JSON Type | [Internal Type][] | Description | | Field | JSON Type | [Internal Type][] | Description |
|:-----------------|:---------------------|:------------------|:---------------| |:-----------------|:---------------------|:------------------|:---------------|
| `Amount` | [Currency Amount][] | Amount | [API v1][]: Only available in API v1. The maximum amount of currency to deliver. For non-XRP amounts, the nested field names MUST be lower-case. If the [`tfPartialPayment` flag](#payment-flags) is set, deliver _up to_ this amount instead. | | `Amount` | [Currency Amount][] | Amount | Alias to `DeliverMax`. |
| `DeliverMax` | [Currency Amount][] | Amount | [API v2][]: Only available in API v2. The maximum amount of currency to deliver. For non-XRP amounts, the nested field names MUST be lower-case. If the [`tfPartialPayment` flag](#payment-flags) is set, deliver _up to_ this amount instead. {% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}New in: rippled 2.0.0{% /badge %} | | `DeliverMax` | [Currency Amount][] | Amount | [API v2][]: The maximum amount of currency to deliver. For non-XRP amounts, the nested field names MUST be lower-case. If the [`tfPartialPayment` flag](#payment-flags) is set, deliver _up to_ this amount instead. {% badge href="https://github.com/XRPLF/rippled/releases/tag/2.0.0" %}New in: rippled 2.0.0{% /badge %} |
| `DeliverMin` | [Currency Amount][] | Amount | _(Optional)_ Minimum amount of destination currency this transaction should deliver. Only valid if this is a [partial payment](../../../../concepts/payment-types/partial-payments.md). For non-XRP amounts, the nested field names are lower-case. | | `DeliverMin` | [Currency Amount][] | Amount | _(Optional)_ Minimum amount of destination currency this transaction should deliver. Only valid if this is a [partial payment](../../../../concepts/payment-types/partial-payments.md). For non-XRP amounts, the nested field names are lower-case. |
| `Destination` | String | AccountID | The unique address of the account receiving the payment. | | `Destination` | String | AccountID | The unique address of the account receiving the payment. |
| `DestinationTag` | Number | UInt32 | _(Optional)_ Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay. | | `DestinationTag` | Number | UInt32 | _(Optional)_ Arbitrary tag that identifies the reason for the payment to the destination, or a hosted recipient to pay. |

2
package-lock.json generated
View File

@@ -20,6 +20,7 @@
"clsx": "^2.0.0", "clsx": "^2.0.0",
"lottie-react": "^2.4.0", "lottie-react": "^2.4.0",
"moment": "^2.29.4", "moment": "^2.29.4",
"node-fetch": "^3.3.2",
"react": "^18.2.0", "react": "^18.2.0",
"react-alert": "^7.0.3", "react-alert": "^7.0.3",
"react18-json-view": "^0.2.6", "react18-json-view": "^0.2.6",
@@ -8108,6 +8109,7 @@
"version": "3.3.2", "version": "3.3.2",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz",
"integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==", "integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==",
"license": "MIT",
"dependencies": { "dependencies": {
"data-uri-to-buffer": "^4.0.0", "data-uri-to-buffer": "^4.0.0",
"fetch-blob": "^3.1.4", "fetch-blob": "^3.1.4",

1
package.json
View File

@@ -23,6 +23,7 @@
"clsx": "^2.0.0", "clsx": "^2.0.0",
"lottie-react": "^2.4.0", "lottie-react": "^2.4.0",
"moment": "^2.29.4", "moment": "^2.29.4",
"node-fetch": "^3.3.2",
"react": "^18.2.0", "react": "^18.2.0",
"react-alert": "^7.0.3", "react-alert": "^7.0.3",
"react18-json-view": "^0.2.6", "react18-json-view": "^0.2.6",

9
resources/dev-tools/components/websocket-api/data/command-list.json
View File

@@ -86,7 +86,8 @@
"ledger_index_max": -1, "ledger_index_max": -1,
"binary": false, "binary": false,
"limit": 2, "limit": 2,
"forward": false "forward": false,
"api_version": 2
} }
}, },
{ {
@@ -224,7 +225,8 @@
"body": { "body": {
"command": "transaction_entry", "command": "transaction_entry",
"tx_hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7", "tx_hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
"ledger_index": 348734 "ledger_index": 348734,
"api_version": 2
} }
}, },
{ {
@@ -234,7 +236,8 @@
"body": { "body": {
"command": "tx", "command": "tx",
"transaction": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7", "transaction": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
"binary": false "binary": false,
"api_version": 2
} }
} }
] ]