algosdk 1.24.1 → 2.1.0

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

@@ -240,7 +240,11 @@ export declare class AccountApplicationResponse extends BaseModel {
      * global data.
      * The raw account uses `AppParams` for this type.
      */
-    constructor(round: number | bigint, appLocalState?: ApplicationLocalState, createdApp?: ApplicationParams);
+    constructor({ round, appLocalState, createdApp, }: {
+        round: number | bigint;
+        appLocalState?: ApplicationLocalState;
+        createdApp?: ApplicationParams;
+    });
     static from_obj_for_encoding(data: Record<string, any>): AccountApplicationResponse;
 }
 /**
@@ -271,7 +275,11 @@ export declare class AccountAssetResponse extends BaseModel {
      * @param createdAsset - (apar) parameters of the asset created by this account.
      * The raw account uses `AssetParams` for this type.
      */
-    constructor(round: number | bigint, assetHolding?: AssetHolding, createdAsset?: AssetParams);
+    constructor({ round, assetHolding, createdAsset, }: {
+        round: number | bigint;
+        assetHolding?: AssetHolding;
+        createdAsset?: AssetParams;
+    });
     static from_obj_for_encoding(data: Record<string, any>): AccountAssetResponse;
 }
 /**
@@ -338,7 +346,10 @@ export declare class AccountStateDelta extends BaseModel {
      * @param address -
      * @param delta - Application state delta.
      */
-    constructor(address: string, delta: EvalDeltaKeyValue[]);
+    constructor({ address, delta, }: {
+        address: string;
+        delta: EvalDeltaKeyValue[];
+    });
     static from_obj_for_encoding(data: Record<string, any>): AccountStateDelta;
 }
 /**
@@ -358,7 +369,10 @@ export declare class Application extends BaseModel {
      * @param id - (appidx) application index.
      * @param params - (appparams) application parameters.
      */
-    constructor(id: number | bigint, params: ApplicationParams);
+    constructor({ id, params, }: {
+        id: number | bigint;
+        params: ApplicationParams;
+    });
     static from_obj_for_encoding(data: Record<string, any>): Application;
 }
 /**
@@ -383,7 +397,11 @@ export declare class ApplicationLocalState extends BaseModel {
      * @param schema - (hsch) schema.
      * @param keyValue - (tkv) storage.
      */
-    constructor(id: number | bigint, schema: ApplicationStateSchema, keyValue?: TealKeyValue[]);
+    constructor({ id, schema, keyValue, }: {
+        id: number | bigint;
+        schema: ApplicationStateSchema;
+        keyValue?: TealKeyValue[];
+    });
     static from_obj_for_encoding(data: Record<string, any>): ApplicationLocalState;
 }
 /**
@@ -458,7 +476,10 @@ export declare class ApplicationStateSchema extends BaseModel {
      * @param numUint - (nui) num of uints.
      * @param numByteSlice - (nbs) num of byte slices.
      */
-    constructor(numUint: number | bigint, numByteSlice: number | bigint);
+    constructor({ numUint, numByteSlice, }: {
+        numUint: number | bigint;
+        numByteSlice: number | bigint;
+    });
     static from_obj_for_encoding(data: Record<string, any>): ApplicationStateSchema;
 }
 /**
@@ -484,7 +505,10 @@ export declare class Asset extends BaseModel {
      * Definition:
      * data/transactions/asset.go : AssetParams
      */
-    constructor(index: number | bigint, params: AssetParams);
+    constructor({ index, params, }: {
+        index: number | bigint;
+        params: AssetParams;
+    });
     static from_obj_for_encoding(data: Record<string, any>): Asset;
 }
 /**
@@ -511,7 +535,11 @@ export declare class AssetHolding extends BaseModel {
      * @param assetId - Asset ID of the holding.
      * @param isFrozen - (f) whether or not the holding is frozen.
      */
-    constructor(amount: number | bigint, assetId: number | bigint, isFrozen: boolean);
+    constructor({ amount, assetId, isFrozen, }: {
+        amount: number | bigint;
+        assetId: number | bigint;
+        isFrozen: boolean;
+    });
     static from_obj_for_encoding(data: Record<string, any>): AssetHolding;
 }
 /**
@@ -652,7 +680,9 @@ export declare class BlockHashResponse extends BaseModel {
      * Creates a new `BlockHashResponse` object.
      * @param blockhash - Block header hash.
      */
