algosdk 3.4.0 → 3.5.1

package/src/composer.ts

@@ -31,6 +31,7 @@ import { SignedTransaction } from './signedTransaction.js';
 import {
   BoxReference,
   OnApplicationComplete,
+  ResourceReference,
   SuggestedParams,
 } from './types/transactions/base.js';
 import { arrayEqual, stringifyJSON, ensureUint64 } from './utils/utils.js';
@@ -217,9 +218,11 @@ export class AtomicTransactionComposer {
     appForeignApps,
     appForeignAssets,
     boxes,
+    access,
     note,
     lease,
     rekeyTo,
+    rejectVersion,
     signer,
   }: {
     /** The ID of the smart contract to call. Set this to 0 to indicate an application creation call. */
@@ -256,12 +259,16 @@ export class AtomicTransactionComposer {
     appForeignAssets?: Array<number | bigint>;
     /** The box references for this application call */
     boxes?: BoxReference[];
+    /** The resource references for this application call */
+    access?: ResourceReference[];
     /** The note value for this application call */
     note?: Uint8Array;
     /** The lease value for this application call */
     lease?: Uint8Array;
     /** If provided, the address that the sender will be rekeyed to at the conclusion of this application call */
     rekeyTo?: string | Address;
+    /** The lowest application version for which this transaction should immediately fail. 0 indicates that no version check should be performed. */
+    rejectVersion?: number | bigint;
     /** A transaction signer that can authorize this application call from sender */
     signer: TransactionSigner;
   }): void {
@@ -324,6 +331,16 @@ export class AtomicTransactionComposer {
       );
     }
 
