Compare commits

...

29 Commits

Author SHA1 Message Date
Denis Angell
edfdd42584 fix standalone errors 2023-02-16 18:52:49 -05:00
Denis Angell
157a9d9409 update standalone 2023-02-16 18:52:25 -05:00
Denis Angell
6c6dade636 integration tests 2023-02-16 18:49:37 -05:00
Denis Angell
369c9fe7a4 fixup! reorder definitions 2023-02-15 17:05:54 -05:00
Denis Angell
31e52fbc3b fixup! prepare for nth clash in definitions.json 2023-02-15 16:51:19 -05:00
Denis Angell
038bbac34f fixup: definitions tecPRECISION_LOSS 2023-02-15 16:45:56 -05:00
Denis Angell
0c4765d2e0 Merge branch 'beta3' into iouescrow 2023-02-15 16:38:23 -05:00
Denis Angell
bc70d3b6c1 fixup! update Amount & Balance 2023-02-15 16:24:00 -05:00
Denis Angell
2d6ab38d33 docstring: replace XRP with amounts 2023-02-15 15:26:05 -05:00
Denis Angell
00d4840501 fixup! remove faucet 2023-02-15 14:24:53 -05:00
Denis Angell
8e90ecd350 reverse else order 2023-02-15 14:23:23 -05:00
Denis Angell
b80521152d Merge branch 'main' into iouescrow 2023-02-15 13:55:58 -05:00
Denis Angell
d890b81924 update validation error response 2023-02-15 13:23:56 -05:00
Denis Angell
81f09ba043 faucet wallet integration test 2023-02-15 13:14:05 -05:00
Denis Angell
46dd51b196 update docstrings 2023-02-15 13:04:22 -05:00
Denis Angell
4d9a5cf4a0 fix ClaimObject 2023-02-15 13:03:27 -05:00
Denis Angell
ffe93d0462 add faucet test 2023-02-14 19:45:48 -05:00
Denis Angell
0787166f6a update faucet 2023-02-14 19:45:48 -05:00
Denis Angell
45008596a4 remove XRP references to amount 2023-02-14 19:45:48 -05:00
Denis Angell
65a8de6f47 Merge branch 'main' into iouescrow 2023-02-09 11:20:36 -05:00
Denis Angell
3b19974634 fix docstring errors 2023-02-09 11:19:50 -05:00
Denis Angell
b7283c5841 refactor signingClaimData 2023-02-09 11:19:36 -05:00
Denis Angell
c8d24d65f5 Merge branch 'main' into iouescrow 2023-02-06 10:56:50 -05:00
Denis Angell
e712d8fd8c remove integration testing 2023-02-06 10:48:27 -05:00
Denis Angell
8fbcb20129 remove redundant check 2023-02-06 10:30:18 -05:00
Denis Angell
a679128f02 rename IC to Token 2023-02-06 10:19:01 -05:00
Denis Angell
9f15deed15 update fund wallet url 2023-02-06 10:18:09 -05:00
Denis Angell
9b540c89f0 update docstrings 2023-02-06 10:17:47 -05:00
dangell7
5541632b7f amendment-xls34d
add transfer rate

Update definitions.json

update test error text

update validation error

fix undefined validation

switch claim signing order, update claim object

update workflow docker

tests (paychan + escrow)

add ic gateway (test)

add faucet

update sdk

fixup git-workflow
2023-02-06 09:19:49 -05:00
28 changed files with 682 additions and 158 deletions

View File

@@ -102,7 +102,7 @@ jobs:
services:
rippled:
image: natenichols/rippled-standalone:latest
image: gcr.io/metaxrplorer/dangell7-iouescrow-standalone:1
ports:
- 6006:6006
options: --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s
@@ -153,7 +153,7 @@ jobs:
services:
rippled:
image: natenichols/rippled-standalone:latest
image: gcr.io/metaxrplorer/dangell7-iouescrow-standalone:1
ports:
- 6006:6006
options: --health-cmd="wget localhost:6006 || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s

View File