-    constructor(blockhash: string);
+    constructor({ blockhash }: {
+        blockhash: string;
+    });
     static from_obj_for_encoding(data: Record<string, any>): BlockHashResponse;
 }
 /**
@@ -674,7 +704,10 @@ export declare class BlockResponse extends BaseModel {
      * @param cert - Optional certificate object. This is only included when the format is set to
      * message pack.
      */
-    constructor(block: BlockHeader, cert?: Record<string, any>);
+    constructor({ block, cert, }: {
+        block: BlockHeader;
+        cert?: Record<string, any>;
+    });
     static from_obj_for_encoding(data: Record<string, any>): BlockResponse;
 }
 /**
@@ -694,7 +727,10 @@ export declare class Box extends BaseModel {
      * @param name - (name) box name, base64 encoded
      * @param value - (value) box value, base64 encoded.
      */
-    constructor(name: string | Uint8Array, value: string | Uint8Array);
+    constructor({ name, value, }: {
+        name: string | Uint8Array;
+        value: string | Uint8Array;
+    });
     static from_obj_for_encoding(data: Record<string, any>): Box;
 }
 /**
@@ -709,7 +745,9 @@ export declare class BoxDescriptor extends BaseModel {
      * Creates a new `BoxDescriptor` object.
      * @param name - Base64 encoded box name
      */
-    constructor(name: string | Uint8Array);
+    constructor({ name }: {
+        name: string | Uint8Array;
+    });
     static from_obj_for_encoding(data: Record<string, any>): BoxDescriptor;
 }
 /**
@@ -721,7 +759,9 @@ export declare class BoxesResponse extends BaseModel {
      * Creates a new `BoxesResponse` object.
      * @param boxes -
      */
-    constructor(boxes: BoxDescriptor[]);
+    constructor({ boxes }: {
+        boxes: BoxDescriptor[];
+    });
     static from_obj_for_encoding(data: Record<string, any>): BoxesResponse;
 }
 export declare class BuildVersion extends BaseModel {
@@ -750,36 +790,6 @@ export declare class BuildVersion extends BaseModel {
     });
     static from_obj_for_encoding(data: Record<string, any>): BuildVersion;
 }
-/**
- *
- */
-export declare class CatchpointAbortResponse extends BaseModel {
-    /**
-     * Catchup abort response string
-     */
-    catchupMessage: string;
-    /**
-     * Creates a new `CatchpointAbortResponse` object.
-     * @param catchupMessage - Catchup abort response string
-     */
-    constructor(catchupMessage: string);
-    static from_obj_for_encoding(data: Record<string, any>): CatchpointAbortResponse;
-}
-/**
- *
- */
-export declare class CatchpointStartResponse extends BaseModel {
-    /**
-     * Catchup start response string
-     */
-    catchupMessage: string;
-    /**
-     * Creates a new `CatchpointStartResponse` object.
-     * @param catchupMessage - Catchup start response string
-     */
-    constructor(catchupMessage: string);
-    static from_obj_for_encoding(data: Record<string, any>): CatchpointStartResponse;
-}
 /**
  * Teal compile Result
  */
@@ -802,7 +812,11 @@ export declare class CompileResponse extends BaseModel {
      * @param result - base64 encoded program bytes
      * @param sourcemap - JSON of the source map
      */
-    constructor(hash: string, result: string, sourcemap?: Record<string, any>);
+    constructor({ hash, result, sourcemap, }: {
+        hash: string;
+        result: string;
+        sourcemap?: Record<string, any>;
+    });
     static from_obj_for_encoding(data: Record<string, any>): CompileResponse;
 }
 /**
@@ -817,7 +831,9 @@ export declare class DisassembleResponse extends BaseModel {
      * Creates a new `DisassembleResponse` object.
      * @param result - disassembled Teal code
      */
-    constructor(result: string);
+    constructor({ result }: {
+        result: string;
+    });
     static from_obj_for_encoding(data: Record<string, any>): DisassembleResponse;
 }
 /**
@@ -884,7 +900,11 @@ export declare class DryrunResponse extends BaseModel {
      * @param protocolVersion - Protocol version is the protocol version Dryrun was operated under.
      * @param txns -
      */
