@solana/transactions 2.0.0-experimental.211879d → 2.0.0-experimental.228d375

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Solana Labs, Inc
+Copyright (c) 2023 Solana Labs, Inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/dist/index.browser.cjs

@@ -1,6 +1,10 @@
 'use strict';
 
 var umiSerializers = require('@metaplex-foundation/umi-serializers');
+var addresses = require('@solana/addresses');
+var codecsDataStructures = require('@solana/codecs-data-structures');
+var codecsNumbers = require('@solana/codecs-numbers');
+var codecsCore = require('@solana/codecs-core');
 var keys = require('@solana/keys');
 
 // ../build-scripts/env-shim.ts
@@ -229,7 +233,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 = keys.getBase58EncodedAddressComparator()))(
+                  (addressComparator || (addressComparator = addresses.getAddressComparator()))(
                     accountMeta.lookupTableAddress,
                     entry.lookupTableAddress
                   ) < 0
@@ -335,7 +339,7 @@ function getOrderedAccountsFromAddressMap(addressMap) {
     if (leftIsWritable !== isWritableRole(rightEntry.role)) {
       return leftIsWritable ? -1 : 1;
     }
-    addressComparator || (addressComparator = keys.getBase58EncodedAddressComparator());
+    addressComparator || (addressComparator = addresses.getAddressComparator());
     if (leftEntry[TYPE] === 1 /* LOOKUP_TABLE */ && rightEntry[TYPE] === 1 /* LOOKUP_TABLE */ && leftEntry.lookupTableAddress !== rightEntry.lookupTableAddress) {
       return addressComparator(leftEntry.lookupTableAddress, rightEntry.lookupTableAddress);
     } else {
@@ -364,7 +368,7 @@ function getCompiledAddressTableLookups(orderedAccounts) {
       entry.readableIndices.push(account.addressIndex);
     }
   }
-  return Object.keys(index).sort(keys.getBase58EncodedAddressComparator()).map((lookupTableAddress) => ({
+  return Object.keys(index).sort(addresses.getAddressComparator()).map((lookupTableAddress) => ({
     lookupTableAddress,
     ...index[lookupTableAddress]
   }));
@@ -443,12 +447,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 = addresses.getAddressCodec();
+  return {
+    description: compat?.description ?? codec.description,
+    deserialize: codec.decode,
+    fixedSize: codec.fixedSize,
+    maxSize: codec.maxSize,
+    serialize: codec.encode
+  };
+}
 function getAddressTableLookupCodec() {
   return umiSerializers.struct(
     [
       [
         "lookupTableAddress",
-        keys.getBase58EncodedAddressCodec(
+        addressSerializerCompat(
           __DEV__ ? {
             description: "The address of the address lookup table account from which instruction addresses should be looked up"
           } : void 0
@@ -478,37 +510,33 @@ function getAddressTableLookupCodec() {
     } : void 0
   );
 }
+var memoizedU8Codec;
+function getMemoizedU8Codec() {
+  if (!memoizedU8Codec)
+    memoizedU8Codec = codecsNumbers.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 umiSerializers.struct(
+  return codecsDataStructures.getStructCodec(
     [
-      [
-        "numSignerAccounts",
-        umiSerializers.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",
-        umiSerializers.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",
-        umiSerializers.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() {
@@ -523,7 +551,7 @@ function getInstructionCodec() {
         )
       ],
       [
-        "addressIndices",
+        "accountIndices",
         umiSerializers.array(
           umiSerializers.u8({
             description: __DEV__ ? "The index of an account, according to the well-ordered accounts list for this transaction" : ""
@@ -543,50 +571,35 @@ 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(bytes3, offset = 0) {
+function decode(bytes3, offset = 0) {
   const firstByte = bytes3[offset];
   if ((firstByte & VERSION_FLAG_MASK) === 0) {
     return ["legacy", offset];
@@ -595,7 +608,7 @@ function deserialize(bytes3, offset = 0) {
     return [version, offset + 1];
   }
 }
-function serialize(value) {
+function encode(value) {
   if (value === "legacy") {
     return new Uint8Array();
   }
@@ -604,11 +617,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 codecsCore.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);
   };
 }
 
@@ -618,7 +652,7 @@ var BASE_CONFIG2 = {
   fixedSize: null,
   maxSize: null
 };
-function serialize2(compiledMessage) {
+function serialize(compiledMessage) {
   if (compiledMessage.version === "legacy") {
     return umiSerializers.struct(getPreludeStructSerializerTuple()).serialize(compiledMessage);
   } else {
@@ -639,13 +673,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",
-      umiSerializers.array(keys.getBase58EncodedAddressCodec(), {
+      umiSerializers.array(toSerializer(addresses.getAddressCodec()), {
         description: __DEV__ ? "A compact-array of static account addresses belonging to this transaction" : "",
         size: umiSerializers.shortU16()
       })
@@ -677,49 +720,7 @@ function getCompiledMessageEncoder() {
   return {
     ...BASE_CONFIG2,
     deserialize: getUnimplementedDecoder("CompiledMessage"),
-    serialize: serialize2
-  };
-}
-
-// src/signatures.ts
-async function getCompiledMessageSignature(message, secretKey) {
-  const wireMessageBytes = getCompiledMessageEncoder().serialize(message);
-  const signature = await keys.signBytes(secretKey, wireMessageBytes);
-  return signature;
-}
-async function signTransaction(keyPair, transaction) {
-  const compiledMessage = compileMessage(transaction);
-  const [signerPublicKey, signature] = await Promise.all([
-    keys.getBase58EncodedAddressFromPublicKey(keyPair.publicKey),
-    getCompiledMessageSignature(compiledMessage, keyPair.privateKey)
-  ]);
-  const nextSignatures = {
-    ..."signatures" in transaction ? transaction.signatures : null,
-    ...{ [signerPublicKey]: signature }
-  };
-  const out = {
-    ...transaction,
-    signatures: nextSignatures
-  };
-  Object.freeze(out);
-  return out;
-}
-
-// 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
+    serialize
   };
 }
 
@@ -729,7 +730,7 @@ var BASE_CONFIG3 = {
   fixedSize: null,
   maxSize: null
 };
-function serialize3(transaction) {
+function serialize2(transaction) {
   const compiledTransaction = getCompiledTransaction(transaction);
   return umiSerializers.struct([
     [
@@ -746,8 +747,82 @@ function getTransactionEncoder() {
   return {
     ...BASE_CONFIG3,
     deserialize: getUnimplementedDecoder("CompiledMessage"),
-    serialize: serialize3
+    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 = umiSerializers.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 = umiSerializers.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 keys.signBytes(secretKey, wireMessageBytes);
+  return signature;
+}
+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 nextSignatures = "signatures" in transaction ? { ...transaction.signatures } : {};
+  const publicKeySignaturePairs = await Promise.all(
+    keyPairs.map(
+      (keyPair) => Promise.all([
+        addresses.getAddressFromPublicKey(keyPair.publicKey),
+        getCompiledMessageSignature(compiledMessage, keyPair.privateKey)
+      ])
+    )
+  );
+  for (const [signerPublicKey, signature] of publicKeySignaturePairs) {
+    nextSignatures[signerPublicKey] = signature;
+  }
+  const out = {
+    ...transaction,
+    signatures: nextSignatures
   };
+  Object.freeze(out);
+  return out;
+}
+function transactionSignature(putativeTransactionSignature) {
+  assertIsTransactionSignature(putativeTransactionSignature);
+  return putativeTransactionSignature;
 }
 
 // src/wire-transaction.ts
@@ -761,12 +836,17 @@ function getBase64EncodedWireTransaction(transaction) {
 exports.appendTransactionInstruction = appendTransactionInstruction;
 exports.assertIsBlockhash = assertIsBlockhash;
 exports.assertIsDurableNonceTransaction = assertIsDurableNonceTransaction;
+exports.assertIsTransactionSignature = assertIsTransactionSignature;
 exports.createTransaction = createTransaction;
 exports.getBase64EncodedWireTransaction = getBase64EncodedWireTransaction;
+exports.getSignatureFromTransaction = getSignatureFromTransaction;
+exports.getTransactionEncoder = getTransactionEncoder;
+exports.isTransactionSignature = isTransactionSignature;
 exports.prependTransactionInstruction = prependTransactionInstruction;
 exports.setTransactionFeePayer = setTransactionFeePayer;
 exports.setTransactionLifetimeUsingBlockhash = setTransactionLifetimeUsingBlockhash;
 exports.setTransactionLifetimeUsingDurableNonce = setTransactionLifetimeUsingDurableNonce;
 exports.signTransaction = signTransaction;
+exports.transactionSignature = transactionSignature;
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.browser.cjs.map