@exodus/solana-lib 3.7.1 → 3.8.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.8.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.7.1...@exodus/solana-lib@3.8.0) (2024-11-29)
+
+
+### Features
+
+
+* feat: support optional `checkBalances` parameter (#4595)
+
+
+
 ## [3.7.1](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.7.0...@exodus/solana-lib@3.7.1) (2024-10-30)
 
 **Note:** Version bump only for package @exodus/solana-lib

package/README.md

@@ -1,8 +1,3 @@
-# Solana lib · [![npm version](https://img.shields.io/badge/npm-private-blue.svg?style=flat)](https://www.npmjs.com/package/@exodus/solana-lib)
+# @exodus/solana-lib
 
-Web wallet example by Solana: https://github.com/solana-labs/example-webwallet
-
-Official lib sdk: https://github.com/solana-labs/solana-web3.js
-
-- The smallest unit is called Lamports. 9 digits precision (a Lamport is 0.000000001 SOL)
-- In addition to fees, Solana has the "Rent" concept, paid every epoch by wallets. If you keep a certain amount of SOL locked (accountReserve) you'd have rent-exemption (https://docs.solana.com/apps/rent#rent-exemption), `0.01 SOL` is more than enough (https://github.com/solana-labs/solana/issues/12332)
+Solana utils, such as for cryptography, address encoding/decoding, transaction building, etc. See [Asset Packages](../../docs/asset-packages.md) for more detail on this package's role.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@exodus/solana-lib",
-  "version": "3.7.1",
-  "description": "Exodus internal Solana low-level library",
+  "version": "3.8.0",
+  "description": "Solana utils, such as for cryptography, address encoding/decoding, transaction building, etc.",
   "type": "module",
   "main": "src/index.js",
   "files": [
@@ -23,7 +23,7 @@
     "@exodus/asset-lib": "^5.0.0",
     "@exodus/buffer-layout": "^1.2.0-exodus1",
     "@exodus/crypto": "^1.0.0-rc.16",
-    "@exodus/currency": "^5.0.2",
+    "@exodus/currency": "^6.0.1",
     "@exodus/key-utils": "^3.7.0",
     "@exodus/solana-web3.js": "^1.63.1-exodus.9-rc4",
     "bn.js": "^5.2.1",
@@ -45,5 +45,5 @@
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/assets.git"
   },
-  "gitHead": "7dda4dfeb25b9a469ee8018f31341ac804c38ab7"
+  "gitHead": "a12da3edd237eb63aa06b726374094d63f29612a"
 }

package/src/transaction.js