+    // Validate that access and legacy foreign arrays are not both specified
+    if (
+      access &&
+      (appAccounts || appForeignApps || appForeignAssets || boxes)
+    ) {
+      throw new Error(
+        'Cannot specify both access and legacy foreign arrays (appAccounts, appForeignApps, appForeignAssets, boxes)'
+      );
+    }
+
     if (methodArgs == null) {
       // eslint-disable-next-line no-param-reassign
       methodArgs = [];
@@ -472,10 +489,12 @@ export class AtomicTransactionComposer {
         sender,
         appIndex: appID,
         appArgs: appArgsEncoded,
-        accounts: foreignAccounts,
-        foreignApps,
-        foreignAssets,
-        boxes: boxReferences,
+        // Only pass legacy foreign arrays if access is not provided
+        accounts: access ? undefined : foreignAccounts,
+        foreignApps: access ? undefined : foreignApps,
+        foreignAssets: access ? undefined : foreignAssets,
+        boxes: access ? undefined : boxReferences,
+        access,
         onComplete:
           onComplete == null ? OnApplicationComplete.NoOpOC : onComplete,
         approvalProgram,
@@ -485,6 +504,7 @@ export class AtomicTransactionComposer {
         numLocalInts,
         numLocalByteSlices,
         extraPages,
+        rejectVersion,
         lease,
         note,
         rekeyTo,

package/src/logicsig.ts

@@ -60,6 +60,7 @@ export function sanityCheckProgram(program: Uint8Array) {
 }
 
 const programTag = new TextEncoder().encode('Program');
+const multisigProgramTag = new TextEncoder().encode('MsigProgram');
 
 /**
  LogicSig implementation
@@ -85,6 +86,10 @@ export class LogicSig implements encoding.Encodable {
         key: 'msig',
         valueSchema: new OptionalSchema(ENCODED_MULTISIG_SCHEMA),
       },
+      {
+        key: 'lmsig',
+        valueSchema: new OptionalSchema(ENCODED_MULTISIG_SCHEMA),
+      },
     ])
   );
 
@@ -92,6 +97,7 @@ export class LogicSig implements encoding.Encodable {
   args: Uint8Array[];
   sig?: Uint8Array;
   msig?: EncodedMultisig;
+  lmsig?: EncodedMultisig;
 
   constructor(program: Uint8Array, programArgs?: Array<Uint8Array> | null) {
     if (
@@ -112,6 +118,7 @@ export class LogicSig implements encoding.Encodable {
     this.args = args;
     this.sig = undefined;
     this.msig = undefined;
+    this.lmsig = undefined;
   }
 
   // eslint-disable-next-line class-methods-use-this
@@ -128,6 +135,9 @@ export class LogicSig implements encoding.Encodable {
     if (this.msig) {
       data.set('msig', encodedMultiSigToEncodingData(this.msig));
     }
+    if (this.lmsig) {
+      data.set('lmsig', encodedMultiSigToEncodingData(this.lmsig));
+    }
     return data;
   }
 
@@ -140,6 +150,9 @@ export class LogicSig implements encoding.Encodable {
     if (data.get('msig')) {
       lsig.msig = encodedMultiSigFromEncodingData(data.get('msig'));
     }
+    if (data.get('lmsig')) {
+      lsig.lmsig = encodedMultiSigFromEncodingData(data.get('lmsig'));
+    }
     return lsig;
   }
 
@@ -148,7 +161,8 @@ export class LogicSig implements encoding.Encodable {
    * @param publicKey - Verification key (derived from sender address or escrow address)
    */
   verify(publicKey: Uint8Array) {
-    if (this.sig && this.msig) {
+    const sigCount = [this.sig, this.msig, this.lmsig].filter(Boolean).length;
+    if (sigCount > 1) {
       return false;
     }
 
@@ -160,7 +174,7 @@ export class LogicSig implements encoding.Encodable {
 
     const toBeSigned = utils.concatArrays(programTag, this.logic);
 
-    if (!this.sig && !this.msig) {
+    if (!this.sig && !this.msig && !this.lmsig) {
       const hash = nacl.genericHash(toBeSigned);
       return utils.arrayEqual(hash, publicKey);
     }
@@ -169,7 +183,25 @@ export class LogicSig implements encoding.Encodable {
       return nacl.verify(toBeSigned, this.sig, publicKey);
     }
 
-    return verifyMultisig(toBeSigned, this.msig!, publicKey);
+    if (this.lmsig) {
+      const multisigAddr = addressFromMultisigPreImg({
+        version: this.lmsig.v,
+        threshold: this.lmsig.thr,
+        pks: this.lmsig.subsig.map((subsig) => subsig.pk),
+      });
+      const lmsigProgram = utils.concatArrays(
+        multisigProgramTag,
+        multisigAddr.publicKey,
+        this.logic
+      );
+      return verifyMultisig(lmsigProgram, this.lmsig!, publicKey);
+    }
+
+    if (this.msig) {
+      return verifyMultisig(toBeSigned, this.msig!, publicKey);
+    }
+
+    return false;
   }
 
   /**
@@ -193,14 +225,14 @@ export class LogicSig implements encoding.Encodable {
     } else {
       const subsigs = pksFromAddresses(msig.addrs).map((pk) => ({ pk }));
 
-      this.msig = {
+      this.lmsig = {
         v: msig.version,
         thr: msig.threshold,
         subsig: subsigs,
       };
 
-      const [sig, index] = this.singleSignMultisig(secretKey, this.msig);
-      this.msig.subsig[index].s = sig;
+      const [sig, index] = this.singleSignMultisig(secretKey, this.lmsig);
+      this.lmsig.subsig[index].s = sig;
     }
   }
 
@@ -209,11 +241,11 @@ export class LogicSig implements encoding.Encodable {
    * @param secretKey - Secret key to sign with
    */
   appendToMultisig(secretKey: Uint8Array) {
-    if (this.msig === undefined) {
+    if (this.lmsig === undefined) {
       throw new Error('no multisig present');
     }
-    const [sig, index] = this.singleSignMultisig(secretKey, this.msig);
-    this.msig.subsig[index].s = sig;
+    const [sig, index] = this.singleSignMultisig(secretKey, this.lmsig);
+    this.lmsig.subsig[index].s = sig;
   }
 
   signProgram(secretKey: Uint8Array) {
@@ -222,6 +254,21 @@ export class LogicSig implements encoding.Encodable {
     return sig;
   }
 
+  signProgramMultisig(secretKey: Uint8Array, msig: EncodedMultisig) {
+    const multisigAddr = addressFromMultisigPreImg({
+      version: msig.v,
+      threshold: msig.thr,
+      pks: msig.subsig.map((subsig) => subsig.pk),
+    });
+    const toBeSigned = utils.concatArrays(
+      multisigProgramTag,
+      multisigAddr.publicKey,
+      this.logic
+    );
+    const sig = nacl.sign(toBeSigned, secretKey);
+    return sig;
+  }
+
   singleSignMultisig(
     secretKey: Uint8Array,
     msig: EncodedMultisig
@@ -238,7 +285,7 @@ export class LogicSig implements encoding.Encodable {
     if (index === -1) {
       throw new Error('invalid secret key');
     }
-    const sig = this.signProgram(secretKey);
+    const sig = this.signProgramMultisig(secretKey, msig);
     return [sig, index];
   }
 
@@ -332,7 +379,7 @@ export class LogicSigAccount implements encoding.Encodable {
    * To verify the delegation signature, use `verify`.
    */
   isDelegated() {
-    return !!(this.lsig.sig || this.lsig.msig);
+    return !!(this.lsig.sig || this.lsig.msig || this.lsig.lmsig);
   }
 
   /**
@@ -354,9 +401,12 @@ export class LogicSigAccount implements encoding.Encodable {
    *  escrow address that is the hash of the LogicSig's program code.
    */
   address(): Address {
-    if (this.lsig.sig && this.lsig.msig) {
+    const sigCount = [this.lsig.sig, this.lsig.msig, this.lsig.lmsig].filter(
+      Boolean
+    ).length;
+    if (sigCount > 1) {
       throw new Error(
-        'LogicSig has too many signatures. At most one of sig or msig may be present'
+        'LogicSig has too many signatures. At most one of sig, msig, or lmsig may be present'
       );
     }
 
@@ -367,11 +417,12 @@ export class LogicSigAccount implements encoding.Encodable {
       return new Address(this.sigkey);
     }
 
-    if (this.lsig.msig) {
+    const msig = this.lsig.lmsig || this.lsig.msig;
+    if (msig) {
       const msigMetadata = {
-        version: this.lsig.msig.v,
-        threshold: this.lsig.msig.thr,
-        pks: this.lsig.msig.subsig.map((subsig) => subsig.pk),
+        version: msig.v,
+        threshold: msig.thr,
+        pks: msig.subsig.map((subsig) => subsig.pk),
       };
       return addressFromMultisigPreImg(msigMetadata);
     }

package/src/makeTxn.ts

@@ -9,8 +9,10 @@ import {
   AssetTransferTransactionParams,
   AssetFreezeTransactionParams,
   ApplicationCallTransactionParams,
+  ApplicationCallReferenceParams,
 } from './types/transactions/base.js';
 import { Address } from './encoding/address.js';
+import { foreignArraysToResourceReferences } from './appAccess.js';
 
 /** Contains parameters common to every transaction type */
 export interface CommonTransactionParams {
@@ -397,6 +399,10 @@ export function makeApplicationCallTxnFromObject({
   foreignApps,
   foreignAssets,
   boxes,
+  convertToAccess,
+  holdings,
+  locals,
+  access,
   approvalProgram,
   clearProgram,
   numLocalInts,
@@ -404,14 +410,35 @@ export function makeApplicationCallTxnFromObject({
   numGlobalInts,
   numGlobalByteSlices,
   extraPages,
+  rejectVersion,
   note,
   lease,
   rekeyTo,
   suggestedParams,
-}: ApplicationCallTransactionParams & CommonTransactionParams): Transaction {
+}: ApplicationCallTransactionParams &
+  CommonTransactionParams &
+  ApplicationCallReferenceParams): Transaction {
   if (onComplete == null) {
     throw Error('onComplete must be provided');
   }
+  if (
+    access &&
+    (accounts || foreignApps || foreignAssets || boxes || holdings || locals)
+  ) {
+    throw Error('cannot specify both access and other access fields');
+  }
+  let access2 = access;
+  if (convertToAccess) {
+    access2 = foreignArraysToResourceReferences({
+      appIndex,
+      accounts,
+      foreignApps,
+      foreignAssets,
+      holdings,
+      locals,
+      boxes,
+    });
+  }
   return new Transaction({
     type: TransactionType.appl,
     sender,
@@ -423,10 +450,12 @@ export function makeApplicationCallTxnFromObject({
       appIndex,
       onComplete,
       appArgs,
-      accounts,
-      foreignAssets,
-      foreignApps,
-      boxes,
+      // Only pass legacy foreign arrays if access is not provided
+      accounts: access2 ? undefined : accounts,
+      foreignAssets: access2 ? undefined : foreignAssets,
+      foreignApps: access2 ? undefined : foreignApps,
+      boxes: access2 ? undefined : boxes,
+      access: access2,
       approvalProgram,
       clearProgram,
       numLocalInts,
@@ -434,6 +463,7 @@ export function makeApplicationCallTxnFromObject({
       numGlobalInts,
       numGlobalByteSlices,
       extraPages,
+      rejectVersion,
     },
   });
 }
@@ -451,6 +481,10 @@ export function makeApplicationCreateTxnFromObject({
   foreignApps,
   foreignAssets,
   boxes,
+  convertToAccess,
+  holdings,
+  locals,
+  access,
   approvalProgram,
   clearProgram,
   numLocalInts,
@@ -469,7 +503,8 @@ export function makeApplicationCreateTxnFromObject({
   Required<
     Pick<ApplicationCallTransactionParams, 'approvalProgram' | 'clearProgram'>
   > &
-  CommonTransactionParams): Transaction {
+  CommonTransactionParams &
+  ApplicationCallReferenceParams): Transaction {
   if (!approvalProgram || !clearProgram) {
     throw Error('approvalProgram and clearProgram must be provided');
   }
@@ -485,6 +520,10 @@ export function makeApplicationCreateTxnFromObject({
     foreignApps,
     foreignAssets,
     boxes,
+    convertToAccess,
+    holdings,
+    locals,
+    access,
     approvalProgram,
     clearProgram,
     numLocalInts,
@@ -512,6 +551,10 @@ export function makeApplicationUpdateTxnFromObject({
   foreignApps,
   foreignAssets,
   boxes,
+  convertToAccess,
+  holdings,
+  locals,
+  access,
   approvalProgram,
   clearProgram,
   note,
@@ -532,7 +575,8 @@ export function makeApplicationUpdateTxnFromObject({
   Required<
     Pick<ApplicationCallTransactionParams, 'approvalProgram' | 'clearProgram'>
   > &
-  CommonTransactionParams): Transaction {
+  CommonTransactionParams &
+  ApplicationCallReferenceParams): Transaction {
   if (!appIndex) {
     throw Error('appIndex must be provided');
   }
@@ -548,6 +592,10 @@ export function makeApplicationUpdateTxnFromObject({
     foreignApps,
     foreignAssets,
     boxes,
+    convertToAccess,
+    holdings,
+    locals,
+    access,
     approvalProgram,
     clearProgram,
     note,
@@ -570,6 +618,10 @@ export function makeApplicationDeleteTxnFromObject({
   foreignApps,
   foreignAssets,
   boxes,
+  convertToAccess,
+  holdings,
+  locals,
+  access,
   note,
   lease,
   rekeyTo,
@@ -585,7 +637,8 @@ export function makeApplicationDeleteTxnFromObject({
   | 'approvalProgram'
   | 'clearProgram'
 > &
-  CommonTransactionParams): Transaction {
+  CommonTransactionParams &
+  ApplicationCallReferenceParams): Transaction {
   if (!appIndex) {
     throw Error('appIndex must be provided');
   }
@@ -598,6 +651,10 @@ export function makeApplicationDeleteTxnFromObject({
     foreignApps,
     foreignAssets,
     boxes,
+    convertToAccess,
+    holdings,
+    locals,
+    access,
     note,
     lease,
     rekeyTo,
@@ -618,6 +675,10 @@ export function makeApplicationOptInTxnFromObject({
   foreignApps,
   foreignAssets,
   boxes,
+  convertToAccess,
+  holdings,
+  locals,
+  access,
   note,
   lease,
   rekeyTo,
@@ -633,7 +694,8 @@ export function makeApplicationOptInTxnFromObject({
   | 'approvalProgram'
   | 'clearProgram'
 > &
-  CommonTransactionParams): Transaction {
+  CommonTransactionParams &
+  ApplicationCallReferenceParams): Transaction {
   if (!appIndex) {
     throw Error('appIndex must be provided');
   }
@@ -647,6 +709,10 @@ export function makeApplicationOptInTxnFromObject({
     foreignAssets,
     boxes,
     note,
+    convertToAccess,
+    holdings,
+    locals,
+    access,
     lease,
     rekeyTo,
     suggestedParams,
@@ -666,6 +732,10 @@ export function makeApplicationCloseOutTxnFromObject({
   foreignApps,
   foreignAssets,
   boxes,
+  convertToAccess,
+  holdings,
+  locals,
+  access,
   note,
   lease,
   rekeyTo,
@@ -681,7 +751,8 @@ export function makeApplicationCloseOutTxnFromObject({
   | 'approvalProgram'
   | 'clearProgram'
 > &
-  CommonTransactionParams): Transaction {
+  CommonTransactionParams &
+  ApplicationCallReferenceParams): Transaction {
   if (!appIndex) {
     throw Error('appIndex must be provided');
   }
@@ -694,6 +765,10 @@ export function makeApplicationCloseOutTxnFromObject({
     foreignApps,
     foreignAssets,
     boxes,
+    convertToAccess,
+    holdings,
+    locals,
+    access,
     note,
     lease,
     rekeyTo,
@@ -714,6 +789,10 @@ export function makeApplicationClearStateTxnFromObject({
   foreignApps,
   foreignAssets,
   boxes,
+  convertToAccess,
+  holdings,
+  locals,
+  access,
   note,
   lease,
   rekeyTo,
@@ -729,7 +808,8 @@ export function makeApplicationClearStateTxnFromObject({
   | 'approvalProgram'
   | 'clearProgram'
 > &
-  CommonTransactionParams): Transaction {
+  CommonTransactionParams &
+  ApplicationCallReferenceParams): Transaction {
   if (!appIndex) {
     throw Error('appIndex must be provided');
   }
@@ -742,6 +822,10 @@ export function makeApplicationClearStateTxnFromObject({
     foreignApps,
     foreignAssets,
     boxes,
+    convertToAccess,
+    holdings,
+    locals,
+    access,
     note,
     lease,
     rekeyTo,
@@ -762,6 +846,10 @@ export function makeApplicationNoOpTxnFromObject({
   foreignApps,
   foreignAssets,
   boxes,
+  convertToAccess,
+  holdings,
+  locals,
+  access,
   note,
   lease,
   rekeyTo,
@@ -777,7 +865,8 @@ export function makeApplicationNoOpTxnFromObject({
   | 'approvalProgram'
   | 'clearProgram'
 > &
-  CommonTransactionParams): Transaction {
+  CommonTransactionParams &
+  ApplicationCallReferenceParams): Transaction {
   if (!appIndex) {
     throw Error('appIndex must be provided');
   }
@@ -790,6 +879,10 @@ export function makeApplicationNoOpTxnFromObject({
     foreignApps,
     foreignAssets,
     boxes,
+    convertToAccess,
+    holdings,
+    locals,
+    access,
     note,
     lease,
     rekeyTo,

package/src/signing.ts

@@ -62,11 +62,11 @@ export function signLogicSigTransactionObject(
       // delegating account is the sender. If that's not the case, the signing
       // will fail.
       lsigAddress = new Address(txn.sender.publicKey);
-    } else if (lsig.msig) {
+    } else if (lsig.lmsig) {
       const msigMetadata = {
-        version: lsig.msig.v,
-        threshold: lsig.msig.thr,
-        pks: lsig.msig.subsig.map((subsig) => subsig.pk),
+        version: lsig.lmsig.v,
+        threshold: lsig.lmsig.thr,
+        pks: lsig.lmsig.subsig.map((subsig) => subsig.pk),
       };
       lsigAddress = addressFromMultisigPreImg(msigMetadata);
     } else {