Add country, direction, and exchangeType to StandardTx

Author: samholmes

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "cSpell.words": [
+    "banxa",
     "Bitrefill",
     "Bity",
     "Changelly",

src/partners/banxa.ts

@@ -13,6 +13,7 @@ import { Response } from 'node-fetch'
 
 import {
   EDGE_APP_START_DATE,
+  FiatPaymentType,
   PartnerPlugin,
   PluginParams,
   PluginResult,
@@ -32,6 +33,7 @@ export const asBanxaParams = asObject({
   })
 })
 
+type BanxaStatus = ReturnType<typeof asBanxaStatus>
 const asBanxaStatus = asMaybe(
   asValue(
     'complete',
@@ -44,15 +46,18 @@ const asBanxaStatus = asMaybe(
   'other'
 )
 
+type BanxaTx = ReturnType<typeof asBanxaTx>
 const asBanxaTx = asObject({
   id: asString,
   status: asBanxaStatus,
   created_at: asString,
+  country: asString,
   fiat_amount: asNumber,
   fiat_code: asString,
   coin_amount: asNumber,
   coin_code: asString,
   order_type: asString,
+  payment_type: asString,
   wallet_address: asMaybe(asString, '')
 })
 
@@ -67,9 +72,6 @@ const PAGE_LIMIT = 100
 const ONE_DAY_MS = 1000 * 60 * 60 * 24
 const ROLLBACK = ONE_DAY_MS * 7 // 7 days
 
-type BanxaTx = ReturnType<typeof asBanxaTx>
-type BanxaStatus = ReturnType<typeof asBanxaStatus>
-
 const statusMap: { [key in BanxaStatus]: Status } = {
   complete: 'complete',
   expired: 'expired',
@@ -263,13 +265,21 @@ export function processBanxaTx(rawTx: unknown): StandardTx {
     payoutAddress = banxaTx.wallet_address
   }
 
+  const direction = banxaTx.order_type === 'CRYPTO-SELL' ? 'sell' : 'buy'
+
+  const paymentType = getFiatPaymentType(banxaTx)
+
   const standardTx: StandardTx = {
     status: statusMap[banxaTx.status],
     orderId: banxaTx.id,
+    countryCode: banxaTx.country,
     depositTxid: undefined,
     depositAddress: undefined,
     depositCurrency: inputCurrency,
     depositAmount: inputAmount,
+    direction,
+    exchangeType: 'fiat',
+    paymentType,
     payoutTxid: undefined,
     payoutAddress,
     payoutCurrency: outputCurrency,
@@ -282,3 +292,45 @@ export function processBanxaTx(rawTx: unknown): StandardTx {
 
   return standardTx
 }
+
+function getFiatPaymentType(tx: BanxaTx): FiatPaymentType {
+  switch (tx.payment_type) {
+    case 'AusPost Retail':
+      return 'auspost'
+    case 'BPay':
+      return 'bpay'
+    case 'Blueshyft Online':
+      return 'blueshyft'
+    case 'POLi Transfer':
+      return 'poli'
+    case 'Sofort Transfer':
+      return 'sofort'
+    case 'Checkout Credit Card':
+    case 'WorldPay Credit Card':
+      return 'credit'
+    case 'ClearJunction Fast Pay':
+    case 'ClearJunction Sell Fast Pay':
+      return 'fasterpayments'
+    case 'ClearJunction Sepa':
+    case 'Ten31 Sepa':
+      return 'sepa'
+    case 'DCBank Interac':
+    case 'DCBank Interac Sell':
+      return 'interac'
+    case 'Enumis Transfer':
+      return 'fasterpayments'
+    case 'Monoova Sell':
+      return 'banktransfer'
+    case 'NPP PayID':
+    case 'PayID via Monoova':
+      return 'payid'
+    case 'WorldPay ApplePay':
+      return 'applepay'
+    case 'WorldPay GooglePay':
+      return 'googlepay'
+    case 'iDEAL Transfer':
+      return 'ideal'
+    default:
+      throw new Error(`Unknown payment method: ${tx.payment_type} for ${tx.id}`)
+  }
+}

src/partners/bitaccess.ts

@@ -4,7 +4,8 @@ import {
   asObject,
   asOptional,
   asString,
-  asUnknown
+  asUnknown,
+  asValue
 } from 'cleaners'
 import crypto from 'crypto'
 import fetch from 'node-fetch'
@@ -13,11 +14,13 @@ import { PartnerPlugin, PluginParams, PluginResult, StandardTx } from '../types'
 import { datelog } from '../util'
 
 const asBitaccessTx = asObject({
+  trade_type: asValue<['buy', 'sell']>('buy', 'sell'),
   transaction_id: asString,
   tx_hash: asOptional(asString),
   deposit_address: asString,
   deposit_currency: asString,
   deposit_amount: asNumber,
+  location_address: asString,
   withdrawal_address: asOptional(asString),
   withdrawal_currency: asString,
   withdrawal_amount: asNumber,
@@ -132,13 +135,19 @@ export function processBitaccessTx(rawTx: unknown): StandardTx {
     payoutTxid = tx.tx_hash
   }
 
+  const countryCode = parseLocationAddressForCountryCode(tx.location_address)
+
   const standardTx: StandardTx = {
     status: 'complete',
     orderId: tx.transaction_id,
+    countryCode,
     depositTxid,
     depositAddress: tx.deposit_address,
     depositCurrency: tx.deposit_currency.toUpperCase(),
     depositAmount: tx.deposit_amount,
+    direction: tx.trade_type,
+    exchangeType: 'fiat',
+    paymentType: 'cash',
     payoutTxid,
     payoutAddress: tx.withdrawal_address,
     payoutCurrency: tx.withdrawal_currency.toUpperCase(),
@@ -150,3 +159,11 @@ export function processBitaccessTx(rawTx: unknown): StandardTx {
   }
   return standardTx
 }
+
+function parseLocationAddressForCountryCode(location: string): string {
+  const parts = location.split(', ')
+  if (parts.length !== 4 || parts[3].length > 3) {
+    throw new Error(`Unexpected location address: ${location}`)
+  }
+  return parts[3]
+}

src/partners/bitrefill.ts

@@ -21,6 +21,7 @@ const asBitrefillTx = asObject({
   satoshiPrice: asOptional(asNumber),
   value: asString,
   currency: asString,
+  country: asString,
   coinCurrency: asString,
   receivedPaymentAltcoin: asOptional(asNumber),
   orderId: asString,
@@ -146,10 +147,14 @@ export function processBitrefillTx(rawTx: unknown): StandardTx {
   const standardTx: StandardTx = {
     status: 'complete',
     orderId: tx.orderId,
+    countryCode: tx.country.toUpperCase(),
     depositTxid: undefined,
     depositAddress: undefined,
     depositCurrency: inputCurrency,
     depositAmount,
+    direction: 'sell',
+    exchangeType: 'fiat',
+    paymentType: 'giftcard',
     payoutTxid: undefined,
     payoutAddress: undefined,
     payoutCurrency: tx.currency,

src/partners/bitsofgold.ts

@@ -1,4 +1,12 @@
-import { asArray, asNumber, asObject, asString, asUnknown } from 'cleaners'
+import {
+  asArray,
+  asMaybe,
+  asNumber,
+  asObject,
+  asString,
+  asUnknown,
+  asValue
+} from 'cleaners'
 import fetch from 'node-fetch'
 
 import { PartnerPlugin, PluginParams, PluginResult, StandardTx } from '../types'
@@ -106,13 +114,23 @@ export function processBitsOfGoldTx(rawTx: unknown): StandardTx {
     payoutAmount = data.fiat_amount
   }
 
+  const direction = asMaybe(asValue('buy', 'sell'), undefined)(bogTx.type)
+
+  if (direction == null) {
+    throw new Error(`Invalid direction ${bogTx.type}`)
+  }
+
   const standardTx: StandardTx = {
     status: 'complete',
     orderId: bogTx.id,
+    countryCode: null,
     depositTxid: undefined,
     depositAddress: undefined,
     depositCurrency,
     depositAmount,
+    direction,
+    exchangeType: 'fiat',
+    paymentType: data.fiat_type === 'ILS' ? 'israelibank' : 'sepa',
     payoutTxid: undefined,
     payoutAddress: undefined,
     payoutCurrency,

src/partners/bity.ts

@@ -158,13 +158,29 @@ export const bity: PartnerPlugin = {
 export function processBityTx(rawTx: unknown): StandardTx {
   const tx = asBityTx(rawTx)
 
+  // Assume that one currency is EUR and that's the only fiat currency supported
+  // by Bity.
+  if (
+    tx.input.currency.toUpperCase() !== 'EUR' &&
+    tx.output.currency.toUpperCase() !== 'EUR'
+  ) {
+    throw new Error(
+      `Unknown fiat currency ${tx.input.currency} or ${tx.output.currency}`
+    )
+  }
+  const direction = tx.input.currency.toUpperCase() === 'EUR' ? 'buy' : 'sell'
+
   const standardTx: StandardTx = {
     status: 'complete',
     orderId: tx.id,
+    countryCode: null,
     depositTxid: undefined,
     depositAddress: undefined,
     depositCurrency: tx.input.currency.toUpperCase(),
     depositAmount: safeParseFloat(tx.input.amount),
+    direction,
+    exchangeType: 'fiat',
+    paymentType: 'sepa',
     payoutTxid: undefined,
     payoutAddress: undefined,
     payoutCurrency: tx.output.currency.toUpperCase(),

src/partners/changehero.ts

@@ -164,10 +164,14 @@ export function processChangeHeroTx(rawTx: unknown): StandardTx {
   const standardTx: StandardTx = {
     status: statusMap[tx.status],
     orderId: tx.id,
+    countryCode: null,
     depositTxid: tx.payinHash,
     depositAddress: tx.payinAddress,
     depositCurrency: tx.currencyFrom.toUpperCase(),
     depositAmount: safeParseFloat(tx.amountFrom),
+    direction: null,
+    exchangeType: 'swap',
+    paymentType: null,
     payoutTxid: tx.payoutHash,
     payoutAddress: tx.payoutAddress,
     payoutCurrency: tx.currencyTo.toUpperCase(),

src/partners/changelly.ts

@@ -176,10 +176,14 @@ export function processChangellyTx(rawTx: unknown): StandardTx {
   const standardTx: StandardTx = {
     status: 'complete',
     orderId: tx.id,
+    countryCode: null,
     depositTxid: tx.payinHash,
     depositAddress: tx.payinAddress,
     depositCurrency: tx.currencyFrom.toUpperCase(),
     depositAmount: safeParseFloat(tx.amountFrom),
+    direction: null,
+    exchangeType: 'swap',
+    paymentType: null,
     payoutTxid: tx.payoutHash,
     payoutAddress: tx.payoutAddress,
     payoutCurrency: tx.currencyTo.toUpperCase(),

src/partners/changenow.ts

@@ -147,10 +147,14 @@ export function processChangeNowTx(rawTx: unknown): StandardTx {
   const standardTx: StandardTx = {
     status: statusMap[tx.status],
     orderId: tx.requestId,
+    countryCode: null,
     depositTxid: tx.payin.hash,
     depositAddress: tx.payin.address,
     depositCurrency: tx.payin.currency.toUpperCase(),
     depositAmount: tx.payin.amount ?? tx.payin.expectedAmount ?? 0,
+    direction: null,
+    exchangeType: 'swap',
+    paymentType: null,
     payoutTxid: tx.payout.hash,
     payoutAddress: tx.payout.address,
     payoutCurrency: tx.payout.currency.toUpperCase(),

src/partners/coinswitch.ts

@@ -112,10 +112,14 @@ export function processCoinSwitchTx(rawTx: unknown): StandardTx {
   const standardTx: StandardTx = {
     status: 'complete',
     orderId: tx.orderId,
+    countryCode: null,
     depositTxid,
     depositAddress: tx.exchangeAddress.address,
     depositCurrency: tx.depositCoin.toUpperCase(),
     depositAmount: tx.depositCoinAmount,
+    direction: null,
+    exchangeType: 'swap',
+    paymentType: null,
     payoutTxid,
     payoutAddress: tx.destinationAddress.address,
     payoutCurrency: tx.destinationCoin.toUpperCase(),