-    constructor(error: string, protocolVersion: string, txns: DryrunTxnResult[]);
+    constructor({ error, protocolVersion, txns, }: {
+        error: string;
+        protocolVersion: string;
+        txns: DryrunTxnResult[];
+    });
     static from_obj_for_encoding(data: Record<string, any>): DryrunResponse;
 }
 /**
@@ -910,7 +930,12 @@ export declare class DryrunSource extends BaseModel {
      * @param txnIndex -
      * @param appIndex -
      */
-    constructor(fieldName: string, source: string, txnIndex: number | bigint, appIndex: number | bigint);
+    constructor({ fieldName, source, txnIndex, appIndex, }: {
+        fieldName: string;
+        source: string;
+        txnIndex: number | bigint;
+        appIndex: number | bigint;
+    });
     static from_obj_for_encoding(data: Record<string, any>): DryrunSource;
 }
 /**
@@ -967,11 +992,6 @@ export declare class DryrunTxnResult extends BaseModel {
      * Budget consumed during execution of app call transaction.
      */
     budgetConsumed?: number | bigint;
-    /**
-     * Net cost of app execution. Field is DEPRECATED and is subject for removal.
-     * Instead, use `budget-added` and `budget-consumed.
-     */
-    cost?: number | bigint;
     /**
      * Application state delta.
      */
