algosdk 3.5.2 → 3.7.0-beta.1

package/dist/types/client/v2/algod/models/types.d.ts

@@ -238,6 +238,60 @@ export declare class Account implements Encodable {
     toEncodingData(): Map<string, unknown>;
     static fromEncodingData(data: unknown): Account;
 }
+/**
+ * AccountApplicationResource describes the account's application resource (local
+ * state and params if the account is the creator) for a specific application ID.
+ */
+export declare class AccountApplicationResource implements Encodable {
+    private static encodingSchemaValue;
+    static get encodingSchema(): Schema;
+    /**
+     * The application ID.
+     */
+    id: number;
+    /**
+     * (appl) the application local data stored in this account.
+     * The raw account uses `AppLocalState` for this type.
+     */
+    appLocalState?: ApplicationLocalState;
+    /**
+     * Round when the account opted into or created the application.
+     */
+    createdAtRound?: number;
+    /**
+     * Whether the application has been deleted.
+     */
+    deleted?: boolean;
+    /**
+     * (appp) parameters of the application created by this account including app
+     * global data.
+     * The raw account uses `AppParams` for this type.
+     * Only present if the account is the creator and `include=params` is specified.
+     */
+    params?: ApplicationParams;
+    /**
+     * Creates a new `AccountApplicationResource` object.
+     * @param id - The application ID.
+     * @param appLocalState - (appl) the application local data stored in this account.
+     * The raw account uses `AppLocalState` for this type.
+     * @param createdAtRound - Round when the account opted into or created the application.
+     * @param deleted - Whether the application has been deleted.
+     * @param params - (appp) parameters of the application created by this account including app
+     * global data.
+     * The raw account uses `AppParams` for this type.
+     * Only present if the account is the creator and `include=params` is specified.
+     */
+    constructor({ id, appLocalState, createdAtRound, deleted, params, }: {
+        id: number | bigint;
+        appLocalState?: ApplicationLocalState;
+        createdAtRound?: number | bigint;
+        deleted?: boolean;
+        params?: ApplicationParams;
+    });
+    getEncodingSchema(): Schema;
+    toEncodingData(): Map<string, unknown>;
+    static fromEncodingData(data: unknown): AccountApplicationResource;
+}
 /**
  * AccountApplicationResponse describes the account's application local state and
  * global state (AppLocalState and AppParams, if either exists) for a specific
@@ -280,6 +334,41 @@ export declare class AccountApplicationResponse implements Encodable {
     toEncodingData(): Map<string, unknown>;
     static fromEncodingData(data: unknown): AccountApplicationResponse;
 }
+/**
+ * AccountApplicationsInformationResponse contains a list of application resources
+ * for an account.
+ */
+export declare class AccountApplicationsInformationResponse implements Encodable {
+    private static encodingSchemaValue;
+    static get encodingSchema(): Schema;
+    /**
+     * The round for which this information is relevant.
+     */
+    round: number;
+    applicationResources?: AccountApplicationResource[];
+    /**
+     * Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the next application ID to use as the
+     * pagination cursor.
+     */
+    nextToken?: string;
+    /**
+     * Creates a new `AccountApplicationsInformationResponse` object.
+     * @param round - The round for which this information is relevant.
+     * @param applicationResources -
+     * @param nextToken - Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the next application ID to use as the
+     * pagination cursor.
+     */
+    constructor({ round, applicationResources, nextToken, }: {
+        round: number | bigint;
+        applicationResources?: AccountApplicationResource[];
+        nextToken?: string;
+    });
+    getEncodingSchema(): Schema;
+    toEncodingData(): Map<string, unknown>;
+    static fromEncodingData(data: unknown): AccountApplicationsInformationResponse;
+}
 /**
  * AccountAssetHolding describes the account's asset holding and asset parameters
  * (if either exist) for a specific asset ID.
@@ -508,7 +597,7 @@ export declare class Application implements Encodable {
     /**
      * (appparams) application parameters.
      */
