@algorandfoundation/algokit-utils 5.3.3-beta.2 → 5.4.0-beta.1

package/types/testing/fixtures/algorand-fixture.d.ts

@@ -1,50 +0,0 @@
-import { AlgoConfig } from '../../types/network-client';
-import { AlgorandFixture, AlgorandFixtureConfig } from '../../types/testing';
-/**
- * Creates a test fixture for automated testing against Algorand.
- * By default it tests against an environment variable specified client
- *  if the standard environment variables are specified, otherwise against
- *  a default LocalNet instance, but you can pass in an algod, indexer
- *  and/or kmd if you want to test against an explicitly defined network.
- *
- * @example
- * ```typescript
- * const algorand = algorandFixture()
- *
- * beforeEach(algorand.beforeEach, 10_000)
- *
- * test('My test', async () => {
- *     const {algod, indexer, testAccount, ...} = algorand.context
- *     // test things...
- * })
- * ```
- *
- * @param fixtureConfig The fixture configuration
- * @returns The fixture
- */
-export declare function algorandFixture(fixtureConfig?: AlgorandFixtureConfig): AlgorandFixture;
-/**
- * Creates a test fixture for automated testing against Algorand.
- * By default it tests against an environment variable specified client
- *  if the standard environment variables are specified, otherwise against
- *  a default LocalNet instance, but you can pass in an algod, indexer
- *  and/or kmd if you want to test against an explicitly defined network.
- *
- * @example
- * ```typescript
- * const algorand = algorandFixture(undefined, getConfigFromEnvOrDefaults())
- *
- * beforeEach(algorand.beforeEach, 10_000)
- *
- * test('My test', async () => {
- *     const {algod, indexer, testAccount, ...} = algorand.context
- *     // test things...
- * })
- * ```
- *
- * @param fixtureConfig The fixture configuration
- * @param config The algo configuration
- * @returns The fixture
- */
-export declare function algorandFixture(fixtureConfig: AlgorandFixtureConfig | undefined, config: AlgoConfig): AlgorandFixture;
-//# sourceMappingURL=algorand-fixture.d.ts.map

package/types/testing/fixtures/algorand-fixture.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"algorand-fixture.d.ts","sourceRoot":"","sources":["../../../../src/testing/fixtures/algorand-fixture.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAuD,MAAM,qBAAqB,CAAA;AAEjI;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,eAAe,CAAC,aAAa,CAAC,EAAE,qBAAqB,GAAG,eAAe,CAAA;AAEvF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,eAAe,CAAC,aAAa,EAAE,qBAAqB,GAAG,SAAS,EAAE,MAAM,EAAE,UAAU,GAAG,eAAe,CAAA"}

package/types/testing/fixtures/index.d.ts

@@ -1,3 +0,0 @@
-export * from './algokit-log-capture-fixture';
-export * from './algorand-fixture';
-//# sourceMappingURL=index.d.ts.map

package/types/testing/fixtures/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/testing/fixtures/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA;AAC7C,cAAc,oBAAoB,CAAA"}

package/types/testing/index.d.ts

@@ -1,6 +0,0 @@
-export * from './account';
-export * from './fixtures';
-export * from './indexer';
-export * from './test-logger';
-export * from './transaction-logger';
-//# sourceMappingURL=index.d.ts.map

package/types/testing/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,sBAAsB,CAAA"}

package/types/testing/indexer.d.ts

@@ -1,13 +0,0 @@
-/**
- * Runs the given indexer call until a 404 error is no longer returned.
- * Tried every 200ms up to 100 times.
- * Very rudimentary implementation designed for automated testing.
- * @example
- * ```typescript
- * const transaction = await runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(txnId).do())
- * ```
- * @param run The code to run
- * @returns The result (as a promise), or throws if the indexer didn't catch up in time
- */
-export declare function runWhenIndexerCaughtUp<T>(run: () => Promise<T>): Promise<T>;
-//# sourceMappingURL=indexer.d.ts.map

package/types/testing/indexer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"indexer.d.ts","sourceRoot":"","sources":["../../../src/testing/indexer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,wBAAsB,sBAAsB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAuBjF"}

package/types/testing/test-logger.d.ts

