@exodus/solana-api 2.0.14 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/solana-api",
-  "version": "2.0.14",
+  "version": "2.1.0",
   "description": "Exodus internal Solana asset API wrapper",
   "main": "src/index.js",
   "files": [
@@ -20,7 +20,8 @@
     "@exodus/fetch": "^1.2.0",
     "@exodus/models": "^8.7.2",
     "@exodus/nfts-core": "^0.5.0",
-    "@exodus/solana-lib": "^1.3.15",
+    "@exodus/solana-lib": "^1.4.0",
+    "@ungap/url-search-params": "^0.2.2",
     "bn.js": "^4.11.0",
     "debug": "^4.1.1",
     "lodash": "^4.17.11",
@@ -30,5 +31,5 @@
   "devDependencies": {
     "node-fetch": "~2.6.0"
   },
-  "gitHead": "16410d60f413eda6aeb3372c23875b98c20de06c"
+  "gitHead": "6ffded97383f994c21ccaebb2703c32d48aa70c5"
 }

package/src/api.js

@@ -101,8 +101,12 @@ export class Api {
     return this.api.post({ method, params })
   }
 
+  getTokenByAddress(mint: string) {
+    return this.tokens[mint]
+  }
+
   isTokenSupported(mint: string) {
-    return !!this.tokens[mint]
+    return !!this.getTokenByAddress(mint)
   }
 
   async getEpochInfo(): number {
@@ -115,10 +119,10 @@ export class Api {
     return state
   }
 
-  async getRecentBlockHash(): string {
+  async getRecentBlockHash(commitment?: string): Promise<string> {
     const result = await this.rpcCall(
       'getRecentBlockhash',
-      [{ commitment: 'finalized', encoding: 'jsonParsed' }],
+      [{ commitment: commitment || 'finalized', encoding: 'jsonParsed' }],
       { forceHttp: true }
     )
     return lodash.get(result, 'value.blockhash')
@@ -234,14 +238,8 @@ export class Api {
     tokenAccountsByOwner: ?Array,
     { includeUnparsed = false } = {}
   ): Object {
-    let {
-      fee,
-      preBalances,
-      postBalances,
-      preTokenBalances,
-      postTokenBalances,
-      innerInstructions,
-    } = txDetails.meta
+    let { fee, preBalances, postBalances, preTokenBalances, postTokenBalances, innerInstructions } =
+      txDetails.meta
     preBalances = preBalances || []
     postBalances = postBalances || []
     preTokenBalances = preTokenBalances || []

package/src/index.js

@@ -2,6 +2,7 @@ import { Api } from './api'
 export * from './api'
 export * from './tx-log'
 export * from './account-state'
+export * from './pay'
 
 // At some point we would like to exclude this export. Default export should be the whole asset "plugin" ready to be injected.
 // Clients should not call an specific server api directly.

package/src/pay/index.js

@@ -0,0 +1,3 @@
+export * from './parseURL.js'
+export * from './prepareSendData.js'
+export * from './validateBeforePay'

package/src/pay/parseURL.js

@@ -0,0 +1,117 @@
+// @flow
+import { PublicKey } from '@exodus/solana-lib'
+import BigNumber from 'bignumber.js'
+import assets from '@exodus/assets'
+import URLSearchParams from '@ungap/url-search-params'
+import api from '..'
+
+const SOLANA_PROTOCOL = 'solana:'
+const HTTPS_PROTOCOL = 'https:'
+
+export class ParseURLError extends Error {
+  name = 'ParseURLError'
+}
+
+export type TransactionRequestURL = {
+  link: URL,
+  label?: string,
+  message?: string,
+}
+
+export type TransferRequestURL = {
+  recipient: string,
+  reference?: Array<string>,
+  amount?: string,
+  splToken?: string,
+  message?: string,
+  memo?: string,
+}
+
+export type ParsedURL = TransactionRequestURL | TransferRequestURL
+
+export function parseURL(url: string | URL): ParsedURL {
+  if (typeof url === 'string') {
+    if (url.length > 2048) throw new ParseURLError('length invalid')
+    url = new URL(url)
+  }
+  if (url.protocol !== SOLANA_PROTOCOL) throw new ParseURLError('protocol invalid')
+  if (!url.pathname) throw new ParseURLError('pathname missing')
+  return /[:%]/.test(url.pathname) ? parseTransactionRequestURL(url) : parseTransferRequestURL(url)
+}
+
+function parseTransactionRequestURL(url: URL): TransactionRequestURL {
+  const link = new URL(decodeURIComponent(url.pathname))
+  const searchParams = new URLSearchParams(url.search)
+  if (link.protocol !== HTTPS_PROTOCOL) throw new ParseURLError('link invalid')
+
+  const label = searchParams.get('label') || undefined
+  const message = searchParams.get('message') || undefined
+
+  return {
+    link,
+    label,
+    message,
+  }
+}
+
+function parseTransferRequestURL(url: URL): TransferRequestURL {
+  let recipient: PublicKey
+  try {
+    recipient = new PublicKey(url.pathname)
+  } catch (error) {
+    throw new Error('ParseURLError: recipient invalid')
+  }
+
+  const searchParams = new URLSearchParams(url.search)
+
+  let amount: BigNumber
+  const amountParam = searchParams.get('amount')
+  if (amountParam) {
+    if (!/^\d+(\.\d+)?$/.test(amountParam)) throw new Error('ParseURLError: amount invalid')
+    amount = new BigNumber(amountParam)
+    if (amount.isNaN()) throw new Error('ParseURLError: amount NaN')
+    if (amount.isNegative()) throw new Error('ParseURLError: amount negative')
+  }
+
+  let splToken: PublicKey
+  const splTokenParam = searchParams.get('spl-token')
+  if (splTokenParam) {
+    try {
+      splToken = new PublicKey(splTokenParam)
+    } catch (error) {
+      throw new ParseURLError('spl-token invalid')
+    }
+  }
+
+  let asset = assets.solana
+  if (splToken) {
+    if (!api.isTokenSupported(splToken))
+      throw new ParseURLError(`spl-token ${splToken} is not supported`)
+    asset = api.getTokenByAddress(splToken)
+  }
+
+  let reference: PublicKey[]
+  const referenceParams = searchParams.getAll('reference')
+  if (referenceParams.length) {
+    try {
+      reference = referenceParams.map((reference) => new PublicKey(reference))
+    } catch (error) {
+      throw new ParseURLError('reference invalid')
+    }
+  }
+
+  const label = searchParams.get('label') || undefined
+  const message = searchParams.get('message') || undefined
+  const memo = searchParams.get('memo') || undefined
+
+  return {
+    asset,
+    recipient: recipient.toString(),
+    amount: amount ? amount.toString(10) : undefined,
+    splToken: splToken ? splToken.toString() : undefined,
+    reference,
+    label,
+    message,
+    memo,
+  }
+}

package/src/pay/prepareSendData.js

@@ -0,0 +1,26 @@
+// @flow
+import assert from 'assert'
+
+import type { ParsedURL } from './parseURL'
+
+export function prepareSendData(parsedData: ParsedURL, { asset, feeAmount, walletAccount }) {
+  const { amount: amountStr, recipient, splToken, ...options } = parsedData
+
+  assert(amountStr, 'PrepareTxError: Missing amount')
+  assert(recipient, 'PrepareTxError: Missing recipient')
+
+  const amount = asset.currency.defaultUnit(amountStr)
+
+  return {
+    asset: asset.name,
+    baseAsset: asset.baseAsset,
+    customMintAddress: splToken,
+    feeAmount,
+    receiver: {
+      address: recipient,
+      amount,
+    },
+    walletAccount,
+    ...options,
+  }
+}

package/src/pay/validateBeforePay.js

@@ -0,0 +1,37 @@
+// @flow
+import api from '..'
+import NumberUnit from '@exodus/currency'
+
+export class ValidateError extends Error {
+  name = 'ValidateError'
+}
+
+type PaymentRequest = {
+  asset: Object,
+  senderInfo: Object,
+  feeAmount: NumberUnit,
+  recipient: string,
+  amount: number,
+  checkEnoughBalance?: boolean,
+}
+
+export async function validateBeforePay({
+  asset,
+  senderInfo,
+  amount,
+  feeAmount = 0,
+  recipient,
+  checkEnoughBalance = true,
+}: PaymentRequest) {
+  const isNative = asset.name === asset.baseAsset.name
+  const recipientInfo = await api.getAccountInfo(recipient)
+  if (!recipientInfo) throw new ValidateError(`recipient ${recipient} not found`)
+
+  if (checkEnoughBalance) {
+    const totalAmountMustPay = asset.currency.defaultUnit(amount).add(feeAmount)
+    const currentBalance = isNative ? senderInfo.balance : senderInfo.tokenBalances[asset.name]
+    if (totalAmountMustPay.gt(currentBalance)) throw new ValidateError(`insufficient funds`)
+  }
+
+  return true
+}