Account settings refactor and cleanup (#49)

Author: ildaruz

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "2.2.17",
+  "version": "2.2.18",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package.json

@@ -1,4 +1,4 @@
-import { LedgerEntry } from "xrpl";
+import { LedgerEntry, AccountSetAsfFlags } from "xrpl";
 import BigNumber from "bignumber.js";
 
 import { BLACKHOLE_ACCOUNTS } from "../common";
@@ -36,6 +36,23 @@ export interface AccountRootFlagsKeysInterface {
   disallowIncomingTrustline?: boolean;
 }
 
+export const AccountSetFlags = {
+  requireDestinationTag: AccountSetAsfFlags.asfRequireDest,
+  requireAuthorization: AccountSetAsfFlags.asfRequireAuth,
+  depositAuth: AccountSetAsfFlags.asfDepositAuth,
+  disallowIncomingXRP: AccountSetAsfFlags.asfDisallowXRP,
+  disableMasterKey: AccountSetAsfFlags.asfDisableMaster,
+  enableTransactionIDTracking: AccountSetAsfFlags.asfAccountTxnID,
+  noFreeze: AccountSetAsfFlags.asfNoFreeze,
+  globalFreeze: AccountSetAsfFlags.asfGlobalFreeze,
+  defaultRipple: AccountSetAsfFlags.asfDefaultRipple,
+  authorizedMinter: AccountSetAsfFlags.asfAuthorizedNFTokenMinter,
+  disallowIncomingNFTokenOffer: AccountSetAsfFlags.asfDisallowIncomingNFTokenOffer,
+  disallowIncomingCheck: AccountSetAsfFlags.asfDisallowIncomingCheck,
+  disallowIncomingPayChan: AccountSetAsfFlags.asfDisallowIncomingPayChan,
+  disallowIncomingTrustline: AccountSetAsfFlags.asfDisallowIncomingTrustline,
+};
+
 export const SignerListFlagsKeys = {
   oneOwnerCount: LedgerEntry.SignerListFlags.lsfOneOwnerCount,
 };
@@ -51,6 +68,8 @@ export const AccountFields = {
   Domain: { name: "domain", encoding: "hex" },
   TransferRate: { name: "transferRate", defaults: 0, shift: 9 },
   TickSize: { name: "tickSize", defaults: 0 },
+  RegularKey: { name: "regularKey" },
+  NFTokenMinter: { name: "nftokenMinter" },
 };
 
 /**

src/models/account_info.ts

@@ -1,4 +1,3 @@
-import * as constants from './constants'
 import * as errors from './errors'
 import {xAddressToClassicAddress, isValidXAddress} from 'ripple-address-codec'
 
@@ -22,7 +21,7 @@ export function ensureClassicAddress(account: string): string {
   }
 }
 
-export {constants, errors}
+export {errors}
 export {
   dropsToXrp,
   xrpToDrops,
@@ -33,4 +32,3 @@ export {
   iso8601ToRippleTime,
   rippleTimeToISO8601
 } from './utils'
-export {txFlags} from './txflags'

src/v1/common/constants.ts

@@ -1,7 +1,6 @@
 import * as _ from 'lodash'
 import BigNumber from 'bignumber.js'
-import {constants} from '../../common'
-const AccountFields = constants.AccountFields
+import {AccountFields} from "../../../models/account_info";
 
 function parseField(info, value) {
   if (info.encoding === 'hex' && !info.length) {
@@ -25,14 +24,6 @@ function parseFields(data: any): object {
     }
   }
 
-  if (data.RegularKey) {
-    settings.regularKey = data.RegularKey
-  }
-
-  if (data.NFTokenMinter) {
-    settings.nftokenMinter = data.NFTokenMinter;
-  }
-
   // Since an account can own at most one SignerList,
   // this array must have exactly one member if it is present.
   if (data.signer_lists && data.signer_lists.length === 1) {

src/v1/common/index.ts

@@ -1,20 +1,19 @@
 import * as assert from 'assert'
+import {OfferCreateFlags} from "xrpl";
 import {parseTimestamp} from './utils'
 import parseAmount from './amount'
 import parseMemos from "./memos";
-import {removeUndefined, txFlags} from '../../common'
+import {removeUndefined} from '../../common'
 import {
   FormattedOrderSpecification,
   OfferCreateTransaction
 } from '../../common/types/objects/index'
 
-const flags = txFlags.OfferCreate
-
 function parseOrder(tx: OfferCreateTransaction): FormattedOrderSpecification {
   assert.ok(tx.TransactionType === 'OfferCreate')
 
   // tslint:disable-next-line:no-bitwise
-  const direction = (tx.Flags & flags.Sell) === 0 ? 'buy' : 'sell'
+  const direction = (tx.Flags & OfferCreateFlags.tfSell) === 0 ? 'buy' : 'sell'
   const takerGetsAmount = parseAmount(tx.TakerGets)
   const takerPaysAmount = parseAmount(tx.TakerPays)
   const quantity = direction === 'buy' ? takerPaysAmount : takerGetsAmount
@@ -29,11 +28,11 @@ function parseOrder(tx: OfferCreateTransaction): FormattedOrderSpecification {
     // tslint:disable-next-line:object-literal-shorthand
     totalPrice: totalPrice,
     // tslint:disable-next-line:no-bitwise
-    passive: (tx.Flags & flags.Passive) !== 0 || undefined,
+    passive: (tx.Flags & OfferCreateFlags.tfPassive) !== 0 || undefined,
     // tslint:disable-next-line:no-bitwise
-    immediateOrCancel: (tx.Flags & flags.ImmediateOrCancel) !== 0 || undefined,
+    immediateOrCancel: (tx.Flags & OfferCreateFlags.tfImmediateOrCancel) !== 0 || undefined,
     // tslint:disable-next-line:no-bitwise
-    fillOrKill: (tx.Flags & flags.FillOrKill) !== 0 || undefined,
+    fillOrKill: (tx.Flags & OfferCreateFlags.tfFillOrKill) !== 0 || undefined,
     expirationTime: parseTimestamp(tx.Expiration)
   })
 }

src/v1/common/txflags.ts

@@ -1,8 +1,8 @@
 import * as assert from 'assert'
-import {removeUndefined, txFlags} from '../../common'
+import {PaymentChannelClaimFlags} from "xrpl";
+import {removeUndefined} from '../../common'
 import parseRippledAmount from './ripple-amount'
 import parseMemos from "./memos";
-const claimFlags = txFlags.PaymentChannelClaim
 
 function parsePaymentChannelClaim(tx: any): object {
   assert.ok(tx.TransactionType === 'PaymentChannelClaim')
@@ -15,9 +15,9 @@ function parsePaymentChannelClaim(tx: any): object {
     signature: tx.Signature,
     publicKey: tx.PublicKey,
     // tslint:disable-next-line:no-bitwise
-    renew: Boolean(tx.Flags & claimFlags.Renew) || undefined,
+    renew: Boolean(tx.Flags & PaymentChannelClaimFlags.tfRenew) || undefined,
     // tslint:disable-next-line:no-bitwise
-    close: Boolean(tx.Flags & claimFlags.Close) || undefined
+    close: Boolean(tx.Flags & PaymentChannelClaimFlags.tfClose) || undefined
   })
 }
 

src/v1/ledger/parse/fields.ts

@@ -1,18 +1,19 @@
 import * as _ from 'lodash'
 import * as assert from 'assert'
+import {PaymentFlags} from "xrpl";
 import {isPartialPayment} from './utils'
-import {txFlags, removeUndefined} from '../../common'
+import {removeUndefined} from '../../common'
 import parseAmount from './amount'
 import parseMemos from "./memos";
 
 function isNoDirectRipple(tx) {
   // tslint:disable-next-line:no-bitwise
-  return (tx.Flags & txFlags.Payment.NoRippleDirect) !== 0
+  return (tx.Flags & PaymentFlags.tfNoDirectRipple) !== 0
 }
 
 function isQualityLimited(tx) {
   // tslint:disable-next-line:no-bitwise
-  return (tx.Flags & txFlags.Payment.LimitQuality) !== 0
+  return (tx.Flags & PaymentFlags.tfLimitQuality) !== 0
 }
 
 function removeGenericCounterparty(amount, address) {