@@ -991,8 +1011,6 @@ export declare class DryrunTxnResult extends BaseModel {
      * @param appCallTrace -
      * @param budgetAdded - Budget added during execution of app call transaction.
      * @param budgetConsumed - Budget consumed during execution of app call transaction.
-     * @param cost - Net cost of app execution. Field is DEPRECATED and is subject for removal.
-     * Instead, use `budget-added` and `budget-consumed.
      * @param globalDelta - Application state delta.
      * @param localDeltas -
      * @param logicSigDisassembly - Disassembled lsig program line by line.
@@ -1000,13 +1018,12 @@ export declare class DryrunTxnResult extends BaseModel {
      * @param logicSigTrace -
      * @param logs -
      */
-    constructor({ disassembly, appCallMessages, appCallTrace, budgetAdded, budgetConsumed, cost, globalDelta, localDeltas, logicSigDisassembly, logicSigMessages, logicSigTrace, 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;
-        cost?: number | bigint;
         globalDelta?: EvalDeltaKeyValue[];
         localDeltas?: AccountStateDelta[];
         logicSigDisassembly?: string[];
@@ -1027,7 +1044,10 @@ export declare class ErrorResponse extends BaseModel {
      * @param message -
      * @param data -
      */
-    constructor(message: string, data?: Record<string, any>);
+    constructor({ message, data, }: {
+        message: string;
+        data?: Record<string, any>;
+    });
     static from_obj_for_encoding(data: Record<string, any>): ErrorResponse;
 }
 /**
@@ -1052,7 +1072,11 @@ export declare class EvalDelta extends BaseModel {
      * @param bytes - (bs) bytes value.
      * @param uint - (ui) uint value.
      */
-    constructor(action: number | bigint, bytes?: string, uint?: number | bigint);
+    constructor({ action, bytes, uint, }: {
+        action: number | bigint;
+        bytes?: string;
+        uint?: number | bigint;
+    });
     static from_obj_for_encoding(data: Record<string, any>): EvalDelta;
 }
 /**
@@ -1069,7 +1093,10 @@ export declare class EvalDeltaKeyValue extends BaseModel {
      * @param key -
      * @param value - Represents a TEAL value delta.
      */
-    constructor(key: string, value: EvalDelta);
+    constructor({ key, value }: {
+        key: string;
+        value: EvalDelta;
+    });
     static from_obj_for_encoding(data: Record<string, any>): EvalDeltaKeyValue;
 }
 /**
@@ -1096,7 +1123,11 @@ export declare class LightBlockHeaderProof extends BaseModel {
      * @param treedepth - Represents the depth of the tree that is being proven, i.e. the number of edges
      * from a leaf to the root.
      */
-    constructor(index: number | bigint, proof: string | Uint8Array, treedepth: number | bigint);
+    constructor({ index, proof, treedepth, }: {
+        index: number | bigint;
+        proof: string | Uint8Array;
+        treedepth: number | bigint;
+    });
     static from_obj_for_encoding(data: Record<string, any>): LightBlockHeaderProof;
 }
 /**
@@ -1359,7 +1390,10 @@ export declare class PendingTransactionsResponse extends BaseModel {
      * @param topTransactions - An array of signed transaction objects.
      * @param totalTransactions - Total number of transactions in the pool.
      */
-    constructor(topTransactions: EncodedSignedTransaction[], totalTransactions: number | bigint);
+    constructor({ topTransactions, totalTransactions, }: {
+        topTransactions: EncodedSignedTransaction[];
+        totalTransactions: number | bigint;
+    });
     static from_obj_for_encoding(data: Record<string, any>): PendingTransactionsResponse;
 }
 /**
@@ -1374,7 +1408,9 @@ export declare class PostTransactionsResponse extends BaseModel {
      * Creates a new `PostTransactionsResponse` object.
      * @param txid - encoding of the transaction hash.
      */
-    constructor(txid: string);
+    constructor({ txid }: {
+        txid: string;
+    });
     static from_obj_for_encoding(data: Record<string, any>): PostTransactionsResponse;
 }
 /**
@@ -1394,7 +1430,10 @@ export declare class StateProof extends BaseModel {
      * @param message - Represents the message that the state proofs are attesting to.
      * @param stateproof - The encoded StateProof for the message.
      */
-    constructor(message: StateProofMessage, stateproof: string | Uint8Array);
+    constructor({ message, stateproof, }: {
+        message: StateProofMessage;
+        stateproof: string | Uint8Array;
+    });
     static from_obj_for_encoding(data: Record<string, any>): StateProof;
 }
 /**
@@ -1464,7 +1503,11 @@ export declare class SupplyResponse extends BaseModel {
      * @param onlineMoney - OnlineMoney
      * @param totalMoney - TotalMoney
      */
-    constructor(currentRound: number | bigint, onlineMoney: number | bigint, totalMoney: number | bigint);
+    constructor({ currentRound, onlineMoney, totalMoney, }: {
+        currentRound: number | bigint;
+        onlineMoney: number | bigint;
+        totalMoney: number | bigint;
+    });
     static from_obj_for_encoding(data: Record<string, any>): SupplyResponse;
 }
 /**
@@ -1481,7 +1524,10 @@ export declare class TealKeyValue extends BaseModel {
      * @param key -
      * @param value - Represents a TEAL value.
      */
-    constructor(key: string, value: TealValue);
+    constructor({ key, value }: {
+        key: string;
+        value: TealValue;
+    });
     static from_obj_for_encoding(data: Record<string, any>): TealKeyValue;
 }
 /**
@@ -1506,7 +1552,11 @@ export declare class TealValue extends BaseModel {
      * @param bytes - (tb) bytes value.
      * @param uint - (ui) uint value.
      */
-    constructor(type: number | bigint, bytes: string, uint: number | bigint);
+    constructor({ type, bytes, uint, }: {
+        type: number | bigint;
+        bytes: string;
+        uint: number | bigint;
+    });
     static from_obj_for_encoding(data: Record<string, any>): TealValue;
 }
 /**
@@ -1629,6 +1679,11 @@ export declare class Version extends BaseModel {
      * @param genesisId -
      * @param versions -
      */
-    constructor(build: BuildVersion, genesisHashB64: string | Uint8Array, genesisId: string, versions: string[]);
+    constructor({ build, genesisHashB64, genesisId, versions, }: {
+        build: BuildVersion;
+        genesisHashB64: string | Uint8Array;
+        genesisId: string;
+        versions: string[];
+    });
     static from_obj_for_encoding(data: Record<string, any>): Version;
 }

package/dist/types/client/v2/basemodel.d.ts

@@ -1,6 +1,3 @@
-/**
- * Base class for models
- */
 export default class BaseModel {
     attribute_map: Record<string, string>;
     /**

package/dist/types/client/v2/indexer/lookupAssetTransactions.d.ts

@@ -140,10 +140,6 @@ export default class LookupAssetTransactions extends JSONRequest {
      * @category query
      */
     maxRound(round: number): this;
-    /**
-     * @deprecated Redundant query parameter. Asset ID is already passed into the method.
-     */
-    assetID(id: number): this;
     /**
      * Maximum number of results to return.
      *

package/dist/types/composer.d.ts

@@ -74,7 +74,7 @@ export declare class AtomicTransactionComposer {
      * causes the current group to exceed MAX_GROUP_SIZE, or if the provided arguments are invalid
      * for the given method.
      */
-    addMethodCall({ appID, method, methodArgs, sender, suggestedParams, onComplete, approvalProgram, clearProgram, numGlobalInts, numGlobalByteSlices, numLocalInts, numLocalByteSlices, extraPages, boxes, note, lease, rekeyTo, signer, }: {
+    addMethodCall({ appID, method, methodArgs, sender, suggestedParams, onComplete, approvalProgram, clearProgram, numGlobalInts, numGlobalByteSlices, numLocalInts, numLocalByteSlices, extraPages, appAccounts, appForeignApps, appForeignAssets, boxes, note, lease, rekeyTo, signer, }: {
         /** The ID of the smart contract to call. Set this to 0 to indicate an application creation call. */
         appID: number;
         /** The method to call on the smart contract */
@@ -101,6 +101,12 @@ export declare 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 */

package/dist/types/logicsig.d.ts

@@ -16,6 +16,8 @@ interface LogicSigStorageStructure {
 export declare function sanityCheckProgram(program: Uint8Array): void;
 /**
  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 declare class LogicSig implements LogicSigStorageStructure {
     tag: Buffer;
@@ -132,16 +134,6 @@ export declare class LogicSigAccount {
      */
     sign(secretKey: Uint8Array): void;
 }
-/**
- * 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 declare function makeLogicSig(program: Uint8Array, args?: Uint8Array[]): LogicSig;
 /**
  * signLogicSigTransactionObject takes a transaction and a LogicSig object and
  * returns a signed transaction.
@@ -181,6 +173,14 @@ export declare function logicSigFromByte(encoded: Uint8Array): LogicSig;
  * @param programHash - string representation of teal program hash (= contract address for LogicSigs)
  */
 export declare function tealSign(sk: Uint8Array, data: Uint8Array | Buffer, programHash: string): Uint8Array;
+/**
+ * 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 declare function verifyTealSign(data: Uint8Array | Buffer, programHash: string, sig: Uint8Array, pk: Uint8Array): boolean;
 /**
  * tealSignFromProgram creates a signature compatible with ed25519verify opcode from raw program bytes
  * @param sk - uint8array with secret key

package/dist/types/main.d.ts

@@ -60,7 +60,6 @@ export declare function encodeObj(o: Record<string | number | symbol, any>): Uin
 export declare function decodeObj(o: ArrayLike<number>): unknown;
 export declare const ERROR_MULTISIG_BAD_SENDER: Error;
 export declare const ERROR_INVALID_MICROALGOS: Error;
-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';
@@ -77,10 +76,9 @@ export * as indexerModels from './client/v2/indexer/models/types';
 export { mnemonicToMasterDerivationKey, masterDerivationKeyToMnemonic, secretKeyToMnemonic, mnemonicToSecretKey, seedFromMnemonic, mnemonicFromSeed, } from './mnemonic/mnemonic';
 export { microalgosToAlgos, algosToMicroalgos, INVALID_MICROALGOS_ERROR_MSG, } from './convert';
 export { computeGroupID, assignGroupID } from './group';
-export { LogicSigAccount, makeLogicSig, signLogicSigTransaction, signLogicSigTransactionObject, logicSigFromByte, tealSign, tealSignFromProgram, } from './logicsig';
+export { LogicSig, LogicSigAccount, signLogicSigTransaction, signLogicSigTransactionObject, logicSigFromByte, tealSign, tealSignFromProgram, verifyTealSign, } from './logicsig';
 export { signMultisigTransaction, mergeMultisigTransactions, appendSignMultisigTransaction, createMultisigTransaction, appendSignRawMultisigSignature, verifyMultisig, multisigAddress, } from './multisig';
 export { SourceMap } from './logic/sourcemap';
-export declare const LogicTemplates: any;
 export * from './dryrun';
 export * from './makeTxn';
 export * from './transaction';