@@ -24,23 +24,26 @@ import {
 } from './vendor/index.js'
 
 class Tx {
-  constructor({
-    from,
-    to,
-    amount,
-    recentBlockhash,
-    fee, // (Fee per Signature: 5000 lamports)
-    // Tokens related:
-    // pass either name or mintAddress, if both, mintAddress has priority
-    tokenMintAddress,
-    destinationAddressType,
-    isAssociatedTokenAccountActive, // true when recipient balance !== 0
-    fromTokenAddresses, // sender token addresses
-    instructions,
-    feePayer,
-    memo,
-    reference,
-  } = {}) {
+  constructor(
+    {
+      from,
+      to,
+      amount,
+      recentBlockhash,
+      fee, // (Fee per Signature: 5000 lamports)
+      // Tokens related:
+      // pass either name or mintAddress, if both, mintAddress has priority
+      tokenMintAddress,
+      destinationAddressType,
+      isAssociatedTokenAccountActive, // true when recipient balance !== 0
+      fromTokenAddresses, // sender token addresses
+      instructions,
+      feePayer,
+      memo,
+      reference,
+    } = {},
+    options = {}
+  ) {
     if (!instructions) {
       assert(from, 'from is required')
       assert(to, 'to is required')
@@ -78,7 +81,7 @@ class Tx {
 
     if (tokenMintAddress) {
       // TOKEN transfer tx
-      this.buildTokenTransaction(this.txObj)
+      this.buildTokenTransaction(this.txObj, options)
     } else if (instructions) {
       this.buildInstructionsTransaction(this.txObj)
     } else {
@@ -138,18 +141,21 @@ class Tx {
     })
   }
 
-  buildTokenTransaction({
-    from,
-    to,
-    amount,
-    recentBlockhash,
-    tokenMintAddress,
-    destinationAddressType,
-    isAssociatedTokenAccountActive,
-    fromTokenAddresses,
-    feePayer,
-    reference,
-  }) {
+  buildTokenTransaction(
+    {
+      from,
+      to,
+      amount,
+      recentBlockhash,
+      tokenMintAddress,
+      destinationAddressType,
+      isAssociatedTokenAccountActive,
+      fromTokenAddresses,
+      feePayer,
+      reference,
+    },
+    { checkBalances = true } = {}
+  ) {
     this.transaction = new Transaction({
       recentBlockhash,
       feePayer: feePayer ? new PublicKey(feePayer) : undefined,
@@ -166,6 +172,7 @@ class Tx {
 
     let amountLeft = amount
     let amountToSend
+    let isNotEnoughBalance = false
     for (let {
       mintAddress,
       tokenAccountAddress,
@@ -183,7 +190,9 @@ class Tx {
         amountToSend = amountLeft
         amountLeft = 0
       } else {
-        amountToSend = balance // not enough balance
+        // Not enough balance case.
+        isNotEnoughBalance = true
+        amountToSend = balance
         amountLeft -= amountToSend
       }
 
@@ -229,7 +238,12 @@ class Tx {
       this.transaction.add(tokenTransferInstruction)
     }
 
-    assert(amountLeft === 0, `Not enough balance to send ${amount} ${tokenMintAddress}`)
+    if (checkBalances) {
+      assert(
+        isNotEnoughBalance === false,
+        `Not enough balance to send ${amount} ${tokenMintAddress}`
+      )
+    }
   }
 
   static createStakeAccountTransaction({ address, amount, seed = SEED, pool, recentBlockhash }) {

package/src/tx/prepare-for-signing.js

@@ -27,9 +27,10 @@ const deserializeTransactionBytes = (wireTransactionBuffer) => {
 /**
  * Prepares the transaction to be signed (exodus & ledger).
  * @param {UnsignedTx} unsignedTx
+ * @param {checkBalances?: boolean} options
  * @returns a Solana Web3.js VersionedTransaction object (supports both Legacy & Versioned transactions)
  */
-export function prepareForSigning(unsignedTx) {
+export function prepareForSigning(unsignedTx, { checkBalances = true } = {}) {
   const {
     amount: unitAmount,
     fee: feeAmount,
@@ -58,7 +59,7 @@ export function prepareForSigning(unsignedTx) {
 
     const txData = { ...unsignedTx.txData, address, amount, fee }
 
-    const legacyTransaction = createTx({ txData, method, from })
+    const legacyTransaction = createTx({ txData, method, from }, { checkBalances })
     return VersionedTransaction.deserialize(
       legacyTransaction.serialize({ requireAllSignatures: false, verifySignatures: false })
     )
@@ -70,7 +71,7 @@ export function prepareForSigning(unsignedTx) {
   )
 }
 
-const createTx = ({ txData, method, from }) => {
+const createTx = ({ txData, method, from }, options) => {
   let tx
   switch (method) {
     case 'delegate':
@@ -101,7 +102,7 @@ const createTx = ({ txData, method, from }) => {
       break
     default:
       // SOL and Token tx
-      tx = createTokenTransaction(txData)
+      tx = createTokenTransaction(txData, options)
       break
   }
 
@@ -205,22 +206,8 @@ const createMagicEdenExchangeTransaction = ({
     takerAddress,
   })
 
-const createTokenTransaction = ({
-  amount,
-  destinationAddressType,
-  fee,
-  feePayer,
-  from,
-  fromTokenAddresses,
-  instructions,
-  isAssociatedTokenAccountActive,
-  recentBlockhash,
-  to,
-  tokenMintAddress,
-  memo,
-  reference,
-}) =>
-  new Transaction({
+const createTokenTransaction = (
+  {
     amount,
     destinationAddressType,
     fee,
@@ -234,7 +221,27 @@ const createTokenTransaction = ({
     tokenMintAddress,
     memo,
     reference,
-  }).transaction
+  },
+  options
+) =>
+  new Transaction(
+    {
+      amount,
+      destinationAddressType,
+      fee,
+      feePayer,
+      from,
+      fromTokenAddresses,
+      instructions,
+      isAssociatedTokenAccountActive,
+      recentBlockhash,
+      to,
+      tokenMintAddress,
+      memo,
+      reference,
+    },
+    options
+  ).transaction
 
 const createCloseAccountTransaction = ({ account, programId, recentBlockhash, walletPublicKey }) =>
   Transaction.createCloseAccount({