algosdk 1.24.1 → 2.1.0

package/src/client/v2/algod/sendRawTransaction.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import JSONRequest from '../jsonrequest';
 import HTTPClient from '../../client';
 import { concatArrays } from '../../../utils/utils';

package/src/client/v2/basemodel.ts

@@ -1,3 +1,5 @@
+import { Buffer } from 'buffer';
+
 /**
  * Base class for models
  */

package/src/client/v2/indexer/lookupAccountTransactions.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import JSONRequest from '../jsonrequest';
 import HTTPClient from '../../client';
 import IntDecoding from '../../../types/intDecoding';

package/src/client/v2/indexer/lookupApplicationBoxByIDandName.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import JSONRequest from '../jsonrequest';
 import HTTPClient from '../../client';
 import IntDecoding from '../../../types/intDecoding';

package/src/client/v2/indexer/lookupAssetTransactions.ts

@@ -176,14 +176,6 @@ export default class LookupAssetTransactions extends JSONRequest {
     return this;
   }
 
-  /**
-   * @deprecated Redundant query parameter. Asset ID is already passed into the method.
-   */
-  assetID(id: number) {
-    this.query['asset-id'] = id;
-    return this;
-  }
-
   /**
    * Maximum number of results to return.
    *

package/src/client/v2/indexer/models/types.ts

@@ -3,6 +3,7 @@
  */
 
 /* eslint-disable no-use-before-define */
+import { Buffer } from 'buffer';
 import BaseModel from '../../basemodel';
 
 /**

package/src/composer.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import {
   ABIType,
   ABITupleType,
@@ -202,6 +203,9 @@ export class AtomicTransactionComposer {
     numLocalInts,
     numLocalByteSlices,
     extraPages,
+    appAccounts,
+    appForeignApps,
+    appForeignAssets,
     boxes,
     note,
     lease,
@@ -234,6 +238,12 @@ export class AtomicTransactionComposer {
     numLocalByteSlices?: number;
     /** The number of extra pages to allocate for the application's programs. Only set this if this is an application creation call. If omitted, defaults to 0. */
     extraPages?: number;
+    /** Array of Address strings that represent external accounts supplied to this application. If accounts are provided here, the accounts specified in the method args will appear after these. */
+    appAccounts?: string[];
+    /** Array of App ID numbers that represent external apps supplied to this application. If apps are provided here, the apps specified in the method args will appear after these. */
+    appForeignApps?: number[];
+    /** Array of Asset ID numbers that represent external assets supplied to this application. If assets are provided here, the assets specified in the method args will appear after these. */
+    appForeignAssets?: number[];
     /** The box references for this application call */
     boxes?: BoxReference[];
     /** The note value for this application call */
@@ -370,9 +380,12 @@ export class AtomicTransactionComposer {
     }
 
     const resolvedRefIndexes: number[] = [];
