added: Xgram swap provider

Author: xgram

scripts/mappings/xgramMappings.ts

@@ -20,7 +20,7 @@ xgram.set('AVAXC', 'avalanche')
 xgram.set('BITCOINCASH', 'bitcoincash')
 
 // WARNING: Not included by the synchronizer synchronization
-xgram.set('BSC', 'binance')
+xgram.set('BSC', 'binancesmartchain')
 
 // WARNING: Not included by the synchronizer synchronization
 xgram.set('BSV', 'bitcoinsv')

scripts/synchronizers/xgram/xgramSynchronizer.ts

@@ -1,31 +1,17 @@
-import fs from 'fs'
-import path from 'path'
-
-import { EdgeCurrencyPluginId } from '../../../src/util/edgeCurrencyPluginIds'
 import { MapctlConfig } from '../../mapctlConfig'
 import { FetchChainCodeResult, SwapSynchronizer } from '../../types'
+import { getMappingFilePath, loadMappingFile } from '../../util/loadMappingFile'
 
-const MAPPING_FILE_PATH = path.join(
-  __dirname,
-  '../../mappings/xgramMappings.ts'
-)
-
+const NAME = 'xgram'
 export const makeXgramSynchronizer = (
   _config: MapctlConfig
 ): SwapSynchronizer => {
   return {
-    name: 'xgram',
-    get map(): Map<string, EdgeCurrencyPluginId | null> {
-      if (fs.existsSync(MAPPING_FILE_PATH)) {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        const { xgram } = require('../../mappings/xgramMappings')
-        return xgram
-      }
-      return new Map()
+    name: NAME,
+    get map() {
+      return loadMappingFile(NAME)
     },
-    mappingFilePath: MAPPING_FILE_PATH,
-    fetchChainCodes: async (): Promise<FetchChainCodeResult[]> => {
-      return []
-    }
+    mappingFilePath: getMappingFilePath(NAME),
+    fetchChainCodes: async (): Promise<FetchChainCodeResult[]> => []
   }
 }

src/index.ts

@@ -32,7 +32,6 @@ const plugins = {
   bridgeless: makeBridgelessPlugin,
   changehero: makeChangeHeroPlugin,
   changenow: makeChangeNowPlugin,
-  xgram: makeXgramPlugin,
   cosmosibc: makeCosmosIbcPlugin,
   exolix: makeExolixPlugin,
   godex: makeGodexPlugin,
@@ -50,6 +49,7 @@ const plugins = {
   transfer: makeTransferPlugin,
   unizen: makeUnizenPlugin,
   velodrome: makeVelodromePlugin,
+  xgram: makeXgramPlugin,
   xrpdex,
   fantomsonicupgrade: makeFantomSonicUpgradePlugin,
   '0xgasless': make0xGaslessPlugin

src/mappings/xgram.ts

@@ -22,8 +22,8 @@ xgram.set('avalanche', 'AVAXC')
 xgram.set('axelar', null)
 xgram.set('badcoin', null)
 xgram.set('base', null)
-xgram.set('binance', 'BSC')
-xgram.set('binancesmartchain', null)
+xgram.set('binance', null)
+xgram.set('binancesmartchain', 'BSC')
 xgram.set('bitcoin', 'BTC')
 xgram.set('bitcoincash', 'BITCOINCASH')
 xgram.set('bitcoincashtestnet', null)
@@ -34,6 +34,7 @@ xgram.set('bitcointestnet', null)
 xgram.set('bitcointestnet4', null)
 xgram.set('bobevm', null)
 xgram.set('botanix', null)
+xgram.set('cacao', null)
 xgram.set('calibration', null)
 xgram.set('cardano', 'ada')
 xgram.set('cardanotestnet', null)
@@ -63,7 +64,11 @@ xgram.set('hyperevm', null)
 xgram.set('liberland', null)
 xgram.set('liberlandtestnet', null)
 xgram.set('litecoin', null)
+xgram.set('mayachain', null)
+xgram.set('monad', null)
 xgram.set('monero', 'XMR')
+xgram.set('nym', null)
+xgram.set('opbnb', null)
 xgram.set('optimism', 'OPTIMISM')
 xgram.set('osmosis', 'OSMO')
 xgram.set('piratechain', null)

src/swap/central/xgram.ts

@@ -3,12 +3,11 @@ import {
   asBoolean,
   asDate,
   asEither,
+  asMaybe,
   asNumber,
   asObject,
-  asOptional,
   asString,
-  asValue,
-  Cleaner
+  asValue
 } from 'cleaners'
 import {
   EdgeCorePluginOptions,
@@ -29,17 +28,21 @@ import { EdgeCurrencyPluginId } from '../../util/edgeCurrencyPluginIds'
 import {
   checkWhitelistedMainnetCodes,
   CurrencyPluginIdSwapChainCodeMap,
-  denominationToNative,
   ensureInFuture,
   getContractAddresses,
   getMaxSwappable,
   makeSwapPluginQuote,
   mapToRecord,
-  nativeToDenomination,
   SwapOrder
 } from '../../util/swapHelpers'
-import { convertRequest, getAddress, memoType } from '../../util/utils'
-import { EdgeSwapRequestPlugin } from '../types'
+import {
+  convertRequest,
+  denominationToNative,
+  getAddress,
+  memoType,
+  nativeToDenomination
+} from '../../util/utils'
+import { EdgeSwapRequestPlugin, StringMap } from '../types'
 
 const pluginId = 'xgram'
 
@@ -51,8 +54,7 @@ export const swapInfo: EdgeSwapInfo = {
 }
 
 const asInitOptions = asObject({
-  apiKey: asString,
-  affiliateId: asOptional(asString)
+  apiKey: asString
 })
 
 const orderUri = 'https://xgram.io/exchange/order?id='
@@ -64,8 +66,11 @@ export const MAINNET_CODE_TRANSCRIPTION: CurrencyPluginIdSwapChainCodeMap = mapT
   xgramMapping
 )
 
-const swapType: FlowType = 'fixed'
-type FlowType = 'fixed' | 'float'
+const addressTypeMap: StringMap = {
+  zcash: 'transparentAddress'
+}
+
+const swapType = 'fixed' as const
 
 export function makeXgramPlugin(opts: EdgeCorePluginOptions): EdgeSwapPlugin {
   const { io } = opts
@@ -85,8 +90,14 @@ export function makeXgramPlugin(opts: EdgeCorePluginOptions): EdgeSwapPlugin {
     const { fromWallet, toWallet, nativeAmount } = request
 
     const [fromAddress, toAddress] = await Promise.all([
-      getAddress(fromWallet),
-      getAddress(toWallet)
+      getAddress(
+        request.fromWallet,
+        addressTypeMap[request.fromWallet.currencyInfo.pluginId]
+      ),
+      getAddress(
+        request.toWallet,
+        addressTypeMap[request.toWallet.currencyInfo.pluginId]
+      )
     ])
 
     const { fromContractAddress, toContractAddress } = getContractAddresses(
@@ -132,10 +143,11 @@ export function makeXgramPlugin(opts: EdgeCorePluginOptions): EdgeSwapPlugin {
 
       const orderResponseJson = await orderResponse.json()
       const quoteFor = request?.quoteFor === 'from' ? 'from' : 'to'
-      const quoteReply = asTemplateQuoteReply(orderResponseJson)
+      const quoteReply = asXgramQuoteReply(orderResponseJson)
 
       if ('errors' in quoteReply) {
         const errors = quoteReply.errors
+
         if (errors.find(error => error.code === 'REGION_UNSUPPORTED') != null) {
           throw new SwapPermissionError(swapInfo, 'geoRestriction')
         }
@@ -145,7 +157,9 @@ export function makeXgramPlugin(opts: EdgeCorePluginOptions): EdgeSwapPlugin {
         ) {
           throw new SwapCurrencyError(swapInfo, request)
         }
-        const limitError = errors.find(isTemplateLimitError)
+        const limitError = errors
+          .map(e => asMaybe(asXgramLimitError)(e))
+          .find(e => e != null)
 
         if (limitError?.code === 'BELOW_LIMIT') {
           const sourceAmountLimit = denominationToNative(
@@ -297,15 +311,6 @@ export function makeXgramPlugin(opts: EdgeCorePluginOptions): EdgeSwapPlugin {
   return out
 }
 
-export function asOptionalBlank<T>(
-  cleaner: Cleaner<T>
-): Cleaner<T | undefined> {
-  return function asIgnoredBlank(raw: any) {
-    if (raw == null || raw === '') return undefined
-    return cleaner(raw)
-  }
-}
-
 interface XgramResponse {
   id: string
   fromAmount: string
@@ -315,48 +320,28 @@ interface XgramResponse {
   validUntil?: Date | null
 }
 
-// Type guard to narrow Xgram limit errors in the union type
-function isTemplateLimitError(
-  error: any
-): error is {
-  code: 'BELOW_LIMIT' | 'ABOVE_LIMIT'
-  destinationAmountLimit: string
-  error: string
-  sourceAmountLimit: string
-} {
-  return (
-    error != null &&
-    (error.code === 'BELOW_LIMIT' || error.code === 'ABOVE_LIMIT') &&
-    typeof error.sourceAmountLimit === 'string'
-  )
-}
-
-const asTemplateLimitError = asObject({
+const asXgramLimitError = asObject({
   code: asValue('BELOW_LIMIT', 'ABOVE_LIMIT'),
   destinationAmountLimit: asString,
   error: asString,
   sourceAmountLimit: asString
 })
 
-const asTemplateRegionError = asObject({
+const asXgramRegionError = asObject({
   code: asValue('REGION_UNSUPPORTED'),
   message: asString
 })
 
-const asTemplateCurrencyError = asObject({
+const asXgramCurrencyError = asObject({
   code: asValue('CURRENCY_UNSUPPORTED'),
   error: asString
 })
-const asTemplateError = asObject({
+const asXgramError = asObject({
   errors: asArray(
-    asEither(
-      asTemplateLimitError,
-      asTemplateRegionError,
-      asTemplateCurrencyError
-    )
+    asEither(asXgramLimitError, asXgramRegionError, asXgramCurrencyError)
   )
 })
-const asTemplateQuote = asObject({
+const asXgramQuote = asObject({
   ccyAmountToExpected: asNumber,
   depositAddress: asString,
   depositTag: asString,
@@ -365,4 +350,4 @@ const asTemplateQuote = asObject({
   expiresAt: asDate,
   ccyAmountFrom: asString
 })
-const asTemplateQuoteReply = asEither(asTemplateQuote, asTemplateError)
+const asXgramQuoteReply = asEither(asXgramQuote, asXgramError)