@algorandfoundation/algorand-typescript 1.0.0-alpha.62 → 1.0.0-alpha.64

package/arc-28.d.ts

@@ -7,8 +7,8 @@ import { DeliberateAny } from './internal/typescript-helpers';
  * @param event An ARC4Struct instance, or a plain object with a named type
  *
  * @example
- * class Demo extends Struct<{ a: UintN64 }> {}
- * emit(new Demo({ a: new UintN64(123) }))
+ * class Demo extends Struct<{ a: Uint64 }> {}
+ * emit(new Demo({ a: new Uint64(123) }))
  *
  * @example
  * type Demo = { a: uint64 }
@@ -25,7 +25,7 @@ export declare function emit<TEvent extends Record<string, DeliberateAny>>(event
  * @param eventProps A set of event properties (order is significant)
  *
  * @example
- * emit("Demo", new UintN64(123))
+ * emit("Demo", new Uint64(123))
  *
  * @example
  * const a: uint64 = 123

package/arc4/c2c.d.ts

@@ -1,8 +1,7 @@
 import { CompileContractOptions, CompiledContract } from '../compiled';
-import * as gtxn from '../gtxn';
+import { gtxn } from '../gtxn';
 import { AnyFunction, ConstructorFor, DeliberateAny, InstanceMethod } from '../internal/typescript-helpers';
-import * as itxn from '../itxn';
-import { ApplicationCallFields, ApplicationCallInnerTxn } from '../itxn';
+import { itxn } from '../itxn';
 import { Contract } from './index';
 /**
  * Defines txn fields that are available for a bare create application call.
@@ -11,7 +10,7 @@ import { Contract } from './index';
  *  - appId: because the appId is not known when creating an application
  *  - appArgs: because a bare call cannot have arguments
  */
-export type BareCreateApplicationCallFields = Omit<ApplicationCallFields, 'appId' | 'appArgs'>;
+export type BareCreateApplicationCallFields = Omit<itxn.ApplicationCallFields, 'appId' | 'appArgs'>;
 /**
  * Conditional type which given a group transaction type, returns the equivalent inner transaction
  * params type.
@@ -27,24 +26,24 @@ export type TypedApplicationArg<TArg> = TArg extends gtxn.Transaction ? GtxnToIt
 /**
  * Conditional type which maps a tuple of application arguments to a tuple of input types for specifying those arguments.
  */
-export type TypedApplicationArgs<TArgs> = TArgs extends [] ? [] : TArgs extends [infer TArg, ...infer TRest] ? [TypedApplicationArg<TArg>, ...TypedApplicationArgs<TRest>] : never;
+export type TypedApplicationArgs<TArgs> = TArgs extends [] ? [] : TArgs extends [infer TArg, ...infer TRest] ? readonly [TypedApplicationArg<TArg>, ...TypedApplicationArgs<TRest>] : never;
 /**
  * Application call fields with `appArgs` replaced with an `args` property that is strongly typed to the actual arguments for the
  * given application call.
  */
-export type TypedApplicationCallFields<TArgs> = Omit<ApplicationCallFields, 'appArgs'> & (TArgs extends [] ? {
-    args?: TypedApplicationArgs<TArgs>;
+export type TypedApplicationCallFields<TArgs> = Omit<itxn.ApplicationCallFields, 'appArgs'> & (TArgs extends [] ? {
+    readonly args?: TypedApplicationArgs<TArgs>;
 } : {
-    args: TypedApplicationArgs<TArgs>;
+    readonly args: TypedApplicationArgs<TArgs>;
 });
 /**
  * The response type of a typed application call. Includes the raw itxn result object and the parsed ABI return value if applicable.
  */
 export type TypedApplicationCallResponse<TReturn> = TReturn extends void ? {
-    itxn: ApplicationCallInnerTxn;
+    readonly itxn: itxn.ApplicationCallInnerTxn;
 } : {
-    itxn: ApplicationCallInnerTxn;
-    returnValue: TReturn;
+    readonly itxn: itxn.ApplicationCallInnerTxn;
+    readonly returnValue: TReturn;
 };
 /**
  * Conditional type which maps an ABI method to a factory method for constructing an application call transaction to call that method.
@@ -65,7 +64,7 @@ export type ContractProxy<TContract extends Contract> = CompiledContract & {
      * Create a bare application call itxn to create the contract.
      * @param fields Specify values for transaction fields which should override the default values.
      */
-    bareCreate(fields?: BareCreateApplicationCallFields): ApplicationCallInnerTxn;
+    bareCreate(fields?: BareCreateApplicationCallFields): itxn.ApplicationCallInnerTxn;
 };
 /**
  * Pre compile the target ARC4 contract and return a proxy object for constructing inner transactions to call an instance of that contract.

package/arc4/encoded-types.d.ts

@@ -1,4 +1,4 @@
-import { biguint, BigUintCompat, bytes, BytesBacked, NTuple, StringCompat, uint64, Uint64Compat } from '../primitives';
+import { biguint, BigUintCompat, bytes, BytesBacked, StringCompat, uint64, Uint64Compat } from '../primitives';
 import { Account } from '../reference';
 /**
  * Defines UintN bit sizes which are compatible with the uint64 type
@@ -9,7 +9,7 @@ type UintBitSize = 8 | 16 | 24 | 32 | 40 | 48 | 56 | 64;
  */
 type BigUintBitSize = 72 | 80 | 88 | 96 | 104 | 112 | 120 | 128 | 136 | 144 | 152 | 160 | 168 | 176 | 184 | 192 | 200 | 208 | 216 | 224 | 232 | 240 | 248 | 256 | 264 | 272 | 280 | 288 | 296 | 304 | 312 | 320 | 328 | 336 | 344 | 352 | 360 | 368 | 376 | 384 | 392 | 400 | 408 | 416 | 424 | 432 | 440 | 448 | 456 | 464 | 472 | 480 | 488 | 496 | 504 | 512;
 /**
- * Defines supported bit sizes for the UintN and UFixedNxM types
+ * Defines supported bit sizes for the UintN and UFixed types
  */
 export type BitSize = UintBitSize | BigUintBitSize;
 /**
@@ -28,7 +28,15 @@ declare const TypeProperty: unique symbol;
  * A base type for ARC4 encoded values
  */
 export declare abstract class ARC4Encoded implements BytesBacked {
-    /** @hidden */
+    /**
+     * @hidden
+     *
+     * Since TypeScript is structurally typed, different ARC4Encodeds with compatible
+     * structures will often be assignable to one and another and this is generally
+     * not desirable. The TypeProperty property should be used to declare a literal value
+     * (usually the class name) on each distinct ARC4Encoded class to ensure they are
+     * structurally different.
+     */
     abstract [TypeProperty]?: string;
     /**
      * Retrieve the encoded bytes for this type
@@ -54,9 +62,9 @@ export declare class Str extends ARC4Encoded {
 /**
  * A fixed bit size unsigned int
  */
-export declare class UintN<N extends BitSize> extends ARC4Encoded {
+export declare class Uint<N extends BitSize> extends ARC4Encoded {
     /** @hidden */
-    [TypeProperty]?: `arc4.UintN<${N}>`;
+    [TypeProperty]?: `arc4.Uint<${N}>`;
     /**
      * Create a new UintN instance
      * @param v The native uint64 or biguint value to initialize this UintN from
@@ -68,48 +76,48 @@ export declare class UintN<N extends BitSize> extends ARC4Encoded {
     get native(): NativeForArc4Int<N>;
 }
 /**
- * An alias for UintN<8>
+ * An alias for Uint<8>
  */
-export declare class Byte extends UintN<8> {
+export declare class Byte extends Uint<8> {
 }
 /**
- * An alias for UintN<8>
+ * An alias for Uint<8>
  */
-export declare class UintN8 extends UintN<8> {
+export declare class Uint8 extends Uint<8> {
 }
 /**
- * An alias for UintN<16>
+ * An alias for Uint<16>
  */
-export declare class UintN16 extends UintN<16> {
+export declare class Uint16 extends Uint<16> {
 }
 /**
- * An alias for UintN<32>
+ * An alias for Uint<32>
  */
-export declare class UintN32 extends UintN<32> {
+export declare class Uint32 extends Uint<32> {
 }
 /**
- * An alias for UintN<64>
+ * An alias for Uint<64>
  */
-export declare class UintN64 extends UintN<64> {
+export declare class Uint64 extends Uint<64> {
 }
 /**
- * An alias for UintN<128>
+ * An alias for Uint<128>
  */
-export declare class UintN128 extends UintN<128> {
+export declare class Uint128 extends Uint<128> {
 }
 /**
- * An alias for UintN<256>
+ * An alias for Uint<256>
  */
-export declare class UintN256 extends UintN<256> {
+export declare class Uint256 extends Uint<256> {
 }
 /**
  * A fixed bit size, fixed decimal unsigned value
  */
-export declare class UFixedNxM<N extends BitSize, M extends number> extends ARC4Encoded {
+export declare class UFixed<N extends BitSize, M extends number> extends ARC4Encoded {
     /** @hidden */
-    [TypeProperty]?: `arc4.UFixedNxM<${N}x${M}>`;
+    [TypeProperty]?: `arc4.UFixed<${N}x${M}>`;
     /**
-     * Create a new UFixedNxM value
+     * Create a new UFixed value
      * @param v A string representing the integer and fractional portion of the number
      */
     constructor(v?: `${number}.${number}`);
@@ -123,7 +131,7 @@ export declare class UFixedNxM<N extends BitSize, M extends number> extends ARC4
  */
 export declare class Bool extends ARC4Encoded {
     /** @hidden */
-    [TypeProperty]?: `arc4.Bool`;
+    [TypeProperty]?: 'arc4.Bool';
     /**
      * Create a new Bool value
      * @param v The native boolean to initialize this value from
@@ -137,7 +145,7 @@ export declare class Bool extends ARC4Encoded {
 /**
  * A base type for arc4 array types
  */
-declare abstract class Arc4ArrayBase<TItem extends ARC4Encoded> extends ARC4Encoded {
+declare abstract class Arc4ArrayBase<TItem extends ARC4Encoded> extends ARC4Encoded implements ConcatArray<TItem> {
     protected constructor();
     /**
      * Returns the current length of this array
@@ -149,6 +157,30 @@ declare abstract class Arc4ArrayBase<TItem extends ARC4Encoded> extends ARC4Enco
      * @param index The index of the item to retrieve
      */
     at(index: Uint64Compat): TItem;
+    /** @deprecated Array slicing is not yet supported in Algorand TypeScript
+     * Create a new Dynamic array with all items from this array
+     */
+    slice(): Array<TItem>;
+    /** @deprecated Array slicing is not yet supported in Algorand TypeScript
+     * Create a new DynamicArray with all items up till `end`.
+     * Negative indexes are taken from the end.
+     * @param end An index in which to stop copying items.
+     */
+    slice(end: Uint64Compat): Array<TItem>;
+    /** @deprecated Array slicing is not yet supported in Algorand TypeScript
+     * Create a new DynamicArray with items from `start`, up until `end`
+     * Negative indexes are taken from the end.
+     * @param start An index in which to start copying items.
+     * @param end An index in which to stop copying items
+     */
+    slice(start: Uint64Compat, end: Uint64Compat): Array<TItem>;
+    /**
+     * Creates a string by concatenating all the items in the array delimited by the
+     * specified separator (or ',' by default)
+     * @param separator
+     * @deprecated Join is not supported in Algorand TypeScript
+     */
+    join(separator?: string): string;
     /**
      * Returns an iterator for the items in this array
      */
@@ -186,19 +218,11 @@ export declare class StaticArray<TItem extends ARC4Encoded, TLength extends numb
     constructor(...items: TItem[] & {
         length: TLength;
     });
-    /**
-     * Returns a copy of this array
-     */
-    copy(): StaticArray<TItem, TLength>;
     /**
      * Returns a new array containing all items from _this_ array, and _other_ array
      * @param other Another array to concat with this one
      */
     concat(other: Arc4ArrayBase<TItem>): DynamicArray<TItem>;
-    /**
-     * Return the array items as a native tuple
-     */
-    get native(): NTuple<TItem, TLength>;
 }
 /**
  * A dynamic sized array of arc4 items
@@ -221,29 +245,21 @@ export declare class DynamicArray<TItem extends ARC4Encoded> extends Arc4ArrayBa
      * Pop a single item from this array
      */
     pop(): TItem;
-    /**
-     * Returns a copy of this array
-     */
-    copy(): DynamicArray<TItem>;
     /**
      * Returns a new array containing all items from _this_ array, and _other_ array
      * @param other Another array to concat with this one
      */
     concat(other: Arc4ArrayBase<TItem>): DynamicArray<TItem>;
-    /**
-     * Return the array items as a native immutable array
-     */
-    get native(): TItem[];
 }
 /**
  * @hidden
  */
-type ExpandTupleType<T extends ARC4Encoded[]> = T extends [infer T1 extends ARC4Encoded, ...infer TRest extends ARC4Encoded[]] ? TRest extends [] ? `${T1[typeof TypeProperty]}` : `${T1[typeof TypeProperty]},${ExpandTupleType<TRest>}` : '';
+type ExpandTupleType<T extends readonly ARC4Encoded[]> = T extends [infer T1 extends ARC4Encoded, ...infer TRest extends ARC4Encoded[]] ? TRest extends [] ? `${T1[typeof TypeProperty]}` : `${T1[typeof TypeProperty]},${ExpandTupleType<TRest>}` : '';
 /**
  * An arc4 encoded tuple of values
  * @typeParam TTuple A type representing the native tuple of item types
  */
-export declare class Tuple<TTuple extends [ARC4Encoded, ...ARC4Encoded[]]> extends ARC4Encoded {
+export declare class Tuple<const TTuple extends readonly [ARC4Encoded, ...ARC4Encoded[]]> extends ARC4Encoded {
     /** @hidden */
     [TypeProperty]?: `arc4.Tuple<${ExpandTupleType<TTuple>}>`;
     /**
@@ -274,7 +290,7 @@ export declare class Tuple<TTuple extends [ARC4Encoded, ...ARC4Encoded[]]> exten
  */
 export declare class Address extends Arc4ArrayBase<Byte> {
     /** @hidden */
-    [TypeProperty]?: `arc4.Address`;
+    [TypeProperty]?: 'arc4.Address';
     /**
      * Create a new Address instance
      * @param value An Account, base 32 address string, or the address bytes
@@ -290,12 +306,8 @@ export declare class Address extends Arc4ArrayBase<Byte> {
  */
 declare class StructBase<T> extends ARC4Encoded {
     /** @hidden */
-    [TypeProperty]: string;
+    [TypeProperty]?: 'arc4.Struct';
     get native(): T;
-    /**
-     * Returns a deep copy of this struct
-     */
-    copy(): this;
 }
 /**
  * Type alias for the Struct constructor function
@@ -309,7 +321,7 @@ type StructConstructor = {
  *
  * Usage:
  * ```
- * class MyStruct extends Struct<{ x: UintN8, y: Str, z: DynamicBytes }> {}
+ * class MyStruct extends Struct<{ x: Uint8, y: Str, z: DynamicBytes }> { }
  * ```
  */
 export declare const Struct: StructConstructor;
@@ -318,7 +330,7 @@ export declare const Struct: StructConstructor;
  */
 export declare class DynamicBytes extends Arc4ArrayBase<Byte> {
     /** @hidden */
-    [TypeProperty]?: `arc4.DynamicBytes`;
+    [TypeProperty]?: 'arc4.DynamicBytes';
     /**
      * Create a new DynamicBytes instance
      * @param value The bytes or utf8 interpreted string to initialize this type

package/arc4/index.mjs

@@ -1,3 +1,3 @@
-export { A as ARC4Encoded, t as Address, r as Bool, h as Byte, C as Contract, D as DynamicArray, v as DynamicBytes, s as StaticArray, w as StaticBytes, S as Str, u as Struct, T as Tuple, q as UFixedNxM, U as UintN, o as UintN128, k as UintN16, p as UintN256, l as UintN32, n as UintN64, j as UintN8, y as abiCall, a as abimethod, g as arc4EncodedLength, b as baremethod, x as compileArc4, e as decodeArc4, f as encodeArc4, d as interpretAsArc4, m as methodSelector } from '../index-D6p-MoP4.js';
+export { A as ARC4Encoded, t as Address, r as Bool, h as Byte, C as Contract, D as DynamicArray, v as DynamicBytes, s as StaticArray, w as StaticBytes, S as Str, u as Struct, T as Tuple, q as UFixed, U as Uint, o as Uint128, k as Uint16, p as Uint256, l as Uint32, n as Uint64, j as Uint8, y as abiCall, a as abimethod, g as arc4EncodedLength, b as baremethod, x as compileArc4, e as decodeArc4, f as encodeArc4, d as interpretAsArc4, m as methodSelector } from '../index-Dsr3xdFj.js';
 import '../errors-Bg4n2Chz.js';
 //# sourceMappingURL=index.mjs.map

package/arrays.d.ts

@@ -0,0 +1,75 @@
+import { uint64, Uint64Compat } from './primitives';
+/**
+ * A fixed sized array
+ * @typeParam TItem The type of a single item in the array
+ * @typeParam TLength The fixed length of the array
+ */
+export declare class FixedArray<TItem, TLength extends number> implements ConcatArray<TItem> {
+    /**
+     * Create a new FixedArray instance
+     */
+    constructor();
+    /**
+     * Create a new FixedArray instance with the specified items
+     * @param items The initial items for the array
+     */
+    constructor(...items: TItem[] & {
+        length: TLength;
+    });
+    /**
+     * Returns a new array containing all items from _this_ array, and _other_ array
+     * @param items Another array to concat with this one
+     */
+    concat(...items: (TItem | ConcatArray<TItem>)[]): TItem[];
+    /**
+     * Returns the current length of this array
+     */
+    get length(): uint64;
+    /**
+     * Returns the item at the given index.
+     * Negative indexes are taken from the end.
+     * @param index The index of the item to retrieve
+     */
+    at(index: Uint64Compat): TItem;
+    /** @deprecated Array slicing is not yet supported in Algorand TypeScript
+     * Create a new Dynamic array with all items from this array
+     */
+    slice(): Array<TItem>;
+    /** @deprecated Array slicing is not yet supported in Algorand TypeScript
+     * Create a new DynamicArray with all items up till `end`.
+     * Negative indexes are taken from the end.
+     * @param end An index in which to stop copying items.
+     */
+    slice(end: Uint64Compat): Array<TItem>;
+    /** @deprecated Array slicing is not yet supported in Algorand TypeScript
+     * Create a new DynamicArray with items from `start`, up until `end`
+     * Negative indexes are taken from the end.
+     * @param start An index in which to start copying items.
+     * @param end An index in which to stop copying items
+     */
+    slice(start: Uint64Compat, end: Uint64Compat): Array<TItem>;
+    /**
+     * Returns an iterator for the items in this array
+     */
+    [Symbol.iterator](): IterableIterator<TItem>;
+    /**
+     * Returns an iterator for a tuple of the indexes and items in this array
+     */
+    entries(): ArrayIterator<readonly [uint64, TItem]>;
+    /**
+     * Returns an iterator for the indexes in this array
+     */
+    keys(): IterableIterator<uint64>;
+    /**
+     * Get or set the item at the specified index.
+     * Negative indexes are not supported
+     */
+    [index: uint64]: TItem;
+    /**
+     * Creates a string by concatenating all the items in the array delimited by the
+     * specified separator (or ',' by default)
+     * @param separator
+     * @deprecated Join is not supported in Algorand TypeScript
+     */
+    join(separator?: string): string;
+}

package/compiled.d.ts

@@ -10,31 +10,31 @@ export type CompiledContract = {
     /**
      * Approval program pages for a contract, after template variables have been replaced and compiled to AVM bytecode
      */
-    approvalProgram: [bytes, bytes];
+    readonly approvalProgram: readonly [bytes, bytes];
     /**
      * Clear state program pages for a contract, after template variables have been replaced and compiled to AVM bytecode
      */
-    clearStateProgram: [bytes, bytes];
+    readonly clearStateProgram: readonly [bytes, bytes];
     /**
      * By default, provides extra program pages required based on approval and clear state program size, can be overridden when calling `compile(ExampleContractType, { extraProgramPages: ... })`
      */
-    extraProgramPages: uint64;
+    readonly extraProgramPages: uint64;
     /**
      * By default, provides global num uints based on contract state totals, can be overridden when calling `compile(ExampleContractType, { globalUints: ... })`
      */
-    globalUints: uint64;
+    readonly globalUints: uint64;
     /**
      * By default, provides global num bytes based on contract state totals, can be overridden when calling `compile(ExampleContractType, { globalBytes: ... })`
      */
-    globalBytes: uint64;
+    readonly globalBytes: uint64;
     /**
      * By default, provides local num uints based on contract state totals, can be overridden when calling `compile(ExampleContractType, { localUints: ... })`
      */
-    localUints: uint64;
+    readonly localUints: uint64;
     /**
      * By default, provides local num bytes based on contract state totals, can be overridden  when calling `compile(ExampleContractType, { localBytes: ... })`
      */
-    localBytes: uint64;
+    readonly localBytes: uint64;
 };
 /**
  * Provides account for a Logic Signature. Created by calling `compile(LogicSigType)`
@@ -43,7 +43,7 @@ export type CompiledLogicSig = {
     /**
      * Address of a logic sig program, after template variables have been replaced and compiled to AVM bytecode
      */
-    account: Account;
+    readonly account: Account;
 };
 /**
  * Options for compiling a contract
@@ -52,32 +52,32 @@ export type CompileContractOptions = {
     /**
      * Number of extra program pages, defaults to minimum required for contract
      */
-    extraProgramPages?: uint64;
+    readonly extraProgramPages?: uint64;
     /**
      * Number of global uint64s, defaults to value defined for contract
      */
-    globalUints?: uint64;
+    readonly globalUints?: uint64;
     /**
      * Number of global bytes, defaults to value defined for contract
      */
-    globalBytes?: uint64;
+    readonly globalBytes?: uint64;
     /**
      * Number of local uint64s, defaults to value defined for contract
      */
-    localUints?: uint64;
+    readonly localUints?: uint64;
     /**
      * Number of local bytes, defaults to value defined for contract
      */
-    localBytes?: uint64;
+    readonly localBytes?: uint64;
     /**
      * Template variables to substitute into the contract, key should be without the prefix, must evaluate to a compile time constant
      * and match the type of the template var declaration
      */
-    templateVars?: Record<string, DeliberateAny>;
+    readonly templateVars?: Record<string, DeliberateAny>;
     /**
      * Prefix to add to provided template vars, defaults to the prefix supplied on command line (which defaults to TMPL_)
      */
-    templateVarsPrefix?: string;
+    readonly templateVarsPrefix?: string;
 };
 /**
  * Options for compiling a logic signature