@exodus/solana-api 1.0.1

package/README.md

@@ -0,0 +1,4 @@
+# Solana Api · [![npm version](https://img.shields.io/badge/npm-private-blue.svg?style=flat)](https://www.npmjs.com/package/@exodus/solana-api)
+
+- To get all transactions data from an address we gotta call 3 rpcs `getConfirmedSignaturesForAddress2` (get txIds) -> `getConfirmedTransaction` (get tx details) -> `getBlockTime` (get tx timestamp). Pretty annoying and resource-consuming backend-side. (https://github.com/solana-labs/solana/issues/12411)
+- calling `getBlockTime` might results in an error if the slot/block requested is too old (https://github.com/solana-labs/solana/issues/12413), looks like some Solana validators can choose to not keep all the ledger blocks (fix in progress by solana team).

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@exodus/solana-api",
+  "version": "1.0.1",
+  "description": "Exodus internal Solana asset API wrapper",
+  "main": "src/index.js",
+  "files": [
+    "src/",
+    "!src/__tests__"
+  ],
+  "author": "Exodus",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "dependencies": {
+    "fetchival": "~0.3.2",
+    "lodash": "^4.17.11",
+    "ms": "~0.7.1"
+  },
+  "devDependencies": {
+    "node-fetch": "~1.6.3"
+  },
+  "gitHead": "7afc2c44aff00085db4d14b7696a3fc88f165628"
+}

package/src/index.js

@@ -0,0 +1,241 @@
+// @flow
+import ms from 'ms'
+import fetchival from 'fetchival'
+
+// Doc: https://docs.solana.com/apps/jsonrpc-api
+
+const RPC_URL = 'https://api.mainnet-beta.solana.com' // https://solana-api.projectserum.com
+
+class Api {
+  constructor(rpcUrl) {
+    this.setServer(rpcUrl)
+  }
+
+  setServer(rpcUrl) {
+    this.rpcUrl = rpcUrl || RPC_URL
+  }
+
+  request(path) {
+    return fetchival(this.rpcUrl, {
+      timeout: ms('15s'),
+      headers: { 'Content-Type': 'application/json' },
+    })(path)
+  }
+
+  async getRecentBlockHash() {
+    try {
+      const { result, error } = await this.request('').post({
+        jsonrpc: '2.0',
+        id: getCurrentTime(),
+        method: 'getRecentBlockhash',
+        params: [],
+      })
+      if (error) throw new Error(error.message)
+      return result.value.blockhash
+    } catch (err) {
+      console.log(err)
+      throw new Error(JSON.stringify(await concatStream(err.response)))
+    }
+  }
+
+  // Transaction structure: https://docs.solana.com/apps/jsonrpc-api#transaction-structure
+  async getTransactionById(id: string) {
+    try {
+      const { result, error } = await this.request('').post({
+        jsonrpc: '2.0',
+        id: getCurrentTime(),
+        method: 'getConfirmedTransaction',
+        params: [id, 'json'],
+      })
+      if (error) throw new Error(error.message)
+      return result
+    } catch (err) {
+      console.log(err)
+      throw new Error(JSON.stringify(await concatStream(err.response)))
+    }
+  }
+
+  async getFee(): number {
+    try {
+      const { result, error } = await this.request('').post({
+        jsonrpc: '2.0',
+        id: getCurrentTime(),
+        method: 'getFees',
+        params: [],
+      })
+      if (error) throw new Error(error.message)
+      return result.value.feeCalculator.lamportsPerSignature
+    } catch (err) {
+      throw new Error(JSON.stringify(await concatStream(err.response)))
+    }
+  }
+
+  async getBalance(address: string): number {
+    try {
+      const { result, error } = await this.request('').post({
+        jsonrpc: '2.0',
+        id: getCurrentTime(),
+        method: 'getBalance',
+        params: [address],
+      })
+      if (error) throw new Error(error.message)
+      return result.value || 0
+    } catch (err) {
+      console.log(err)
+      throw new Error(JSON.stringify(await concatStream(err.response)))
+    }
+  }
+
+  async getBlockTime(slot: number): any {
+    try {
+      const { result, error } = await this.request('').post({
+        jsonrpc: '2.0',
+        id: getCurrentTime(),
+        method: 'getBlockTime',
+        params: [slot],
+      })
+      // might result in error if executed on a validator with partial ledger (https://github.com/solana-labs/solana/issues/12413)
+      if (error) console.log(error.message)
+      return result
+    } catch (err) {
+      console.log(err)
+      throw new Error(JSON.stringify(await concatStream(err.response)))
+    }
+  }
+
+  async getConfirmedSignaturesForAddress(address: string, { before, until, limit }): any {
+    try {
+      until = until || undefined
+      const { result, error } = await this.request('').post({
+        jsonrpc: '2.0',
+        id: getCurrentTime(),
+        method: 'getConfirmedSignaturesForAddress2',
+        params: [address, { before, until, limit }],
+      })
+      if (error) throw new Error(error.message)
+      return result
+    } catch (err) {
+      console.log(err)
+      throw new Error(JSON.stringify(await concatStream(err.response)))
+    }
+  }
+
+  /**
+   * Get transactions from an address
+   */
+  async getTransactions(address: string, { cursor, limit } = {}): any {
+    let transactions = []
+    // cursor is a txHash
+
+    try {
+      let until = cursor
+
+      const txsId = await this.getConfirmedSignaturesForAddress(address, {
+        until,
+        limit,
+      })
+
+      for (let tx of txsId) {
+        // get tx details
+        const txDetails = await this.getTransactionById(tx.signature)
+        if (txDetails === null) continue
+
+        const timestamp = (await this.getBlockTime(tx.slot)) * 1000
+
+        const from = txDetails.transaction.message.accountKeys[0]
+        const to = txDetails.transaction.message.accountKeys[1]
+        let { preBalances, postBalances, fee } = txDetails.meta
+        const isSending = address === from
+        fee = !isSending ? 0 : fee
+        const amount = Math.abs(
+          isSending ? preBalances[0] - postBalances[0] - fee : postBalances[1] - preBalances[1]
+        )
+
+        transactions.push({
+          id: tx.signature,
+          memo: tx.memo,
+          slot: tx.slot,
+          timestamp,
+          date: new Date(timestamp),
+          fee, // lamports
+          from,
+          to,
+          amount, // lamports
+          error: !(txDetails.meta.status.Ok === null),
+        })
+      }
+    } catch (err) {
+      console.warn('Solana error:', err)
+      if (err.response) {
+        const error = new Error(JSON.stringify(await concatStream(err.response)))
+        error.status = err.response.status
+        error.statusText = err.response.statusText
+        throw error
+      }
+      throw err
+    }
+
+    const newCursor = transactions[0] ? transactions[0].id : cursor
+
+    return { transactions, newCursor }
+  }
+
+  /**
+   * Broadcast a signed transaction
+   */
+  broadcastTransaction = async (signedTx: string): string => {
+    console.log('Solana broadcasting TX:', signedTx)
+
+    const { result, error } = await this.request('')
+      .post({
+        jsonrpc: '2.0',
+        id: getCurrentTime(),
+        method: 'sendTransaction',
+        params: [signedTx],
+      })
+      .catch(async (err) => {
+        throw new Error(JSON.stringify(await concatStream(err.response)))
+      })
+
+    if (error) throw new Error(error.message)
+
+    console.log(`tx ${result} sent!`)
+    return result || null
+  }
+}
+
+export default new Api()
+
+function getCurrentTime() {
+  const date = new Date()
+  return date.getTime()
+}
+
+function concatStream(response) {
+  const stream = response.body
+  if (typeof stream !== 'object')
+    throw new Error(`${response.status} - ${response.statusText || 'Server Error'}`)
+  if ('locked' in stream) {
+    // fetch browser
+    try {
+      return response.json()
+    } catch (e) {
+      return response.text()
+    }
+  }
+  return new Promise((resolve, reject) => {
+    let result = ''
+    stream.on('data', (chunk) => {
+      result += chunk.toString()
+    })
+    stream.on('end', () => {
+      try {
+        const parsed = JSON.parse(result)
+        resolve(parsed)
+      } catch (e) {
+        resolve(result) // plain text
+      }
+    })
+    stream.on('error', (err) => reject(err))
+  })
+}