@exodus/solana-lib 1.2.3 → 1.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/solana-lib",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Exodus internal Solana low-level library",
   "main": "src/index.js",
   "files": [
@@ -14,13 +14,13 @@
   },
   "dependencies": {
     "@exodus/asset-lib": "^3.4.3",
-    "@exodus/assets": "^8.0.0",
+    "@exodus/assets": "^8.0.2",
+    "@exodus/buffer-layout": "^1.2.0-exodus1",
     "@exodus/models": "^8.4.0",
-    "@exodus/solana-spl-token": "^0.0.13-exodus2",
-    "@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": "5be453e5b6c47cf82b8c80a83e8a4bebbb487a2e"
+  "gitHead": "791e305a718246460d5ac93ed2eb7808955c0f5d"
 }

package/src/constants.js

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

package/src/encode.js

@@ -1,7 +1,6 @@
 // @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 { PublicKey } from './vendor'
+import { SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID, TOKEN_PROGRAM_ID } from './constants'
 import { getPublicKey } from './keypair'
 import bs58 from 'bs58'
 import BN from 'bn.js'

package/src/helpers/spl-token.js

@@ -0,0 +1,108 @@
+import assert from 'assert'
+import BN from 'bn.js'
+import * as BufferLayout from '@exodus/buffer-layout'
+import { Account, PublicKey, TransactionInstruction } from '../vendor'
+import * as Layout from '../vendor/utils/layout'
+
+// Extracted from https://github.com/ExodusMovement/solana-spl-token/blob/master/src/index.js#L263
+
+/**
+ * 64-bit value
+ */
+export class U64 extends BN {
+  /**
+   * Convert to Buffer representation
+   */
+  toBuffer(): typeof Buffer {
+    const a = super.toArray().reverse()
+    const b = Buffer.from(a)
+    if (b.length === 8) {
+      return b
+    }
+    assert(b.length < 8, 'u64 too large')
+
+    const zeroPad = Buffer.alloc(8)
+    b.copy(zeroPad)
+    return zeroPad
+  }
+
+  /**
+   * Construct a u64 from Buffer representation
+   */
+  static fromBuffer(buffer: typeof Buffer): U64 {
+    assert(buffer.length === 8, `Invalid buffer length: ${buffer.length}`)
+    return new U64(
+      [...buffer]
+        .reverse()
+        .map((i) => `00${i.toString(16)}`.slice(-2))
+        .join(''),
+      16
+    )
+  }
+}
+
+const u64 = U64 // alias
+
+/**
+ * An ERC20-like Token
+ */
+export class Token {
+  /**
+   * Construct a Transfer instruction
+   *
+   * @param programId SPL Token program account
+   * @param source Source account
+   * @param destination Destination account
+   * @param owner Owner of the source account
+   * @param multiSigners Signing accounts if `authority` is a multiSig
+   * @param amount Number of tokens to transfer
+   */
+  static createTransferInstruction(
+    programId: PublicKey,
+    source: PublicKey,
+    destination: PublicKey,
+    owner: PublicKey,
+    multiSigners: Array<Account>,
+    amount: number | u64
+  ): TransactionInstruction {
+    const dataLayout = BufferLayout.struct([
+      BufferLayout.u8('instruction'),
+      Layout.uint64('amount'),
+    ])
+
+    const data = Buffer.alloc(dataLayout.span)
+    dataLayout.encode(
+      {
+        instruction: 3, // Transfer instruction
+        amount: new U64(amount).toBuffer(),
+      },
+      data
+    )
+
+    let keys = [
+      { pubkey: source, isSigner: false, isWritable: true },
+      { pubkey: destination, isSigner: false, isWritable: true },
+    ]
+    if (multiSigners.length === 0) {
+      keys.push({
+        pubkey: owner,
+        isSigner: true,
+        isWritable: false,
+      })
+    } else {
+      keys.push({ pubkey: owner, isSigner: false, isWritable: false })
+      multiSigners.forEach((signer) =>
+        keys.push({
+          pubkey: signer.publicKey,
+          isSigner: true,
+          isWritable: false,
+        })
+      )
+    }
+    return new TransactionInstruction({
+      keys,
+      programId: programId,
+      data,
+    })
+  }
+}

package/src/{helpers.js → helpers/tokenTransfer.js}

@@ -1,12 +1,7 @@
-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'
+import { Token } from './spl-token'
+import { PublicKey, TransactionInstruction, SystemProgram, SYSVAR_RENT_PUBKEY } from '../vendor'
+import { SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID, TOKEN_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 = (
@@ -57,17 +52,11 @@ function createIx(
   })
 }
 