-    params: ApplicationParams;
+    params?: ApplicationParams;
     /**
      * Creates a new `Application` object.
      * @param id - (appidx) application index.
@@ -516,7 +605,7 @@ export declare class Application implements Encodable {
      */
     constructor({ id, params, }: {
         id: number | bigint;
-        params: ApplicationParams;
+        params?: ApplicationParams;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -684,6 +773,10 @@ export declare class ApplicationParams implements Encodable {
      * (lsch) local schema
      */
     localStateSchema?: ApplicationStateSchema;
+    /**
+     * (ss) the account responsible for extra pages and global state MBR
+     */
+    sizeSponsor?: Address;
     /**
      * (v) the number of updates to the application programs
      */
@@ -698,9 +791,10 @@ export declare class ApplicationParams implements Encodable {
      * @param globalState - (gs) global state
      * @param globalStateSchema - (gsch) global schema
      * @param localStateSchema - (lsch) local schema
+     * @param sizeSponsor - (ss) the account responsible for extra pages and global state MBR
      * @param version - (v) the number of updates to the application programs
      */
-    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, version, }: {
+    constructor({ approvalProgram, clearStateProgram, creator, extraProgramPages, globalState, globalStateSchema, localStateSchema, sizeSponsor, version, }: {
         approvalProgram: string | Uint8Array;
         clearStateProgram: string | Uint8Array;
         creator: Address | string;
@@ -708,6 +802,7 @@ export declare class ApplicationParams implements Encodable {
         globalState?: TealKeyValue[];
         globalStateSchema?: ApplicationStateSchema;
         localStateSchema?: ApplicationStateSchema;
+        sizeSponsor?: Address | string;
         version?: number | bigint;
     });
     getEncodingSchema(): Schema;
@@ -806,7 +901,7 @@ export declare class Asset implements Encodable {
      * Definition:
      * data/transactions/asset.go : AssetParams
      */
-    params: AssetParams;
+    params?: AssetParams;
     /**
      * Creates a new `Asset` object.
      * @param index - unique asset identifier
@@ -817,7 +912,7 @@ export declare class Asset implements Encodable {
      */
     constructor({ index, params, }: {
         index: number | bigint;
-        params: AssetParams;
+        params?: AssetParams;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -1210,12 +1305,20 @@ export declare class BoxDescriptor implements Encodable {
      * Base64 encoded box name
      */
     name: Uint8Array;
+    /**
+     * Base64 encoded box value. Present only when the `values` query parameter is set
+     * to true.
+     */
+    value?: Uint8Array;
     /**
      * Creates a new `BoxDescriptor` object.
      * @param name - Base64 encoded box name
+     * @param value - Base64 encoded box value. Present only when the `values` query parameter is set
+     * to true.
      */
-    constructor({ name }: {
+    constructor({ name, value, }: {
         name: string | Uint8Array;
+        value?: string | Uint8Array;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -1249,18 +1352,34 @@ export declare class BoxReference implements Encodable {
     static fromEncodingData(data: unknown): BoxReference;
 }
 /**
- * Box names of an application
+ * Boxes of an application
  */
 export declare class BoxesResponse implements Encodable {
     private static encodingSchemaValue;
     static get encodingSchema(): Schema;
     boxes: BoxDescriptor[];
+    /**
+     * Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the box name to use as the pagination cursor,
+     * encoded in the goal app call arg form.
+     */
+    nextToken?: string;
+    /**
+     * The round for which this information is relevant.
+     */
+    round?: number;
     /**
      * Creates a new `BoxesResponse` object.
      * @param boxes -
+     * @param nextToken - Used for pagination, when making another request provide this token with the
+     * next parameter. The next token is the box name to use as the pagination cursor,
+     * encoded in the goal app call arg form.
+     * @param round - The round for which this information is relevant.
      */
-    constructor({ boxes }: {
+    constructor({ boxes, nextToken, round, }: {
         boxes: BoxDescriptor[];
+        nextToken?: string;
+        round?: number | bigint;
     });
     getEncodingSchema(): Schema;
     toEncodingData(): Map<string, unknown>;
@@ -1350,223 +1469,6 @@ export declare class DisassembleResponse implements Encodable {
     toEncodingData(): Map<string, unknown>;
     static fromEncodingData(data: unknown): DisassembleResponse;
 }
-/**
- * Request data type for dryrun endpoint. Given the Transactions and simulated
- * ledger state upload, run TEAL scripts and return debugging information.
- */
-export declare class DryrunRequest implements Encodable {
-    private static encodingSchemaValue;
-    static get encodingSchema(): Schema;
-    accounts: Account[];
-    apps: Application[];
-    /**
-     * LatestTimestamp is available to some TEAL scripts. Defaults to the latest
-     * confirmed timestamp this algod is attached to.
-     */
-    latestTimestamp: number;
-    /**
-     * ProtocolVersion specifies a specific version string to operate under, otherwise
-     * whatever the current protocol of the network this algod is running in.
-     */
-    protocolVersion: string;
-    /**
-     * Round is available to some TEAL scripts. Defaults to the current round on the
-     * network this algod is attached to.
-     */
-    round: bigint;
-    sources: DryrunSource[];
-    txns: SignedTransaction[];
-    /**
-     * Creates a new `DryrunRequest` object.
-     * @param accounts -
-     * @param apps -
-     * @param latestTimestamp - LatestTimestamp is available to some TEAL scripts. Defaults to the latest
-     * confirmed timestamp this algod is attached to.
-     * @param protocolVersion - ProtocolVersion specifies a specific version string to operate under, otherwise
-     * whatever the current protocol of the network this algod is running in.
-     * @param round - Round is available to some TEAL scripts. Defaults to the current round on the
-     * network this algod is attached to.
-     * @param sources -
-     * @param txns -
-     */
-    constructor({ accounts, apps, latestTimestamp, protocolVersion, round, sources, txns, }: {
-        accounts: Account[];
-        apps: Application[];
-        latestTimestamp: number | bigint;
-        protocolVersion: string;
-        round: number | bigint;
-        sources: DryrunSource[];
-        txns: SignedTransaction[];
-    });
-    getEncodingSchema(): Schema;
-    toEncodingData(): Map<string, unknown>;
-    static fromEncodingData(data: unknown): DryrunRequest;
-}
-/**
- * DryrunResponse contains per-txn debug information from a dryrun.
- */
-export declare class DryrunResponse implements Encodable {
-    private static encodingSchemaValue;
-    static get encodingSchema(): Schema;
-    error: string;
-    /**
-     * Protocol version is the protocol version Dryrun was operated under.
-     */
-    protocolVersion: string;
-    txns: DryrunTxnResult[];
-    /**
-     * Creates a new `DryrunResponse` object.
-     * @param error -
-     * @param protocolVersion - Protocol version is the protocol version Dryrun was operated under.
-     * @param txns -
-     */
-    constructor({ error, protocolVersion, txns, }: {
-        error: string;
-        protocolVersion: string;
-        txns: DryrunTxnResult[];
-    });
-    getEncodingSchema(): Schema;
-    toEncodingData(): Map<string, unknown>;
-    static fromEncodingData(data: unknown): DryrunResponse;
-}
-/**
- * DryrunSource is TEAL source text that gets uploaded, compiled, and inserted into
- * transactions or application state.
- */
-export declare class DryrunSource implements Encodable {
-    private static encodingSchemaValue;
-    static get encodingSchema(): Schema;
-    appIndex: bigint;
-    /**
-     * FieldName is what kind of sources this is. If lsig then it goes into the
-     * transactions[this.TxnIndex].LogicSig. If approv or clearp it goes into the
-     * Approval Program or Clear State Program of application[this.AppIndex].
-     */
-    fieldName: string;
-    source: string;
-    txnIndex: number;
-    /**
-     * Creates a new `DryrunSource` object.
-     * @param appIndex -
-     * @param fieldName - FieldName is what kind of sources this is. If lsig then it goes into the
-     * transactions[this.TxnIndex].LogicSig. If approv or clearp it goes into the
-     * Approval Program or Clear State Program of application[this.AppIndex].
-     * @param source -
-     * @param txnIndex -
-     */
-    constructor({ appIndex, fieldName, source, txnIndex, }: {
-        appIndex: number | bigint;
-        fieldName: string;
-        source: string;
-        txnIndex: number | bigint;
-    });
-    getEncodingSchema(): Schema;
-    toEncodingData(): Map<string, unknown>;
-    static fromEncodingData(data: unknown): DryrunSource;
-}
-/**
- * Stores the TEAL eval step data
- */
-export declare class DryrunState implements Encodable {
-    private static encodingSchemaValue;
-    static get encodingSchema(): Schema;
-    /**
-     * Line number
-     */
-    line: number;
-    /**
-     * Program counter
-     */
-    pc: number;
-    stack: TealValue[];
-    /**
-     * Evaluation error if any
-     */
-    error?: string;
-    scratch?: TealValue[];
-    /**
-     * Creates a new `DryrunState` object.
-     * @param line - Line number
-     * @param pc - Program counter
-     * @param stack -
-     * @param error - Evaluation error if any
-     * @param scratch -
-     */
-    constructor({ line, pc, stack, error, scratch, }: {
-        line: number | bigint;
-        pc: number | bigint;
-        stack: TealValue[];
-        error?: string;
-        scratch?: TealValue[];
-    });
-    getEncodingSchema(): Schema;
-    toEncodingData(): Map<string, unknown>;
-    static fromEncodingData(data: unknown): DryrunState;
-}
-/**
- * DryrunTxnResult contains any LogicSig or ApplicationCall program debug
- * information and state updates from a dryrun.
- */
-export declare class DryrunTxnResult implements Encodable {
-    private static encodingSchemaValue;
-    static get encodingSchema(): Schema;
-    /**
-     * Disassembled program line by line.
-     */
-    disassembly: string[];
-    appCallMessages?: string[];
-    appCallTrace?: DryrunState[];
-    /**
-     * Budget added during execution of app call transaction.
-     */
-    budgetAdded?: number;
-    /**
-     * Budget consumed during execution of app call transaction.
-     */
-    budgetConsumed?: number;
-    /**
-     * Application state delta.
-     */
-    globalDelta?: EvalDeltaKeyValue[];
-    localDeltas?: AccountStateDelta[];
-    /**
-     * Disassembled lsig program line by line.
-     */
-    logicSigDisassembly?: string[];
-    logicSigMessages?: string[];
-    logicSigTrace?: DryrunState[];
-    logs?: Uint8Array[];
-    /**
-     * Creates a new `DryrunTxnResult` object.
-     * @param disassembly - Disassembled program line by line.
-     * @param appCallMessages -
-     * @param appCallTrace -
-     * @param budgetAdded - Budget added during execution of app call transaction.
-     * @param budgetConsumed - Budget consumed during execution of app call transaction.
-     * @param globalDelta - Application state delta.
-     * @param localDeltas -
-     * @param logicSigDisassembly - Disassembled lsig program line by line.
-     * @param logicSigMessages -
-     * @param logicSigTrace -
-     * @param logs -
-     */
-    constructor({ disassembly, appCallMessages, appCallTrace, budgetAdded, budgetConsumed, globalDelta, localDeltas, logicSigDisassembly, logicSigMessages, logicSigTrace, logs, }: {
-        disassembly: string[];
-        appCallMessages?: string[];
-        appCallTrace?: DryrunState[];
-        budgetAdded?: number | bigint;
-        budgetConsumed?: number | bigint;
-        globalDelta?: EvalDeltaKeyValue[];
-        localDeltas?: AccountStateDelta[];
-        logicSigDisassembly?: string[];
-        logicSigMessages?: string[];
-        logicSigTrace?: DryrunState[];
-        logs?: Uint8Array[];
-    });
-    getEncodingSchema(): Schema;
-    toEncodingData(): Map<string, unknown>;
-    static fromEncodingData(data: unknown): DryrunTxnResult;
-}
 /**
  * An error response with optional data field.
  */
@@ -2897,9 +2799,16 @@ export declare class SupplyResponse implements Encodable {
      */
     currentRound: bigint;
     /**
-     * OnlineMoney
+     * Total stake held by accounts with status Online at current_round, including
+     * those whose participation keys have expired but have not yet been marked
+     * offline.
      */
     onlineMoney: bigint;
+    /**
+     * Online stake used by agreement to vote for current_round, excluding accounts
+     * whose participation keys have expired.
+     */
+    onlineStake: bigint;
     /**
      * TotalMoney
      */
@@ -2907,12 +2816,17 @@ export declare class SupplyResponse implements Encodable {
     /**
      * Creates a new `SupplyResponse` object.
      * @param currentRound - Round
-     * @param onlineMoney - OnlineMoney
+     * @param onlineMoney - Total stake held by accounts with status Online at current_round, including
+     * those whose participation keys have expired but have not yet been marked
+     * offline.
+     * @param onlineStake - Online stake used by agreement to vote for current_round, excluding accounts
+     * whose participation keys have expired.
      * @param totalMoney - TotalMoney
      */
-    constructor({ currentRound, onlineMoney, totalMoney, }: {
+    constructor({ currentRound, onlineMoney, onlineStake, totalMoney, }: {
         currentRound: number | bigint;
         onlineMoney: number | bigint;
+        onlineStake: number | bigint;
         totalMoney: number | bigint;
     });
     getEncodingSchema(): Schema;
@@ -3027,8 +2941,8 @@ export declare class TransactionParametersResponse implements Encodable {
      */
     lastRound: bigint;
     /**
-     * The minimum transaction fee (not per byte) required for the
-     * txn to validate for the current network protocol.
+     * The minimum transaction fee (not per byte) required for the txn to validate for
+     * the current network protocol.
      */
     minFee: bigint;
     /**
@@ -3042,8 +2956,8 @@ export declare class TransactionParametersResponse implements Encodable {
      * @param genesisHash - GenesisHash is the hash of the genesis block.
      * @param genesisId - GenesisID is an ID listed in the genesis block.
      * @param lastRound - LastRound indicates the last round seen
-     * @param minFee - The minimum transaction fee (not per byte) required for the
-     * txn to validate for the current network protocol.
+     * @param minFee - The minimum transaction fee (not per byte) required for the txn to validate for
+     * the current network protocol.
      */
     constructor({ consensusVersion, fee, genesisHash, genesisId, lastRound, minFee, }: {
         consensusVersion: string;

package/dist/types/ed25519-signer.d.ts

@@ -0,0 +1,7 @@
+import { Address } from './encoding/address.js';
+import { AddressWithDelegatedLsigSigner, AddressWithMxBytesSigner, AddressWithProgramDataSigner, AddressWithTransactionSigner } from './signer.js';
+export interface Ed25519SigningKey {
+    ed25519PublicKey: Uint8Array;
+    ed25519Signer: (bytesToSign: Uint8Array) => Promise<Uint8Array>;
+}
+export declare function addressWithSignersFromRawEd25519Signer(ed25519SigningKey: Ed25519SigningKey, sendingAddress?: Address): AddressWithTransactionSigner & AddressWithDelegatedLsigSigner & AddressWithMxBytesSigner & AddressWithProgramDataSigner;

package/dist/types/encoding/address.d.ts

@@ -1,9 +1,19 @@
+import type { EncodedPQSig } from '../types/transactions/encoded.js';
 export declare const ALGORAND_ADDRESS_BYTE_LENGTH = 36;
 export declare const ALGORAND_CHECKSUM_BYTE_LENGTH = 4;
 export declare const ALGORAND_ADDRESS_LENGTH = 58;
 export declare const ALGORAND_ZERO_ADDRESS_STRING = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ";
 export declare const MALFORMED_ADDRESS_ERROR_MSG = "address seems to be malformed";
 export declare const CHECKSUM_ADDRESS_ERROR_MSG = "wrong checksum for address";
+/**
+ * The required byte length of a post-quantum signature scheme identifier.
+ */
+export declare const PQ_SCHEME_SIZE = 2;
+/**
+ * The largest value a post-quantum address salt may take. The salt occupies a
+ * single byte of the address preimage.
+ */
+export declare const PQ_SALT_MAX = 255;
 /**
  * Represents an Algorand address
  */
@@ -64,3 +74,30 @@ export declare function encodeAddress(address: Uint8Array): string;
  * @returns The address corresponding to that application's escrow account.
  */
 export declare function getApplicationAddress(appID: number | bigint): Address;
+/**
+ * Derive a post-quantum (PQ) account address together with the canonical salt
+ * used to derive it.
+ *
+ * @param schemeBytes - The 2-byte ASCII PQ scheme identifier (e.g. "f1" for Falcon-1024).
+ * @param key - The scheme's canonical public key.
+ * @returns The derived Address and the canonical 1-byte salt.
+ */
+export declare function addressFromPQKey(schemeBytes: Uint8Array, key: Uint8Array): {
+    address: Address;
+    salt: number;
+};
+/**
+ * Derive the account address that a post-quantum signature authorizes.
+ *
+ * Unlike an Ed25519 signature, a PQ signature carries the scheme, salt and
+ * public key of the signing account, so the address it authorizes is fully
+ * determined by the signature and does not have to be supplied out of band.
+ *
+ * This also validates the signature's self-consistency: the salt must be the
+ * canonical one for the given scheme and public key, which is what the network
+ * requires.
+ *
+ * @param pqsig - The post-quantum signature to derive the address from.
+ * @returns The address of the account the signature authorizes.
+ */
+export declare function addressFromPQSig(pqsig: EncodedPQSig): Address;

package/dist/types/falcon-signer.d.ts

@@ -0,0 +1,11 @@
+import { Address } from './encoding/address.js';
+import { AddressWithDelegatedLsigSigner, AddressWithTransactionSigner } from './signer.js';
+/**
+ * The 2-byte ASCII identifier of the Falcon-1024 post-quantum signature scheme.
+ */
+export declare const FALCON_1024_SCHEME: Uint8Array;
+export interface Falcon1024SigningKey {
+    falcon1024PublicKey: Uint8Array;
+    falcon1024Signer: (bytesToSign: Uint8Array) => Promise<Uint8Array>;
+}
+export declare function addressWithSignersFromRawFalcon1024Signer(falconSigningKey: Falcon1024SigningKey, sendingAddress?: Address): AddressWithTransactionSigner & AddressWithDelegatedLsigSigner;