algosdk 2.0.0 → 2.2.0

package/src/logicsig.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import * as nacl from './nacl/naclWrappers';
 import * as address from './encoding/address';
 import * as encoding from './encoding/encoding';
@@ -495,6 +496,29 @@ export function tealSign(
   return nacl.sign(toBeSigned, sk);
 }
 
+/**
+ * verifyTealSign verifies a signature as would the ed25519verify opcode
+ * @param data - buffer with original signed data
+ * @param programHash - string representation of teal program hash (= contract address for LogicSigs)
+ * @param sig - uint8array with the signature to verify (produced by tealSign/tealSignFromProgram)
+ * @param pk - uint8array with public key to verify against
+ */
+export function verifyTealSign(
+  data: Uint8Array | Buffer,
+  programHash: string,
+  sig: Uint8Array,
+  pk: Uint8Array
+) {
+  const parts = utils.concatArrays(
+    address.decodeAddress(programHash).publicKey,
+    data
+  );
+  const toBeSigned = Buffer.from(
+    utils.concatArrays(SIGN_PROGRAM_DATA_PREFIX, parts)
+  );
+  return nacl.verify(toBeSigned, sig, pk);
+}
+
 /**
  * tealSignFromProgram creates a signature compatible with ed25519verify opcode from raw program bytes
  * @param sk - uint8array with secret key

package/src/main.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import * as nacl from './nacl/naclWrappers';
 import * as address from './encoding/address';
 import * as encoding from './encoding/encoding';
@@ -160,6 +161,7 @@ export {
   logicSigFromByte,
   tealSign,
   tealSignFromProgram,
+  verifyTealSign,
 } from './logicsig';
 export {
   signMultisigTransaction,

package/src/multisig.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import * as nacl from './nacl/naclWrappers';
 import * as address from './encoding/address';
 import * as encoding from './encoding/encoding';

package/src/signer.ts

@@ -1,4 +1,4 @@
-import { Transaction } from './transaction';
+import { encodeUnsignedSimulateTransaction, Transaction } from './transaction';
 import Account from './types/account';
 import { LogicSigAccount, signLogicSigTransactionObject } from './logicsig';
 import { MultisigMetadata } from './types/multisig';
@@ -80,6 +80,23 @@ export function makeMultiSigAccountTransactionSigner(
   };
 }
 
+/**
+ * Create a makeEmptyTransactionSigner that does not specify any signer or
+ * signing capabilities. This should only be used to simulate transactions.
+ */
+export function makeEmptyTransactionSigner(): TransactionSigner {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  return (txnGroup: Transaction[], indexesToSign: number[]) => {
+    const unsigned: Uint8Array[] = [];
+
+    for (const index of indexesToSign) {
+      unsigned.push(encodeUnsignedSimulateTransaction(txnGroup[index]));
+    }
+
+    return Promise.resolve(unsigned);
+  };
+}
+
 /** Represents an unsigned transactions and a signer that can authorize that transaction. */
 export interface TransactionWithSigner {
   /** An unsigned transaction */

package/src/transaction.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import base32 from 'hi-base32';
 import * as address from './encoding/address';
 import * as encoding from './encoding/encoding';
@@ -1277,6 +1278,24 @@ export class Transaction implements TransactionStorageStructure {
   }
 }
 
+/**
+ * encodeUnsignedSimulateTransaction takes a txnBuilder.Transaction object,
+ * converts it into a SignedTransaction-like object, and converts it to a Buffer.
+ *
+ * Note: this function should only be used to simulate unsigned transactions.
+ *
+ * @param transactionObject - Transaction object to simulate.
+ */
+export function encodeUnsignedSimulateTransaction(
+  transactionObject: Transaction
+) {
+  const objToEncode: EncodedSignedTransaction = {
+    sig: null,
+    txn: transactionObject.get_obj_for_encoding(),
+  };
+  return encoding.rawEncode(objToEncode);
+}
+
 /**
  * encodeUnsignedTransaction takes a completed txnBuilder.Transaction object, such as from the makeFoo
  * family of transactions, and converts it to a Buffer

package/src/types/transactions/builder.ts

@@ -45,10 +45,10 @@ export type TransactionBase =
  * - A: Additional parameters on top of the base transaction parameters
  * - O: A set of overwrites for transaction parameters
  */
-export type ConstructTransaction<A = {}, O = {}> = DistributiveOverwrite<
-  TransactionBase & A,
-  O
->;
+export type ConstructTransaction<
+  A = {},
+  O extends Partial<TransactionBase & A> = {}
+> = DistributiveOverwrite<TransactionBase & A, O>;
 
 /**
  * Only accept transaction objects that include suggestedParams as an object

package/src/types/transactions/encoded.ts

@@ -1,3 +1,5 @@
+import { Buffer } from 'buffer';
+
 /**
  * Interfaces for the encoded transaction object. Every property is labelled with its associated Transaction type property
  */

package/src/types/utils.ts

@@ -27,7 +27,7 @@ export type Overwrite<T, U extends Partial<T>> = Pick<
 /**
  * Same as Overwrite, but will distribute the Overwrite over unions
  */
-export type DistributiveOverwrite<T, K> = T extends unknown
+export type DistributiveOverwrite<T, K extends Partial<T>> = T extends unknown
   ? Overwrite<T, K>
   : never;
 

package/src/utils/utils.ts

@@ -114,8 +114,11 @@ export function removeUndefinedProperties(
  */
 export function isNode() {
   return (
+    // @ts-ignore
     typeof process === 'object' &&
+    // @ts-ignore
     typeof process.versions === 'object' &&
+    // @ts-ignore
     typeof process.versions.node !== 'undefined'
   );
 }