@solana/transactions 2.0.0-experimental.71b920d → 2.0.0-experimental.72efece

package/dist/index.native.js

@@ -1,77 +1,68 @@
-import { getBase58EncodedAddressFromPublicKey, signBytes, getBase58EncodedAddressComparator, getBase58EncodedAddressCodec } from '@solana/keys';
-import { struct, mapSerializer, array, shortU16, string, base58, u8, bytes } from '@metaplex-foundation/umi-serializers';
+import { base58, struct, array, bytes, shortU16, mapSerializer, string, u8 } from '@metaplex-foundation/umi-serializers';
+import { getAddressFromPublicKey, getAddressComparator, getAddressCodec } from '@solana/addresses';
+import { getStructCodec } from '@solana/codecs-data-structures';
+import { getU8Codec } from '@solana/codecs-numbers';
+import { combineCodec } from '@solana/codecs-core';
+import { signBytes } from '@solana/keys';
 
 // ../build-scripts/env-shim.ts
 var __DEV__ = /* @__PURE__ */ (() => process["env"].NODE_ENV === "development")();
 
-// src/create-transaction.ts
-function createTransaction({
-  version
-}) {
-  const out = {
-    instructions: [],
-    version
-  };
-  Object.freeze(out);
-  return out;
-}
-
-// src/fee-payer.ts
-function setTransactionFeePayer(feePayer, transaction) {
-  if ("feePayer" in transaction && feePayer === transaction.feePayer) {
-    return transaction;
-  }
-  let out;
+// src/unsigned-transaction.ts
+function getUnsignedTransaction(transaction) {
   if ("signatures" in transaction) {
     const {
       signatures: _,
       // eslint-disable-line @typescript-eslint/no-unused-vars
       ...unsignedTransaction
     } = transaction;
-    out = {
-      ...unsignedTransaction,
-      feePayer
-    };
+    return unsignedTransaction;
   } else {
-    out = {
-      ...transaction,
-      feePayer
-    };
+    return transaction;
   }
-  Object.freeze(out);
-  return out;
 }
 
-// src/instructions.ts
-function replaceInstructions(transaction, nextInstructions) {
-  let out;
-  if ("signatures" in transaction) {
-    const {
-      signatures: _,
-      // eslint-disable-line @typescript-eslint/no-unused-vars
-      ...unsignedTransaction
-    } = transaction;
-    out = {
-      ...unsignedTransaction,
-      instructions: nextInstructions
-    };
-  } else {
-    out = {
-      ...transaction,
-      instructions: nextInstructions
-    };
+// src/blockhash.ts
+function assertIsBlockhash(putativeBlockhash) {
+  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 bytes3 = base58.serialize(putativeBlockhash);
+    const numBytes = bytes3.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
+    });
   }
-  return out;
 }
