@solana/transactions 2.0.0-experimental.fd64233 → 2.0.0-experimental.feaeef2

package/README.md

@@ -30,7 +30,7 @@ const transferTransaction = pipe(
     createTransaction({ version: 0 }),
     tx => setTransactionFeePayer(myAddress, tx),
     tx => setTransactionLifetimeUsingBlockhash(latestBlockhash, tx),
-    tx => appendTransactionInstruction(createTransferInstruction(myAddress, toAddress, amountInLamports), tx)
+    tx => appendTransactionInstruction(createTransferInstruction(myAddress, toAddress, amountInLamports), tx),
 );
 ```
 
@@ -144,7 +144,7 @@ const nonce =
 
 const durableNonceTransaction = setTransactionLifetimeUsingDurableNonce(
     { nonce, nonceAccountAddress, nonceAuthorityAddress },
-    tx
+    tx,
 );
 ```
 
@@ -210,14 +210,18 @@ const memoTransaction = appendTransactionInstruction(
         data: new TextEncoder().encode('Hello world!'),
         programAddress: address('MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr'),
     },
-    tx
+    tx,
 );
 ```
 
+If you'd like to add multiple instructions to a transaction at once, you may use the `appendTransactionInstructions` function instead which accepts an array of instructions.
+
 #### `prependTransactionInstruction()`
 
 Given an instruction, this method will return a new transaction with that instruction having been added to the beginning of the list of existing instructions.
 
+If you'd like to prepend multiple instructions to a transaction at once, you may use the `prependTransactionInstructions` function instead which accepts an array of instructions.
+
 See [`appendTransactionInstruction()`](#appendtransactioninstruction) for an example of how to use this function.
 
 ## Signing transactions

package/dist/index.browser.cjs

@@ -1,35 +1,33 @@
 'use strict';
 
+var errors = require('@solana/errors');
 var codecsStrings = require('@solana/codecs-strings');
 var addresses = require('@solana/addresses');
 var functional = require('@solana/functional');
 var codecsCore = require('@solana/codecs-core');
 var codecsDataStructures = require('@solana/codecs-data-structures');
 var codecsNumbers = require('@solana/codecs-numbers');
-var errors = require('@solana/errors');
 var keys = require('@solana/keys');
 
-// ../rpc-types/dist/index.browser.js
+// src/blockhash.ts
 var base58Encoder;
 function assertIsBlockhash(putativeBlockhash) {
   if (!base58Encoder)
     base58Encoder = codecsStrings.getBase58Encoder();
-  try {
-    if (
-      // Lowest value (32 bytes of zeroes)
-      putativeBlockhash.length < 32 || // Highest value (32 bytes of 255)
-      putativeBlockhash.length > 44
-    ) {
-      throw new Error("Expected input string to decode to a byte array of length 32.");
-    }
-    const bytes = base58Encoder.encode(putativeBlockhash);
-    const numBytes = bytes.byteLength;
-    if (numBytes !== 32) {
-      throw new Error(`Expected input string to decode to a byte array of length 32. Actual length: ${numBytes}`);
-    }
-  } catch (e) {
-    throw new Error(`\`${putativeBlockhash}\` is not a blockhash`, {
-      cause: e
+  if (
+    // Lowest value (32 bytes of zeroes)
+    putativeBlockhash.length < 32 || // Highest value (32 bytes of 255)
+    putativeBlockhash.length > 44
+  ) {
+    throw new errors.SolanaError(errors.SOLANA_ERROR__BLOCKHASH_STRING_LENGTH_OUT_OF_RANGE, {
+      actualLength: putativeBlockhash.length
+    });
+  }
+  const bytes = base58Encoder.encode(putativeBlockhash);
+  const numBytes = bytes.byteLength;
+  if (numBytes !== 32) {
+    throw new errors.SolanaError(errors.SOLANA_ERROR__INVALID_BLOCKHASH_BYTE_LENGTH, {
+      actualLength: numBytes
     });
   }
 }
