@exodus/solana-lib 1.1.0 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/solana-lib",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Exodus internal Solana low-level library",
   "main": "src/index.js",
   "files": [
@@ -15,13 +15,12 @@
   "dependencies": {
     "@exodus/asset-lib": "^3.4.3",
     "@exodus/assets": "^8.0.0",
-    "@exodus/buffer-layout": "^1.2.0-exodus0",
-    "@exodus/models": "^8.2.0",
-    "@exodus/solana-web3.js": "0.87.1-exodus1",
+    "@exodus/models": "^8.4.0",
+    "@exodus/solana-spl-token": "^0.0.13-exodus1",
+    "@exodus/solana-web3.js": "^0.87.1-exodus4",
     "bn.js": "~4.11.0",
     "bs58": "~4.0.1",
-    "create-hash": "~1.1.3",
     "tweetnacl": "^1.0.3"
   },
-  "gitHead": "f18544ae45db87c7efec7d8139e1e04c51e0fc32"
+  "gitHead": "51f71e5bcebd886116bf433c8fe79859a185d16c"
 }

package/src/constants.js

@@ -0,0 +1,7 @@
+import { PublicKey, SystemProgram } from '@exodus/solana-web3.js'
+export { TOKEN_PROGRAM_ID } from '@exodus/solana-spl-token'
+
+export const SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID = new PublicKey(
+  'ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL'
+)
+export const SYSTEM_PROGRAM_ID = SystemProgram.programId

package/src/encode.js

@@ -1,4 +1,7 @@
 // @flow
+import { PublicKey } from '@exodus/solana-web3.js'
+import { TOKEN_PROGRAM_ID } from '@exodus/solana-spl-token'
+import { SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID } from './constants'
 import { getPublicKey } from './keypair'
 import bs58 from 'bs58'
 import BN from 'bn.js'
@@ -27,3 +30,16 @@ export function isValidAddress(address: string): boolean {
     return false
   }
 }
+
+// doc: https://spl.solana.com/associated-token-account (HACK: refactored to sync)
+export function findAssociatedTokenAddress(
+  walletAddress: string,
+  tokenMintAddress: string
+): string {
+  walletAddress = new PublicKey(walletAddress)
+  tokenMintAddress = new PublicKey(tokenMintAddress)
+  return PublicKey.findProgramAddress(
+    [walletAddress.toBuffer(), TOKEN_PROGRAM_ID.toBuffer(), tokenMintAddress.toBuffer()],
+    SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID
+  )[0].toBase58() // returns encoded PublicKey
+}

package/src/helpers.js

@@ -0,0 +1,83 @@
+import {
+  PublicKey,
+  TransactionInstruction,
+  SystemProgram,
+  SYSVAR_RENT_PUBKEY,
+} from '@exodus/solana-web3.js'
+import { Token, TOKEN_PROGRAM_ID } from '@exodus/solana-spl-token'
+import { SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID } from './constants'
+import { findAssociatedTokenAddress } from './encode'
+
+// https://github.com/paul-schaaf/spl-token-ui/blob/main/src/solana/token/associatedToken.ts#L59
+export const createAssociatedTokenAccount = (
+  senderAddress: string,
+  tokenMintAddress: string,
+  ownerAddress: string // destination SOL address
+) => {
+  const associatedTokenAccountPublicKey = new PublicKey(
+    findAssociatedTokenAddress(ownerAddress, tokenMintAddress)
+  )
+
+  const feePayerPublicKey = new PublicKey(senderAddress)
+  const ownerPublicKey = new PublicKey(ownerAddress)
+  const tokenMintPublicKey = new PublicKey(tokenMintAddress)
+
+  const ix = createIx(
+    feePayerPublicKey, // feePayer
+    associatedTokenAccountPublicKey,
+    ownerPublicKey,
+    tokenMintPublicKey
+  )
+
+  return ix // returns the instruction
+}
+
+function createIx(
+  funderPubkey: PublicKey,
+  associatedTokenAccountPublicKey: PublicKey,
+  ownerPublicKey: PublicKey,
+  tokenMintPublicKey: PublicKey
+) {
+  return new TransactionInstruction({
+    programId: SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID,
+    data: Buffer.from([]),
+    keys: [
+      { pubkey: funderPubkey, isSigner: true, isWritable: true },
+      {
+        pubkey: associatedTokenAccountPublicKey,
+        isSigner: false,
+        isWritable: true,
+      },
+      { pubkey: ownerPublicKey, isSigner: false, isWritable: false },
+      { pubkey: tokenMintPublicKey, isSigner: false, isWritable: false },
+      { pubkey: SystemProgram.programId, isSigner: false, isWritable: false },
+      { pubkey: TOKEN_PROGRAM_ID, isSigner: false, isWritable: false },
+      { pubkey: SYSVAR_RENT_PUBKEY, isSigner: false, isWritable: false },
+    ],
+  })
+}
+
+// https://github.com/paul-schaaf/spl-token-ui/blob/main/src/solana/token/editing.ts#L207
+export const createTokenTransferInstruction = (
+  owner,
+  fromTokenAddress,
+  tokenMintAddress,
+  to,
+  amount
+) => {
+  const sourcePubkey = new PublicKey(fromTokenAddress) // the token ADDRESS needed!
+  const destinationPubkey = new PublicKey(findAssociatedTokenAddress(to, tokenMintAddress))
+  console.log(`destination associatedTokenAddress: ${destinationPubkey.toBase58()}`)
+  const ownerAccountOrWalletPublicKey = new PublicKey(owner) // the only native SOL address
+
+  const transferIx = Token.createTransferInstruction(
+    TOKEN_PROGRAM_ID,
+    sourcePubkey,
+    destinationPubkey,
+    ownerAccountOrWalletPublicKey,
+    [],
+    amount
+  )
+
+  return transferIx
+}