-function appendTransactionInstruction(instruction, transaction) {
-  const nextInstructions = [...transaction.instructions, instruction];
-  const out = replaceInstructions(transaction, nextInstructions);
+function setTransactionLifetimeUsingBlockhash(blockhashLifetimeConstraint, transaction) {
+  if ("lifetimeConstraint" in transaction && transaction.lifetimeConstraint.blockhash === blockhashLifetimeConstraint.blockhash && transaction.lifetimeConstraint.lastValidBlockHeight === blockhashLifetimeConstraint.lastValidBlockHeight) {
+    return transaction;
+  }
+  const out = {
+    ...getUnsignedTransaction(transaction),
+    lifetimeConstraint: blockhashLifetimeConstraint
+  };
   Object.freeze(out);
   return out;
 }
-function prependTransactionInstruction(instruction, transaction) {
-  const nextInstructions = [instruction, ...transaction.instructions];
-  const out = replaceInstructions(transaction, nextInstructions);
+
+// src/create-transaction.ts
+function createTransaction({
+  version
+}) {
+  const out = {
+    instructions: [],
+    version
+  };
   Object.freeze(out);
   return out;
 }
@@ -98,6 +89,96 @@ 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");
+  }
+}
+function createAdvanceNonceAccountInstruction(nonceAccountAddress, nonceAuthorityAddress) {
+  return {
+    accounts: [
+      { address: nonceAccountAddress, role: AccountRole.WRITABLE },
+      {
+        address: RECENT_BLOCKHASHES_SYSVAR_ADDRESS,
+        role: AccountRole.READONLY
+      },
+      { address: nonceAuthorityAddress, role: AccountRole.READONLY_SIGNER }
+    ],
+    data: new Uint8Array([4, 0, 0, 0]),
+    programAddress: SYSTEM_PROGRAM_ADDRESS
+  };
+}
+function isAdvanceNonceAccountInstruction(instruction) {
+  return instruction.programAddress === SYSTEM_PROGRAM_ADDRESS && // Test for `AdvanceNonceAccount` instruction data
+  instruction.data != null && isAdvanceNonceAccountInstructionData(instruction.data) && // Test for exactly 3 accounts
+  instruction.accounts?.length === 3 && // First account is nonce account address
+  instruction.accounts[0].address != null && instruction.accounts[0].role === AccountRole.WRITABLE && // Second account is recent blockhashes sysvar
+  instruction.accounts[1].address === RECENT_BLOCKHASHES_SYSVAR_ADDRESS && instruction.accounts[1].role === AccountRole.READONLY && // Third account is nonce authority account
+  instruction.accounts[2].address != null && instruction.accounts[2].role === AccountRole.READONLY_SIGNER;
+}
+function isAdvanceNonceAccountInstructionData(data) {
+  return data.byteLength === 4 && data[0] === 4 && data[1] === 0 && data[2] === 0 && data[3] === 0;
+}
+function isDurableNonceTransaction(transaction) {
+  return "lifetimeConstraint" in transaction && typeof transaction.lifetimeConstraint.nonce === "string" && transaction.instructions[0] != null && isAdvanceNonceAccountInstruction(transaction.instructions[0]);
+}
+function setTransactionLifetimeUsingDurableNonce({
+  nonce,
+  nonceAccountAddress,
+  nonceAuthorityAddress
+}, transaction) {
+  const isAlreadyDurableNonceTransaction = isDurableNonceTransaction(transaction);
+  if (isAlreadyDurableNonceTransaction && transaction.lifetimeConstraint.nonce === nonce && transaction.instructions[0].accounts[0].address === nonceAccountAddress && transaction.instructions[0].accounts[2].address === nonceAuthorityAddress) {
+    return transaction;
+  }
+  const out = {
+    ...getUnsignedTransaction(transaction),
+    instructions: [
+      createAdvanceNonceAccountInstruction(nonceAccountAddress, nonceAuthorityAddress),
+      ...isAlreadyDurableNonceTransaction ? transaction.instructions.slice(1) : transaction.instructions
+    ],
+    lifetimeConstraint: {
+      nonce
+    }
+  };
+  Object.freeze(out);
+  return out;
+}
+
+// src/fee-payer.ts
+function setTransactionFeePayer(feePayer, transaction) {
+  if ("feePayer" in transaction && feePayer === transaction.feePayer) {
+    return transaction;
+  }
+  const out = {
+    ...getUnsignedTransaction(transaction),
+    feePayer
+  };
+  Object.freeze(out);
+  return out;
+}
+
+// src/instructions.ts
+function appendTransactionInstruction(instruction, transaction) {
+  const out = {
+    ...getUnsignedTransaction(transaction),
+    instructions: [...transaction.instructions, instruction]
+  };
+  Object.freeze(out);
+  return out;
+}
+function prependTransactionInstruction(instruction, transaction) {
+  const out = {
+    ...getUnsignedTransaction(transaction),
+    instructions: [instruction, ...transaction.instructions]
+  };
+  Object.freeze(out);
+  return out;
+}
 function upsert(addressMap, address, update) {
   addressMap[address] = update(addressMap[address] ?? { role: AccountRole.READONLY });
 }