@@ -1,41 +0,0 @@
-import { Logger } from '../types/logging';
-import { LogSnapshotConfig } from '../types/testing';
-/** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger.
- * This is useful for automated testing.
- */
-export declare class TestLogger implements Logger {
-    private originalLogger;
-    private logs;
-    /**
-     * Create a new test logger that wraps the given logger if provided.
-     * @param originalLogger The optional original logger to wrap.
-     */
-    constructor(originalLogger?: Logger);
-    /** Returns all logs captured thus far. */
-    get capturedLogs(): string[];
-    /** Clears all logs captured so far. */
-    clear(): void;
-    /**
-     * Returns a captured log snapshot.
-     * This helps ensure that the provided configuration items won't appear
-     *  with random values in the log snapshot, but rather will get substituted with predictable ids.
-     *
-     * https://jestjs.io/docs/snapshot-testing#2-tests-should-be-deterministic
-     *
-     * @example Jest Example
-     * ```typescript
-     * const logger = new TestLogger()
-     * ...
-     * expect(logger.getLogSnapshot()).toMatchSnapshot()
-     * ```
-     * @param config The snapshot configuration
-     * @returns The snapshotted logs.
-     */
-    getLogSnapshot(config?: LogSnapshotConfig): string;
-    error(message: string, ...optionalParams: unknown[]): void;
-    warn(message: string, ...optionalParams: unknown[]): void;
-    info(message: string, ...optionalParams: unknown[]): void;
-    verbose(message: string, ...optionalParams: unknown[]): void;
-    debug(message: string, ...optionalParams: unknown[]): void;
-}
-//# sourceMappingURL=test-logger.d.ts.map

package/types/testing/test-logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"test-logger.d.ts","sourceRoot":"","sources":["../../../src/testing/test-logger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AAEpD;;GAEG;AACH,qBAAa,UAAW,YAAW,MAAM;IACvC,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,IAAI,CAAU;IAEtB;;;OAGG;gBACS,cAAc,CAAC,EAAE,MAAM;IAKnC,0CAA0C;IAC1C,IAAI,YAAY,IAAI,MAAM,EAAE,CAE3B;IAED,uCAAuC;IACvC,KAAK;IAIL;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,iBAAiB;IAczC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;IAI1D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;IAIzD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;IAIzD,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;IAI5D,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;CAI3D"}

package/types/testing/transaction-logger.d.ts

@@ -1,31 +0,0 @@
-import algosdk from 'algosdk';
-import Algodv2 = algosdk.Algodv2;
-import Indexer = algosdk.Indexer;
-/**
- * Allows you to keep track of Algorand transaction IDs by wrapping an `Algodv2` in a proxy.
- * Useful for automated tests.
- */
-export declare class TransactionLogger {
-    private _sentTransactionIds;
-    /**
-     * The list of transaction IDs that has been logged thus far.
-     */
-    get sentTransactionIds(): Readonly<string[]>;
-    /**
-     * Clear all logged IDs.
-     */
-    clear(): void;
-    /**
-     * The method that captures raw transactions and stores the transaction IDs.
-     */
-    logRawTransaction(signedTransactions: Uint8Array | Uint8Array[]): void;
-    /** Return a proxy that wraps the given Algodv2 with this transaction logger.
-     *
-     * @param algod The `Algodv2` to wrap
-     * @returns The wrapped `Algodv2`, any transactions sent using this algod instance will be logged by this transaction logger
-     */
-    capture(algod: Algodv2): Algodv2;
-    /** Wait until all logged transactions IDs appear in the given `Indexer`. */
-    waitForIndexer(indexer: Indexer): Promise<void>;
-}
-//# sourceMappingURL=transaction-logger.d.ts.map

package/types/testing/transaction-logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"transaction-logger.d.ts","sourceRoot":"","sources":["../../../src/testing/transaction-logger.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAEhC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAEhC;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,mBAAmB,CAAe;IAE1C;;OAEG;IACH,IAAI,kBAAkB,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC,CAE3C;IAED;;OAEG;IACH,KAAK;IAIL;;OAEG;IACH,iBAAiB,CAAC,kBAAkB,EAAE,UAAU,GAAG,UAAU,EAAE;IAY/D;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAIhC,4EAA4E;IACtE,cAAc,CAAC,OAAO,EAAE,OAAO;CAGtC"}