package/src/index.js

@@ -1,6 +1,8 @@
 // @flow
 
+export * from './constants'
 export * from './encode'
 export * from './keypair'
 export * from './tx'
+export { default as tokens } from './tokens'
 export { default as Transaction } from './transaction'

package/src/tokens.js

@@ -0,0 +1,26 @@
+// reference https://github.com/project-serum/spl-token-wallet/blob/master/src/utils/tokens/names.js
+
+const TOKENS = [
+  {
+    mintAddress: 'SRMuApVNdxXokk5GT7XD5cUUgXMBCoAz2LHeuAoKWRt',
+    tokenName: 'Serum',
+    tokenSymbol: 'SRM',
+  },
+  {
+    tokenSymbol: 'BTC',
+    mintAddress: '9n4nbM75f5Ui33ZbPYXn59EwSgE8CGsHtAeTH5YFeJ9E',
+    tokenName: 'Wrapped Bitcoin',
+    icon:
+      'https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/bitcoin/info/logo.png',
+  },
+  {
+    tokenSymbol: 'USDC',
+    mintAddress: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v',
+    tokenName: 'USD Coin',
+    icon:
+      'https://raw.githubusercontent.com/trustwallet/assets/f3ffd0b9ae2165336279ce2f8db1981a55ce30f8/blockchains/ethereum/assets/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/logo.png',
+  },
+  // ... TODO: do we want to add decimals for every token? (Serum SRM is 6)
+]
+
+export default TOKENS

package/src/transaction.js

@@ -3,6 +3,8 @@ import assert from 'assert'
 
 import { Account, SystemProgram, Transaction, PublicKey } from '@exodus/solana-web3.js'
 import { getKeyPairFromPrivateKey } from './keypair'
+import { createAssociatedTokenAccount, createTokenTransferInstruction } from './helpers'
+import TOKENS from './tokens'
 import bs58 from 'bs58'
 
 class Tx {
@@ -10,21 +12,47 @@ class Tx {
     from,
     to,
     amount,
-    // fee, // (Fee per Signature: 5000 lamports)
     recentBlockhash,
+    // fee, // (Fee per Signature: 5000 lamports)
+    // Tokens related:
+    tokenTicker,
+    isAssociatedTokenAccountActive, // true when recipient balance !== 0
+    fromTokenAddresses, // sender token addresses
   } = {}) {
     assert(from, 'from is required')
     assert(to, 'to is required')
     assert(amount, 'amount is required')
     assert(typeof amount === 'number', 'amount must be a number')
     assert(recentBlockhash, 'recentBlockhash is required')
+    if (tokenTicker) {
+      assert(
+        typeof isAssociatedTokenAccountActive !== 'undefined',
+        'isAssociatedTokenAccountActive is required when sending tokens'
+      ) // needed to create the recipient account
+      assert(Array.isArray(fromTokenAddresses), 'fromTokenAddresses Array is required')
+    }
+
+    const token = TOKENS.find(({ tokenSymbol }) => tokenSymbol === tokenTicker)
     this.txObj = {
       from,
       to,
       amount,
       recentBlockhash,
+      token,
+      isAssociatedTokenAccountActive,
+      fromTokenAddresses,
     }
 
+    if (token) {
+      // TOKEN transfer tx
+      this.buildTokenTransaction(this.txObj)
+    } else {
+      // SOL tx
+      this.buildSOLtransaction(this.txObj)
+    }
+  }
+
+  buildSOLtransaction({ from, to, amount, recentBlockhash }) {
     const txInstruction = SystemProgram.transfer({
       fromPubkey: new PublicKey(from),
       toPubkey: new PublicKey(to),
@@ -37,6 +65,53 @@ class Tx {
     })
   }
 
+  buildTokenTransaction({
+    from,
+    to,
+    amount,
+    recentBlockhash,
+    token,
+    isAssociatedTokenAccountActive,
+    fromTokenAddresses,
+  }) {
+    this.transaction = new Transaction({
+      recentBlockhash,
+    })
+    // crete account instruction
+    if (!isAssociatedTokenAccountActive)
+      this.transaction.add(createAssociatedTokenAccount(from, token.mintAddress, to))
+
+    let amountLeft = amount
+    let amountToSend
+    for (let { ticker, tokenAccountAddress, balance } of fromTokenAddresses) {
+      // need to add more of this instruction until we reach the desired balance (amount) to send
+      assert(ticker === token.tokenSymbol, `Got unexpected ticker ${ticker}`)
+      if (amountLeft === 0) break
+
+      balance = Number(balance)
+      if (balance >= amountLeft) {
+        amountToSend = amountLeft
+        amountLeft = 0
+      } else {
+        amountToSend = balance // not enough balance
+        amountLeft -= amountToSend
+      }
+
+      // add transfer token instruction
+      this.transaction.add(
+        createTokenTransferInstruction(
+          from,
+          tokenAccountAddress,
+          token.mintAddress,
+          to,
+          amountToSend
+        )
+      )
+    }
+
+    assert(amountLeft === 0, `Not enough balance to send ${amount} ${token.tokenSymbol}`)
+  }
+
   static sign(tx: Tx, privateKey: Buffer | string) {
     if (!privateKey) throw new Error('Please provide a secretKey')
     const { secretKey } = getKeyPairFromPrivateKey(privateKey)