@@ -150,7 +231,7 @@ function getAddressMapFromInstructions(feePayer, instructions) {
                 const shouldReplaceEntry = (
                   // Consider using the new LOOKUP_TABLE if its address is different...
                   entry.lookupTableAddress !== accountMeta.lookupTableAddress && // ...and sorts before the existing one.
-                  (addressComparator || (addressComparator = getBase58EncodedAddressComparator()))(
+                  (addressComparator || (addressComparator = getAddressComparator()))(
                     accountMeta.lookupTableAddress,
                     entry.lookupTableAddress
                   ) < 0
@@ -256,7 +337,7 @@ function getOrderedAccountsFromAddressMap(addressMap) {
     if (leftIsWritable !== isWritableRole(rightEntry.role)) {
       return leftIsWritable ? -1 : 1;
     }
-    addressComparator || (addressComparator = getBase58EncodedAddressComparator());
+    addressComparator || (addressComparator = getAddressComparator());
     if (leftEntry[TYPE] === 1 /* LOOKUP_TABLE */ && rightEntry[TYPE] === 1 /* LOOKUP_TABLE */ && leftEntry.lookupTableAddress !== rightEntry.lookupTableAddress) {
       return addressComparator(leftEntry.lookupTableAddress, rightEntry.lookupTableAddress);
     } else {
@@ -285,7 +366,7 @@ function getCompiledAddressTableLookups(orderedAccounts) {
       entry.readableIndices.push(account.addressIndex);
     }
   }
-  return Object.keys(index).sort(getBase58EncodedAddressComparator()).map((lookupTableAddress) => ({
+  return Object.keys(index).sort(getAddressComparator()).map((lookupTableAddress) => ({
     lookupTableAddress,
     ...index[lookupTableAddress]
   }));
@@ -364,12 +445,40 @@ function compileMessage(transaction) {
     version: transaction.version
   };
 }
+
+// src/compile-transaction.ts
+function getCompiledTransaction(transaction) {
+  const compiledMessage = compileMessage(transaction);
+  let signatures;
+  if ("signatures" in transaction) {
+    signatures = [];
+    for (let ii = 0; ii < compiledMessage.header.numSignerAccounts; ii++) {
+      signatures[ii] = transaction.signatures[compiledMessage.staticAccounts[ii]] ?? new Uint8Array(Array(64).fill(0));
+    }
+  } else {
+    signatures = Array(compiledMessage.header.numSignerAccounts).fill(new Uint8Array(Array(64).fill(0)));
+  }
+  return {
+    compiledMessage,
+    signatures
+  };
+}
+function addressSerializerCompat(compat) {
+  const codec = getAddressCodec();
+  return {
+    description: compat?.description ?? codec.description,
+    deserialize: codec.decode,
+    fixedSize: codec.fixedSize,
+    maxSize: codec.maxSize,
+    serialize: codec.encode
+  };
+}
 function getAddressTableLookupCodec() {
   return struct(
     [
       [
         "lookupTableAddress",
-        getBase58EncodedAddressCodec(
+        addressSerializerCompat(
           __DEV__ ? {
             description: "The address of the address lookup table account from which instruction addresses should be looked up"
           } : void 0
@@ -399,37 +508,33 @@ function getAddressTableLookupCodec() {
     } : void 0
   );
 }
+var memoizedU8Codec;
+function getMemoizedU8Codec() {
+  if (!memoizedU8Codec)
+    memoizedU8Codec = getU8Codec();
+  return memoizedU8Codec;
+}
+function getMemoizedU8CodecDescription(description) {
+  const codec = getMemoizedU8Codec();
+  return {
+    ...codec,
+    description: description ?? codec.description
+  };
+}
+var numSignerAccountsDescription = __DEV__ ? "The expected number of addresses in the static address list belonging to accounts that are required to sign this transaction" : void 0;
+var numReadonlySignerAccountsDescription = __DEV__ ? "The expected number of addresses in the static address list belonging to accounts that are required to sign this transaction, but may not be writable" : void 0;
+var numReadonlyNonSignerAccountsDescription = __DEV__ ? "The expected number of addresses in the static address list belonging to accounts that are neither signers, nor writable" : void 0;
+var messageHeaderDescription = __DEV__ ? "The transaction message header containing counts of the signer, readonly-signer, and readonly-nonsigner account addresses" : void 0;
 function getMessageHeaderCodec() {
-  return struct(
+  return getStructCodec(
     [
-      [
-        "numSignerAccounts",
-        u8(
-          __DEV__ ? {
-            description: "The expected number of addresses in the static address list belonging to accounts that are required to sign this transaction"
-          } : void 0
-        )
-      ],
-      [
-        "numReadonlySignerAccounts",
-        u8(
-          __DEV__ ? {
-            description: "The expected number of addresses in the static address list belonging to accounts that are required to sign this transaction, but may not be writable"
-          } : void 0
-        )
-      ],
-      [
-        "numReadonlyNonSignerAccounts",
-        u8(
-          __DEV__ ? {
-            description: "The expected number of addresses in the static address list belonging to accounts that are neither signers, nor writable"
-          } : void 0
-        )
-      ]
+      ["numSignerAccounts", getMemoizedU8CodecDescription(numSignerAccountsDescription)],
+      ["numReadonlySignerAccounts", getMemoizedU8CodecDescription(numReadonlySignerAccountsDescription)],
+      ["numReadonlyNonSignerAccounts", getMemoizedU8CodecDescription(numReadonlyNonSignerAccountsDescription)]
     ],
-    __DEV__ ? {
-      description: "The transaction message header containing counts of the signer, readonly-signer, and readonly-nonsigner account addresses"
-    } : void 0
+    {
+      description: messageHeaderDescription
+    }
   );
 }
 function getInstructionCodec() {
@@ -444,7 +549,7 @@ function getInstructionCodec() {
         )
       ],
       [
-        "addressIndices",
+        "accountIndices",
         array(
           u8({
             description: __DEV__ ? "The index of an account, according to the well-ordered accounts list for this transaction" : ""
@@ -464,51 +569,36 @@ function getInstructionCodec() {
       ]
     ]),
     (value) => {
-      if (value.addressIndices !== void 0 && value.data !== void 0) {
+      if (value.accountIndices !== void 0 && value.data !== void 0) {
         return value;
       }
       return {
         ...value,
-        addressIndices: value.addressIndices ?? [],
+        accountIndices: value.accountIndices ?? [],
         data: value.data ?? new Uint8Array(0)
       };
     },
     (value) => {
-      if (value.addressIndices.length && value.data.byteLength) {
+      if (value.accountIndices.length && value.data.byteLength) {
         return value;
       }
-      const { addressIndices, data, ...rest } = value;
+      const { accountIndices, data, ...rest } = value;
       return {
         ...rest,
-        ...addressIndices.length ? { addressIndices } : null,
+        ...accountIndices.length ? { accountIndices } : null,
         ...data.byteLength ? { data } : null
       };
     }
   );
 }
-
-// src/serializers/unimplemented.ts
-function getError(type, name) {
-  const functionSuffix = name + type[0].toUpperCase() + type.slice(1);
-  return new Error(
-    `No ${type} exists for ${name}. Use \`get${functionSuffix}()\` if you need a ${type}, and \`get${name}Codec()\` if you need to both encode and decode ${name}`
-  );
-}
-function getUnimplementedDecoder(name) {
-  return () => {
-    throw getError("decoder", name);
-  };
-}
-
-// src/serializers/transaction-version.ts
 var VERSION_FLAG_MASK = 128;
 var BASE_CONFIG = {
   description: __DEV__ ? "A single byte that encodes the version of the transaction" : "",
   fixedSize: null,
   maxSize: 1
 };
-function deserialize(bytes2, offset = 0) {
-  const firstByte = bytes2[offset];
+function decode(bytes3, offset = 0) {
+  const firstByte = bytes3[offset];
   if ((firstByte & VERSION_FLAG_MASK) === 0) {
     return ["legacy", offset];
   } else {
@@ -516,7 +606,7 @@ function deserialize(bytes2, offset = 0) {
     return [version, offset + 1];
   }
 }
-function serialize(value) {
+function encode(value) {
   if (value === "legacy") {
     return new Uint8Array();
   }
@@ -525,11 +615,32 @@ function serialize(value) {
   }
   return new Uint8Array([value | VERSION_FLAG_MASK]);
 }
-function getTransactionVersionCodec() {
+function getTransactionVersionDecoder() {
   return {
     ...BASE_CONFIG,
-    deserialize,
-    serialize
+    decode
+  };
+}
+function getTransactionVersionEncoder() {
+  return {
+    ...BASE_CONFIG,
+    encode
+  };
+}
+function getTransactionVersionCodec() {
+  return combineCodec(getTransactionVersionEncoder(), getTransactionVersionDecoder());
+}
+
+// src/serializers/unimplemented.ts
+function getError(type, name) {
+  const functionSuffix = name + type[0].toUpperCase() + type.slice(1);
+  return new Error(
+    `No ${type} exists for ${name}. Use \`get${functionSuffix}()\` if you need a ${type}, and \`get${name}Codec()\` if you need to both encode and decode ${name}`
+  );
+}
+function getUnimplementedDecoder(name) {
+  return () => {
+    throw getError("decoder", name);
   };
 }
 
@@ -539,7 +650,7 @@ var BASE_CONFIG2 = {
   fixedSize: null,
   maxSize: null
 };
-function serialize2(compiledMessage) {
+function serialize(compiledMessage) {
   if (compiledMessage.version === "legacy") {
     return struct(getPreludeStructSerializerTuple()).serialize(compiledMessage);
   } else {
@@ -560,13 +671,22 @@ function serialize2(compiledMessage) {
     ).serialize(compiledMessage);
   }
 }
+function toSerializer(codec) {
+  return {
+    description: codec.description,
+    deserialize: codec.decode,
+    fixedSize: codec.fixedSize,
+    maxSize: codec.maxSize,
+    serialize: codec.encode
+  };
+}
 function getPreludeStructSerializerTuple() {
   return [
-    ["version", getTransactionVersionCodec()],
-    ["header", getMessageHeaderCodec()],
+    ["version", toSerializer(getTransactionVersionCodec())],
+    ["header", toSerializer(getMessageHeaderCodec())],
     [
       "staticAccounts",
-      array(getBase58EncodedAddressCodec(), {
+      array(toSerializer(getAddressCodec()), {
         description: __DEV__ ? "A compact-array of static account addresses belonging to this transaction" : "",
         size: shortU16()
       })
@@ -598,26 +718,99 @@ function getCompiledMessageEncoder() {
   return {
     ...BASE_CONFIG2,
     deserialize: getUnimplementedDecoder("CompiledMessage"),
-    serialize: serialize2
+    serialize
   };
 }
 
-// src/signatures.ts
+// src/serializers/transaction.ts
+var BASE_CONFIG3 = {
+  description: __DEV__ ? "The wire format of a Solana transaction" : "",
+  fixedSize: null,
+  maxSize: null
+};
+function serialize2(transaction) {
+  const compiledTransaction = getCompiledTransaction(transaction);
+  return struct([
+    [
+      "signatures",
+      array(bytes({ size: 64 }), {
+        ...__DEV__ ? { description: "A compact array of 64-byte, base-64 encoded Ed25519 signatures" } : null,
+        size: shortU16()
+      })
+    ],
+    ["compiledMessage", getCompiledMessageEncoder()]
+  ]).serialize(compiledTransaction);
+}
+function getTransactionEncoder() {
+  return {
+    ...BASE_CONFIG3,
+    deserialize: getUnimplementedDecoder("CompiledMessage"),
+    serialize: serialize2
+  };
+}
+function assertIsTransactionSignature(putativeTransactionSignature) {
+  try {
+    if (
+      // Lowest value (64 bytes of zeroes)
+      putativeTransactionSignature.length < 64 || // Highest value (64 bytes of 255)
+      putativeTransactionSignature.length > 88
+    ) {
+      throw new Error("Expected input string to decode to a byte array of length 64.");
+    }
+    const bytes3 = base58.serialize(putativeTransactionSignature);
+    const numBytes = bytes3.byteLength;
+    if (numBytes !== 64) {
+      throw new Error(`Expected input string to decode to a byte array of length 64. Actual length: ${numBytes}`);
+    }
+  } catch (e) {
+    throw new Error(`\`${putativeTransactionSignature}\` is not a transaction signature`, {
+      cause: e
+    });
+  }
+}
+function isTransactionSignature(putativeTransactionSignature) {
+  if (
+    // Lowest value (64 bytes of zeroes)
+    putativeTransactionSignature.length < 64 || // Highest value (64 bytes of 255)
+    putativeTransactionSignature.length > 88
+  ) {
+    return false;
+  }
+  const bytes3 = base58.serialize(putativeTransactionSignature);
+  const numBytes = bytes3.byteLength;
+  if (numBytes !== 64) {
+    return false;
+  }
+  return true;
+}
 async function getCompiledMessageSignature(message, secretKey) {
   const wireMessageBytes = getCompiledMessageEncoder().serialize(message);
   const signature = await signBytes(secretKey, wireMessageBytes);
   return signature;
 }
-async function signTransaction(keyPair, transaction) {
+function getSignatureFromTransaction(transaction) {
+  const signature = transaction.signatures[transaction.feePayer];
+  if (!signature) {
+    throw new Error(
+      "Could not determine this transaction's signature. Make sure that the transaction has been signed by its fee payer."
+    );
+  }
+  return signature;
+}
+async function signTransaction(keyPairs, transaction) {
   const compiledMessage = compileMessage(transaction);
-  const [signerPublicKey, signature] = await Promise.all([
-    getBase58EncodedAddressFromPublicKey(keyPair.publicKey),
-    getCompiledMessageSignature(compiledMessage, keyPair.privateKey)
-  ]);
-  const nextSignatures = {
-    ..."signatures" in transaction ? transaction.signatures : null,
-    ...{ [signerPublicKey]: signature }
-  };
+  const nextSignatures = "signatures" in transaction ? { ...transaction.signatures } : {};
+  const publicKeySignaturePairs = await Promise.all(
+    keyPairs.map(
+      (keyPair) => Promise.all([
+        getAddressFromPublicKey(keyPair.publicKey),
+        getCompiledMessageSignature(compiledMessage, keyPair.privateKey)
+      ])
+    )
+  );
+  for (const [signerPublicKey, signature] of publicKeySignaturePairs) {
+    nextSignatures[signerPublicKey] = signature;
+  }
   const out = {
     ...transaction,
     signatures: nextSignatures
@@ -625,7 +818,19 @@ async function signTransaction(keyPair, transaction) {
   Object.freeze(out);
   return out;
 }
+function transactionSignature(putativeTransactionSignature) {
+  assertIsTransactionSignature(putativeTransactionSignature);
+  return putativeTransactionSignature;
+}
+
+// src/wire-transaction.ts
+function getBase64EncodedWireTransaction(transaction) {
+  const wireTransactionBytes = getTransactionEncoder().serialize(transaction);
+  {
+    return btoa(String.fromCharCode(...wireTransactionBytes));
+  }
+}
 
-export { appendTransactionInstruction, createTransaction, prependTransactionInstruction, setTransactionFeePayer, signTransaction };
+export { appendTransactionInstruction, assertIsBlockhash, assertIsDurableNonceTransaction, assertIsTransactionSignature, createTransaction, getBase64EncodedWireTransaction, getSignatureFromTransaction, getTransactionEncoder, isTransactionSignature, prependTransactionInstruction, setTransactionFeePayer, setTransactionLifetimeUsingBlockhash, setTransactionLifetimeUsingDurableNonce, signTransaction, transactionSignature };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.native.js.map