mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-18 03:05:48 +00:00
Compare commits
15 Commits
@transia/x
...
@transia/x
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
036312d361 | ||
|
|
3467680506 | ||
|
|
f209126364 | ||
|
|
33a8b3679a | ||
|
|
572aaa7a40 | ||
|
|
b6c11d1df8 | ||
|
|
526d1e7686 | ||
|
|
3c668f41b8 | ||
|
|
aeb29a20a1 | ||
|
|
8c814482e5 | ||
|
|
5b57ea8b77 | ||
|
|
7663e6049f | ||
|
|
420d6b2c35 | ||
|
|
02c41d2eb1 | ||
|
|
3f1a54f018 |
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
@@ -29,7 +29,7 @@
|
|||||||
"enable": true
|
"enable": true
|
||||||
},
|
},
|
||||||
"editor.codeActionsOnSave": {
|
"editor.codeActionsOnSave": {
|
||||||
"source.fixAll.eslint": true
|
"source.fixAll.eslint": "explicit"
|
||||||
},
|
},
|
||||||
"files.insertFinalNewline": true,
|
"files.insertFinalNewline": true,
|
||||||
"files.trimFinalNewlines": true,
|
"files.trimFinalNewlines": true,
|
||||||
|
|||||||
@@ -32,19 +32,19 @@ All of which works in Node.js (tested for v14+) & web browsers (tested for Chrom
|
|||||||
In an existing project (with package.json), install xrpl.js with:
|
In an existing project (with package.json), install xrpl.js with:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ npm install --save xrpl
|
$ npm install --save @transia/xrpl
|
||||||
```
|
```
|
||||||
|
|
||||||
Or with `yarn`:
|
Or with `yarn`:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ yarn add xrpl
|
$ yarn add @transia/xrpl
|
||||||
```
|
```
|
||||||
|
|
||||||
Example usage:
|
Example usage:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const xrpl = require("xrpl");
|
const xrpl = require("@transia/xrpl");
|
||||||
async function main() {
|
async function main() {
|
||||||
const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233");
|
const client = new xrpl.Client("wss://s.altnet.rippletest.net:51233");
|
||||||
await client.connect();
|
await client.connect();
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@transia/ripple-binary-codec",
|
"name": "@transia/ripple-binary-codec",
|
||||||
"version": "1.4.6-alpha.5",
|
"version": "1.4.6-alpha.8",
|
||||||
"description": "XRP Ledger binary codec",
|
"description": "XRP Ledger binary codec",
|
||||||
"files": [
|
"files": [
|
||||||
"dist/*",
|
"dist/*",
|
||||||
|
|||||||
@@ -37,7 +37,7 @@
|
|||||||
"LedgerHashes": 104,
|
"LedgerHashes": 104,
|
||||||
"Amendments": 102,
|
"Amendments": 102,
|
||||||
"FeeSettings": 115,
|
"FeeSettings": 115,
|
||||||
"ImportVlseq": 73,
|
"ImportVLSequence": 73,
|
||||||
"Escrow": 117,
|
"Escrow": 117,
|
||||||
"PayChannel": 120,
|
"PayChannel": 120,
|
||||||
"Check": 67,
|
"Check": 67,
|
||||||
@@ -2521,11 +2521,11 @@
|
|||||||
"temBAD_PATH": -291,
|
"temBAD_PATH": -291,
|
||||||
"temBAD_PATH_LOOP": -290,
|
"temBAD_PATH_LOOP": -290,
|
||||||
"temBAD_REGKEY": -289,
|
"temBAD_REGKEY": -289,
|
||||||
"temBAD_SEND_XRP_LIMIT": -288,
|
"temBAD_SEND_NATIVE_LIMIT": -288,
|
||||||
"temBAD_SEND_XRP_MAX": -287,
|
"temBAD_SEND_NATIVE_MAX": -287,
|
||||||
"temBAD_SEND_XRP_NO_DIRECT": -286,
|
"temBAD_SEND_NATIVE_NO_DIRECT": -286,
|
||||||
"temBAD_SEND_XRP_PARTIAL": -285,
|
"temBAD_SEND_NATIVE_PARTIAL": -285,
|
||||||
"temBAD_SEND_XRP_PATHS": -284,
|
"temBAD_SEND_NATIVE_PATHS": -284,
|
||||||
"temBAD_SEQUENCE": -283,
|
"temBAD_SEQUENCE": -283,
|
||||||
"temBAD_SIGNATURE": -282,
|
"temBAD_SIGNATURE": -282,
|
||||||
"temBAD_SRC_ACCOUNT": -281,
|
"temBAD_SRC_ACCOUNT": -281,
|
||||||
@@ -2557,7 +2557,6 @@
|
|||||||
"temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255,
|
"temXCHAIN_BRIDGE_BAD_REWARD_AMOUNT": -255,
|
||||||
"temXCHAIN_TOO_MANY_ATTESTATIONS": -254,
|
"temXCHAIN_TOO_MANY_ATTESTATIONS": -254,
|
||||||
"temHOOK_DATA_TOO_LARGE": -253,
|
"temHOOK_DATA_TOO_LARGE": -253,
|
||||||
"temHOOK_REJECTED": -252,
|
|
||||||
|
|
||||||
"tefFAILURE": -199,
|
"tefFAILURE": -199,
|
||||||
"tefALREADY": -198,
|
"tefALREADY": -198,
|
||||||
@@ -2582,6 +2581,7 @@
|
|||||||
"tefNFTOKEN_IS_NOT_TRANSFERABLE": -179,
|
"tefNFTOKEN_IS_NOT_TRANSFERABLE": -179,
|
||||||
"tefPAST_IMPORT_SEQ": -178,
|
"tefPAST_IMPORT_SEQ": -178,
|
||||||
"tefPAST_IMPORT_VL_SEQ": -177,
|
"tefPAST_IMPORT_VL_SEQ": -177,
|
||||||
|
"tefNONDIR_EMIT": -176,
|
||||||
|
|
||||||
"terRETRY": -99,
|
"terRETRY": -99,
|
||||||
"terFUNDS_SPENT": -98,
|
"terFUNDS_SPENT": -98,
|
||||||
@@ -2610,7 +2610,7 @@
|
|||||||
"tecINSUF_RESERVE_LINE": 122,
|
"tecINSUF_RESERVE_LINE": 122,
|
||||||
"tecINSUF_RESERVE_OFFER": 123,
|
"tecINSUF_RESERVE_OFFER": 123,
|
||||||
"tecNO_DST": 124,
|
"tecNO_DST": 124,
|
||||||
"tecNO_DST_INSUF_XRP": 125,
|
"tecNO_DST_INSUF_NATIVE": 125,
|
||||||
"tecNO_LINE_INSUF_RESERVE": 126,
|
"tecNO_LINE_INSUF_RESERVE": 126,
|
||||||
"tecNO_LINE_REDUNDANT": 127,
|
"tecNO_LINE_REDUNDANT": 127,
|
||||||
"tecPATH_DRY": 128,
|
"tecPATH_DRY": 128,
|
||||||
@@ -2672,6 +2672,7 @@
|
|||||||
"tecXCHAIN_PAYMENT_FAILED": 184,
|
"tecXCHAIN_PAYMENT_FAILED": 184,
|
||||||
"tecXCHAIN_SELF_COMMIT": 185,
|
"tecXCHAIN_SELF_COMMIT": 185,
|
||||||
"tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186,
|
"tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186,
|
||||||
|
"tecINSUF_RESERVE_SELLER": 187,
|
||||||
"tecLAST_POSSIBLE_ENTRY": 255
|
"tecLAST_POSSIBLE_ENTRY": 255
|
||||||
},
|
},
|
||||||
"TRANSACTION_TYPES": {
|
"TRANSACTION_TYPES": {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@transia/xrpl",
|
"name": "@transia/xrpl",
|
||||||
"version": "2.7.3-alpha.18",
|
"version": "2.7.3-alpha.24",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
|
"description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
|
||||||
"files": [
|
"files": [
|
||||||
@@ -23,7 +23,7 @@
|
|||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@transia/ripple-address-codec": "^4.2.8-alpha.0",
|
"@transia/ripple-address-codec": "^4.2.8-alpha.0",
|
||||||
"@transia/ripple-binary-codec": "^1.4.6-alpha.5",
|
"@transia/ripple-binary-codec": "^1.4.6-alpha.8",
|
||||||
"@transia/ripple-keypairs": "^1.1.8-alpha.0",
|
"@transia/ripple-keypairs": "^1.1.8-alpha.0",
|
||||||
"bignumber.js": "^9.0.0",
|
"bignumber.js": "^9.0.0",
|
||||||
"bip32": "^2.0.6",
|
"bip32": "^2.0.6",
|
||||||
|
|||||||
@@ -14,6 +14,17 @@ export interface HookExecution {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface HookEmission {
|
||||||
|
HookEmission: {
|
||||||
|
EmitGeneration: number
|
||||||
|
EmitBurden: string
|
||||||
|
EmitParentTxnID: string
|
||||||
|
EmitNonce: string
|
||||||
|
EmitCallback: string
|
||||||
|
EmitHookHash: string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
export interface CreatedNode {
|
export interface CreatedNode {
|
||||||
CreatedNode: {
|
CreatedNode: {
|
||||||
LedgerEntryType: string
|
LedgerEntryType: string
|
||||||
@@ -75,6 +86,7 @@ export function isDeletedNode(node: Node): node is DeletedNode {
|
|||||||
|
|
||||||
export interface TransactionMetadata {
|
export interface TransactionMetadata {
|
||||||
HookExecutions?: HookExecution[]
|
HookExecutions?: HookExecution[]
|
||||||
|
HookEmissions?: HookEmission[]
|
||||||
AffectedNodes: Node[]
|
AffectedNodes: Node[]
|
||||||
DeliveredAmount?: Amount
|
DeliveredAmount?: Amount
|
||||||
// "unavailable" possible for transactions before 2014-01-20
|
// "unavailable" possible for transactions before 2014-01-20
|
||||||
|
|||||||
@@ -2,16 +2,15 @@ import {
|
|||||||
xAddressToClassicAddress,
|
xAddressToClassicAddress,
|
||||||
isValidXAddress,
|
isValidXAddress,
|
||||||
} from '@transia/ripple-address-codec'
|
} from '@transia/ripple-address-codec'
|
||||||
import BigNumber from 'bignumber.js'
|
import { encode } from '@transia/ripple-binary-codec'
|
||||||
|
|
||||||
import type { Client } from '..'
|
import type { Client } from '..'
|
||||||
import { ValidationError, XrplError } from '../errors'
|
import { ValidationError, XrplError } from '../errors'
|
||||||
import { AccountInfoRequest, AccountObjectsRequest } from '../models/methods'
|
import { AccountInfoRequest, AccountObjectsRequest } from '../models/methods'
|
||||||
import { Transaction } from '../models/transactions'
|
import { Transaction } from '../models/transactions'
|
||||||
import { setTransactionFlagsToNumber } from '../models/utils/flags'
|
import { setTransactionFlagsToNumber } from '../models/utils/flags'
|
||||||
import { xrpToDrops } from '../utils'
|
|
||||||
|
|
||||||
import { getFeeXrp } from './getFeeXrp'
|
import { getFeeEstimateXrp } from './getFeeXrp'
|
||||||
|
|
||||||
// Expire unconfirmed transactions after 20 ledger versions, approximately 1 minute, by default
|
// Expire unconfirmed transactions after 20 ledger versions, approximately 1 minute, by default
|
||||||
const LEDGER_OFFSET = 20
|
const LEDGER_OFFSET = 20
|
||||||
@@ -50,17 +49,18 @@ async function autofill<T extends Transaction>(
|
|||||||
if (tx.Sequence == null) {
|
if (tx.Sequence == null) {
|
||||||
promises.push(setNextValidSequenceNumber(this, tx))
|
promises.push(setNextValidSequenceNumber(this, tx))
|
||||||
}
|
}
|
||||||
if (tx.Fee == null) {
|
|
||||||
promises.push(calculateFeePerTransactionType(this, tx, signersCount))
|
|
||||||
}
|
|
||||||
if (tx.LastLedgerSequence == null) {
|
if (tx.LastLedgerSequence == null) {
|
||||||
promises.push(setLatestValidatedLedgerSequence(this, tx))
|
promises.push(setLatestValidatedLedgerSequence(this, tx))
|
||||||
}
|
}
|
||||||
if (tx.TransactionType === 'AccountDelete') {
|
if (tx.TransactionType === 'AccountDelete') {
|
||||||
promises.push(checkAccountDeleteBlockers(this, tx))
|
promises.push(checkAccountDeleteBlockers(this, tx))
|
||||||
}
|
}
|
||||||
|
await Promise.all(promises).then(() => tx)
|
||||||
|
|
||||||
return Promise.all(promises).then(() => tx)
|
if (tx.Fee == null) {
|
||||||
|
await calculateFeePerTransactionType(this, tx, signersCount)
|
||||||
|
}
|
||||||
|
return tx
|
||||||
}
|
}
|
||||||
|
|
||||||
function setValidAddresses(tx: Transaction): void {
|
function setValidAddresses(tx: Transaction): void {
|
||||||
@@ -146,64 +146,17 @@ async function setNextValidSequenceNumber(
|
|||||||
tx.Sequence = data.result.account_data.Sequence
|
tx.Sequence = data.result.account_data.Sequence
|
||||||
}
|
}
|
||||||
|
|
||||||
async function fetchAccountDeleteFee(client: Client): Promise<BigNumber> {
|
|
||||||
const response = await client.request({ command: 'server_state' })
|
|
||||||
const fee = response.result.state.validated_ledger?.reserve_inc
|
|
||||||
|
|
||||||
if (fee == null) {
|
|
||||||
return Promise.reject(new Error('Could not fetch Owner Reserve.'))
|
|
||||||
}
|
|
||||||
|
|
||||||
return new BigNumber(fee)
|
|
||||||
}
|
|
||||||
|
|
||||||
async function calculateFeePerTransactionType(
|
async function calculateFeePerTransactionType(
|
||||||
client: Client,
|
client: Client,
|
||||||
tx: Transaction,
|
tx: Transaction,
|
||||||
signersCount = 0,
|
signersCount = 0,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
// netFee is usually 0.00001 XRP (10 drops)
|
const copyTx = { ...tx }
|
||||||
const netFeeXRP = await getFeeXrp(client)
|
copyTx.SigningPubKey = ``
|
||||||
const netFeeDrops = xrpToDrops(netFeeXRP)
|
copyTx.Fee = `0`
|
||||||
let baseFee = new BigNumber(netFeeDrops)
|
const tx_blob = encode(copyTx)
|
||||||
|
// eslint-disable-next-line require-atomic-updates, no-param-reassign -- ignore
|
||||||
// EscrowFinish Transaction with Fulfillment
|
tx.Fee = await getFeeEstimateXrp(client, tx_blob, signersCount)
|
||||||
if (tx.TransactionType === 'EscrowFinish' && tx.Fulfillment != null) {
|
|
||||||
const fulfillmentBytesSize: number = Math.ceil(tx.Fulfillment.length / 2)
|
|
||||||
// 10 drops × (33 + (Fulfillment size in bytes / 16))
|
|
||||||
const product = new BigNumber(
|
|
||||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers -- expected use of magic numbers
|
|
||||||
scaleValue(netFeeDrops, 33 + fulfillmentBytesSize / 16),
|
|
||||||
)
|
|
||||||
baseFee = product.dp(0, BigNumber.ROUND_CEIL)
|
|
||||||
}
|
|
||||||
|
|
||||||
// AccountDelete Transaction
|
|
||||||
if (tx.TransactionType === 'AccountDelete') {
|
|
||||||
baseFee = await fetchAccountDeleteFee(client)
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Multi-signed Transaction
|
|
||||||
* 10 drops × (1 + Number of Signatures Provided)
|
|
||||||
*/
|
|
||||||
if (signersCount > 0) {
|
|
||||||
baseFee = BigNumber.sum(baseFee, scaleValue(netFeeDrops, 1 + signersCount))
|
|
||||||
}
|
|
||||||
|
|
||||||
const maxFeeDrops = xrpToDrops(client.maxFeeXRP)
|
|
||||||
const totalFee =
|
|
||||||
tx.TransactionType === 'AccountDelete'
|
|
||||||
? baseFee
|
|
||||||
: BigNumber.min(baseFee, maxFeeDrops)
|
|
||||||
|
|
||||||
// Round up baseFee and return it as a string
|
|
||||||
// eslint-disable-next-line no-param-reassign, @typescript-eslint/no-magic-numbers -- param reassign is safe, base 10 magic num
|
|
||||||
tx.Fee = totalFee.dp(0, BigNumber.ROUND_CEIL).toString(10)
|
|
||||||
}
|
|
||||||
|
|
||||||
function scaleValue(value, multiplier): string {
|
|
||||||
return new BigNumber(value).times(multiplier).toString()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async function setLatestValidatedLedgerSequence(
|
async function setLatestValidatedLedgerSequence(
|
||||||
|
|||||||
@@ -50,15 +50,20 @@ export async function getFeeXrp(
|
|||||||
*
|
*
|
||||||
* @param client - The Client used to connect to the ledger.
|
* @param client - The Client used to connect to the ledger.
|
||||||
* @param txBlob - The encoded transaction to estimate the fee for.
|
* @param txBlob - The encoded transaction to estimate the fee for.
|
||||||
|
* @param signersCount - The number of multisigners.
|
||||||
* @returns The transaction fee.
|
* @returns The transaction fee.
|
||||||
*/
|
*/
|
||||||
export async function getFeeEstimateXrp(
|
export async function getFeeEstimateXrp(
|
||||||
client: Client,
|
client: Client,
|
||||||
txBlob: string,
|
txBlob: string,
|
||||||
|
signersCount = 0,
|
||||||
): Promise<string> {
|
): Promise<string> {
|
||||||
const response = await client.request({
|
const response = await client.request({
|
||||||
command: 'fee',
|
command: 'fee',
|
||||||
tx_blob: txBlob,
|
tx_blob: txBlob,
|
||||||
})
|
})
|
||||||
return response.result.drops.base_fee
|
const openLedgerFee = response.result.drops.open_ledger_fee
|
||||||
|
const baseFee = new BigNumber(response.result.drops.base_fee)
|
||||||
|
const totalFee = BigNumber.sum(openLedgerFee, Number(baseFee) * signersCount)
|
||||||
|
return new BigNumber(totalFee.toFixed(NUM_DECIMAL_PLACES)).toString(BASE_10)
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user