@algorandfoundation/algorand-typescript 0.0.1-alpha.9 → 1.0.0-beta.2

package/arc-28.d.ts

@@ -0,0 +1,34 @@
+import { DeliberateAny } from './typescript-helpers';
+/**
+ * Emit an arc28 event log using either an ARC4Struct type or a named object type.
+ * Object types must have an ARC4 equivalent type.
+ *
+ * Anonymous types cannot be used as the type name is used to determine the event prefix
+ * @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) }))
+ *
+ * @example
+ * type Demo = { a: uint64 }
+ * emit<Demo>({a: 123})
+ * // or
+ * const d: Demo = { a: 123 }
+ * emit(d)
+ */
+export declare function emit<TEvent extends Record<string, DeliberateAny>>(event: TEvent): void;
+/**
+ * Emit an arc28 event log using an explicit name and inferred property/field types.
+ * Property types must be ARC4 or have an ARC4 equivalent type.
+ * @param eventName The name of the event (must be a compile time constant)
+ * @param eventProps A set of event properties (order is significant)
+ *
+ * @example
+ * emit("Demo", new UintN64(123))
+ *
+ * @example
+ * const a: uint64 = 123
+ * emit("Demo", a)
+ */
+export declare function emit<TProps extends [...DeliberateAny[]]>(eventName: string, ...eventProps: TProps): void;

package/arc4/encoded-types.d.ts

@@ -1,43 +1,82 @@
-import { biguint, BigUintCompat, bytes, BytesBacked, StringCompat, uint64, Uint64Compat } from '../primitives';
+import { biguint, BigUintCompat, bytes, BytesBacked, BytesCompat, StringCompat, uint64, Uint64Compat } from '../primitives';
 import { Account } from '../reference';
