@exodus/solana-lib 3.4.2 → 3.5.0

package/CHANGELOG.md

@@ -0,0 +1,210 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [3.5.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.4.2...@exodus/solana-lib@3.5.0) (2024-06-19)
+
+
+### Features
+
+* **solana-lib:** support signing legacy transaction from buffer ([#2604](https://github.com/ExodusMovement/assets/issues/2604)) ([b08a818](https://github.com/ExodusMovement/assets/commit/b08a8187916dc4a874eabb6b29e79014c63f835b))
+
+
+
+## [3.4.2](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.4.1...@exodus/solana-lib@3.4.2) (2024-06-06)
+
+**Note:** Version bump only for package @exodus/solana-lib
+
+
+
+
+
+## [3.4.1](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.4.0...@exodus/solana-lib@3.4.1) (2024-05-28)
+
+
+### Bug Fixes
+
+* support using keychain private keys ([#2399](https://github.com/ExodusMovement/assets/issues/2399)) ([b900ad3](https://github.com/ExodusMovement/assets/commit/b900ad3b5bdf363f8c83175a5297333375a27529))
+
+
+
+## [3.4.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.3.1...@exodus/solana-lib@3.4.0) (2024-05-23)
+
+
+### Features
+
+* **solana-lib:** recreate a Web3.js transaction if `transactionBuffer` supplied ([#2351](https://github.com/ExodusMovement/assets/issues/2351)) ([8ab56db](https://github.com/ExodusMovement/assets/commit/8ab56dbd120380cd7f89a4954c5d0f765156dbe3))
+
+
+
+## [3.3.1](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.3.0...@exodus/solana-lib@3.3.1) (2024-05-15)
+
+
+### Bug Fixes
+
+* **solana-plugin:** supply a proper Web3 Transaction instance to simulation ([#2288](https://github.com/ExodusMovement/assets/issues/2288)) ([5316cc0](https://github.com/ExodusMovement/assets/commit/5316cc0ce23643da8e9926adfd8e0db904b704e4))
+
+
+
+## [3.3.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.2.2...@exodus/solana-lib@3.3.0) (2024-05-10)
+
+
+### Features
+
+* `signatureType` to external signer ([#2244](https://github.com/ExodusMovement/assets/issues/2244)) ([ba0f522](https://github.com/ExodusMovement/assets/commit/ba0f522acd0b0ef744c82405ba9e67d5f90ac9c3))
+
+
+
+## [3.2.2](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.2.1...@exodus/solana-lib@3.2.2) (2024-05-08)
+
+
+### Bug Fixes
+
+* provide `assetName` to createGetKeyIdentifier ([#2191](https://github.com/ExodusMovement/assets/issues/2191)) ([55e5171](https://github.com/ExodusMovement/assets/commit/55e5171b142fd72ff88b645f02f0ad358b93ccf8))
+
+
+
+## [3.2.1](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.2.0...@exodus/solana-lib@3.2.1) (2024-04-26)
+
+
+### Bug Fixes
+
+* handle decode staking tx crash ([#2161](https://github.com/ExodusMovement/assets/issues/2161)) ([970ef7c](https://github.com/ExodusMovement/assets/commit/970ef7ca4abc393826716702c4d4e56d13ee7914))
+
+
+
+## [3.2.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.1.1...@exodus/solana-lib@3.2.0) (2024-04-24)
+
+
+### Features
+
+* support external signer for solana message signing ([#2151](https://github.com/ExodusMovement/assets/issues/2151)) ([a58921c](https://github.com/ExodusMovement/assets/commit/a58921c6d2020fd67a99dc4c17129c04e346eb8b))
+
+
+
+## [3.1.1](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.1.0...@exodus/solana-lib@3.1.1) (2024-04-22)
+
+**Note:** Version bump only for package @exodus/solana-lib
+
+
+
+
+
+## [3.1.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.0.1...@exodus/solana-lib@3.1.0) (2024-04-20)
+
+
+### Features
+
+* add compute budget instruction ([#2006](https://github.com/ExodusMovement/assets/issues/2006)) ([f1479ac](https://github.com/ExodusMovement/assets/commit/f1479aca619370da573f442ef4526e6d21db14d2))
+
+
+
+## [3.0.1](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@3.0.0...@exodus/solana-lib@3.0.1) (2024-04-17)
+
+**Note:** Version bump only for package @exodus/solana-lib
+
+
+
+
+
+## [3.0.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@2.4.0...@exodus/solana-lib@3.0.0) (2024-04-12)
+
+
+### ⚠ BREAKING CHANGES
+
+* **solana:** transaction signing (#2017)
+
+### Bug Fixes
+
+* replace serum with fork ([#2037](https://github.com/ExodusMovement/assets/issues/2037)) ([d7fdbae](https://github.com/ExodusMovement/assets/commit/d7fdbae87cfa605afeff8f2b836a5a2839105f78))
+* **solana:** transaction signing ([#2017](https://github.com/ExodusMovement/assets/issues/2017)) ([78393f9](https://github.com/ExodusMovement/assets/commit/78393f96c5102636dab62e1cf0b368475c8b038e))
+
+
+
+## [2.4.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@2.3.0...@exodus/solana-lib@2.4.0) (2024-04-08)
+
+
+### Features
+
+* **solana:** add signMessage ([#1980](https://github.com/ExodusMovement/assets/issues/1980)) ([fd0b28c](https://github.com/ExodusMovement/assets/commit/fd0b28ce0c86249ec8a5d32ee0a3e542513c6d47))
+
+
+
+## [2.3.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@2.2.0...@exodus/solana-lib@2.3.0) (2024-04-04)
+
+
+### Features
+
+* implement helius priority fee ([#1799](https://github.com/ExodusMovement/assets/issues/1799)) ([e681ee7](https://github.com/ExodusMovement/assets/commit/e681ee7f52526bc8a77ab9917d57fb5c2fca2fd4))
+
+
+
+## [2.2.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@2.1.0...@exodus/solana-lib@2.2.0) (2024-04-04)
+
+
+### Features
+
+* add support for external signer for Solana ([#1952](https://github.com/ExodusMovement/assets/issues/1952)) ([70424fe](https://github.com/ExodusMovement/assets/commit/70424fe54c4bcf6be897a182761746b1e02475f3))
+
+
+
+## [2.1.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@2.0.0...@exodus/solana-lib@2.1.0) (2024-03-27)
+
+
+### Features
+
+* add new Solana token 2022 program ([#1808](https://github.com/ExodusMovement/assets/issues/1808)) ([90747bc](https://github.com/ExodusMovement/assets/commit/90747bc97fba0e629a1eaba5878dd06f834b0d72))
+
+
+### Bug Fixes
+
+* support token-2022 program for metaplex transfer ([#1894](https://github.com/ExodusMovement/assets/issues/1894)) ([31f712a](https://github.com/ExodusMovement/assets/commit/31f712a8fda681969b1c3dbe6f4c5e3d250f3062))
+
+
+
+## [2.0.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@1.8.2...@exodus/solana-lib@2.0.0) (2024-03-21)
+
+
+### ⚠ BREAKING CHANGES
+
+* decouple solana-lib from solana-meta (#1810)
+
+### Features
+
+* decouple solana-lib from solana-meta ([#1810](https://github.com/ExodusMovement/assets/issues/1810)) ([50db597](https://github.com/ExodusMovement/assets/commit/50db59734b1e48f8616f5de1ff61bfac356685a3))
+
+
+
+## [1.8.2](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@1.8.1...@exodus/solana-lib@1.8.2) (2024-03-18)
+
+
+### Bug Fixes
+
+* accurately calculate solana priority fee ([#1777](https://github.com/ExodusMovement/assets/issues/1777)) ([aa72d65](https://github.com/ExodusMovement/assets/commit/aa72d65d0117e7ff418967c019c1f3cb865961eb))
+
+
+
+
+
+## [1.8.1](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@1.8.0...@exodus/solana-lib@1.8.1) (2024-03-16)
+
+**Note:** Version bump only for package @exodus/solana-lib
+
+
+
+
+
+# [1.8.0](https://github.com/ExodusMovement/assets/compare/@exodus/solana-lib@1.7.5...@exodus/solana-lib@1.8.0) (2024-03-12)
+
+
+### Bug Fixes
+
+* increase SOL fee boundary check ([#1717](https://github.com/ExodusMovement/assets/issues/1717)) ([6ae954e](https://github.com/ExodusMovement/assets/commit/6ae954e2314acf0a84ea6dea07b89e5bba96e5b1))
+* solana test case ([#1602](https://github.com/ExodusMovement/assets/issues/1602)) ([00b8ddd](https://github.com/ExodusMovement/assets/commit/00b8ddd7726d50bbfe227ddacced7e388c2af283))
+
+
+### Features
+
+* add SOL prioritization fee ([#1682](https://github.com/ExodusMovement/assets/issues/1682)) ([f199ef5](https://github.com/ExodusMovement/assets/commit/f199ef52dc9047768c5a8f4ccb75cd5f82a13e2e))
+* **solana:** migrate some implementations and remove `@exodus/solana-spl-tokan` usage. ([#1669](https://github.com/ExodusMovement/assets/issues/1669)) ([ee75e1f](https://github.com/ExodusMovement/assets/commit/ee75e1fbf5c276aafc91260dee9ad6e44e5c8b8b))

package/package.json

@@ -1,20 +1,21 @@
 {
   "name": "@exodus/solana-lib",
-  "version": "3.4.2",
+  "version": "3.5.0",
   "description": "Exodus internal Solana low-level library",
   "main": "src/index.js",
   "files": [
-    "src/",
+    "src",
+    "CHANGELOG.md",
     "!src/**/__tests__"
   ],
-  "author": "Exodus",
+  "author": "Exodus Movement, Inc.",
   "license": "ISC",
   "publishConfig": {
     "access": "restricted"
   },
   "scripts": {
     "test": "run -T jest",
-    "lint": "run -T eslint ./src",
+    "lint": "run -T eslint .",
     "lint:fix": "yarn lint --fix"
   },
   "dependencies": {
@@ -23,7 +24,7 @@
     "@exodus/currency": "^2.3.2",
     "@exodus/key-utils": "^3.1.0",
     "@exodus/models": "^10.1.0",
-    "@exodus/project-serum-serum": "0.13.64-exodus.0",
+    "@exodus/project-serum-serum": "^0.13.64-exodus.0",
     "@exodus/solana-web3.js": "^1.63.1-exodus.3",
     "bn.js": "^5.2.1",
     "borsh": "^0.7.0",
@@ -40,5 +41,13 @@
     "@solana/web3.js": "^1.90.0",
     "bip39": "^2.6.0"
   },
-  "gitHead": "9d24eb58422692fc1acdcb834061d02b2632801d"
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/assets/issues?q=is%3Aissue+is%3Aopen+label%3Asolana-lib"
+  },
+  "homepage": "https://github.com/ExodusMovement/assets/tree/master/solana/solana-lib",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/assets.git"
+  },
+  "gitHead": "61b8ec6544e7a62a774f0e74e6a1b623371742fa"
 }

package/src/tx/common.js

@@ -22,16 +22,8 @@ export function getTxId(tx) {
 }
 
 function getFirstSignature(tx) {
-  if (isVersionedTransaction(tx)) {
-    // Versioned
-    if (tx.signatures.length > 0) {
-      return tx.signatures[0]
-    }
-  } else {
-    // Legacy
-    if (tx.signatures.length > 0) {
-      return tx.signatures[0].signature
-    }
+  if (tx.signatures.length > 0) {
+    return tx.signatures[0]
   }
 
   return null

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

@@ -20,10 +20,14 @@ const addComputeBudgetToTransaction = ({ transaction, computeUnits }) => {
   transaction.add(computeBudgetInstruction)
 }
 
+const deserializeTransactionBytes = (wireTransactionBuffer) => {
+  return VersionedTransaction.deserialize(Uint8Array.from(wireTransactionBuffer))
+}
+
 /**
  * Prepares the transaction to be signed (exodus & ledger).
  * @param {UnsignedTx} unsignedTx
- * @returns a Solana Web3.js Transaction object
+ * @returns a Solana Web3.js VersionedTransaction object (supports both Legacy & Versioned transactions)
  */
 export function prepareForSigning(unsignedTx) {
   const {
@@ -37,7 +41,7 @@ export function prepareForSigning(unsignedTx) {
 
   // Recreate a Web3.js Transaction instance if the buffer provided.
   if (transactionBuffer) {
-    return VersionedTransaction.deserialize(transactionBuffer)
+    return deserializeTransactionBytes(transactionBuffer)
   }
 
   if (!transaction) {
@@ -54,31 +58,19 @@ export function prepareForSigning(unsignedTx) {
 
     const txData = { ...unsignedTx.txData, address, amount, fee }
 
-    const transaction = createTx({ txData, method })
-
-    if (txData.priorityFee) {
-      addPriorityFeeToTransaction({
-        transaction,
-        priorityFee: txData.priorityFee,
-      })
-    }
-
-    if (txData.computeUnits) {
-      addComputeBudgetToTransaction({ transaction, computeUnits: txData.computeUnits })
-    }
-
-    if (!transaction.feePayer) {
-      transaction.feePayer = new PublicKey(from)
-    }
-
-    return transaction
+    const legacyTransaction = createTx({ txData, method, from })
+    return VersionedTransaction.deserialize(
+      legacyTransaction.serialize({ requireAllSignatures: false, verifySignatures: false })
+    )
   }
 
   // unsignedTx contained a transaction in web3.js format
-  return transaction
+  return VersionedTransaction.deserialize(
+    transaction.serialize({ requireAllSignatures: false, verifySignatures: false })
+  )
 }
 
-const createTx = ({ txData, method }) => {
+const createTx = ({ txData, method, from }) => {
   let tx
   switch (method) {
     case 'delegate':
@@ -113,6 +105,31 @@ const createTx = ({ txData, method }) => {
       break
   }
 
+  if (txData.priorityFee) {
+    addPriorityFeeToTransaction({
+      transaction: tx,
+      priorityFee: txData.priorityFee,
+    })
+  }
+
+  if (txData.computeUnits) {
+    addComputeBudgetToTransaction({ transaction: tx, computeUnits: txData.computeUnits })
+  }
+
+  const publicKey = new PublicKey(from)
+  if (!tx.feePayer) {
+    tx.feePayer = publicKey
+  }
+
+  if (tx.signatures.length !== tx.compileMessage().header.numRequiredSignatures) {
+    // Some transactions that we construct internally are technically not complete.
+    // They don't contain the empty signature slot for the public key.
+    tx.signatures.push({
+      publicKey,
+      signature: null,
+    })
+  }
+
   return tx
 }
 

package/src/tx/sign-hardware.js

@@ -2,7 +2,7 @@ import assert from 'minimalistic-assert'
 
 import { prepareForSigning } from './prepare-for-signing'
 import { PublicKey } from '../vendor'
-import { isVersionedTransaction, isLegacyTransaction, extractTransaction } from './common'
+import { extractTransaction } from './common'
 
 export async function signHardware({ unsignedTx, hardwareDevice, accountIndex }) {
   assert(hardwareDevice, 'expected hardwareDevice to be defined')
@@ -19,9 +19,7 @@ const signWithHardwareWallet = async ({ tx, hardwareDevice, accountIndex }) => {
   assert(hardwareDevice, `hardwareDevice required`)
   assert(Number.isInteger(accountIndex), `accountIndex required`)
 
-  const messageToSign = isVersionedTransaction(tx)
-    ? tx.message.serialize()
-    : tx.compileMessage().serialize()
+  const messageToSign = tx.message.serialize()
 
   return hardwareDevice.signTransaction({
     assetName: 'solana',
@@ -31,24 +29,6 @@ const signWithHardwareWallet = async ({ tx, hardwareDevice, accountIndex }) => {
 }
 
 const applySignatures = ({ tx, signatures }) => {
-  if (isLegacyTransaction(tx)) {
-    signatures.forEach(({ publicKey: publicKeyBuffer }) => {
-      const publicKey = new PublicKey(publicKeyBuffer)
-      // Some transactions that we construct internally are technically not complete.
-      // They don't contain the empty signature slot for the public key.
-      const foundEmptySignatureSlot = tx.signatures.find(({ publicKey: pubKey }) =>
-        pubKey.equals(publicKey)
-      )
-      if (!foundEmptySignatureSlot) {
-        // We could use `setSigners` but maybe this is more robust?
-        tx.signatures.push({
-          publicKey,
-          signature: null,
-        })
-      }
-    })
-  }
-
   signatures.forEach(({ publicKey, signature }) => {
     tx.addSignature(new PublicKey(publicKey), signature)
   })

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

@@ -5,7 +5,7 @@ import bs58 from 'bs58'
 import { prepareForSigning } from './prepare-for-signing'
 import { getKeyPairFromPrivateKey } from '../keypair'
 import { PublicKey } from '../vendor'
-import { extractTransaction, isVersionedTransaction } from './common'
+import { extractTransaction } from './common'
 
 /**
  *
@@ -38,44 +38,10 @@ export async function signUnsignedTx(unsignedTx, privateKey) {
   return extractTransaction({ tx })
 }
 
-// Some transactions that we construct internally are technically not complete.
-// They don't contain the empty signature slot for the public key.
-export const fillTransactionWithEmptySignatureSlot = ({ transaction, publicKey }) => {
-  const foundEmptySignatureSlot = transaction.signatures.find(({ publicKey: _publicKey }) =>
-    _publicKey.equals(publicKey)
-  )
-  if (!foundEmptySignatureSlot) {
-    // We could use `setSigners` but maybe this is more robust?
-    transaction.signatures.push({
-      publicKey,
-      signature: null,
-    })
-  }
-}
-
 // Signs plain tx.
 const _signTx = async ({ tx, signer }) => {
   const publicKey = new PublicKey(bs58.encode(Buffer.from(await signer.getPublicKey())))
-
-  if (isVersionedTransaction(tx)) {
-    // VersionedTransaction
-    return _signVersionedTransaction({ tx, signer, publicKey })
-  }
-
-  // Legacy Transactions
-  fillTransactionWithEmptySignatureSlot({ transaction: tx, publicKey })
-
-  return _signLegacyTransaction({ tx, signer, publicKey })
-}
-
-const _signVersionedTransaction = async ({ tx, signer, publicKey }) => {
   const messageData = tx.message.serialize()
   const signature = await signer.sign({ data: messageData, signatureType: 'ed25519' })
   tx.addSignature(publicKey, signature)
 }
-
-const _signLegacyTransaction = async ({ tx, signer, publicKey }) => {
-  const messageData = tx.compileMessage().serialize()
-  const signature = await signer.sign({ data: messageData, signatureType: 'ed25519' })
-  tx.addSignature(publicKey, signature)
-}