algosdk 2.8.0 → 3.0.0-beta.1

package/src/abi/abi_type.ts

@@ -13,10 +13,9 @@
     // | string
     // | (T1, ..., Tn)
 */
-import { Buffer } from 'buffer';
-import { encodeAddress, decodeAddress } from '../encoding/address';
-import { bigIntToBytes, bytesToBigInt } from '../encoding/bigint';
-import { concatArrays } from '../utils/utils';
+import { encodeAddress, decodeAddress } from '../encoding/address.js';
+import { bigIntToBytes, bytesToBigInt } from '../encoding/bigint.js';
+import { concatArrays } from '../utils/utils.js';
 
 export const MAX_LEN = 2 ** 16 - 1;
 export const ADDR_BYTE_SIZE = 32;
@@ -62,7 +61,7 @@ export abstract class ABIType {
     if (str.endsWith(']')) {
       const stringMatches = str.match(staticArrayRegexp);
       // Match the string itself, array element type, then array length
-      if (stringMatches.length !== 3) {
+      if (!stringMatches || stringMatches.length !== 3) {
         throw new Error(`malformed static array string: ${str}`);
       }
       // Parse static array using regex
@@ -77,8 +76,8 @@ export abstract class ABIType {
     }
     if (str.startsWith('uint')) {
       // Checks if the parsed number contains only digits, no whitespaces
-      const digitsOnly = (string) =>
-        [...string].every((c) => '0123456789'.includes(c));
+      const digitsOnly = (s: string) =>
+        [...s].every((c) => '0123456789'.includes(c));
       const typeSizeStr = str.slice(4, str.length);
       if (!digitsOnly(typeSizeStr)) {
         throw new Error(`malformed uint string: ${typeSizeStr}`);
@@ -94,7 +93,7 @@ export abstract class ABIType {
     }
     if (str.startsWith('ufixed')) {
       const stringMatches = str.match(ufixedRegexp);
-      if (stringMatches.length !== 3) {
+      if (!stringMatches || stringMatches.length !== 3) {
         throw new Error(`malformed ufixed type: ${str}`);
       }
       const ufixedSize = parseInt(stringMatches[1], 10);
@@ -380,7 +379,12 @@ export class ABIStringType extends ABIType {
     if (typeof value !== 'string' && !(value instanceof Uint8Array)) {
       throw new Error(`Cannot encode value as string: ${value}`);
     }
-    const encodedBytes = Buffer.from(value);
+    let encodedBytes: Uint8Array;
+    if (typeof value === 'string') {
+      encodedBytes = new TextEncoder().encode(value);
+    } else {
+      encodedBytes = value;
+    }
     const encodedLength = bigIntToBytes(
       encodedBytes.length,
       LENGTH_ENCODE_BYTE_SIZE
@@ -399,8 +403,12 @@ export class ABIStringType extends ABIType {
         `byte string is too short to be decoded. Actual length is ${byteString.length}, but expected at least ${LENGTH_ENCODE_BYTE_SIZE}`
       );
     }
-    const buf = Buffer.from(byteString);
-    const byteLength = buf.readUIntBE(0, LENGTH_ENCODE_BYTE_SIZE);
+    const view = new DataView(
+      byteString.buffer,
+      byteString.byteOffset,
+      LENGTH_ENCODE_BYTE_SIZE
+    );
+    const byteLength = view.getUint16(0);
     const byteValue = byteString.slice(
       LENGTH_ENCODE_BYTE_SIZE,
       byteString.length
@@ -410,7 +418,7 @@ export class ABIStringType extends ABIType {
         `string length bytes do not match the actual length of string. Expected ${byteLength}, got ${byteValue.length}`
       );
     }
-    return Buffer.from(byteValue).toString('utf-8');
+    return new TextDecoder('utf-8').decode(byteValue);
   }
 }
 
@@ -517,8 +525,8 @@ export class ABIArrayDynamicType extends ABIType {
   }
 
   decode(byteString: Uint8Array): ABIValue[] {
-    const buf = Buffer.from(byteString);
-    const byteLength = buf.readUIntBE(0, LENGTH_ENCODE_BYTE_SIZE);
+    const view = new DataView(byteString.buffer, 0, LENGTH_ENCODE_BYTE_SIZE);
+    const byteLength = view.getUint16(0);
     const convertedTuple = this.toABITupleType(byteLength);
     return convertedTuple.decode(
       byteString.slice(LENGTH_ENCODE_BYTE_SIZE, byteString.length)
@@ -657,10 +665,10 @@ export class ABITupleType extends ABIType {
   decode(byteString: Uint8Array): ABIValue[] {
     const tupleTypes = this.childTypes;
     const dynamicSegments: Segment[] = [];
-    const valuePartition: Uint8Array[] = [];
+    const valuePartition: Array<Uint8Array | null> = [];
     let i = 0;
     let iterIndex = 0;
-    const buf = Buffer.from(byteString);
+    const view = new DataView(byteString.buffer);
 
     while (i < tupleTypes.length) {
       const tupleType = tupleTypes[i];
@@ -671,7 +679,9 @@ export class ABITupleType extends ABIType {
         ) {
           throw new Error('dynamic type in tuple is too short to be decoded');
         }
-        const dynamicIndex = buf.readUIntBE(iterIndex, LENGTH_ENCODE_BYTE_SIZE);
+        // Since LENGTH_ENCODE_BYTE_SIZE is 2 and indices are at most 2 bytes,
+        // we can use getUint16 using the iterIndex offset.
+        const dynamicIndex = view.getUint16(iterIndex);
         if (dynamicSegments.length > 0) {
           dynamicSegments[dynamicSegments.length - 1].right = dynamicIndex;
           // Check that right side of segment is greater than the left side
@@ -761,7 +771,7 @@ export class ABITupleType extends ABIType {
     // Decode each tuple element
     const returnValues: ABIValue[] = [];
     for (let j = 0; j < tupleTypes.length; j++) {
-      const valueTi = tupleTypes[j].decode(valuePartition[j]);
+      const valueTi = tupleTypes[j].decode(valuePartition[j]!);
       returnValues.push(valueTi);
     }
     return returnValues;

package/src/abi/contract.ts

@@ -1,4 +1,5 @@
-import { ABIMethod, ABIMethodParams, getMethodByName } from './method';
+import { ABIMethod, ABIMethodParams, getMethodByName } from './method.js';
+import { ARC28Event } from './event.js';
 
 export interface ABIContractNetworkInfo {
   appID: number;
@@ -13,6 +14,7 @@ export interface ABIContractParams {
   desc?: string;
   networks?: ABIContractNetworks;
   methods: ABIMethodParams[];
+  events?: ARC28Event[];
 }
 
 export class ABIContract {
@@ -20,6 +22,8 @@ export class ABIContract {
   public readonly description?: string;
   public readonly networks: ABIContractNetworks;
   public readonly methods: ABIMethod[];
+  /** [ARC-28](https://arc.algorand.foundation/ARCs/arc-0028) events that MAY be emitted by this contract */
+  public readonly events?: ARC28Event[];
 
   constructor(params: ABIContractParams) {
     if (
@@ -34,6 +38,7 @@ export class ABIContract {
     this.description = params.desc;
     this.networks = params.networks ? { ...params.networks } : {};
     this.methods = params.methods.map((method) => new ABIMethod(method));
+    this.events = params.events;
   }
 
   toJSON(): ABIContractParams {
@@ -42,6 +47,7 @@ export class ABIContract {
       desc: this.description,
       networks: this.networks,
       methods: this.methods.map((method) => method.toJSON()),
+      events: this.events,
     };
   }
 

package/src/abi/event.ts

@@ -0,0 +1,16 @@
+/** [ARC-28](https://arc.algorand.foundation/ARCs/arc-0028) event description */
+export interface ARC28Event {
+  /** The name of the event */
+  name: string;
+  /** Optional, user-friendly description for the event */
+  desc?: string;
+  /** The arguments of the event, in order */
+  args: Array<{
+    /** The type of the argument */
+    type: string;
+    /** Optional, user-friendly name for the argument */
+    name?: string;
+    /** Optional, user-friendly description for the argument */
+    desc?: string;
+  }>;
+}

package/src/abi/index.ts

@@ -1,6 +1,6 @@
-export * from './abi_type';
-export * from './contract';
-export * from './interface';
-export * from './method';
-export * from './transaction';
-export * from './reference';
+export * from './abi_type.js';
+export * from './contract.js';
+export * from './interface.js';
+export * from './method.js';
+export * from './transaction.js';
+export * from './reference.js';

package/src/abi/interface.ts

@@ -1,4 +1,4 @@
-import { ABIMethod, ABIMethodParams, getMethodByName } from './method';
+import { ABIMethod, ABIMethodParams, getMethodByName } from './method.js';
 
 export interface ABIInterfaceParams {
   name: string;

package/src/abi/method.ts

@@ -1,11 +1,14 @@
-import { genericHash } from '../nacl/naclWrappers';
-import { ABIType, ABITupleType } from './abi_type';
-import { ABITransactionType, abiTypeIsTransaction } from './transaction';
-import { ABIReferenceType, abiTypeIsReference } from './reference';
-
-function parseMethodSignature(
-  signature: string
-): { name: string; args: string[]; returns: string } {
+import { genericHash } from '../nacl/naclWrappers.js';
+import { ABIType, ABITupleType } from './abi_type.js';
+import { ABITransactionType, abiTypeIsTransaction } from './transaction.js';
+import { ABIReferenceType, abiTypeIsReference } from './reference.js';
+import { ARC28Event } from './event.js';
+
+function parseMethodSignature(signature: string): {
+  name: string;
+  args: string[];
+  returns: string;
+} {
   const argsStart = signature.indexOf('(');
   if (argsStart === -1) {
     throw new Error(`Invalid method signature: ${signature}`);
@@ -61,6 +64,10 @@ export interface ABIMethodParams {
   desc?: string;
   args: ABIMethodArgParams[];
   returns: ABIMethodReturnParams;
+  /** Optional, is it a read-only method (according to [ARC-22](https://arc.algorand.foundation/ARCs/arc-0022)) */
+  readonly?: boolean;
+  /** [ARC-28](https://arc.algorand.foundation/ARCs/arc-0028) events that MAY be emitted by this method */
+  events?: ARC28Event[];
 }
 
 export type ABIArgumentType = ABIType | ABITransactionType | ABIReferenceType;
@@ -77,6 +84,8 @@ export class ABIMethod {
   }>;
 
   public readonly returns: { type: ABIReturnType; description?: string };
+  public readonly events?: ARC28Event[];
+  public readonly readonly?: boolean;
 
   constructor(params: ABIMethodParams) {
     if (
@@ -111,6 +120,9 @@ export class ABIMethod {
           : ABIType.from(params.returns.type),
       description: params.returns.desc,
     };
+
+    this.events = params.events;
+    this.readonly = params.readonly;
   }
 
   getSignature(): string {
@@ -147,6 +159,8 @@ export class ABIMethod {
         type: this.returns.type.toString(),
         desc: this.returns.description,
       },
+      events: this.events,
+      readonly: this.readonly,
     };
   }
 

package/src/abi/transaction.ts

@@ -1,4 +1,4 @@
-import { Transaction } from '../transaction';
+import { Transaction } from '../transaction.js';
 
 export enum ABITransactionType {
   /**
@@ -57,5 +57,5 @@ export function abiCheckTransactionType(
     return true;
   }
 
-  return txn.type && txn.type.toString() === type.toString();
+  return txn.type ? txn.type.toString() === type.toString() : false;
 }

package/src/account.ts

@@ -1,12 +1,12 @@
-import * as nacl from './nacl/naclWrappers';
-import * as address from './encoding/address';
-import Account from './types/account';
+import * as nacl from './nacl/naclWrappers.js';
+import { Address } from './encoding/address.js';
+import Account from './types/account.js';
 
 /**
  * generateAccount returns a new Algorand address and its corresponding secret key
  */
 export default function generateAccount(): Account {
   const keys = nacl.keyPair();
-  const encodedPk = address.encodeAddress(keys.publicKey);
-  return { addr: encodedPk, sk: keys.secretKey };
+  const addr = new Address(keys.publicKey);
+  return { addr, sk: keys.secretKey };
 }

package/src/boxStorage.ts

@@ -1,20 +1,17 @@
-import { EncodedBoxReference } from './types';
-import { BoxReference } from './types/transactions/base';
+import { BoxReference } from './types/transactions/base.js';
 
-function translateBoxReference(
+function boxReferenceToEncodingData(
   reference: BoxReference,
-  foreignApps: number[],
-  appIndex: number
-): EncodedBoxReference {
-  const referenceId = reference.appIndex;
+  foreignApps: bigint[],
+  appIndex: bigint
+): Map<string, unknown> {
+  const referenceId = BigInt(reference.appIndex);
   const referenceName = reference.name;
-  const isOwnReference = referenceId === 0 || referenceId === appIndex;
-  let index = 0;
+  const isOwnReference = referenceId === BigInt(0) || referenceId === appIndex;
+
+  // Foreign apps start from index 1; index 0 is its own app ID.
+  const index = foreignApps.indexOf(referenceId) + 1;
 
-  if (foreignApps != null) {
-    // Foreign apps start from index 1; index 0 is its own app ID.
-    index = foreignApps.indexOf(referenceId) + 1;
-  }
   // Check if the app referenced is itself after checking the foreign apps array.
   // If index is zero, then the app ID was not found in the foreign apps array
   // or the foreign apps array was null.
@@ -23,20 +20,25 @@ function translateBoxReference(
     // its own foreign apps array.
     throw new Error(`Box ref with appId ${referenceId} not in foreign-apps`);
   }
-  return { i: index, n: referenceName };
+
+  return new Map<string, number | Uint8Array>([
+    ['i', index],
+    ['n', referenceName],
+  ]);
 }
 
 /**
- * translateBoxReferences translates an array of BoxReferences with app IDs
- * into an array of EncodedBoxReferences with foreign indices.
+ * boxReferencesToEncodingData translates an array of BoxReferences into an array of encoding data
+ * maps.
  */
-export function translateBoxReferences(
-  references: BoxReference[] | undefined,
-  foreignApps: number[],
-  appIndex: number
-): EncodedBoxReference[] {
-  if (references == null) return [];
+export function boxReferencesToEncodingData(
+  references: ReadonlyArray<BoxReference>,
+  foreignApps: ReadonlyArray<number | bigint>,
+  appIndex: number | bigint
+): Array<Map<string, unknown>> {
+  const appIndexBigInt = BigInt(appIndex);
+  const foreignAppsBigInt = foreignApps.map(BigInt);
   return references.map((bx) =>
-    translateBoxReference(bx, foreignApps, appIndex)
+    boxReferenceToEncodingData(bx, foreignAppsBigInt, appIndexBigInt)
   );
 }

package/src/client/baseHTTPClient.ts

@@ -26,8 +26,11 @@ export interface BaseHTTPClientError {
  * wallets to provide access to paid API services without leaking
  * the secret tokens/URLs.
  *
- * Note that post and delete also have an optional query parameter
- * This is to allow future extension where post and delete may have queries
+ * The parameter `customOptions` is an object that can be used to configure
+ * individual requests with specific specific to the BaseHTTPClient implementation.
+ *
+ * Note that DELETE requests have an optional query parameter.
+ * This is to allow future extension where DELETE may have queries
  * Currently however HTTPClient does not make use of it
  *
  * Compared to HTTPClient, BaseHTTPClient does not deal with serialization/deserialization
@@ -41,18 +44,21 @@ export interface BaseHTTPClient {
   get(
     relativePath: string,
     query?: Query<string>,
-    requestHeaders?: Record<string, string>
+    requestHeaders?: Record<string, string>,
+    customOptions?: Record<string, unknown>
   ): Promise<BaseHTTPClientResponse>;
   post(
     relativePath: string,
     data: Uint8Array,
     query?: Query<string>,
-    requestHeaders?: Record<string, string>
+    requestHeaders?: Record<string, string>,
+    customOptions?: Record<string, unknown>
   ): Promise<BaseHTTPClientResponse>;
   delete(
     relativePath: string,
-    data: Uint8Array,
+    data?: Uint8Array,
     query?: Query<string>,
-    requestHeaders?: Record<string, string>
+    requestHeaders?: Record<string, string>,
+    customOptions?: Record<string, unknown>
   ): Promise<BaseHTTPClientResponse>;
 }