package/types/types/account.d.ts

@@ -1,70 +0,0 @@
-import algosdk from 'algosdk';
-import Account = algosdk.Account;
-import MultisigMetadata = algosdk.MultisigMetadata;
-import Transaction = algosdk.Transaction;
-import TransactionSigner = algosdk.TransactionSigner;
-/**
- * The account name identifier used for fund dispensing in test environments
- */
-export declare const DISPENSER_ACCOUNT = "DISPENSER";
-/** Account wrapper that supports partial or full multisig signing. */
-export declare class MultisigAccount {
-    _params: algosdk.MultisigMetadata;
-    _signingAccounts: (algosdk.Account | SigningAccount)[];
-    _addr: string;
-    _signer: TransactionSigner;
-    /** The parameters for the multisig account */
-    get params(): Readonly<algosdk.MultisigMetadata>;
-    /** The list of accounts that are present to sign */
-    get signingAccounts(): Readonly<(algosdk.Account | SigningAccount)[]>;
-    /** The address of the multisig account */
-    get addr(): Readonly<string>;
-    get signer(): TransactionSigner;
-    constructor(multisigParams: MultisigMetadata, signingAccounts: (Account | SigningAccount)[]);
-    /**
-     * Sign the given transaction
-     * @param transaction Either a transaction object or a raw, partially signed transaction
-     * @returns The transaction signed by the present signers
-     */
-    sign(transaction: Transaction | Uint8Array): Uint8Array;
-}
-/** Account wrapper that supports a rekeyed account */
-export declare class SigningAccount implements Account {
-    private _account;
-    private _signer;
-    private _sender;
-    /**
-     * Algorand address of the sender
-     */
-    get addr(): Readonly<string>;
-    /**
-     * Secret key belonging to the signer
-     */
-    get sk(): Readonly<Uint8Array>;
-    /**
-     * Transaction signer for the underlying signing account
-     */
-    get signer(): TransactionSigner;
-    /**
-     * Algorand account of the sender address and signer private key
-     */
-    get sender(): Account;
-    constructor(account: Account, sender: string | undefined);
-}
-/** A wrapper around `TransactionSigner` that also has the sender address. */
-export interface TransactionSignerAccount {
-    addr: Readonly<string>;
-    signer: TransactionSigner;
-}
-/** Config for an account config */
-export interface AccountConfig {
-    /** Mnemonic for an account */
-    accountMnemonic: string;
-    /** Address of a rekeyed account */
-    senderAddress?: string;
-    /** Account name used to retrieve config */
-    accountName: string;
-    /** @deprecated Renamed to senderAddress in 2.3.1 */
-    senderMnemonic?: string;
-}
-//# sourceMappingURL=account.d.ts.map

package/types/types/account.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../../src/types/account.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAA;AAClD,OAAO,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;AACxC,OAAO,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAA;AAEpD;;GAEG;AACH,eAAO,MAAM,iBAAiB,cAAc,CAAA;AAE5C,sEAAsE;AACtE,qBAAa,eAAe;IAC1B,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAA;IACjC,gBAAgB,EAAE,CAAC,OAAO,CAAC,OAAO,GAAG,cAAc,CAAC,EAAE,CAAA;IACtD,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,iBAAiB,CAAA;IAE1B,8CAA8C;IAC9C,IAAI,MAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAE/C;IAED,oDAAoD;IACpD,IAAI,eAAe,IAAI,QAAQ,CAAC,CAAC,OAAO,CAAC,OAAO,GAAG,cAAc,CAAC,EAAE,CAAC,CAEpE;IAED,0CAA0C;IAC1C,IAAI,IAAI,IAAI,QAAQ,CAAC,MAAM,CAAC,CAE3B;IAED,IAAI,MAAM,IAAI,iBAAiB,CAE9B;gBAEW,cAAc,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC,OAAO,GAAG,cAAc,CAAC,EAAE;IAU3F;;;;OAIG;IACI,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU;CAY/D;AAED,sDAAsD;AACtD,qBAAa,cAAe,YAAW,OAAO;IAC5C,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,OAAO,CAAQ;IAEvB;;OAEG;IACH,IAAI,IAAI,IAAI,QAAQ,CAAC,MAAM,CAAC,CAE3B;IAED;;OAEG;IACH,IAAI,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,CAE7B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,iBAAiB,CAE9B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAKpB;gBAEW,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS;CAKzD;AAED,6EAA6E;AAC7E,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACtB,MAAM,EAAE,iBAAiB,CAAA;CAC1B;AAED,mCAAmC;AACnC,MAAM,WAAW,aAAa;IAC5B,8BAA8B;IAC9B,eAAe,EAAE,MAAM,CAAA;IACvB,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAA;IAEnB,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB"}