@@ -11,6 +11,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
@@ -95,7 +96,7 @@ function signingData(
*/
interface ClaimObject extends JsonObject {
channel: string
amount: string | number
amount: AmountObject
}
/**
@@ -105,16 +106,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()
}

View File

@@ -776,6 +776,16 @@
"type": "UInt32"
}
],
[
"LockCount",
{
"nth": 49,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "UInt32"
}
],
[
"IndexNext",
{
@@ -1486,6 +1496,16 @@
"type": "Amount"
}
],
[
"LockedBalance",
{
"nth": 31,
"isVLEncoded": false,
"isSerialized": true,
"isSigningField": true,
"type": "Amount"
}
],
[
"PublicKey",
{
@@ -2567,7 +2587,8 @@
"tecXCHAIN_ACCOUNT_CREATE_TOO_MANY": 183,
"tecXCHAIN_PAYMENT_FAILED": 184,
"tecXCHAIN_SELF_COMMIT": 185,
"tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186
"tecXCHAIN_BAD_PUBLIC_KEY_ACCOUNT_PAIR": 186,
"tecPRECISION_LOSS": 187
},
"TRANSACTION_TYPES": {
"Invalid": -1,

View File

@@ -120,7 +120,7 @@ describe('Signing data', function () {
].join(''),
)
})
test('can create claim blob', function () {
test('can create native claim blob', function () {
const channel =
'43904CBFCDCEC530B4037871F86EE90BF799DF8D2E0EA564BC8A3F332E4F5FB1'
const amount = '1000'
@@ -137,4 +137,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(''),
)
})
})

View File

@@ -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
}

View File

@@ -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
}

View File

@@ -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
}
/**

View File

@@ -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
}
/**

View File

@@ -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

View File

@@ -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
*/

View File

@@ -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) {

View File

@@ -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
*/

View File

@@ -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') {

View File

@@ -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) {

View File

@@ -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') {

View File

@@ -31,7 +31,7 @@ describe('server_state', function () {
id: 0,
result: {
state: {
build_version: '1.7.3',
build_version: '1.10.0-rc1',
complete_ledgers: '2563-2932',
io_latency_ms: 1,
jq_trans_overflow: '0',
@@ -103,6 +103,8 @@ describe('server_state', function () {
)
const removeKeys = [
'initial_sync_duration_us',
'node_size',
'complete_ledgers',
'load',
'state_accounting',
@@ -133,7 +135,7 @@ describe('server_state', function () {
)
assert.equal(
typeof response.result.state.state_accounting[key].transitions,
'number',
'string',
)
})

View File

@@ -158,7 +158,7 @@ describe('subscribe', function () {
// Explicitly checking that there are only known fields in the return
const expectedResult = {
fee_base: ledgerResponse.fee_base,
fee_ref: ledgerResponse.fee_ref,
fee_ref: 0,
ledger_hash: ledgerResponse.ledger_hash,
ledger_index: ledgerResponse.ledger_index,
ledger_time: ledgerResponse.ledger_time,

View File

@@ -1,11 +1,14 @@
import { Client, Wallet } from '../../src'
import { AccountSet, TrustSet, Payment } from '../../src/models/transactions'
import serverUrl from './serverUrl'
import { fundAccount } from './utils'
import { fundAccount, ledgerAccept } from './utils'
export interface XrplIntegrationTestContext {
client: Client
wallet: Wallet
destination: Wallet
gateway: Wallet
}
export async function teardownClient(
@@ -29,18 +32,137 @@ async function connectWithRetry(client: Client, tries = 0): Promise<void> {
})
}
// eslint-disable-next-line max-params -- need comments
async function initToken(
client: Client,
wallet: Wallet,
destination: Wallet,
gateway: Wallet,
): Promise<void> {
const atx: AccountSet = {
TransactionType: 'AccountSet',
Account: gateway.classicAddress,
SetFlag: 8,
}
const atxr = await client.submit(atx, {
wallet: gateway,
})
if (atxr.result.engine_result !== 'tesSUCCESS') {
// eslint-disable-next-line no-console -- happens only when something goes wrong
console.log(atxr)
}
await ledgerAccept(client)
const wtl: TrustSet = {
TransactionType: 'TrustSet',
Account: wallet.classicAddress,
LimitAmount: {
currency: 'USD',
issuer: gateway.classicAddress,
value: '100000',
},
}
const wtlr = await client.submit(wtl, {
wallet,
})
if (wtlr.result.engine_result !== 'tesSUCCESS') {
// eslint-disable-next-line no-console -- happens only when something goes wrong
console.log(wtlr)
}
await ledgerAccept(client)
const dtl: TrustSet = {
TransactionType: 'TrustSet',
Account: destination.classicAddress,
LimitAmount: {
currency: 'USD',
issuer: gateway.classicAddress,
value: '100000',
},
}
const dtlr = await client.submit(dtl, {
wallet: destination,
})
if (wtlr.result.engine_result !== 'tesSUCCESS') {
// eslint-disable-next-line no-console -- happens only when something goes wrong
console.log(dtlr)
}
await ledgerAccept(client)
const wp: Payment = {
TransactionType: 'Payment',
Account: gateway.classicAddress,
Destination: wallet.classicAddress,
Amount: {
currency: 'USD',
issuer: gateway.classicAddress,
value: '10000',
},
}
const wpr = await client.submit(wp, {
wallet: gateway,
})
if (wpr.result.engine_result !== 'tesSUCCESS') {
// eslint-disable-next-line no-console -- happens only when something goes wrong
console.log(wpr)
}
await ledgerAccept(client)
const dp: Payment = {
TransactionType: 'Payment',
Account: gateway.classicAddress,
Destination: destination.classicAddress,
Amount: {
currency: 'USD',
issuer: gateway.classicAddress,
value: '10000',
},
}
const dpr = await client.submit(dp, {
wallet: gateway,
})
if (dpr.result.engine_result !== 'tesSUCCESS') {
// eslint-disable-next-line no-console -- happens only when something goes wrong
console.log(dpr)
}
await ledgerAccept(client)
}
export async function setupClient(
server = serverUrl,
token?: boolean | false,
): Promise<XrplIntegrationTestContext> {
const context: XrplIntegrationTestContext = {
client: new Client(server, { timeout: 200000 }),
wallet: Wallet.generate(),
destination: Wallet.generate(),
gateway: Wallet.generate(),
}
return connectWithRetry(context.client).then(async () => {
await fundAccount(context.client, context.wallet, {
count: 20,
delayMs: 1000,
})
if (token) {
await fundAccount(context.client, context.destination, {
count: 20,
delayMs: 1000,
})
await fundAccount(context.client, context.gateway, {
count: 20,
delayMs: 1000,
})
await initToken(
context.client,
context.wallet,
context.destination,
context.gateway,
)
}
return context
})
}

View File

@@ -7,13 +7,7 @@ import {
teardownClient,
type XrplIntegrationTestContext,
} from '../setup'
import {
// calculateWaitTimeForTransaction,
generateFundedWallet,
// getXRPBalance,
testTransaction,
submitTransaction,
} from '../utils'
import { testTransaction, submitTransaction } from '../utils'
// TODO: Fix these tests
// NOTE: Because ledger accept is called among multiple tests, the actual ledger close time is not
@@ -30,16 +24,13 @@ describe('EscrowCancel', function () {
let testContext: XrplIntegrationTestContext
beforeEach(async () => {
testContext = await setupClient(serverUrl)
testContext = await setupClient(serverUrl, true)
})
afterEach(async () => teardownClient(testContext))
it(
'base',
'test xrp',
async () => {
// Funding the wallet can take some time, so we do it first BEFORE getting the ledger close_time.
const wallet1 = await generateFundedWallet(testContext.client)
// get the most recent close_time from the standalone container for cancel & finish after.
const CLOSE_TIME: number = (
await testContext.client.request({
@@ -54,7 +45,7 @@ describe('EscrowCancel', function () {
Account: testContext.wallet.classicAddress,
TransactionType: 'EscrowCreate',
Amount: '10000',
Destination: wallet1.classicAddress,
Destination: testContext.destination.classicAddress,
CancelAfter: CLOSE_TIME + 3,
FinishAfter: CLOSE_TIME + 2,
}
@@ -74,12 +65,101 @@ describe('EscrowCancel', function () {
})
).result.account_objects
assert.equal(accountObjects.length, 1)
assert.equal(accountObjects.length, 2)
const sequence = (
await testContext.client.request({
command: 'tx',
transaction: accountObjects[0].PreviousTxnID,
transaction: accountObjects[1].PreviousTxnID,
})
).result.Sequence
if (!sequence) {
throw new Error('sequence did not exist')
}
const cancelTx: EscrowCancel = {
TransactionType: 'EscrowCancel',
Account: testContext.wallet.classicAddress,
Owner: testContext.wallet.classicAddress,
OfferSequence: sequence,
}
// We set the CancelAfter timer to be 3 seconds after the last ledger close_time. We need to wait this long
// before we can cancel the escrow.
// const cancelAfterTimerPromise = new Promise((resolve) => {
// setTimeout(resolve, waitTimeInMs)
// })
// Make sure we wait long enough before canceling the escrow.
// await cancelAfterTimerPromise
// await testTransaction(testContext.client, cancelTx, testContext.wallet, {
// count: 20,
// delayMs: 2000,
// })
await submitTransaction({
client: testContext.client,
transaction: cancelTx,
wallet: testContext.wallet,
})
// Make sure the Destination wallet did not receive any XRP.
// assert.equal(
// await getXRPBalance(testContext.client, wallet1),
// initialBalanceWallet1,
// )
},
TIMEOUT,
)
it(
'test token',
async () => {
// get the most recent close_time from the standalone container for cancel & finish after.
const CLOSE_TIME: number = (
await testContext.client.request({
command: 'ledger',
ledger_index: 'validated',
})
).result.ledger.close_time
// const waitTimeInMs = calculateWaitTimeForTransaction(CLOSE_TIME)
const createTx: EscrowCreate = {
Account: testContext.wallet.classicAddress,
TransactionType: 'EscrowCreate',
Amount: {
currency: 'USD',
issuer: testContext.gateway.classicAddress,
value: '100',
},
Destination: testContext.destination.classicAddress,
CancelAfter: CLOSE_TIME + 3,
FinishAfter: CLOSE_TIME + 2,
}
await testTransaction(testContext.client, createTx, testContext.wallet)
// const initialBalanceWallet1 = await getXRPBalance(
// testContext.client,
// wallet1,
// )
// check that the object was actually created
const accountObjects = (
await testContext.client.request({
command: 'account_objects',
account: testContext.wallet.classicAddress,
})
).result.account_objects
assert.equal(accountObjects.length, 2)
const sequence = (
await testContext.client.request({
command: 'tx',
transaction: accountObjects[1].PreviousTxnID,
})
).result.Sequence

View File

@@ -7,7 +7,7 @@ import {
teardownClient,
type XrplIntegrationTestContext,
} from '../setup'
import { generateFundedWallet, testTransaction } from '../utils'
import { testTransaction } from '../utils'
// how long before each test case times out
const TIMEOUT = 20000
@@ -16,15 +16,13 @@ describe('EscrowCreate', function () {
let testContext: XrplIntegrationTestContext
beforeEach(async () => {
testContext = await setupClient(serverUrl)
testContext = await setupClient(serverUrl, true)
})
afterEach(async () => teardownClient(testContext))
it(
'base',
'test xrp',
async () => {
const wallet2 = await generateFundedWallet(testContext.client)
// get the most recent close_time from the standalone container for finish after.
const CLOSE_TIME: number = (
await testContext.client.request({
@@ -37,7 +35,7 @@ describe('EscrowCreate', function () {
Account: testContext.wallet.classicAddress,
TransactionType: 'EscrowCreate',
Amount: '10000',
Destination: wallet2.classicAddress,
Destination: testContext.destination.classicAddress,
FinishAfter: CLOSE_TIME + 2,
}
@@ -51,7 +49,46 @@ describe('EscrowCreate', function () {
account: testContext.wallet.classicAddress,
})
).result.account_objects.length,
1,
2,
)
},
TIMEOUT,
)
it(
'test token',
async () => {
// get the most recent close_time from the standalone container for finish after.
const CLOSE_TIME: number = (
await testContext.client.request({
command: 'ledger',
ledger_index: 'validated',
})
).result.ledger.close_time
const tx: EscrowCreate = {
Account: testContext.wallet.classicAddress,
TransactionType: 'EscrowCreate',
Amount: {
currency: 'USD',
issuer: testContext.gateway.classicAddress,
value: '100',
},
Destination: testContext.destination.classicAddress,
FinishAfter: CLOSE_TIME + 2,
}
await testTransaction(testContext.client, tx, testContext.wallet)
// check that the object was actually created
assert.equal(
(
await testContext.client.request({
command: 'account_objects',
account: testContext.wallet.classicAddress,
})
).result.account_objects.length,
2,
)
},
TIMEOUT,

View File

@@ -9,7 +9,6 @@ import {
} from '../setup'
import {
calculateWaitTimeForTransaction,
generateFundedWallet,
getXRPBalance,
testTransaction,
} from '../utils'
@@ -21,15 +20,13 @@ describe('EscrowFinish', function () {
let testContext: XrplIntegrationTestContext
beforeEach(async () => {
testContext = await setupClient(serverUrl)
testContext = await setupClient(serverUrl, true)
})
afterEach(async () => teardownClient(testContext))
it(
'base',
'test xrp',
async () => {
const wallet1 = await generateFundedWallet(testContext.client)
// get the most recent close_time from the standalone container for cancel & finish after.
const CLOSE_TIME: number = (
await testContext.client.request({
@@ -40,13 +37,11 @@ describe('EscrowFinish', function () {
const waitTimeInMs = calculateWaitTimeForTransaction(CLOSE_TIME)
const AMOUNT = 10000
const createTx: EscrowCreate = {
Account: testContext.wallet.classicAddress,
TransactionType: 'EscrowCreate',
Amount: AMOUNT.toString(),
Destination: wallet1.classicAddress,
Amount: '10000',
Destination: testContext.destination.classicAddress,
FinishAfter: CLOSE_TIME + 2,
}
@@ -56,7 +51,10 @@ describe('EscrowFinish', function () {
await testTransaction(testContext.client, createTx, testContext.wallet)
const initialBalance = await getXRPBalance(testContext.client, wallet1)
const initialBalance = await getXRPBalance(
testContext.client,
testContext.destination,
)
// check that the object was actually created
const accountObjects = (
@@ -66,12 +64,12 @@ describe('EscrowFinish', function () {
})
).result.account_objects
assert.equal(accountObjects.length, 1)
assert.equal(accountObjects.length, 2)
const sequence = (
await testContext.client.request({
command: 'tx',
transaction: accountObjects[0].PreviousTxnID,
transaction: accountObjects[1].PreviousTxnID,
})
).result.Sequence
@@ -86,9 +84,81 @@ describe('EscrowFinish', function () {
await testTransaction(testContext.client, finishTx, testContext.wallet)
const expectedBalance = String(Number(initialBalance) + Number(AMOUNT))
const expectedBalance = String(Number(initialBalance) + Number('10000'))
assert.equal(
await getXRPBalance(testContext.client, wallet1),
await getXRPBalance(testContext.client, testContext.destination),
expectedBalance,
)
},
TIMEOUT,
)
it(
'test token',
async () => {
// get the most recent close_time from the standalone container for cancel & finish after.
const CLOSE_TIME: number = (
await testContext.client.request({
command: 'ledger',
ledger_index: 'validated',
})
).result.ledger.close_time
const waitTimeInMs = calculateWaitTimeForTransaction(CLOSE_TIME)
const createTx: EscrowCreate = {
Account: testContext.wallet.classicAddress,
TransactionType: 'EscrowCreate',
Amount: {
currency: 'USD',
issuer: testContext.gateway.classicAddress,
value: '100',
},
Destination: testContext.destination.classicAddress,
FinishAfter: CLOSE_TIME + 2,
}
const finishAfterPromise = new Promise((resolve) => {
setTimeout(resolve, waitTimeInMs)
})
await testTransaction(testContext.client, createTx, testContext.wallet)
const initialBalance = await getXRPBalance(
testContext.client,
testContext.destination,
)
// check that the object was actually created
const accountObjects = (
await testContext.client.request({
command: 'account_objects',
account: testContext.wallet.classicAddress,
})
).result.account_objects
assert.equal(accountObjects.length, 2)
const sequence = (
await testContext.client.request({
command: 'tx',
transaction: accountObjects[1].PreviousTxnID,
})
).result.Sequence
const finishTx: EscrowFinish = {
TransactionType: 'EscrowFinish',
Account: testContext.wallet.classicAddress,
Owner: testContext.wallet.classicAddress,
OfferSequence: sequence!,
}
await finishAfterPromise
await testTransaction(testContext.client, finishTx, testContext.wallet)
const expectedBalance = String(Number(initialBalance))
assert.equal(
await getXRPBalance(testContext.client, testContext.destination),
expectedBalance,
)
},

View File

@@ -5,7 +5,7 @@ import {
teardownClient,
type XrplIntegrationTestContext,
} from '../setup'
import { generateFundedWallet, testTransaction } from '../utils'
import { testTransaction } from '../utils'
// how long before each test case times out
const TIMEOUT = 20000
@@ -15,19 +15,18 @@ describe('PaymentChannelClaim', function () {
let testContext: XrplIntegrationTestContext
beforeEach(async () => {
testContext = await setupClient(serverUrl)
testContext = await setupClient(serverUrl, true)
})
afterEach(async () => teardownClient(testContext))
it(
'base',
'test xrp',
async () => {
const wallet2 = await generateFundedWallet(testContext.client)
const paymentChannelCreate: PaymentChannelCreate = {
TransactionType: 'PaymentChannelCreate',
Account: testContext.wallet.classicAddress,
Amount: '100',
Destination: wallet2.classicAddress,
Destination: testContext.destination.classicAddress,
SettleDelay: 86400,
PublicKey: testContext.wallet.publicKey,
}
@@ -48,7 +47,7 @@ describe('PaymentChannelClaim', function () {
TransactionType: 'PaymentChannelClaim',
Channel: hashPaymentChannel(
testContext.wallet.classicAddress,
wallet2.classicAddress,
testContext.destination.classicAddress,
paymentChannelResponse.result.tx_json.Sequence ?? 0,
),
Amount: '100',
@@ -62,4 +61,48 @@ describe('PaymentChannelClaim', function () {
},
TIMEOUT,
)
it(
'test token',
async () => {
const paymentChannelCreate: PaymentChannelCreate = {
TransactionType: 'PaymentChannelCreate',
Account: testContext.wallet.classicAddress,
Amount: {
currency: 'USD',
issuer: testContext.gateway.classicAddress,
value: '100',
},
Destination: testContext.destination.classicAddress,
SettleDelay: 86400,
PublicKey: testContext.wallet.publicKey,
}
const paymentChannelResponse = await testContext.client.submit(
paymentChannelCreate,
{ wallet: testContext.wallet },
)
const paymentChannelClaim: PaymentChannelClaim = {
Account: testContext.wallet.classicAddress,
TransactionType: 'PaymentChannelClaim',
Channel: hashPaymentChannel(
testContext.wallet.classicAddress,
testContext.destination.classicAddress,
paymentChannelResponse.result.tx_json.Sequence ?? 0,
),
Amount: {
currency: 'USD',
issuer: testContext.gateway.classicAddress,
value: '100',
},
}
await testTransaction(
testContext.client,
paymentChannelClaim,
testContext.wallet,
)
},
TIMEOUT,
)
})

View File

@@ -1,32 +1,78 @@
import { PaymentChannelCreate } from '../../../src'
import { PaymentChannelCreate, hashes, PaymentChannelClaim } from '../../../src'
import serverUrl from '../serverUrl'
import {
setupClient,
teardownClient,
type XrplIntegrationTestContext,
} from '../setup'
import { generateFundedWallet, testTransaction } from '../utils'
import { testTransaction } from '../utils'
// how long before each test case times out
const TIMEOUT = 20000
const { hashPaymentChannel } = hashes
describe('PaymentChannelCreate', function () {
describe('PaymentChannelClaim', function () {
let testContext: XrplIntegrationTestContext
beforeEach(async () => {
testContext = await setupClient(serverUrl)
testContext = await setupClient(serverUrl, true)
})
afterEach(async () => teardownClient(testContext))
it(
'base',
'test xrp',
async () => {
const wallet2 = await generateFundedWallet(testContext.client)
const paymentChannelCreate: PaymentChannelCreate = {
TransactionType: 'PaymentChannelCreate',
Account: testContext.wallet.classicAddress,
Amount: '100',
Destination: wallet2.classicAddress,
Destination: testContext.destination.classicAddress,
SettleDelay: 86400,
PublicKey: testContext.wallet.publicKey,
}
const paymentChannelResponse = await testContext.client.submit(
paymentChannelCreate,
{ wallet: testContext.wallet },
)
await testTransaction(
testContext.client,
paymentChannelCreate,
testContext.wallet,
)
const paymentChannelClaim: PaymentChannelClaim = {
Account: testContext.wallet.classicAddress,
TransactionType: 'PaymentChannelClaim',
Channel: hashPaymentChannel(
testContext.wallet.classicAddress,
testContext.destination.classicAddress,
paymentChannelResponse.result.tx_json.Sequence ?? 0,
),
Amount: '100',
}
await testTransaction(
testContext.client,
paymentChannelClaim,
testContext.wallet,
)
},
TIMEOUT,
)
it(
'test token',
async () => {
const paymentChannelCreate: PaymentChannelCreate = {
TransactionType: 'PaymentChannelCreate',
Account: testContext.wallet.classicAddress,
Amount: {
currency: 'USD',
issuer: testContext.gateway.classicAddress,
value: '100',
},
Destination: testContext.destination.classicAddress,
SettleDelay: 86400,
PublicKey: testContext.wallet.publicKey,
}

View File

@@ -5,29 +5,28 @@ import {
teardownClient,
type XrplIntegrationTestContext,
} from '../setup'
import { generateFundedWallet, testTransaction } from '../utils'
import { testTransaction } from '../utils'
// how long before each test case times out
const TIMEOUT = 20000
const { hashPaymentChannel } = hashes
describe('PaymentChannelFund', function () {
describe('PaymentChannelClaim', function () {
let testContext: XrplIntegrationTestContext
beforeEach(async () => {
testContext = await setupClient(serverUrl)
testContext = await setupClient(serverUrl, true)
})
afterEach(async () => teardownClient(testContext))
it(
'base',
'test xrp',
async () => {
const wallet2 = await generateFundedWallet(testContext.client)
const paymentChannelCreate: PaymentChannelCreate = {
TransactionType: 'PaymentChannelCreate',
Account: testContext.wallet.classicAddress,
Amount: '100',
Destination: wallet2.classicAddress,
Destination: testContext.destination.classicAddress,
SettleDelay: 86400,
PublicKey: testContext.wallet.publicKey,
}
@@ -36,6 +35,7 @@ describe('PaymentChannelFund', function () {
paymentChannelCreate,
{ wallet: testContext.wallet },
)
await testTransaction(
testContext.client,
paymentChannelCreate,
@@ -47,7 +47,7 @@ describe('PaymentChannelFund', function () {
TransactionType: 'PaymentChannelFund',
Channel: hashPaymentChannel(
testContext.wallet.classicAddress,
wallet2.classicAddress,
testContext.destination.classicAddress,
paymentChannelResponse.result.tx_json.Sequence ?? 0,
),
Amount: '100',
@@ -61,4 +61,48 @@ describe('PaymentChannelFund', function () {
},
TIMEOUT,
)
it(
'test token',
async () => {
const paymentChannelCreate: PaymentChannelCreate = {
TransactionType: 'PaymentChannelCreate',
Account: testContext.wallet.classicAddress,
Amount: {
currency: 'USD',
issuer: testContext.gateway.classicAddress,
value: '100',
},
Destination: testContext.destination.classicAddress,
SettleDelay: 86400,
PublicKey: testContext.wallet.publicKey,
}
const paymentChannelResponse = await testContext.client.submit(
paymentChannelCreate,
{ wallet: testContext.wallet },
)
const paymentChannelFund: PaymentChannelFund = {
Account: testContext.wallet.classicAddress,
TransactionType: 'PaymentChannelFund',
Channel: hashPaymentChannel(
testContext.wallet.classicAddress,
testContext.destination.classicAddress,
paymentChannelResponse.result.tx_json.Sequence ?? 0,
),
Amount: {
currency: 'USD',
issuer: testContext.gateway.classicAddress,
value: '100',
},
}
await testTransaction(
testContext.client,
paymentChannelFund,
testContext.wallet,
)
},
TIMEOUT,
)
})

View File

@@ -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',
)
})

View File

@@ -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',
)
})

View File

@@ -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',
)
})

View File

@@ -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',
)
})