-export type BitSize = 8 | 16 | 32 | 64 | 128 | 256 | 512;
-type NativeForArc4Int<N extends BitSize> = N extends 8 | 16 | 32 | 64 ? uint64 : biguint;
-type CompatForArc4Int<N extends BitSize> = N extends 8 | 16 | 32 | 64 ? Uint64Compat : BigUintCompat;
-declare abstract class AbiEncoded implements BytesBacked {
+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;
+export type BitSize = UintBitSize | BigUintBitSize;
+type NativeForArc4Int<N extends BitSize> = N extends UintBitSize ? uint64 : biguint;
+type CompatForArc4Int<N extends BitSize> = N extends UintBitSize ? Uint64Compat : BigUintCompat;
+declare const TypeProperty: unique symbol;
+export declare abstract class ARC4Encoded implements BytesBacked {
+    abstract [TypeProperty]?: string;
     get bytes(): bytes;
 }
-export declare class Str extends AbiEncoded {
-    constructor(s: StringCompat);
+export declare class Str extends ARC4Encoded {
+    #private;
+    [TypeProperty]?: 'arc4.Str';
+    constructor(s?: StringCompat);
     get native(): string;
 }
-export declare class UintN<N extends BitSize> extends AbiEncoded {
+export declare class UintN<N extends BitSize> extends ARC4Encoded {
+    [TypeProperty]?: `arc4.UintN<${N}>`;
     constructor(v?: CompatForArc4Int<N>);
     get native(): NativeForArc4Int<N>;
 }
-export declare class UFixedNxM<N extends BitSize, M extends number> {
-    constructor(v: `${number}:${number}`, n?: N, m?: M);
-    get native(): NativeForArc4Int<N>;
-}
 export declare class Byte extends UintN<8> {
-    constructor(v: Uint64Compat);
-    get native(): uint64;
 }
-export declare class Bool {
-    #private;
-    constructor(v: boolean);
+export declare class UintN8 extends UintN<8> {
+}
+export declare class UintN16 extends UintN<16> {
+}
+export declare class UintN32 extends UintN<32> {
+}
+export declare class UintN64 extends UintN<64> {
+}
+export declare class UintN128 extends UintN<128> {
+}
+export declare class UintN256 extends UintN<256> {
+}
+export declare class UFixedNxM<N extends BitSize, M extends number> extends ARC4Encoded {
+    [TypeProperty]?: `arc4.UFixedNxM<${N}x${M}>`;
+    constructor(v: `${number}.${number}`);
+    get native(): NativeForArc4Int<N>;
+}
+export declare class Bool extends ARC4Encoded {
+    [TypeProperty]?: `arc4.Bool`;
+    constructor(v?: boolean);
     get native(): boolean;
 }
-declare abstract class Arc4Array<TItem> extends AbiEncoded {
-    protected items: TItem[];
-    protected constructor(items: TItem[]);
+declare abstract class Arc4ReadonlyArray<TItem extends ARC4Encoded> extends ARC4Encoded {
+    protected constructor();
+    /**
+     * 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;
-    slice(start: Uint64Compat, end: Uint64Compat): DynamicArray<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(): IterableIterator<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;
 }
-export declare class StaticArray<TItem, TLength extends number> extends Arc4Array<TItem> {
+export declare class StaticArray<TItem extends ARC4Encoded, TLength extends number> extends Arc4ReadonlyArray<TItem> {
+    [TypeProperty]?: `arc4.StaticArray<${TItem[typeof TypeProperty]}, ${TLength}>`;
     constructor();
     constructor(...items: TItem[] & {
         length: TLength;
@@ -45,21 +84,64 @@ export declare class StaticArray<TItem, TLength extends number> extends Arc4Arra
     constructor(...items: TItem[]);
     copy(): StaticArray<TItem, TLength>;
 }
-export declare class DynamicArray<TItem> extends Arc4Array<TItem> {
+export declare class DynamicArray<TItem extends ARC4Encoded> extends Arc4ReadonlyArray<TItem> {
+    [TypeProperty]?: `arc4.DynamicArray<${TItem[typeof TypeProperty]}>`;
     constructor(...items: TItem[]);
+    /**
+     * Push a number of items into this array
+     * @param items The items to be added to this array
+     */
     push(...items: TItem[]): void;
+    /**
+     * Pop a single item from this array
+     */
     pop(): TItem;
     copy(): DynamicArray<TItem>;
 }
-type ItemAt<TTuple extends unknown[], TIndex extends number> = undefined extends TTuple[TIndex] ? never : TTuple[TIndex];
-export declare class Tuple<TTuple extends unknown[]> {
-    #private;
+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>}` : '';
+export declare class Tuple<TTuple extends [ARC4Encoded, ...ARC4Encoded[]]> extends ARC4Encoded {
+    [TypeProperty]?: `arc4.Tuple<${ExpandTupleType<TTuple>}>`;
     constructor(...items: TTuple);
-    at<TIndex extends number>(index: TIndex): ItemAt<TTuple, TIndex>;
+    at<TIndex extends keyof TTuple>(index: TIndex): TTuple[TIndex];
+    get length(): TTuple['length'] & uint64;
     get native(): TTuple;
 }
-export declare class Address extends StaticArray<Byte, 32> {
-    constructor(value: Account | string | bytes);
+export declare class Address extends Arc4ReadonlyArray<Byte> {
+    [TypeProperty]?: `arc4.Address`;
+    constructor(value?: Account | string | bytes);
     get native(): Account;
 }
+type StructConstraint = Record<string, ARC4Encoded>;
+declare class StructBase extends ARC4Encoded {
+    [TypeProperty]: string;
+}
+type StructConstructor = new <T extends StructConstraint>(initial: T) => StructBase & T;
+export declare const Struct: StructConstructor;
+export declare class DynamicBytes extends Arc4ReadonlyArray<Byte> {
+    [TypeProperty]?: `arc4.DynamicBytes`;
+    constructor(value?: bytes | string);
+    get native(): bytes;
+}
+export declare class StaticBytes<TLength extends number = 0> extends Arc4ReadonlyArray<Byte> {
+    [TypeProperty]?: `arc4.StaticBytes<${TLength}>`;
+    constructor(value?: bytes | string);
+    get native(): bytes;
+}
+/**
+ * Interpret the provided bytes as an ARC4 encoded type with no validation
+ * @param bytes An arc4 encoded bytes value
+ * @param prefix The prefix (if any), present in the bytes value. This prefix will be validated and removed
+ */
+export declare function interpretAsArc4<T extends ARC4Encoded>(bytes: BytesCompat, prefix?: 'none' | 'log'): T;
+/**
+ * Decode the provided bytes to a native Algorand TypeScript value
+ * @param bytes An arc4 encoded bytes value
+ * @param prefix The prefix (if any), present in the bytes value. This prefix will be validated and removed
+ */
+export declare function decodeArc4<T>(bytes: BytesCompat, prefix?: 'none' | 'log'): T;
+/**
+ * Encode the provided Algorand TypeScript value as ARC4 bytes
+ * @param value Any native Algorand TypeScript value with a supported ARC4 encoding
+ */
+export declare function encodeArc4<T>(value: T): bytes;
 export {};

package/arc4/index.d.ts

@@ -1,4 +1,5 @@
 import { BaseContract } from '../base-contract';
+import { bytes } from '../primitives';
 import { DeliberateAny } from '../typescript-helpers';
 export * from './encoded-types';
 export declare class Contract extends BaseContract {
@@ -55,3 +56,10 @@ export type BareMethodConfig = {
     onCreate?: CreateOptions;
 };
 export declare function baremethod<TContract extends Contract>(config?: BareMethodConfig): <TArgs extends DeliberateAny[], TReturn>(target: (this: TContract, ...args: TArgs) => TReturn, ctx: ClassMethodDecoratorContext<TContract>) => (this: TContract, ...args: TArgs) => TReturn;
+/**
+ * Returns the ARC4 method selector for a given ARC4 method signature. The method selector is the first
+ * 4 bytes of the SHA512/256 hash of the method signature.
+ * @param methodSignature An ARC4 method signature. Eg. `hello(string)string`. Must be a compile time constant.
+ * @returns The ARC4 method selector. Eg. `02BECE11`
+ */
+export declare function methodSelector(methodSignature: string): bytes;

package/arc4/index.mjs

@@ -0,0 +1,5 @@
+export { d as ARC4Encoded, I as Address, F as Bool, u as Byte, h as Contract, H as DynamicArray, K as DynamicBytes, O as OnCompleteAction, G as StaticArray, L as StaticBytes, S as Str, J as Struct, T as Tuple, E as UFixedNxM, t as UintN, z as UintN128, w as UintN16, D as UintN256, x as UintN32, y as UintN64, v as UintN8, j as abimethod, r as baremethod, P as decodeArc4, Q as encodeArc4, M as interpretAsArc4, s as methodSelector } from '../index-BykxIQos.js';
+import '../op-Buke-Sl8.js';
+import 'node:buffer';
+import 'node:util';
+//# sourceMappingURL=index.mjs.map

package/arc4/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;"}

package/base-contract.d.ts

@@ -1,5 +1,71 @@
+import { Contract } from './arc4';
 import { uint64 } from './primitives';
+import { ConstructorFor } from './typescript-helpers';
 export declare abstract class BaseContract {
     abstract approvalProgram(): boolean | uint64;
     clearStateProgram(): boolean | uint64;
 }
+type NumberRange = {
+    from: number;
+    to: number;
+};
+/**
+ * Options class to manually define the total amount of global and local state contract will use.
+ *
+ * This is not required when all state is assigned to `this.`, but is required if a
+ * contract dynamically interacts with state via `AppGlobal.getBytes` etc, or if you want
+ * to reserve additional state storage for future contract updates, since the Algorand protocol
+ * doesn't allow increasing them after creation.
+ */
+type StateTotals = {
+    globalUints?: number;
+    globalBytes?: number;
+    localUints?: number;
+    localBytes?: number;
+};
+type ContractOptions = {
+    /**
+     * Determines which AVM version to use, this affects what operations are supported.
+     * Defaults to value provided supplied on command line (which defaults to current mainnet version)
+     */
+    avmVersion?: 10 | 11;
+    /**
+     * Override the name of the logic signature when generating build artifacts.
+     * Defaults to the class name
+     */
+    name?: string;
+    /**
+     * Allows you to mark a slot ID or range of slot IDs as "off limits" to Puya.
+     * These slot ID(s) will never be written to or otherwise manipulating by the compiler itself.
+     * This is particularly useful in combination with `op.gload_bytes` / `op.gload_uint64`
+     * which lets a contract in a group transaction read from the scratch slots of another contract
+     * that occurs earlier in the transaction group.
+     *
+     * In the case of inheritance, scratch slots reserved become cumulative. It is not an error
+     * to have overlapping ranges or values either, so if a base class contract reserves slots
+     * 0-5 inclusive and the derived contract reserves 5-10 inclusive, then within the derived
+     * contract all slots 0-10 will be marked as reserved.
+     */
+    scratchSlots?: Array<number | NumberRange>;
+    /**
+     * Allows defining what values should be used for global and local uint and bytes storage
+     * values when creating a contract. Used when outputting ARC-32 application.json schemas.
+     *
+     * If left unspecified, the totals will be determined by the compiler based on state
+     * variables assigned to `this`.
+     *
+     * This setting is not inherited, and only applies to the exact `Contract` it is specified
+     * on. If a base class does specify this setting, and a derived class does not, a warning
+     * will be emitted for the derived class. To resolve this warning, `stateTotals` must be
+     * specified. An empty object may be provided in order to indicate that this contract should
+     * revert to the default behaviour
+     */
+    stateTotals?: StateTotals;
+};
+/**
+ * The contract decorator can be used to specify additional configuration options for a smart contract
+ * @param options An object containing the configuration options
+ */
+export declare const ContractOptionsSymbol: unique symbol;
+export declare function contract(options: ContractOptions): <T extends ConstructorFor<Contract>>(contract: T, ctx: ClassDecoratorContext) => T;
+export {};

package/box.d.ts

@@ -29,8 +29,8 @@ export type BoxRef = {
     get(options: {
         default: bytes;
     }): bytes;
-    put(value: bytes): bytes;
-    splice(start: uint64, end: uint64, value: bytes): void;
+    put(value: bytes): void;
+    splice(start: uint64, length: uint64, value: bytes): void;
     replace(start: uint64, value: bytes): void;
     extract(start: uint64, length: uint64): bytes;
     delete(): boolean;

package/compiled.d.ts

@@ -0,0 +1,108 @@
+import { BaseContract } from './base-contract';
+import { LogicSig } from './logic-sig';
+import { bytes, uint64 } from './primitives';
+import { Account } from './reference';
+import { ConstructorFor, DeliberateAny } from './typescript-helpers';
+/**
+ * Provides compiled programs and state allocation values for a Contract. Created by calling `compile(ExampleContractType)`
+ */
+export type CompiledContract = {
+    /**
+     * Approval program pages for a contract, after template variables have been replaced and compiled to AVM bytecode
+     */
+    approvalProgram: [bytes, bytes];
+    /**
+     * Clear state program pages for a contract, after template variables have been replaced and compiled to AVM bytecode
+     */
+    clearStateProgram: [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;
+    /**
+     * By default, provides global num uints based on contract state totals, can be overridden when calling `compile(ExampleContractType, { globalUints: ... })`
+     */
+    globalUints: uint64;
+    /**
+     * By default, provides global num bytes based on contract state totals, can be overridden when calling `compile(ExampleContractType, { globalBytes: ... })`
+     */
+    globalBytes: uint64;
+    /**
+     * By default, provides local num uints based on contract state totals, can be overridden when calling `compile(ExampleContractType, { localUints: ... })`
+     */
+    localUints: uint64;
+    /**
+     * By default, provides local num bytes based on contract state totals, can be overridden  when calling `compile(ExampleContractType, { localBytes: ... })`
+     */
+    localBytes: uint64;
+};
+/**
+ * Provides account for a Logic Signature. Created by calling `compile(LogicSigType)`
+ */
+export type CompiledLogicSig = {
+    /**
+     * Address of a logic sig program, after template variables have been replaced and compiled to AVM bytecode
+     */
+    account: Account;
+};
+/**
+ * Options for compiling a contract
+ */
+type CompileContractOptions = {
+    /**
+     * Number of extra program pages, defaults to minimum required for contract
+     */
+    extraProgramPages?: uint64;
+    /**
+     * Number of global uint64s, defaults to value defined for contract
+     */
+    globalUints?: uint64;
+    /**
+     * Number of global bytes, defaults to value defined for contract
+     */
+    globalBytes?: uint64;
+    /**
+     * Number of local uint64s, defaults to value defined for contract
+     */
+    localUints?: uint64;
+    /**
+     * Number of local bytes, defaults to value defined for contract
+     */
+    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>;
+    /**
+     * Prefix to add to provided template vars, defaults to the prefix supplied on command line (which defaults to TMPL_)
+     */
+    templateVarsPrefix?: string;
+};
+/**
+ * Options for compiling a logic signature
+ */
+type CompileLogicSigOptions = {
+    /**
+     * 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>;
+    /**
+     * Prefix to add to provided template vars, defaults to the prefix supplied on command line (which defaults to TMPL_)
+     */
+    templateVarsPrefix?: string;
+};
+/**
+ * Compile a contract and return the resulting byte code for approval and clear state programs.
+ * @param contract The contract class to compile
+ * @param options Options for compiling the contract
+ */
+export declare function compile(contract: ConstructorFor<BaseContract>, options?: CompileContractOptions): CompiledContract;
+/**
+ * Compile a logic signature and return an account ready for signing transactions.
+ * @param logicSig The logic sig class to compile
+ * @param options Options for compiling the logic sig
+ */
+export declare function compile(logicSig: ConstructorFor<LogicSig>, options?: CompileLogicSigOptions): CompiledLogicSig;
+export {};

package/execution-context.d.ts

@@ -1,4 +1,4 @@
-import { Contract, gtxn, itxn } from '.';
+import { Box, BoxMap, BoxRef, Contract, GlobalState, gtxn, itxn, LocalState } from '.';
 import { AbiMethodConfig, BareMethodConfig } from './arc4';
 import { OpsNamespace } from './op-types';
 import { bytes, uint64 } from './primitives';
@@ -30,6 +30,13 @@ export type ExecutionContext = {
         assetFreeze: typeof itxn.assetFreeze;
         applicationCall: typeof itxn.applicationCall;
     };
+    state: {
+        GlobalState: typeof GlobalState;
+        LocalState: typeof LocalState;
+        Box: typeof Box;
+        BoxMap: typeof BoxMap;
+        BoxRef: typeof BoxRef;
+    };
 };
 declare global {
     var puyaTsExecutionContext: ExecutionContext | undefined;

package/impl/errors.d.ts

@@ -27,3 +27,10 @@ export declare class CodeError extends Error {
     constructor(message: string, options?: ErrorOptions);
 }
 export declare function codeError(message: string): never;
+/**
+ * This error can be used in stub implementations that are expected to be overridden
+ * by the testing framework
+ */
+export declare class NoImplementation extends Error {
+    constructor();
+}

package/impl/primitives.d.ts

@@ -6,13 +6,13 @@ export declare function toExternalValue(val: uint64): bigint;
 export declare function toExternalValue(val: biguint): bigint;
 export declare function toExternalValue(val: bytes): Uint8Array;
 export declare function toExternalValue(val: string): string;
-export declare const toBytes: (val: unknown) => bytes;
 /**
  * Convert a StubUint64Compat value into a 'number' if possible.
  * This value may be negative
  * @param v
  */
 export declare const getNumber: (v: StubUint64Compat) => number;
+export declare const getUint8Array: (v: StubBytesCompat) => Uint8Array;
 export declare const isBytes: (v: unknown) => v is StubBytesCompat;
 export declare const isUint64: (v: unknown) => v is StubUint64Compat;
 export declare const checkUint64: (v: bigint) => bigint;
@@ -51,7 +51,7 @@ export declare class BytesCls extends AlgoTsPrimitiveCls {
     get length(): Uint64Cls;
     toBytes(): BytesCls;
     at(i: StubUint64Compat): BytesCls;
-    slice(start: undefined | StubUint64Compat, end: undefined | StubUint64Compat): BytesCls;
+    slice(start?: StubUint64Compat, end?: StubUint64Compat): BytesCls;
     concat(other: StubBytesCompat): BytesCls;
     bitwiseAnd(other: StubBytesCompat): BytesCls;
     bitwiseOr(other: StubBytesCompat): BytesCls;
@@ -78,5 +78,5 @@ export declare const arrayUtil: {
     arrayAt<T>(arrayLike: T[] | Uint8Array, index: StubUint64Compat): T | Uint8Array;
     arraySlice(arrayLike: Uint8Array, start: undefined | StubUint64Compat, end: undefined | StubUint64Compat): Uint8Array;
     arraySlice<T>(arrayLike: T[], start: undefined | StubUint64Compat, end: undefined | StubUint64Compat): T[];
-    arraySlice<T>(arrayLike: Uint8Array | T[], start: undefined | StubUint64Compat, end: undefined | StubUint64Compat): Uint8Array | T[];
+    arraySlice<T>(arrayLike: Uint8Array<ArrayBufferLike> | T[], start: undefined | StubUint64Compat, end: undefined | StubUint64Compat): Uint8Array<ArrayBufferLike> | T[];
 };