package/types/types/algo-http-client-with-retry.d.ts

@@ -1,14 +0,0 @@
-import type { BaseHTTPClientResponse, Query } from 'algosdk/dist/types/client/baseHTTPClient';
-import { URLTokenBaseHTTPClient } from './urlTokenBaseHTTPClient';
-/** A HTTP Client that wraps the Algorand SDK HTTP Client with retries */
-export declare class AlgoHttpClientWithRetry extends URLTokenBaseHTTPClient {
-    private static readonly MAX_TRIES;
-    private static readonly MAX_BACKOFF_MS;
-    private static readonly RETRY_STATUS_CODES;
-    private static readonly RETRY_ERROR_CODES;
-    private callWithRetry;
-    get(relativePath: string, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
-    post(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
-    delete(relativePath: string, data: Uint8Array, query?: Query<string>, requestHeaders?: Record<string, string>): Promise<BaseHTTPClientResponse>;
-}
-//# sourceMappingURL=algo-http-client-with-retry.d.ts.map

package/types/types/algo-http-client-with-retry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"algo-http-client-with-retry.d.ts","sourceRoot":"","sources":["../../../src/types/algo-http-client-with-retry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,0CAA0C,CAAA;AAE7F,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AAEjE,yEAAyE;AACzE,qBAAa,uBAAwB,SAAQ,sBAAsB;IACjE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAI;IACrC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAQ;IAI9C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAsC;IAChF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAUxC;YAEa,aAAa;IAiCrB,GAAG,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,cAAc,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAI9H,IAAI,CACR,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,UAAU,EAChB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACrB,cAAc,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAC1C,OAAO,CAAC,sBAAsB,CAAC;IAI5B,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,UAAU,EAChB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACrB,cAAc,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GAC1C,OAAO,CAAC,sBAAsB,CAAC;CAGnC"}

package/types/types/amount.d.ts

@@ -1,24 +0,0 @@
-/** Wrapper class to ensure safe, explicit conversion between µAlgos, Algos and numbers */
-export declare class AlgoAmount {
-    private amountInMicroAlgos;
-    /** Return the amount as a number in µAlgos */
-    get microAlgos(): number;
-    /** Return the amount as a number in Algos */
-    get algos(): number;
-    constructor(amount: {
-        algos: number;
-    } | {
-        microAlgos: number;
-    });
-    toString(): string;
-    /** valueOf allows you to use `AlgoAmount` in comparison operations such as `<` and `>=` etc.,
-     * but it's not recommended to use this to convert to a number, it's much safer to explicitly call
-     * the algos or microAlgos properties
-     */
-    valueOf(): number;
-    /** Create a `AlgoAmount` object representing the given number of Algos */
-    static Algos(amount: number): AlgoAmount;
-    /** Create a `AlgoAmount` object representing the given number of µAlgos */
-    static MicroAlgos(amount: number): AlgoAmount;
-}
-//# sourceMappingURL=amount.d.ts.map

package/types/types/amount.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../../../src/types/amount.ts"],"names":[],"mappings":"AAEA,0FAA0F;AAC1F,qBAAa,UAAU;IACrB,OAAO,CAAC,kBAAkB,CAAA;IAE1B,8CAA8C;IAC9C,IAAI,UAAU,WAEb;IAED,6CAA6C;IAC7C,IAAI,KAAK,WAER;gBAEW,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE;IAI9D,QAAQ,IAAI,MAAM;IAIlB;;;OAGG;IACH,OAAO,IAAI,MAAM;IAIjB,0EAA0E;IAC1E,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM;IAI3B,2EAA2E;IAC3E,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM;CAGjC"}