@@ -62,7 +60,7 @@ function isTransactionWithBlockhashLifetime(transaction) {
 }
 function assertIsTransactionWithBlockhashLifetime(transaction) {
   if (!isTransactionWithBlockhashLifetime(transaction)) {
-    throw new Error("Transaction does not have a blockhash lifetime");
+    throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__EXPECTED_BLOCKHASH_LIFETIME);
   }
 }
 function setTransactionLifetimeUsingBlockhash(blockhashLifetimeConstraint, transaction) {
@@ -88,8 +86,6 @@ function createTransaction({
   Object.freeze(out);
   return out;
 }
-
-// ../instructions/dist/index.browser.js
 var AccountRole = /* @__PURE__ */ ((AccountRole2) => {
   AccountRole2[AccountRole2["WRITABLE_SIGNER"] = /* 3 */
   3] = "WRITABLE_SIGNER";
@@ -111,13 +107,11 @@ function isWritableRole(role) {
 function mergeRoles(roleA, roleB) {
   return roleA | roleB;
 }
-
-// src/durable-nonce.ts
 var RECENT_BLOCKHASHES_SYSVAR_ADDRESS = "SysvarRecentB1ockHashes11111111111111111111";
 var SYSTEM_PROGRAM_ADDRESS = "11111111111111111111111111111111";
 function assertIsDurableNonceTransaction(transaction) {
   if (!isDurableNonceTransaction(transaction)) {
-    throw new Error("Transaction is not a durable nonce transaction");
+    throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__EXPECTED_NONCE_LIFETIME);
   }
 }
 function createAdvanceNonceAccountInstruction(nonceAccountAddress, nonceAuthorityAddress) {
@@ -203,17 +197,23 @@ function setTransactionFeePayer(feePayer, transaction) {
 
 // src/instructions.ts
 function appendTransactionInstruction(instruction, transaction) {
+  return appendTransactionInstructions([instruction], transaction);
+}
+function appendTransactionInstructions(instructions, transaction) {
   const out = {
     ...getUnsignedTransaction(transaction),
-    instructions: [...transaction.instructions, instruction]
+    instructions: [...transaction.instructions, ...instructions]
   };
   Object.freeze(out);
   return out;
 }
 function prependTransactionInstruction(instruction, transaction) {
+  return prependTransactionInstructions([instruction], transaction);
+}
+function prependTransactionInstructions(instructions, transaction) {
   const out = {
     ...getUnsignedTransaction(transaction),
-    instructions: [instruction, ...transaction.instructions]
+    instructions: [...instructions, ...transaction.instructions]
   };
   Object.freeze(out);
   return out;
@@ -260,8 +260,9 @@ function getAddressLookupMetas(compiledAddressTableLookups, addressesByLookupTab
   const compiledAddressTableLookupAddresses = compiledAddressTableLookups.map((l) => l.lookupTableAddress);
   const missing = compiledAddressTableLookupAddresses.filter((a) => addressesByLookupTableAddress[a] === void 0);
   if (missing.length > 0) {
-    const missingAddresses = missing.join(", ");
-    throw new Error(`Addresses not provided for lookup tables: [${missingAddresses}]`);
+    throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__FAILED_TO_DECOMPILE_ADDRESS_LOOKUP_TABLE_CONTENTS_MISSING, {
+      lookupTableAddresses: missing
+    });
   }
   const readOnlyMetas = [];
   const writableMetas = [];
@@ -269,8 +270,13 @@ function getAddressLookupMetas(compiledAddressTableLookups, addressesByLookupTab
     const addresses = addressesByLookupTableAddress[lookup.lookupTableAddress];
     const highestIndex = Math.max(...lookup.readableIndices, ...lookup.writableIndices);
     if (highestIndex >= addresses.length) {
-      throw new Error(
-        `Cannot look up index ${highestIndex} in lookup table [${lookup.lookupTableAddress}]. The lookup table may have been extended since the addresses provided were retrieved.`
+      throw new errors.SolanaError(
+        errors.SOLANA_ERROR__TRANSACTION__FAILED_TO_DECOMPILE_ADDRESS_LOOKUP_TABLE_INDEX_OUT_OF_RANGE,
+        {
+          highestKnownIndex: addresses.length - 1,
+          highestRequestedIndex: highestIndex,
+          lookupTableAddress: lookup.lookupTableAddress
+        }
       );
     }
     const readOnlyForLookup = lookup.readableIndices.map((r) => ({
@@ -293,7 +299,9 @@ function getAddressLookupMetas(compiledAddressTableLookups, addressesByLookupTab
 function convertInstruction(instruction, accountMetas) {
   const programAddress = accountMetas[instruction.programAddressIndex]?.address;
   if (!programAddress) {
-    throw new Error(`Could not find program address at index ${instruction.programAddressIndex}`);
+    throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__FAILED_TO_DECOMPILE_INSTRUCTION_PROGRAM_ADDRESS_NOT_FOUND, {
+      index: instruction.programAddressIndex
+    });
   }
   const accounts = instruction.accountIndices?.map((accountIndex) => accountMetas[accountIndex]);
   const { data } = instruction;
@@ -338,8 +346,9 @@ function convertSignatures(compiledTransaction) {
 function decompileTransaction(compiledTransaction, config) {
   const { compiledMessage } = compiledTransaction;
   const feePayer = compiledMessage.staticAccounts[0];
-  if (!feePayer)
-    throw new Error("No fee payer set in CompiledTransaction");
+  if (!feePayer) {
+    throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__FAILED_TO_DECOMPILE_FEE_PAYER_MISSING);
+  }
   const accountMetas = getAccountMetas(compiledMessage);
   const accountLookupMetas = "addressTableLookups" in compiledMessage && compiledMessage.addressTableLookups !== void 0 && compiledMessage.addressTableLookups.length > 0 ? getAddressLookupMetas(compiledMessage.addressTableLookups, config?.addressesByLookupTableAddress ?? {}) : [];
   const transactionMetas = [...accountMetas, ...accountLookupMetas];
@@ -379,13 +388,13 @@ function getAddressMapFromInstructions(feePayer, instructions) {
         if (isWritableRole(entry.role)) {
           switch (entry[TYPE]) {
             case 0 /* FEE_PAYER */:
-              throw new Error(
-                `This transaction includes an address (\`${instruction.programAddress}\`) which is both invoked and set as the fee payer. Program addresses may not pay fees.`
-              );
+              throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__INVOKED_PROGRAMS_CANNOT_PAY_FEES, {
+                programAddress: instruction.programAddress
+              });
             default:
-              throw new Error(
-                `This transaction includes an address (\`${instruction.programAddress}\`) which is both invoked and marked writable. Program addresses may not be writable.`
-              );
+              throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__INVOKED_PROGRAMS_MUST_NOT_BE_WRITABLE, {
+                programAddress: instruction.programAddress
+              });
           }
         }
         if (entry[TYPE] === 2 /* STATIC */) {
@@ -450,8 +459,11 @@ function getAddressMapFromInstructions(feePayer, instructions) {
                 addressesOfInvokedPrograms.has(account.address)
               ) {
                 if (isWritableRole(accountMeta.role)) {
-                  throw new Error(
-                    `This transaction includes an address (\`${account.address}\`) which is both invoked and marked writable. Program addresses may not be writable.`
+                  throw new errors.SolanaError(
+                    errors.SOLANA_ERROR__TRANSACTION__INVOKED_PROGRAMS_MUST_NOT_BE_WRITABLE,
+                    {
+                      programAddress: account.address
+                    }
                   );
                 }
                 if (entry.role !== nextRole) {
@@ -741,7 +753,9 @@ function getTransactionVersionEncoder() {
         return offset;
       }
       if (value < 0 || value > 127) {
-        throw new Error(`Transaction version must be in the range [0, 127]. \`${value}\` given.`);
+        throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__VERSION_NUMBER_OUT_OF_RANGE, {
+          actualVersion: value
+        });
       }
       bytes.set([value | VERSION_FLAG_MASK], offset);
       return offset + 1;
@@ -828,12 +842,15 @@ function getCompiledMessageEncoder() {
   });
 }
 function getCompiledMessageDecoder() {
-  return codecsCore.mapDecoder(codecsDataStructures.getStructDecoder(getPreludeStructDecoderTuple()), ({ addressTableLookups, ...restOfMessage }) => {
-    if (restOfMessage.version === "legacy" || !addressTableLookups?.length) {
-      return restOfMessage;
+  return codecsCore.mapDecoder(
+    codecsDataStructures.getStructDecoder(getPreludeStructDecoderTuple()),
+    ({ addressTableLookups, ...restOfMessage }) => {
+      if (restOfMessage.version === "legacy" || !addressTableLookups?.length) {
+        return restOfMessage;
+      }
+      return { ...restOfMessage, addressTableLookups };
     }
-    return { ...restOfMessage, addressTableLookups };
-  });
+  );
 }
 function getCompiledMessageCodec() {
   return codecsCore.combineCodec(getCompiledMessageEncoder(), getCompiledMessageDecoder());
@@ -893,7 +910,7 @@ function getSignatureFromTransaction(transaction) {
     base58Decoder = codecsStrings.getBase58Decoder();
   const signatureBytes = transaction.signatures[transaction.feePayer];
   if (!signatureBytes) {
-    throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION_SIGNATURE_NOT_COMPUTABLE);
+    throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__FEE_PAYER_SIGNATURE_MISSING);
   }
   const transactionSignature = base58Decoder.decode(signatureBytes);
   return transactionSignature;
@@ -933,7 +950,7 @@ function assertTransactionIsFullySigned(transaction) {
     }
   });
   if (missingSigs.length > 0) {
-    throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION_MISSING_SIGNATURES, {
+    throw new errors.SolanaError(errors.SOLANA_ERROR__TRANSACTION__SIGNATURES_MISSING, {
       addresses: missingSigs
     });
   }
@@ -944,6 +961,7 @@ function getBase64EncodedWireTransaction(transaction) {
 }
 
 exports.appendTransactionInstruction = appendTransactionInstruction;
+exports.appendTransactionInstructions = appendTransactionInstructions;
 exports.assertIsDurableNonceTransaction = assertIsDurableNonceTransaction;
 exports.assertIsTransactionWithBlockhashLifetime = assertIsTransactionWithBlockhashLifetime;
 exports.assertTransactionIsFullySigned = assertTransactionIsFullySigned;
@@ -959,9 +977,11 @@ exports.getSignatureFromTransaction = getSignatureFromTransaction;
 exports.getTransactionCodec = getTransactionCodec;
 exports.getTransactionDecoder = getTransactionDecoder;
 exports.getTransactionEncoder = getTransactionEncoder;
+exports.getUnsignedTransaction = getUnsignedTransaction;
 exports.isAdvanceNonceAccountInstruction = isAdvanceNonceAccountInstruction;
 exports.partiallySignTransaction = partiallySignTransaction;
 exports.prependTransactionInstruction = prependTransactionInstruction;
+exports.prependTransactionInstructions = prependTransactionInstructions;
 exports.setTransactionFeePayer = setTransactionFeePayer;
 exports.setTransactionLifetimeUsingBlockhash = setTransactionLifetimeUsingBlockhash;
 exports.setTransactionLifetimeUsingDurableNonce = setTransactionLifetimeUsingDurableNonce;