-// https://github.com/paul-schaaf/spl-token-ui/blob/main/src/solana/token/editing.ts#L207
-export const createTokenTransferInstruction = (
-  owner,
-  fromTokenAddress,
-  tokenMintAddress,
-  to,
-  amount
-) => {
+// https://github.com/paul-schaaf/spl-token-ui/blob/main/src/solana/token/editing.ts#L211
+export const createTokenTransferInstruction = (owner, fromTokenAddress, 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 destinationPubkey = new PublicKey(to)
+  console.log(`destination token address: ${destinationPubkey.toBase58()}`)
   const ownerAccountOrWalletPublicKey = new PublicKey(owner) // the only native SOL address
 
   const transferIx = Token.createTransferInstruction(

package/src/tokens.js

@@ -1,26 +1,13 @@
-// reference https://github.com/project-serum/spl-token-wallet/blob/master/src/utils/tokens/names.js
+// adapted from https://github.com/project-serum/spl-token-wallet/blob/master/src/utils/tokens/names.js
 
 const TOKENS = [
   {
     mintAddress: 'SRMuApVNdxXokk5GT7XD5cUUgXMBCoAz2LHeuAoKWRt',
-    tokenName: 'Serum',
+    tokenName: 'serum',
+    tokenProperName: '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

@@ -1,9 +1,13 @@
 // @flow
 import assert from 'assert'
 
-import { Account, SystemProgram, Transaction, PublicKey } from '@exodus/solana-web3.js'
 import { getKeyPairFromPrivateKey } from './keypair'
-import { createAssociatedTokenAccount, createTokenTransferInstruction } from './helpers'
+import { findAssociatedTokenAddress } from './encode'
+import {
+  createAssociatedTokenAccount,
+  createTokenTransferInstruction,
+} from './helpers/tokenTransfer'
+import { PublicKey, Account, Transaction, SystemProgram } from './vendor'
 import TOKENS from './tokens'
 import bs58 from 'bs58'
 
@@ -15,7 +19,8 @@ class Tx {
     recentBlockhash,
     // fee, // (Fee per Signature: 5000 lamports)
     // Tokens related:
-    tokenTicker,
+    tokenName,
+    destinationAddressType,
     isAssociatedTokenAccountActive, // true when recipient balance !== 0
     fromTokenAddresses, // sender token addresses
   } = {}) {
@@ -24,7 +29,11 @@ class Tx {
     assert(amount, 'amount is required')
     assert(typeof amount === 'number', 'amount must be a number')
     assert(recentBlockhash, 'recentBlockhash is required')
-    if (tokenTicker) {
+    if (tokenName) {
+      assert(
+        typeof destinationAddressType !== 'undefined',
+        'destinationAddressType is required when sending tokens'
+      )
       assert(
         typeof isAssociatedTokenAccountActive !== 'undefined',
         'isAssociatedTokenAccountActive is required when sending tokens'
@@ -32,13 +41,14 @@ class Tx {
       assert(Array.isArray(fromTokenAddresses), 'fromTokenAddresses Array is required')
     }
 
-    const token = TOKENS.find(({ tokenSymbol }) => tokenSymbol === tokenTicker)
+    const token = TOKENS.find(({ tokenName: name }) => name === tokenName)
     this.txObj = {
       from,
       to,
       amount,
       recentBlockhash,
       token,
+      destinationAddressType,
       isAssociatedTokenAccountActive,
       fromTokenAddresses,
     }
@@ -71,14 +81,18 @@ class Tx {
     amount,
     recentBlockhash,
     token,
+    destinationAddressType,
     isAssociatedTokenAccountActive,
     fromTokenAddresses,
   }) {
     this.transaction = new Transaction({
       recentBlockhash,
     })
+    const isUnknown = destinationAddressType === null
+    const isSOLaddress = destinationAddressType === 'solana'
     // crete account instruction
-    if (!isAssociatedTokenAccountActive)
+    if (isUnknown) throw new Error('Destination SOL balance cannot be zero (address not active)') // cannot initialize without knowing the owner
+    if (isSOLaddress && !isAssociatedTokenAccountActive)
       this.transaction.add(createAssociatedTokenAccount(from, token.mintAddress, to))
 
     let amountLeft = amount
@@ -97,15 +111,10 @@ class Tx {
         amountLeft -= amountToSend
       }
 
+      const dest = isSOLaddress ? findAssociatedTokenAddress(to, token.mintAddress) : to
       // add transfer token instruction
       this.transaction.add(
-        createTokenTransferInstruction(
-          from,
-          tokenAccountAddress,
-          token.mintAddress,
-          to,
-          amountToSend
-        )
+        createTokenTransferInstruction(from, tokenAccountAddress, dest, amountToSend)
       )
     }
 

package/src/tx/create-unsigned-tx.js

@@ -6,6 +6,11 @@ export function createUnsignedTx({
   to,
   amount,
   recentBlockhash,
+  // Tokens related:
+  tokenName,
+  destinationAddressType,
+  isAssociatedTokenAccountActive, // true when recipient balance !== 0
+  fromTokenAddresses, // sender token addresses
 }: ParsedTransaction): UnsignedTransaction {
   return {
     txData: {
@@ -13,6 +18,11 @@ export function createUnsignedTx({
       to,
       amount: amount.toBase().toNumber(),
       recentBlockhash,
+      // Tokens related:
+      tokenName,
+      destinationAddressType,
+      isAssociatedTokenAccountActive,
+      fromTokenAddresses,
     },
     txMeta: {
       assetName: asset.name,

package/src/tx/parse-unsigned-tx.js

@@ -3,7 +3,16 @@ import type { UnsignedTransaction, ParsedTransaction } from '@exodus/models/lib/
 
 export function parseUnsignedTx(unsignedTx: UnsignedTransaction): ParsedTransaction {
   const asset = assets.solana
-  const { from, to, recentBlockhash, ...txData } = unsignedTx.txData
+  const {
+    from,
+    to,
+    recentBlockhash,
+    tokenName,
+    destinationAddressType,
+    isAssociatedTokenAccountActive,
+    fromTokenAddresses,
+    ...txData
+  } = unsignedTx.txData
 
   const amount = asset.currency.baseUnit(txData.amount)
   return {
@@ -12,5 +21,10 @@ export function parseUnsignedTx(unsignedTx: UnsignedTransaction): ParsedTransact
     to,
     amount,
     recentBlockhash,
+    // token related
+    tokenName,
+    destinationAddressType,
+    isAssociatedTokenAccountActive,
+    fromTokenAddresses,
   }
 }

package/src/tx/sign-unsigned-tx.js

@@ -6,7 +6,16 @@ export function signUnsignedTx(
   unsignedTx: UnsignedTransaction,
   privateKey: Buffer
 ): SignedTransaction {
-  const { from, to, amount, recentBlockhash } = unsignedTx.txData
+  const {
+    from,
+    to,
+    amount,
+    recentBlockhash,
+    tokenName,
+    destinationAddressType,
+    isAssociatedTokenAccountActive,
+    fromTokenAddresses,
+  } = unsignedTx.txData
 
   const asset = assets.solana
   const tx = new Transaction({
@@ -14,6 +23,10 @@ export function signUnsignedTx(
     to,
     amount: asset.currency.baseUnit(amount).toNumber(),
     recentBlockhash,
+    tokenName,
+    destinationAddressType,
+    isAssociatedTokenAccountActive,
+    fromTokenAddresses,
   })
 
   // sign plain tx

package/src/vendor/account.js

@@ -0,0 +1,38 @@
+// @flow
+import type { KeyPair } from 'tweetnacl'
+import { PublicKey } from './publickey'
+import { getKeyPairFromPrivateKey } from '../keypair'
+
+/**
+ * An account key pair (public and secret keys).
+ */
+export class Account {
+  _keypair: KeyPair
+
+  /**
+   * Create a new Account object
+   *
+   * @param secretKey Secret key for the account
+   */
+  constructor(secretKey: Buffer | Uint8Array | Array<number>) {
+    if (secretKey) {
+      this._keypair = getKeyPairFromPrivateKey(Buffer.from(secretKey, 'hex'))
+    } else {
+      throw new Error('Please provide a secretKey')
+    }
+  }
+
+  /**
+   * The public key for this account
+   */
+  get publicKey(): PublicKey {
+    return new PublicKey(this._keypair.publicKey)
+  }
+
+  /**
+   * The **unencrypted** secret key for this account
+   */
+  get secretKey(): Buffer {
+    return this._keypair.secretKey
+  }
+}

package/src/vendor/index.js

@@ -0,0 +1,8 @@
+export * from './account'
+export * from './instruction'
+export * from './message'
+export * from './nonce-account'
+export * from './publickey'
+export * from './system-program'
+export * from './sysvar'
+export * from './transaction'

package/src/vendor/instruction.js

@@ -0,0 +1,46 @@
+// @flow
+
+import * as BufferLayout from '@exodus/buffer-layout'
+
+import * as Layout from './utils/layout'
+
+/**
+ * @typedef {Object} InstructionType
+ * @property (index} The Instruction index (from solana upstream program)
+ * @property (BufferLayout} The BufferLayout to use to build data
+ */
+export type InstructionType = {|
+  index: number,
+  layout: typeof BufferLayout,
+|}
+
+/**
+ * Populate a buffer of instruction data using an InstructionType
+ */
+export function encodeData(type: InstructionType, fields: Object): Buffer {
+  const allocLength = type.layout.span >= 0 ? type.layout.span : Layout.getAlloc(type, fields)
+  const data = Buffer.alloc(allocLength)
+  const layoutFields = Object.assign({ instruction: type.index }, fields)
+  type.layout.encode(layoutFields, data)
+  return data
+}
+
+/**
+ * Decode instruction data buffer using an InstructionType
+ */
+export function decodeData(type: InstructionType, buffer: Buffer): Object {
+  let data
+  try {
+    data = type.layout.decode(buffer)
+  } catch (err) {
+    throw new Error('invalid instruction; ' + err)
+  }
+
+  if (data.instruction !== type.index) {
+    throw new Error(
+      `invalid instruction; instruction index mismatch ${data.instruction} != ${type.index}`
+    )
+  }
+
+  return data
+}