-    const foreignAccounts: string[] = [];
-    const foreignApps: number[] = [];
-    const foreignAssets: number[] = [];
+    const foreignAccounts: string[] =
+      appAccounts == null ? [] : appAccounts.slice();
+    const foreignApps: number[] =
+      appForeignApps == null ? [] : appForeignApps.slice();
+    const foreignAssets: number[] =
+      appForeignAssets == null ? [] : appForeignAssets.slice();
     for (let i = 0; i < refArgTypes.length; i++) {
       const refType = refArgTypes[i];
       const refValue = refArgValues[i];

package/src/dryrun.ts

@@ -1,3 +1,4 @@
+import { Buffer } from 'buffer';
 import AlgodClient from './client/v2/algod/algod';
 import {
   AccountStateDelta,
@@ -92,22 +93,22 @@ export async function createDryrun({
       // Create application,
       if (t.txn.appIndex === undefined || t.txn.appIndex === 0) {
         appInfos.push(
-          new Application(
-            defaultAppId,
-            new ApplicationParams({
+          new Application({
+            id: defaultAppId,
+            params: new ApplicationParams({
               creator: encodeAddress(t.txn.from.publicKey),
               approvalProgram: t.txn.appApprovalProgram,
               clearStateProgram: t.txn.appClearProgram,
-              localStateSchema: new ApplicationStateSchema(
-                t.txn.appLocalInts,
-                t.txn.appLocalByteSlices
-              ),
-              globalStateSchema: new ApplicationStateSchema(
-                t.txn.appGlobalInts,
-                t.txn.appGlobalByteSlices
-              ),
-            })
-          )
+              localStateSchema: new ApplicationStateSchema({
+                numUint: t.txn.appLocalInts,
+                numByteSlice: t.txn.appLocalByteSlices,
+              }),
+              globalStateSchema: new ApplicationStateSchema({
+                numUint: t.txn.appGlobalInts,
+                numByteSlice: t.txn.appGlobalByteSlices,
+              }),
+            }),
+          })
         );
       } else {
         apps.push(t.txn.appIndex);

package/src/encoding/address.ts

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

package/src/encoding/bigint.ts

@@ -1,3 +1,5 @@
+import { Buffer } from 'buffer';
+
 /**
  * bigIntToBytes converts a BigInt to a big-endian Uint8Array for encoding.
  * @param bi - The bigint to convert.

package/src/encoding/uint64.ts

@@ -1,3 +1,10 @@
+import { concatArrays } from '../utils/utils';
+
+// NOTE: at the moment we specifically do not use Buffer.writeBigUInt64BE and
+// Buffer.readBigUInt64BE. This is because projects using webpack v4
+// automatically include an old version of the npm `buffer` package (v4.9.2 at
+// the time of writing), and this old version does not have these methods.
+
 /**
  * encodeUint64 converts an integer to its binary representation.
  * @param num - The number to convert. This must be an unsigned integer less than
@@ -12,11 +19,11 @@ export function encodeUint64(num: number | bigint) {
     throw new Error('Input is not a 64-bit unsigned integer');
   }
 
-  const buf = Buffer.allocUnsafe(8);
+  const encoding = new Uint8Array(8);
+  const view = new DataView(encoding.buffer);
+  view.setBigUint64(0, BigInt(num));
 
-  buf.writeBigUInt64BE(BigInt(num));
-
-  return new Uint8Array(buf);
+  return encoding;
 }
 
 /**
@@ -59,13 +66,12 @@ export function decodeUint64(data: any, decodingMode: any = 'safe') {
   }
 
   // insert 0s at the beginning if data is smaller than 8 bytes
-  const padding = Buffer.allocUnsafe(8 - data.byteLength);
-  padding.fill(0);
-
-  const buf = Buffer.concat([padding, Buffer.from(data)]);
+  const padding = new Uint8Array(8 - data.byteLength);
+  const encoding = concatArrays(padding, data);
+  const view = new DataView(encoding.buffer);
 
-  const num = buf.readBigUInt64BE();
-  const isBig = num > Number.MAX_SAFE_INTEGER;
+  const num = view.getBigUint64(0);
+  const isBig = num > BigInt(Number.MAX_SAFE_INTEGER);
 
   if (decodingMode === 'safe') {
     if (isBig) {

package/src/group.ts

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

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';
@@ -54,6 +55,8 @@ export function sanityCheckProgram(program: Uint8Array) {
 
 /**
  LogicSig implementation
+
+ LogicSig cannot sign transactions in all cases.  Instead, use LogicSigAccount as a safe, general purpose signing mechanism.  Since LogicSig does not track the provided signature's public key, LogicSig cannot sign transactions when delegated to a non-multisig account _and_ the sender is not the delegating account.
  */
 export class LogicSig implements LogicSigStorageStructure {
   tag = Buffer.from('Program');
@@ -375,19 +378,6 @@ export class LogicSigAccount {
   }
 }
 
-/**
- * makeLogicSig creates LogicSig object from program and arguments
- *
- * @deprecated Use new LogicSigAccount(...) instead
- *
- * @param program - Program to make LogicSig from
- * @param args - Arguments as array of Uint8Array
- * @returns LogicSig object
- */
-export function makeLogicSig(program: Uint8Array, args?: Uint8Array[]) {
-  return new LogicSig(program, args);
-}
-
 function signLogicSigTransactionWithAddress(
   txn: txnBuilder.Transaction,
   lsig: LogicSig,
@@ -506,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,8 +1,8 @@
+import { Buffer } from 'buffer';
 import * as nacl from './nacl/naclWrappers';
 import * as address from './encoding/address';
 import * as encoding from './encoding/encoding';
 import * as txnBuilder from './transaction';
-import * as LogicTemplatesCommonJSExport from './logicTemplates';
 import Bid, { BidOptions } from './bid';
 import * as convert from './convert';
 import * as utils from './utils/utils';
@@ -117,7 +117,6 @@ export const ERROR_INVALID_MICROALGOS = new Error(
   convert.INVALID_MICROALGOS_ERROR_MSG
 );
 
-export * from './client/algod';
 export { default as Algodv2 } from './client/v2/algod/algod';
 export { default as Kmd } from './client/kmd';
 export { default as IntDecoding } from './types/intDecoding';
@@ -155,13 +154,14 @@ export {
 } from './convert';
 export { computeGroupID, assignGroupID } from './group';
 export {
+  LogicSig,
   LogicSigAccount,
-  makeLogicSig,
   signLogicSigTransaction,
   signLogicSigTransactionObject,
   logicSigFromByte,
   tealSign,
   tealSignFromProgram,
+  verifyTealSign,
 } from './logicsig';
 export {
   signMultisigTransaction,
@@ -174,8 +174,6 @@ export {
 } from './multisig';
 export { SourceMap } from './logic/sourcemap';
 
-export const LogicTemplates = LogicTemplatesCommonJSExport.default;
-
 export * from './dryrun';
 export * from './makeTxn';
 export * from './transaction';