mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-07 06:15:49 +00:00
Compare commits
7 Commits
@transia/r
...
@transia/x
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
32fba22240 | ||
|
|
f4c244ec0a | ||
|
|
e1c80b5ede | ||
|
|
10ea540984 | ||
|
|
77e475ae2d | ||
|
|
3e929eff56 | ||
|
|
f570b89d71 |
8
package-lock.json
generated
8
package-lock.json
generated
@@ -17148,7 +17148,7 @@
|
||||
},
|
||||
"packages/ripple-binary-codec": {
|
||||
"name": "@transia/ripple-binary-codec",
|
||||
"version": "1.4.6-alpha.1",
|
||||
"version": "1.4.6-alpha.2",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"@transia/ripple-address-codec": "^4.2.8-alpha.0",
|
||||
@@ -17188,11 +17188,11 @@
|
||||
},
|
||||
"packages/xrpl": {
|
||||
"name": "@transia/xrpl",
|
||||
"version": "2.7.3-alpha.1",
|
||||
"version": "2.7.3-alpha.2",
|
||||
"license": "ISC",
|
||||
"dependencies": {
|
||||
"@transia/ripple-address-codec": "^4.2.8-alpha.0",
|
||||
"@transia/ripple-binary-codec": "^1.4.6-alpha.1",
|
||||
"@transia/ripple-binary-codec": "^1.4.6-alpha.2",
|
||||
"@transia/ripple-keypairs": "^1.1.8-alpha.0",
|
||||
"bignumber.js": "^9.0.0",
|
||||
"bip32": "^2.0.6",
|
||||
@@ -19388,7 +19388,7 @@
|
||||
"requires": {
|
||||
"@geut/browser-node-core": "^2.0.13",
|
||||
"@transia/ripple-address-codec": "^4.2.8-alpha.0",
|
||||
"@transia/ripple-binary-codec": "^1.4.6-alpha.1",
|
||||
"@transia/ripple-binary-codec": "^1.4.6-alpha.2",
|
||||
"@transia/ripple-keypairs": "^1.1.8-alpha.0",
|
||||
"@types/node": "^14.18.36",
|
||||
"assert-browserify": "^2.0.0",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@transia/ripple-binary-codec",
|
||||
"version": "1.4.6-alpha.1",
|
||||
"version": "1.4.6-alpha.2",
|
||||
"description": "XRP Ledger binary codec",
|
||||
"files": [
|
||||
"dist/*",
|
||||
|
||||
@@ -15,6 +15,7 @@ import { STObject } from './types/st-object'
|
||||
import { JsonObject } from './types/serialized-type'
|
||||
import { Buffer } from 'buffer/'
|
||||
import bigInt = require('big-integer')
|
||||
import { AmountObject } from './types/amount'
|
||||
|
||||
/**
|
||||
* Construct a BinaryParser
|
||||
@@ -122,7 +123,7 @@ function signingData(
|
||||
*/
|
||||
interface ClaimObject extends JsonObject {
|
||||
channel: string
|
||||
amount: string | number
|
||||
amount: AmountObject
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -133,16 +134,19 @@ interface ClaimObject extends JsonObject {
|
||||
* @returns the serialized object with appropriate prefix
|
||||
*/
|
||||
function signingClaimData(claim: ClaimObject): Buffer {
|
||||
const num = bigInt(String(claim.amount))
|
||||
const prefix = HashPrefix.paymentChannelClaim
|
||||
const channel = coreTypes.Hash256.from(claim.channel).toBytes()
|
||||
const amount = coreTypes.UInt64.from(num).toBytes()
|
||||
|
||||
const bytesList = new BytesList()
|
||||
|
||||
bytesList.put(prefix)
|
||||
bytesList.put(channel)
|
||||
bytesList.put(amount)
|
||||
if (typeof claim.amount === 'string') {
|
||||
const num = bigInt(String(claim.amount))
|
||||
const amount = coreTypes.UInt64.from(num).toBytes()
|
||||
bytesList.put(amount)
|
||||
} else {
|
||||
const amount = coreTypes.Amount.from(claim.amount).toBytes()
|
||||
bytesList.put(amount)
|
||||
}
|
||||
return bytesList.toBytes()
|
||||
}
|
||||
|
||||
|
||||
@@ -5,7 +5,10 @@ import {
|
||||
XrplDefinitionsBase,
|
||||
} from '../enums'
|
||||
import { SerializedType, JsonObject } from './serialized-type'
|
||||
import { xAddressToClassicAddress, isValidXAddress } from '@transia/ripple-address-codec'
|
||||
import {
|
||||
xAddressToClassicAddress,
|
||||
isValidXAddress,
|
||||
} from '@transia/ripple-address-codec'
|
||||
import { BinaryParser } from '../serdes/binary-parser'
|
||||
import { BinarySerializer, BytesList } from '../serdes/binary-serializer'
|
||||
import { Buffer } from 'buffer/'
|
||||
|
||||
@@ -170,59 +170,7 @@ describe('Signing data', function () {
|
||||
].join(''),
|
||||
)
|
||||
})
|
||||
|
||||
test('can create multi signing blobs with custom definitions', function () {
|
||||
const customPaymentDefinitions = JSON.parse(
|
||||
JSON.stringify(normalDefinitions),
|
||||
)
|
||||
customPaymentDefinitions.TRANSACTION_TYPES.Payment = 31
|
||||
|
||||
const newDefs = new XrplDefinitions(customPaymentDefinitions)
|
||||
const signingAccount = 'rJZdUusLDtY9NEsGea7ijqhVrXv98rYBYN'
|
||||
const signingJson = { ...tx_json, SigningPubKey: '' }
|
||||
const actual = encodeForMultisigning(signingJson, signingAccount, newDefs)
|
||||
expect(actual).toBe(
|
||||
[
|
||||
'534D5400', // signingPrefix
|
||||
// TransactionType
|
||||
'12',
|
||||
'001F',
|
||||
// Flags
|
||||
'22',
|
||||
'80000000',
|
||||
// Sequence
|
||||
'24',
|
||||
'00000001',
|
||||
// Amount
|
||||
'61',
|
||||
// native amount
|
||||
'40000000000003E8',
|
||||
// Fee
|
||||
'68',
|
||||
// native amount
|
||||
'400000000000000A',
|
||||
// SigningPubKey
|
||||
'73',
|
||||
// VLLength
|
||||
'00',
|
||||
// '',
|
||||
// Account
|
||||
'81',
|
||||
// VLLength
|
||||
'14',
|
||||
'5B812C9D57731E27A2DA8B1830195F88EF32A3B6',
|
||||
// Destination
|
||||
'83',
|
||||
// VLLength
|
||||
'14',
|
||||
'B5F762798A53D543A014CAF8B297CFF8F2F937E8',
|
||||
// signingAccount suffix
|
||||
'C0A5ABEF242802EFED4B041E8F2D4A8CC86AE3D1',
|
||||
].join(''),
|
||||
)
|
||||
})
|
||||
|
||||
test('can create claim blob', function () {
|
||||
test('can create native claim blob', function () {
|
||||
const channel =
|
||||
'43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1'
|
||||
const amount = '1000'
|
||||
@@ -239,4 +187,27 @@ describe('Signing data', function () {
|
||||
].join(''),
|
||||
)
|
||||
})
|
||||
test('can create ic claim blob', function () {
|
||||
const channel =
|
||||
'43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1'
|
||||
const amount = {
|
||||
issuer: 'rJZdUusLDtY9NEsGea7ijqhVrXv98rYBYN',
|
||||
currency: 'USD',
|
||||
value: '10',
|
||||
}
|
||||
const json = { channel, amount }
|
||||
const actual = encodeForSigningClaim(json)
|
||||
expect(actual).toBe(
|
||||
[
|
||||
// hash prefix
|
||||
'434C4D00',
|
||||
// channel ID
|
||||
'43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1',
|
||||
// amount as a uint64
|
||||
'D4C38D7EA4C680000000000000000000000000005553440000000000C0A5ABEF',
|
||||
// amount as a uint64
|
||||
'242802EFED4B041E8F2D4A8CC86AE3D1',
|
||||
].join(''),
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@transia/xrpl",
|
||||
"version": "2.7.3-alpha.1",
|
||||
"version": "2.7.3-alpha.2",
|
||||
"license": "ISC",
|
||||
"description": "A TypeScript/JavaScript API for interacting with the XRP Ledger in Node.js and the browser",
|
||||
"files": [
|
||||
@@ -23,7 +23,7 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"@transia/ripple-address-codec": "^4.2.8-alpha.0",
|
||||
"@transia/ripple-binary-codec": "^1.4.6-alpha.1",
|
||||
"@transia/ripple-binary-codec": "^1.4.6-alpha.2",
|
||||
"@transia/ripple-keypairs": "^1.1.8-alpha.0",
|
||||
"bignumber.js": "^9.0.0",
|
||||
"bip32": "^2.0.6",
|
||||
|
||||
@@ -1,9 +1,4 @@
|
||||
/* eslint-disable max-lines -- There are lots of equivalent constructors which make sense to have here. */
|
||||
import BigNumber from 'bignumber.js'
|
||||
import { fromSeed } from 'bip32'
|
||||
import { mnemonicToSeedSync, validateMnemonic } from 'bip39'
|
||||
import isEqual from 'lodash/isEqual'
|
||||
import omitBy from 'lodash/omitBy'
|
||||
import {
|
||||
classicAddressToXAddress,
|
||||
isValidXAddress,
|
||||
@@ -23,6 +18,11 @@ import {
|
||||
verify,
|
||||
sign,
|
||||
} from '@transia/ripple-keypairs'
|
||||
import BigNumber from 'bignumber.js'
|
||||
import { fromSeed } from 'bip32'
|
||||
import { mnemonicToSeedSync, validateMnemonic } from 'bip39'
|
||||
import isEqual from 'lodash/isEqual'
|
||||
import omitBy from 'lodash/omitBy'
|
||||
|
||||
import ECDSA from '../ECDSA'
|
||||
import { ValidationError, XrplError } from '../errors'
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
import { BigNumber } from 'bignumber.js'
|
||||
import { flatMap } from 'lodash'
|
||||
import { decodeAccountID } from '@transia/ripple-address-codec'
|
||||
import {
|
||||
decode,
|
||||
@@ -8,6 +6,8 @@ import {
|
||||
encodeForSigningClaim,
|
||||
} from '@transia/ripple-binary-codec'
|
||||
import { sign as signWithKeypair, verify } from '@transia/ripple-keypairs'
|
||||
import { BigNumber } from 'bignumber.js'
|
||||
import { flatMap } from 'lodash'
|
||||
|
||||
import { ValidationError } from '../errors'
|
||||
import { Signer } from '../models/common'
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import BigNumber from 'bignumber.js'
|
||||
import { decode } from '@transia/ripple-binary-codec'
|
||||
import BigNumber from 'bignumber.js'
|
||||
|
||||
import type {
|
||||
AccountTxResponse,
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
import { Amount } from '../common'
|
||||
|
||||
import BaseLedgerEntry from './BaseLedgerEntry'
|
||||
|
||||
/**
|
||||
* The Escrow object type represents a held payment of XRP waiting to be
|
||||
* The Escrow object type represents a held payment waiting to be
|
||||
* executed or canceled.
|
||||
*
|
||||
* @category Ledger Entries
|
||||
@@ -10,17 +12,17 @@ export default interface Escrow extends BaseLedgerEntry {
|
||||
LedgerEntryType: 'Escrow'
|
||||
/**
|
||||
* The address of the owner (sender) of this held payment. This is the
|
||||
* account that provided the XRP, and gets it back if the held payment is
|
||||
* account that provided the amounts, and gets it back if the held payment is
|
||||
* canceled.
|
||||
*/
|
||||
Account: string
|
||||
/**
|
||||
* The destination address where the XRP is paid if the held payment is
|
||||
* The destination address where the amounts are paid if the held payment is
|
||||
* successful.
|
||||
*/
|
||||
Destination: string
|
||||
/** The amount of XRP, in drops, to be delivered by the held payment. */
|
||||
Amount: string
|
||||
/** The amount to be delivered by the held payment. */
|
||||
Amount: Amount
|
||||
/**
|
||||
* A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the
|
||||
* EscrowFinish transaction must contain a fulfillment that satisfies this
|
||||
@@ -71,4 +73,9 @@ export default interface Escrow extends BaseLedgerEntry {
|
||||
* modified this object.
|
||||
*/
|
||||
PreviousTxnLgrSeq: number
|
||||
/**
|
||||
* The fee to charge when users finish an escrow, initially set on the
|
||||
* creation of an escrow contract, and updated on subsequent finish transactions
|
||||
*/
|
||||
TransferRate?: number
|
||||
}
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
import { Amount } from '../common'
|
||||
|
||||
import BaseLedgerEntry from './BaseLedgerEntry'
|
||||
|
||||
/**
|
||||
* The PayChannel object type represents a payment channel. Payment channels
|
||||
* enable small, rapid off-ledger payments of XRP that can be later reconciled
|
||||
* with the consensus ledger. A payment channel holds a balance of XRP that can
|
||||
* enable small, rapid off-ledger payments that can be later reconciled
|
||||
* with the consensus ledger. A payment channel holds a balance that can
|
||||
* only be paid out to a specific destination address until the channel is
|
||||
* closed.
|
||||
*
|
||||
@@ -18,37 +20,37 @@ export default interface PayChannel extends BaseLedgerEntry {
|
||||
Account: string
|
||||
/**
|
||||
* The destination address for this payment channel. While the payment
|
||||
* channel is open, this address is the only one that can receive XRP from the
|
||||
* channel is open, this address is the only one that can receive amounts from the
|
||||
* channel. This comes from the Destination field of the transaction that
|
||||
* created the channel.
|
||||
*/
|
||||
Destination: string
|
||||
/**
|
||||
* Total XRP, in drops, that has been allocated to this channel. This
|
||||
* includes XRP that has been paid to the destination address. This is
|
||||
* initially set by the transaction that created the channel and can be
|
||||
* increased if the source address sends a PaymentChannelFund transaction.
|
||||
* Total amount that has been allocated to this channel. This includes amounts
|
||||
* that have been paid to the destination address. This is initially set by the
|
||||
* transaction that created the channel and can be increased if the source
|
||||
* address sends a PaymentChannelFund transaction.
|
||||
*/
|
||||
Amount: string
|
||||
Amount: Amount
|
||||
/**
|
||||
* Total XRP, in drops, already paid out by the channel. The difference
|
||||
* between this value and the Amount field is how much XRP can still be paid
|
||||
* to the destination address with PaymentChannelClaim transactions. If the
|
||||
* channel closes, the remaining difference is returned to the source address.
|
||||
* Total amount already paid out by the channel. The difference between this value
|
||||
* and the Amount field is how much can still be paid to the destination address
|
||||
* with PaymentChannelClaim transactions. If the channel closes, the remaining
|
||||
* difference is returned to the source address.
|
||||
*/
|
||||
Balance: string
|
||||
Balance: Amount
|
||||
/**
|
||||
* Public key, in hexadecimal, of the key pair that can be used to sign
|
||||
* claims against this channel. This can be any valid secp256k1 or Ed25519
|
||||
* public key. This is set by the transaction that created the channel and
|
||||
* must match the public key used in claims against the channel. The channel
|
||||
* source address can also send XRP from this channel to the destination
|
||||
* source address can also send amounts from this channel to the destination
|
||||
* without signed claims.
|
||||
*/
|
||||
PublicKey: string
|
||||
/**
|
||||
* Number of seconds the source address must wait to close the channel if
|
||||
* it still has any XRP in it. Smaller values mean that the destination
|
||||
* it still has any amount in it. Smaller values mean that the destination
|
||||
* address has less time to redeem any outstanding claims after the source
|
||||
* address requests to close the channel. Can be any value that fits in a
|
||||
* 32-bit unsigned integer (0 to 2^32-1). This is set by the transaction that
|
||||
@@ -104,4 +106,10 @@ export default interface PayChannel extends BaseLedgerEntry {
|
||||
* this object, in case the directory consists of multiple pages.
|
||||
*/
|
||||
DestinationNode?: string
|
||||
/**
|
||||
* The fee to charge when users make claims on a payment channel, initially
|
||||
* set on the creation of a payment channel and updated on subsequent funding
|
||||
* or claim transactions.
|
||||
*/
|
||||
TransferRate?: number
|
||||
}
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
import { LedgerIndex } from '../common'
|
||||
import { Amount, LedgerIndex } from '../common'
|
||||
|
||||
import { BaseRequest, BaseResponse } from './baseMethod'
|
||||
|
||||
interface Channel {
|
||||
account: string
|
||||
amount: string
|
||||
amount: Amount
|
||||
balance: string
|
||||
channel_id: string
|
||||
destination_account: string
|
||||
@@ -15,6 +15,7 @@ interface Channel {
|
||||
cancel_after?: number
|
||||
source_tab?: number
|
||||
destination_tag?: number
|
||||
transfer_rate?: number
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { LedgerIndex } from '../common'
|
||||
import { Amount, LedgerIndex } from '../common'
|
||||
|
||||
import { BaseRequest, BaseResponse } from './baseMethod'
|
||||
|
||||
@@ -64,6 +64,14 @@ export interface Trustline {
|
||||
* false.
|
||||
*/
|
||||
freeze_peer?: boolean
|
||||
/**
|
||||
* The total amount of FT, in drops/Amount locked in payment channels or escrow.
|
||||
*/
|
||||
locked_balance?: Amount
|
||||
/**
|
||||
* The total number of lock balances on a RippleState ledger object.
|
||||
*/
|
||||
lock_count?: number
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -9,7 +9,7 @@ import { BaseRequest, BaseResponse } from './baseMethod'
|
||||
*/
|
||||
export interface ChannelVerifyRequest extends BaseRequest {
|
||||
command: 'channel_verify'
|
||||
/** The amount of XRP, in drops, the provided signature authorizes. */
|
||||
/** The amount the provided signature authorizes. */
|
||||
amount: string
|
||||
/**
|
||||
* The Channel ID of the channel that provides the XRP. This is a
|
||||
|
||||
@@ -3,7 +3,7 @@ import { ValidationError } from '../../errors'
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Return escrowed XRP to the sender.
|
||||
* Return escrowed amount to the sender.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
|
||||
@@ -1,22 +1,23 @@
|
||||
/* eslint-disable complexity -- Necessary for validateEscrowCreate */
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Amount } from '../common'
|
||||
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
import { BaseTransaction, isAmount, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Sequester XRP until the escrow process either finishes or is canceled.
|
||||
* Sequester amount until the escrow process either finishes or is canceled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface EscrowCreate extends BaseTransaction {
|
||||
TransactionType: 'EscrowCreate'
|
||||
/**
|
||||
* Amount of XRP, in drops, to deduct from the sender's balance and escrow.
|
||||
* Once escrowed, the XRP can either go to the Destination address (after the.
|
||||
* FinishAfter time) or returned to the sender (after the CancelAfter time).
|
||||
* Amount to deduct from the sender's balance and escrow. Once escrowed, the
|
||||
* amount can either go to the Destination address (after the FinishAfter time)
|
||||
* or returned to the sender (after the CancelAfter time).
|
||||
*/
|
||||
Amount: string
|
||||
/** Address to receive escrowed XRP. */
|
||||
Amount: Amount
|
||||
/** Address to receive escrowed amount. */
|
||||
Destination: string
|
||||
/**
|
||||
* The time, in seconds since the Ripple Epoch, when this escrow expires.
|
||||
@@ -25,7 +26,7 @@ export interface EscrowCreate extends BaseTransaction {
|
||||
*/
|
||||
CancelAfter?: number
|
||||
/**
|
||||
* The time, in seconds since the Ripple Epoch, when the escrowed XRP can be
|
||||
* The time, in seconds since the Ripple Epoch, when the escrowed amount can be
|
||||
* released to the recipient. This value is immutable; the funds cannot move.
|
||||
* until this time is reached.
|
||||
*/
|
||||
@@ -55,8 +56,8 @@ export function validateEscrowCreate(tx: Record<string, unknown>): void {
|
||||
throw new ValidationError('EscrowCreate: missing field Amount')
|
||||
}
|
||||
|
||||
if (typeof tx.Amount !== 'string') {
|
||||
throw new ValidationError('EscrowCreate: Amount must be a string')
|
||||
if (typeof tx.Amount !== 'string' && !isAmount(tx.Amount)) {
|
||||
throw new ValidationError('EscrowCreate: Amount must be an Amount')
|
||||
}
|
||||
|
||||
if (tx.Destination === undefined) {
|
||||
|
||||
@@ -3,7 +3,7 @@ import { ValidationError } from '../../errors'
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Deliver XRP from a held payment to the recipient.
|
||||
* Deliver amount from a held payment to the recipient.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
|
||||
@@ -48,3 +48,12 @@ export { SetHookFlagsInterface, SetHookFlags, SetHook } from './setHook'
|
||||
export { SignerListSet } from './signerListSet'
|
||||
export { TicketCreate } from './ticketCreate'
|
||||
export { TrustSetFlagsInterface, TrustSetFlags, TrustSet } from './trustSet'
|
||||
export {
|
||||
URITokenMintFlagsInterface,
|
||||
URITokenMintFlags,
|
||||
URITokenMint,
|
||||
} from './uriTokenMint'
|
||||
export { URITokenBurn } from './uriTokenBurn'
|
||||
export { URITokenCreateSellOffer } from './uriTokenCreateSellOffer'
|
||||
export { URITokenBuy } from './uriTokenBuy'
|
||||
export { URITokenCancelSellOffer } from './uriTokenCancelSellOffer'
|
||||
|
||||
@@ -74,7 +74,7 @@ export function isDeletedNode(node: Node): node is DeletedNode {
|
||||
}
|
||||
|
||||
export interface TransactionMetadata {
|
||||
HookExecutions: HookExecution[]
|
||||
HookExecutions?: HookExecution[]
|
||||
AffectedNodes: Node[]
|
||||
DeliveredAmount?: Amount
|
||||
// "unavailable" possible for transactions before 2014-01-20
|
||||
|
||||
@@ -1,7 +1,13 @@
|
||||
/* eslint-disable complexity -- Necessary for validatePaymentChannelClaim */
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Amount } from '../common'
|
||||
|
||||
import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
|
||||
import {
|
||||
BaseTransaction,
|
||||
GlobalFlags,
|
||||
validateBaseTransaction,
|
||||
isAmount,
|
||||
} from './common'
|
||||
|
||||
/**
|
||||
* Enum representing values for PaymentChannelClaim transaction flags.
|
||||
@@ -18,15 +24,15 @@ export enum PaymentChannelClaimFlags {
|
||||
/**
|
||||
* Request to close the channel. Only the channel source and destination
|
||||
* addresses can use this flag. This flag closes the channel immediately if it
|
||||
* has no more XRP allocated to it after processing the current claim, or if
|
||||
* has no more funds allocated to it after processing the current claim, or if
|
||||
* the destination address uses it. If the source address uses this flag when
|
||||
* the channel still holds XRP, this schedules the channel to close after
|
||||
* the channel still holds an amount, this schedules the channel to close after
|
||||
* SettleDelay seconds have passed. (Specifically, this sets the Expiration of
|
||||
* the channel to the close time of the previous ledger plus the channel's
|
||||
* SettleDelay time, unless the channel already has an earlier Expiration
|
||||
* time.) If the destination address uses this flag when the channel still
|
||||
* holds XRP, any XRP that remains after processing the claim is returned to
|
||||
* the source address.
|
||||
* holds an amount, any amount that remains after processing the claim is
|
||||
* returned to the source address.
|
||||
*/
|
||||
tfClose = 0x00020000,
|
||||
}
|
||||
@@ -78,21 +84,21 @@ export interface PaymentChannelClaimFlagsInterface extends GlobalFlags {
|
||||
/**
|
||||
* Request to close the channel. Only the channel source and destination
|
||||
* addresses can use this flag. This flag closes the channel immediately if it
|
||||
* has no more XRP allocated to it after processing the current claim, or if
|
||||
* has no more funds allocated to it after processing the current claim, or if
|
||||
* the destination address uses it. If the source address uses this flag when
|
||||
* the channel still holds XRP, this schedules the channel to close after
|
||||
* the channel still holds an amount, this schedules the channel to close after
|
||||
* SettleDelay seconds have passed. (Specifically, this sets the Expiration of
|
||||
* the channel to the close time of the previous ledger plus the channel's
|
||||
* SettleDelay time, unless the channel already has an earlier Expiration
|
||||
* time.) If the destination address uses this flag when the channel still
|
||||
* holds XRP, any XRP that remains after processing the claim is returned to
|
||||
* the source address.
|
||||
* holds an amount, any amount that remains after processing the claim is
|
||||
* returned to the source address.
|
||||
*/
|
||||
tfClose?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Claim XRP from a payment channel, adjust the payment channel's expiration,
|
||||
* Claim amount from a payment channel, adjust the payment channel's expiration,
|
||||
* or both.
|
||||
*
|
||||
* @category Transaction Models
|
||||
@@ -103,18 +109,18 @@ export interface PaymentChannelClaim extends BaseTransaction {
|
||||
/** The unique ID of the channel as a 64-character hexadecimal string. */
|
||||
Channel: string
|
||||
/**
|
||||
* Total amount of XRP, in drops, delivered by this channel after processing
|
||||
* this claim. Required to deliver XRP. Must be more than the total amount
|
||||
* delivered by the channel so far, but not greater than the Amount of the
|
||||
* signed claim. Must be provided except when closing the channel.
|
||||
* Total amount delivered by this channel after processing this claim. Required
|
||||
* to deliver amount. Must be more than the total amount delivered by the channel
|
||||
* so far, but not greater than the Amount of the signed claim. Must be provided
|
||||
* except when closing the channel.
|
||||
*/
|
||||
Balance?: string
|
||||
Balance?: Amount
|
||||
/**
|
||||
* The amount of XRP, in drops, authorized by the Signature. This must match
|
||||
* the amount in the signed message. This is the cumulative amount of XRP that
|
||||
* can be dispensed by the channel, including XRP previously redeemed.
|
||||
* The amount authorized by the Signature. This must match the amount in the
|
||||
* signed message. This is the cumulative amount that can be dispensed by the
|
||||
* channel, including amounts previously redeemed. Required unless closing the channel.
|
||||
*/
|
||||
Amount?: string
|
||||
Amount?: Amount
|
||||
/**
|
||||
* The signature of this claim, as hexadecimal. The signed message contains
|
||||
* the channel ID and the amount of the claim. Required unless the sender of
|
||||
@@ -147,12 +153,12 @@ export function validatePaymentChannelClaim(tx: Record<string, unknown>): void {
|
||||
throw new ValidationError('PaymentChannelClaim: Channel must be a string')
|
||||
}
|
||||
|
||||
if (tx.Balance !== undefined && typeof tx.Balance !== 'string') {
|
||||
throw new ValidationError('PaymentChannelClaim: Balance must be a string')
|
||||
if (tx.Balance !== undefined && !isAmount(tx.Balance)) {
|
||||
throw new ValidationError('PaymentChannelClaim: Balance must be an Amount')
|
||||
}
|
||||
|
||||
if (tx.Amount !== undefined && typeof tx.Amount !== 'string') {
|
||||
throw new ValidationError('PaymentChannelClaim: Amount must be a string')
|
||||
if (tx.Amount !== undefined && !isAmount(tx.Amount)) {
|
||||
throw new ValidationError('PaymentChannelClaim: Amount must be an Amount')
|
||||
}
|
||||
|
||||
if (tx.Signature !== undefined && typeof tx.Signature !== 'string') {
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
/* eslint-disable complexity -- Necessary for validatePaymentChannelCreate */
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Amount } from '../common'
|
||||
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
import { BaseTransaction, validateBaseTransaction, isAmount } from './common'
|
||||
|
||||
/**
|
||||
* Create a unidirectional channel and fund it with XRP. The address sending
|
||||
* Create a unidirectional channel and fund it. The address sending
|
||||
* this transaction becomes the "source address" of the payment channel.
|
||||
*
|
||||
* @category Transaction Models
|
||||
@@ -12,20 +13,20 @@ import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
export interface PaymentChannelCreate extends BaseTransaction {
|
||||
TransactionType: 'PaymentChannelCreate'
|
||||
/**
|
||||
* Amount of XRP, in drops, to deduct from the sender's balance and set aside
|
||||
* in this channel. While the channel is open, the XRP can only go to the
|
||||
* Destination address. When the channel closes, any unclaimed XRP is returned
|
||||
* to the source address's balance.
|
||||
* Amount to deduct from the sender's balance and set aside in this channel.
|
||||
* While the channel is open, the amount can only go to the Destination
|
||||
* address. When the channel closes, any unclaimed amount is returned to
|
||||
* the source address's balance.
|
||||
*/
|
||||
Amount: string
|
||||
Amount: Amount
|
||||
/**
|
||||
* Address to receive XRP claims against this channel. This is also known as
|
||||
* Address to receive claims against this channel. This is also known as
|
||||
* the "destination address" for the channel.
|
||||
*/
|
||||
Destination: string
|
||||
/**
|
||||
* Amount of time the source address must wait before closing the channel if
|
||||
* it has unclaimed XRP.
|
||||
* it has unclaimed amount.
|
||||
*/
|
||||
SettleDelay: number
|
||||
/**
|
||||
@@ -65,8 +66,8 @@ export function validatePaymentChannelCreate(
|
||||
throw new ValidationError('PaymentChannelCreate: missing Amount')
|
||||
}
|
||||
|
||||
if (typeof tx.Amount !== 'string') {
|
||||
throw new ValidationError('PaymentChannelCreate: Amount must be a string')
|
||||
if (typeof tx.Amount !== 'string' && !isAmount(tx.Amount)) {
|
||||
throw new ValidationError('PaymentChannelCreate: Amount must be an Amount')
|
||||
}
|
||||
|
||||
if (tx.Destination === undefined) {
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Amount } from '../common'
|
||||
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
import { BaseTransaction, validateBaseTransaction, isAmount } from './common'
|
||||
|
||||
/**
|
||||
* Add additional XRP to an open payment channel, and optionally update the
|
||||
* Add additional amount to an open payment channel, and optionally update the
|
||||
* expiration time of the channel. Only the source address of the channel can
|
||||
* use this transaction.
|
||||
*
|
||||
@@ -17,16 +18,15 @@ export interface PaymentChannelFund extends BaseTransaction {
|
||||
*/
|
||||
Channel: string
|
||||
/**
|
||||
* Amount of XRP in drops to add to the channel. Must be a positive amount
|
||||
* of XRP.
|
||||
* Amount to add to the channel. Must be a positive amount
|
||||
*/
|
||||
Amount: string
|
||||
Amount: Amount
|
||||
/**
|
||||
* New Expiration time to set for the channel in seconds since the Ripple
|
||||
* Epoch. This must be later than either the current time plus the SettleDelay
|
||||
* of the channel, or the existing Expiration of the channel. After the
|
||||
* Expiration time, any transaction that would access the channel closes the
|
||||
* channel without taking its normal action. Any unspent XRP is returned to
|
||||
* channel without taking its normal action. Any unspent amount is returned to
|
||||
* the source address when the channel closes. (Expiration is separate from
|
||||
* the channel's immutable CancelAfter time.) For more information, see the
|
||||
* PayChannel ledger object type.
|
||||
@@ -55,8 +55,8 @@ export function validatePaymentChannelFund(tx: Record<string, unknown>): void {
|
||||
throw new ValidationError('PaymentChannelFund: missing Amount')
|
||||
}
|
||||
|
||||
if (typeof tx.Amount !== 'string') {
|
||||
throw new ValidationError('PaymentChannelFund: Amount must be a string')
|
||||
if (typeof tx.Amount !== 'string' && !isAmount(tx.Amount)) {
|
||||
throw new ValidationError('PaymentChannelFund: Amount must be an Amount')
|
||||
}
|
||||
|
||||
if (tx.Expiration !== undefined && typeof tx.Expiration !== 'number') {
|
||||
|
||||
@@ -50,6 +50,17 @@ import { SetRegularKey, validateSetRegularKey } from './setRegularKey'
|
||||
import { SignerListSet, validateSignerListSet } from './signerListSet'
|
||||
import { TicketCreate, validateTicketCreate } from './ticketCreate'
|
||||
import { TrustSet, validateTrustSet } from './trustSet'
|
||||
import { URITokenBurn, validateURITokenBurn } from './uriTokenBurn'
|
||||
import { URITokenBuy, validateURITokenBuy } from './uriTokenBuy'
|
||||
import {
|
||||
URITokenCancelSellOffer,
|
||||
validateURITokenCancelSellOffer,
|
||||
} from './uriTokenCancelSellOffer'
|
||||
import {
|
||||
URITokenCreateSellOffer,
|
||||
validateURITokenCreateSellOffer,
|
||||
} from './uriTokenCreateSellOffer'
|
||||
import { URITokenMint, validateURITokenMint } from './uriTokenMint'
|
||||
|
||||
/**
|
||||
* @category Transaction Models
|
||||
@@ -82,6 +93,11 @@ export type Transaction =
|
||||
| SignerListSet
|
||||
| TicketCreate
|
||||
| TrustSet
|
||||
| URITokenBurn
|
||||
| URITokenBuy
|
||||
| URITokenCancelSellOffer
|
||||
| URITokenMint
|
||||
| URITokenCreateSellOffer
|
||||
|
||||
/**
|
||||
* @category Transaction Models
|
||||
@@ -218,6 +234,26 @@ export function validate(transaction: Record<string, unknown>): void {
|
||||
validateTrustSet(tx)
|
||||
break
|
||||
|
||||
case 'URITokenMint':
|
||||
validateURITokenMint(tx)
|
||||
break
|
||||
|
||||
case 'URITokenBurn':
|
||||
validateURITokenBurn(tx)
|
||||
break
|
||||
|
||||
case 'URITokenCreateSellOffer':
|
||||
validateURITokenCreateSellOffer(tx)
|
||||
break
|
||||
|
||||
case 'URITokenBuy':
|
||||
validateURITokenBuy(tx)
|
||||
break
|
||||
|
||||
case 'URITokenCancelSellOffer':
|
||||
validateURITokenCancelSellOffer(tx)
|
||||
break
|
||||
|
||||
default:
|
||||
throw new ValidationError(
|
||||
`Invalid field TransactionType: ${tx.TransactionType}`,
|
||||
|
||||
60
packages/xrpl/src/models/transactions/uriTokenBurn.ts
Normal file
60
packages/xrpl/src/models/transactions/uriTokenBurn.ts
Normal file
@@ -0,0 +1,60 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenBurn} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenBurn = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* TransactionType: 'URITokenBurn',
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* // TransactionType: 'URITokenBurn',
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
|
||||
/**
|
||||
* An URITokenBurn transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenBurn extends BaseTransaction {
|
||||
TransactionType: 'URITokenBurn'
|
||||
/**
|
||||
* Identifies the URIToken object to be removed by the transaction.
|
||||
*/
|
||||
URITokenID: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenBurn at runtime.
|
||||
*
|
||||
* @param tx - An URITokenBurn Transaction.
|
||||
* @throws When the URITokenBurn is Malformed.
|
||||
*/
|
||||
export function validateURITokenBurn(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (tx.URITokenID == null) {
|
||||
throw new ValidationError('NFTokenBurn: missing field URITokenID')
|
||||
}
|
||||
}
|
||||
83
packages/xrpl/src/models/transactions/uriTokenBuy.ts
Normal file
83
packages/xrpl/src/models/transactions/uriTokenBuy.ts
Normal file
@@ -0,0 +1,83 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Amount } from '../common'
|
||||
|
||||
import { BaseTransaction, isAmount, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenBuy} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenBuy = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* Amount: '1000000',
|
||||
* TransactionType: 'URITokenBuy',
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* // Amount: '1000000',
|
||||
* // TransactionType: 'URITokenBuy',
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
|
||||
/**
|
||||
* An URITokenBuy transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenBuy extends BaseTransaction {
|
||||
TransactionType: 'URITokenBuy'
|
||||
/**
|
||||
* Identifies the URITokenID of the NFToken object that the
|
||||
* offer references.
|
||||
*/
|
||||
URITokenID: string
|
||||
/**
|
||||
* Indicates the amount expected or offered for the Token.
|
||||
*
|
||||
* The amount must be non-zero, except when this is a sell
|
||||
* offer and the asset is XRP. This would indicate that the current
|
||||
* owner of the token is giving it away free, either to anyone at all,
|
||||
* or to the account identified by the Destination field.
|
||||
*/
|
||||
Amount: Amount
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenBuy at runtime.
|
||||
*
|
||||
* @param tx - An URITokenBuy Transaction.
|
||||
* @throws When the URITokenBuy is Malformed.
|
||||
*/
|
||||
export function validateURITokenBuy(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (tx.Account === tx.Destination) {
|
||||
throw new ValidationError(
|
||||
'URITokenBuy: Destination and Account must not be equal',
|
||||
)
|
||||
}
|
||||
|
||||
if (tx.URITokenID == null) {
|
||||
throw new ValidationError('URITokenBuy: missing field URITokenID')
|
||||
}
|
||||
|
||||
if (!isAmount(tx.Amount)) {
|
||||
throw new ValidationError('URITokenBuy: invalid Amount')
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,65 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
|
||||
import { BaseTransaction, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenCancelSellOffer} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenCancelSellOffer = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* TransactionType: 'URITokenCancelSellOffer',
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* // TransactionType: 'URITokenCancelSellOffer',
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
|
||||
/**
|
||||
* An URITokenCancelSellOffer transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenCancelSellOffer extends BaseTransaction {
|
||||
TransactionType: 'URITokenCancelSellOffer'
|
||||
/**
|
||||
* Identifies the URITokenID of the NFToken object that the
|
||||
* offer references.
|
||||
*/
|
||||
URITokenID: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenCancelSellOffer at runtime.
|
||||
*
|
||||
* @param tx - An URITokenCancelSellOffer Transaction.
|
||||
* @throws When the URITokenCancelSellOffer is Malformed.
|
||||
*/
|
||||
export function validateURITokenCancelSellOffer(
|
||||
tx: Record<string, unknown>,
|
||||
): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (tx.URITokenID == null) {
|
||||
throw new ValidationError(
|
||||
'URITokenCancelSellOffer: missing field URITokenID',
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Amount } from '../common'
|
||||
|
||||
import { BaseTransaction, isAmount, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenCreateSellOffer} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenCreateSellOffer = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* Amount: '1000000',
|
||||
* TransactionType: 'URITokenCreateSellOffer',
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URITokenID: '7AFCE32EBA8BD310CC2D00BE10B76E2183337EA20444D4580E4DBDB396C101FB',
|
||||
* // Amount: '1000000',
|
||||
* // TransactionType: 'URITokenCreateSellOffer',
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
|
||||
/**
|
||||
* An URITokenCreateSellOffer transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenCreateSellOffer extends BaseTransaction {
|
||||
TransactionType: 'URITokenCreateSellOffer'
|
||||
/**
|
||||
* Identifies the URITokenID of the NFToken object that the
|
||||
* offer references.
|
||||
*/
|
||||
URITokenID: string
|
||||
/**
|
||||
* Indicates the amount expected or offered for the Token.
|
||||
*
|
||||
* The amount must be non-zero, except when this is a sell
|
||||
* offer and the asset is XRP. This would indicate that the current
|
||||
* owner of the token is giving it away free, either to anyone at all,
|
||||
* or to the account identified by the Destination field.
|
||||
*/
|
||||
Amount: Amount
|
||||
/**
|
||||
* If present, indicates that this offer may only be
|
||||
* accepted by the specified account. Attempts by other
|
||||
* accounts to accept this offer MUST fail.
|
||||
*/
|
||||
Destination?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenCreateSellOffer at runtime.
|
||||
*
|
||||
* @param tx - An URITokenCreateSellOffer Transaction.
|
||||
* @throws When the URITokenCreateSellOffer is Malformed.
|
||||
*/
|
||||
export function validateURITokenCreateSellOffer(
|
||||
tx: Record<string, unknown>,
|
||||
): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (tx.Account === tx.Destination) {
|
||||
throw new ValidationError(
|
||||
'URITokenCreateSellOffer: Destination and Account must not be equal',
|
||||
)
|
||||
}
|
||||
|
||||
if (tx.URITokenID == null) {
|
||||
throw new ValidationError(
|
||||
'URITokenCreateSellOffer: missing field URITokenID',
|
||||
)
|
||||
}
|
||||
|
||||
if (!isAmount(tx.Amount)) {
|
||||
throw new ValidationError('URITokenCreateSellOffer: invalid Amount')
|
||||
}
|
||||
}
|
||||
92
packages/xrpl/src/models/transactions/uriTokenMint.ts
Normal file
92
packages/xrpl/src/models/transactions/uriTokenMint.ts
Normal file
@@ -0,0 +1,92 @@
|
||||
import { ValidationError } from '../../errors'
|
||||
import { isHex } from '../utils'
|
||||
|
||||
import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
|
||||
|
||||
/**
|
||||
* Transaction Flags for an URITokenMint Transaction.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*/
|
||||
export enum URITokenMintFlags {
|
||||
/**
|
||||
* If set, indicates that the minted token may be burned by the issuer even
|
||||
* if the issuer does not currently hold the token. The current holder of
|
||||
* the token may always burn it.
|
||||
*/
|
||||
tfBurnable = 0x00000001,
|
||||
}
|
||||
|
||||
/**
|
||||
* Map of flags to boolean values representing {@link URITokenMint} transaction
|
||||
* flags.
|
||||
*
|
||||
* @category Transaction Flags
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const tx: URITokenMint = {
|
||||
* Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* URI: '697066733A2F2F434944',
|
||||
* TransactionType: 'URITokenMint',
|
||||
* Flags: {
|
||||
* tfBurnable: true,
|
||||
* },
|
||||
* }
|
||||
*
|
||||
* // Autofill the tx to see how flags actually look compared to the interface usage.
|
||||
* const autofilledTx = await client.autofill(tx)
|
||||
* console.log(autofilledTx)
|
||||
* // {
|
||||
* // Account: 'rhFcpWDHLqpBmX4ezWiA5VLSS4e1BHqhHd',
|
||||
* // URI: '697066733A2F2F434944',
|
||||
* // TransactionType: 'URITokenMint',
|
||||
* // Flags: 0,
|
||||
* // Sequence: 21970384,
|
||||
* // Fee: '12',
|
||||
* // LastLedgerSequence: 21970404
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
export interface URITokenMintFlagsInterface extends GlobalFlags {
|
||||
tfBurnable?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* An URITokenMint transaction is effectively a limit order . It defines an
|
||||
* intent to exchange currencies, and creates an Offer object if not completely.
|
||||
* Fulfilled when placed. Offers can be partially fulfilled.
|
||||
*
|
||||
* @category Transaction Models
|
||||
*/
|
||||
export interface URITokenMint extends BaseTransaction {
|
||||
TransactionType: 'URITokenMint'
|
||||
Flags?: number | URITokenMintFlagsInterface
|
||||
/**
|
||||
* URI that points to the data and/or metadata associated with the NFT.
|
||||
* This field need not be an HTTP or HTTPS URL; it could be an IPFS URI, a
|
||||
* magnet link, immediate data encoded as an RFC2379 "data" URL, or even an
|
||||
* opaque issuer-specific encoding. The URI is NOT checked for validity, but
|
||||
* the field is limited to a maximum length of 256 bytes.
|
||||
*
|
||||
* This field must be hex-encoded. You can use `convertStringToHex` to
|
||||
* convert this field to the proper encoding.
|
||||
*/
|
||||
URI: string
|
||||
|
||||
Digest?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify the form and type of an URITokenMint at runtime.
|
||||
*
|
||||
* @param tx - An URITokenMint Transaction.
|
||||
* @throws When the URITokenMint is Malformed.
|
||||
*/
|
||||
export function validateURITokenMint(tx: Record<string, unknown>): void {
|
||||
validateBaseTransaction(tx)
|
||||
|
||||
if (typeof tx.URI === 'string' && !isHex(tx.URI)) {
|
||||
throw new ValidationError('URITokenMint: URI must be in hex format')
|
||||
}
|
||||
}
|
||||
@@ -2,6 +2,7 @@
|
||||
/* eslint-disable no-bitwise -- flags require bitwise operations */
|
||||
|
||||
import { ValidationError } from '../../errors'
|
||||
import { Hook } from '../common'
|
||||
import {
|
||||
AccountRootFlagsInterface,
|
||||
AccountRootFlags,
|
||||
@@ -78,10 +79,10 @@ export function setTransactionFlagsToNumber(tx: Transaction): void {
|
||||
return
|
||||
case 'SetHook':
|
||||
tx.Flags = convertSetHookFlagsToNumber(tx.Flags)
|
||||
tx.Hooks.forEach((h) => {
|
||||
h.Hook.Flags = convertSetHookFlagsToNumber(
|
||||
tx.Hooks.forEach((hook: Hook) => {
|
||||
hook.Hook.Flags = convertSetHookFlagsToNumber(
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- idk
|
||||
h.Hook.Flags as SetHookFlagsInterface,
|
||||
hook.Hook.Flags as SetHookFlagsInterface,
|
||||
)
|
||||
})
|
||||
return
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
import {
|
||||
xAddressToClassicAddress,
|
||||
isValidXAddress,
|
||||
} from '@transia/ripple-address-codec'
|
||||
import BigNumber from 'bignumber.js'
|
||||
import { xAddressToClassicAddress, isValidXAddress } from '@transia/ripple-address-codec'
|
||||
|
||||
import type { Client } from '..'
|
||||
import { ValidationError, XrplError } from '../errors'
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
import { xAddressToClassicAddress, isValidXAddress } from '@transia/ripple-address-codec'
|
||||
import {
|
||||
xAddressToClassicAddress,
|
||||
isValidXAddress,
|
||||
} from '@transia/ripple-address-codec'
|
||||
|
||||
/**
|
||||
* If an address is an X-Address, converts it to a classic address.
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
/* eslint-disable no-bitwise -- this file mimics behavior in rippled. It uses
|
||||
bitwise operators for and-ing numbers with a mask and bit shifting. */
|
||||
|
||||
import BigNumber from 'bignumber.js'
|
||||
import { decode, encode } from '@transia/ripple-binary-codec'
|
||||
import BigNumber from 'bignumber.js'
|
||||
|
||||
import { ValidationError, XrplError } from '../../errors'
|
||||
import type { Ledger } from '../../models/ledger'
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
/* eslint-disable no-bitwise -- this file mimics behavior in rippled. It uses
|
||||
bitwise operators for and-ing numbers with a mask and bit shifting. */
|
||||
|
||||
import BigNumber from 'bignumber.js'
|
||||
import { decodeAccountID } from '@transia/ripple-address-codec'
|
||||
import BigNumber from 'bignumber.js'
|
||||
|
||||
import hashLedger, {
|
||||
hashLedgerHeader,
|
||||
|
||||
@@ -8,7 +8,7 @@ import {
|
||||
TRANSACTION_TYPES,
|
||||
TRANSACTION_TYPE_MAP,
|
||||
} from '@transia/ripple-binary-codec'
|
||||
import createHash = require('create-hash')
|
||||
// import createHash = require('create-hash')
|
||||
|
||||
import { XrplError } from '../errors'
|
||||
import { HookParameter } from '../models/common'
|
||||
@@ -58,34 +58,6 @@ export function calculateHookOn(arr: Array<keyof TTS>): string {
|
||||
return hash.toUpperCase()
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate the sha256 of a string
|
||||
*
|
||||
* @param string - the string to calculate the sha256
|
||||
* @returns the sha256
|
||||
*/
|
||||
export async function sha256(string: string): Promise<string> {
|
||||
const hash = createHash('sha256')
|
||||
hash.update(string)
|
||||
const hashBuffer = hash.digest()
|
||||
const hashArray = Array.from(new Uint8Array(hashBuffer))
|
||||
const hashHex = hashArray
|
||||
// eslint-disable-next-line @typescript-eslint/no-magic-numbers -- Required
|
||||
.map((bytes) => bytes.toString(16).padStart(2, '0'))
|
||||
.join('')
|
||||
return hashHex
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate the hex of a namespace
|
||||
*
|
||||
* @param namespace - the namespace to calculate the hex
|
||||
* @returns the hex
|
||||
*/
|
||||
export async function hexNamespace(namespace: string): Promise<string> {
|
||||
return (await sha256(namespace)).toUpperCase()
|
||||
}
|
||||
|
||||
function isHex(value: string): boolean {
|
||||
return /^[0-9A-F]+$/iu.test(value)
|
||||
}
|
||||
|
||||
@@ -40,7 +40,7 @@ import {
|
||||
hashEscrow,
|
||||
hashPaymentChannel,
|
||||
} from './hashes'
|
||||
import { calculateHookOn, hexNamespace, hexHookParameters, TTS } from './hooks'
|
||||
import { calculateHookOn, hexHookParameters, TTS } from './hooks'
|
||||
import parseNFTokenID from './parseNFTokenID'
|
||||
import {
|
||||
percentToTransferRate,
|
||||
@@ -224,7 +224,6 @@ export {
|
||||
createCrossChainPayment,
|
||||
parseNFTokenID,
|
||||
calculateHookOn,
|
||||
hexNamespace,
|
||||
hexHookParameters,
|
||||
TTS,
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/* eslint-disable @typescript-eslint/no-magic-numbers -- Doing hex string parsing. */
|
||||
import BigNumber from 'bignumber.js'
|
||||
import { encodeAccountID } from '@transia/ripple-address-codec'
|
||||
import BigNumber from 'bignumber.js'
|
||||
|
||||
import { XrplError } from '../errors'
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { assert } from 'chai'
|
||||
import { decode } from '@transia/ripple-binary-codec'
|
||||
import { assert } from 'chai'
|
||||
|
||||
import {
|
||||
AccountSet,
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { assert } from 'chai'
|
||||
import { decode } from '@transia/ripple-binary-codec'
|
||||
import { assert } from 'chai'
|
||||
|
||||
import {
|
||||
AccountSet,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { Client } from '@transia/xrpl'
|
||||
import { assert } from 'chai'
|
||||
import _ from 'lodash'
|
||||
import { Client } from 'xrpl'
|
||||
|
||||
import {
|
||||
convertStringToHex,
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { decode } from '@transia/ripple-binary-codec'
|
||||
import { assert } from 'chai'
|
||||
import omit from 'lodash/omit'
|
||||
import throttle from 'lodash/throttle'
|
||||
import { decode } from '@transia/ripple-binary-codec'
|
||||
|
||||
import {
|
||||
Client,
|
||||
|
||||
@@ -82,12 +82,12 @@ describe('EscrowCreate', function () {
|
||||
assert.throws(
|
||||
() => validateEscrowCreate(escrow),
|
||||
ValidationError,
|
||||
'EscrowCreate: Amount must be a string',
|
||||
'EscrowCreate: Amount must be an Amount',
|
||||
)
|
||||
assert.throws(
|
||||
() => validate(escrow),
|
||||
ValidationError,
|
||||
'EscrowCreate: Amount must be a string',
|
||||
'EscrowCreate: Amount must be an Amount',
|
||||
)
|
||||
})
|
||||
|
||||
|
||||
@@ -77,12 +77,12 @@ describe('PaymentChannelClaim', function () {
|
||||
assert.throws(
|
||||
() => validatePaymentChannelClaim(channel),
|
||||
ValidationError,
|
||||
'PaymentChannelClaim: Balance must be a string',
|
||||
'PaymentChannelClaim: Balance must be an Amount',
|
||||
)
|
||||
assert.throws(
|
||||
() => validate(channel),
|
||||
ValidationError,
|
||||
'PaymentChannelClaim: Balance must be a string',
|
||||
'PaymentChannelClaim: Balance must be an Amount',
|
||||
)
|
||||
})
|
||||
|
||||
@@ -92,12 +92,12 @@ describe('PaymentChannelClaim', function () {
|
||||
assert.throws(
|
||||
() => validatePaymentChannelClaim(channel),
|
||||
ValidationError,
|
||||
'PaymentChannelClaim: Amount must be a string',
|
||||
'PaymentChannelClaim: Amount must be an Amount',
|
||||
)
|
||||
assert.throws(
|
||||
() => validate(channel),
|
||||
ValidationError,
|
||||
'PaymentChannelClaim: Amount must be a string',
|
||||
'PaymentChannelClaim: Amount must be an Amount',
|
||||
)
|
||||
})
|
||||
|
||||
|
||||
@@ -106,12 +106,12 @@ describe('PaymentChannelCreate', function () {
|
||||
assert.throws(
|
||||
() => validatePaymentChannelCreate(channel),
|
||||
ValidationError,
|
||||
'PaymentChannelCreate: Amount must be a string',
|
||||
'PaymentChannelCreate: Amount must be an Amount',
|
||||
)
|
||||
assert.throws(
|
||||
() => validate(channel),
|
||||
ValidationError,
|
||||
'PaymentChannelCreate: Amount must be a string',
|
||||
'PaymentChannelCreate: Amount must be an Amount',
|
||||
)
|
||||
})
|
||||
|
||||
|
||||
@@ -70,12 +70,12 @@ describe('PaymentChannelFund', function () {
|
||||
assert.throws(
|
||||
() => validatePaymentChannelFund(channel),
|
||||
ValidationError,
|
||||
'PaymentChannelFund: Amount must be a string',
|
||||
'PaymentChannelFund: Amount must be an Amount',
|
||||
)
|
||||
assert.throws(
|
||||
() => validate(channel),
|
||||
ValidationError,
|
||||
'PaymentChannelFund: Amount must be a string',
|
||||
'PaymentChannelFund: Amount must be an Amount',
|
||||
)
|
||||
})
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
import fs from 'fs'
|
||||
import path from 'path'
|
||||
|
||||
import { assert } from 'chai'
|
||||
import { encode } from '@transia/ripple-binary-codec'
|
||||
import { assert } from 'chai'
|
||||
|
||||
import { OfferCreate, Transaction, ValidationError } from '../../src'
|
||||
import {
|
||||
|
||||
@@ -1,11 +1,6 @@
|
||||
import { assert } from 'chai'
|
||||
|
||||
import {
|
||||
calculateHookOn,
|
||||
hexNamespace,
|
||||
hexHookParameters,
|
||||
TTS,
|
||||
} from '../../src'
|
||||
import { calculateHookOn, hexHookParameters, TTS } from '../../src'
|
||||
|
||||
describe('test hook on', function () {
|
||||
it('invalid', function () {
|
||||
@@ -31,16 +26,6 @@ describe('test hook on', function () {
|
||||
})
|
||||
})
|
||||
|
||||
describe('test hook namespace', function () {
|
||||
it('basic', async function () {
|
||||
const result = await hexNamespace('starter')
|
||||
assert.equal(
|
||||
result,
|
||||
'4FF9961269BF7630D32E15276569C94470174A5DA79FA567C0F62251AA9A36B9',
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
describe('test hook parameters', function () {
|
||||
it('basic', async function () {
|
||||
const parameters = [
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { assert } from 'chai'
|
||||
import { decode } from '@transia/ripple-binary-codec'
|
||||
import { assert } from 'chai'
|
||||
|
||||
import { NFTokenMint, Payment, Transaction } from '../../src'
|
||||
import ECDSA from '../../src/ECDSA'
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { assert } from 'chai'
|
||||
import { decode, encode } from '@transia/ripple-binary-codec'
|
||||
import { assert } from 'chai'
|
||||
|
||||
import { Transaction, ValidationError } from '../../src'
|
||||
import Wallet from '../../src/Wallet'
|
||||
|
||||
Reference in New Issue
Block a user