@algorandfoundation/algokit-utils 9.2.0-beta.7 → 10.0.0-alpha.1

package/packages/algod_client/src/models/transaction-parameters-response.mjs

@@ -0,0 +1,51 @@
+import { bigIntCodec } from "../../../common/src/codecs/primitives/bigint.mjs";
+import { bytesCodec } from "../../../common/src/codecs/primitives/bytes.mjs";
+import { stringCodec } from "../../../common/src/codecs/primitives/string.mjs";
+
+//#region packages/algod_client/src/models/transaction-parameters-response.ts
+const TransactionParametersResponseMeta = {
+	name: "TransactionParametersResponse",
+	kind: "object",
+	fields: [
+		{
+			name: "consensusVersion",
+			wireKey: "consensus-version",
+			optional: false,
+			codec: stringCodec
+		},
+		{
+			name: "fee",
+			wireKey: "fee",
+			optional: false,
+			codec: bigIntCodec
+		},
+		{
+			name: "genesisHash",
+			wireKey: "genesis-hash",
+			optional: false,
+			codec: bytesCodec
+		},
+		{
+			name: "genesisId",
+			wireKey: "genesis-id",
+			optional: false,
+			codec: stringCodec
+		},
+		{
+			name: "lastRound",
+			wireKey: "last-round",
+			optional: false,
+			codec: bigIntCodec
+		},
+		{
+			name: "minFee",
+			wireKey: "min-fee",
+			optional: false,
+			codec: bigIntCodec
+		}
+	]
+};
+
+//#endregion
+export { TransactionParametersResponseMeta };
+//# sourceMappingURL=transaction-parameters-response.mjs.map

package/packages/algod_client/src/models/transaction-parameters-response.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-parameters-response.mjs","names":["TransactionParametersResponseMeta: ObjectModelMetadata<TransactionParametersResponse>"],"sources":["../../../../../packages/algod_client/src/models/transaction-parameters-response.ts"],"sourcesContent":["import type { ObjectModelMetadata } from '@algorandfoundation/algokit-common'\nimport { stringCodec, bigIntCodec, bytesCodec } from '@algorandfoundation/algokit-common'\n\n/**\n * TransactionParams contains the parameters that help a client construct\n * a new transaction.\n */\nexport type TransactionParametersResponse = {\n  /**\n   * ConsensusVersion indicates the consensus protocol version\n   * as of LastRound.\n   */\n  consensusVersion: string\n\n  /**\n   * Fee is the suggested transaction fee\n   * Fee is in units of micro-Algos per byte.\n   * Fee may fall to zero but transactions must still have a fee of\n   * at least MinTxnFee for the current network protocol.\n   */\n  fee: bigint\n\n  /**\n   * GenesisHash is the hash of the genesis block.\n   */\n  genesisHash: Uint8Array\n\n  /**\n   * GenesisID is an ID listed in the genesis block.\n   */\n  genesisId: string\n\n  /**\n   * LastRound indicates the last round seen\n   */\n  lastRound: bigint\n\n  /**\n   * The minimum transaction fee (not per byte) required for the\n   * txn to validate for the current network protocol.\n   */\n  minFee: bigint\n}\n\nexport const TransactionParametersResponseMeta: ObjectModelMetadata<TransactionParametersResponse> = {\n  name: 'TransactionParametersResponse',\n  kind: 'object',\n  fields: [\n    {\n      name: 'consensusVersion',\n      wireKey: 'consensus-version',\n      optional: false,\n      codec: stringCodec,\n    },\n    {\n      name: 'fee',\n      wireKey: 'fee',\n      optional: false,\n      codec: bigIntCodec,\n    },\n    {\n      name: 'genesisHash',\n      wireKey: 'genesis-hash',\n      optional: false,\n      codec: bytesCodec,\n    },\n    {\n      name: 'genesisId',\n      wireKey: 'genesis-id',\n      optional: false,\n      codec: stringCodec,\n    },\n    {\n      name: 'lastRound',\n      wireKey: 'last-round',\n      optional: false,\n      codec: bigIntCodec,\n    },\n    {\n      name: 'minFee',\n      wireKey: 'min-fee',\n      optional: false,\n      codec: bigIntCodec,\n    },\n  ],\n}\n"],"mappings":";;;;;AA4CA,MAAaA,oCAAwF;CACnG,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACF;CACF"}

package/packages/algod_client/src/models/transaction-proof.d.ts

@@ -0,0 +1,31 @@
+//#region packages/algod_client/src/models/transaction-proof.d.ts
+/**
+ * Proof of transaction in a block.
+ */
+type TransactionProof = {
+  /**
+   * Proof of transaction membership.
+   */
+  proof: Uint8Array;
+  /**
+   * Hash of SignedTxnInBlock for verifying proof.
+   */
+  stibhash: Uint8Array;
+  /**
+   * Represents the depth of the tree that is being proven, i.e. the number of edges from a leaf to the root.
+   */
+  treedepth: number;
+  /**
+   * Index of the transaction in the block's payset.
+   */
+  idx: number;
+  /**
+   * The type of hash function used to create the proof, must be one of:
+   * * sha512_256
+   * * sha256
+   */
+  hashtype: 'sha512_256' | 'sha256';
+};
+//#endregion
+export { TransactionProof };
+//# sourceMappingURL=transaction-proof.d.ts.map

package/packages/algod_client/src/models/transaction-proof.js

@@ -0,0 +1,45 @@
+const require_bytes = require('../../../common/src/codecs/primitives/bytes.js');
+const require_number = require('../../../common/src/codecs/primitives/number.js');
+const require_string = require('../../../common/src/codecs/primitives/string.js');
+
+//#region packages/algod_client/src/models/transaction-proof.ts
+const TransactionProofMeta = {
+	name: "TransactionProof",
+	kind: "object",
+	fields: [
+		{
+			name: "proof",
+			wireKey: "proof",
+			optional: false,
+			codec: require_bytes.bytesCodec
+		},
+		{
+			name: "stibhash",
+			wireKey: "stibhash",
+			optional: false,
+			codec: require_bytes.bytesCodec
+		},
+		{
+			name: "treedepth",
+			wireKey: "treedepth",
+			optional: false,
+			codec: require_number.numberCodec
+		},
+		{
+			name: "idx",
+			wireKey: "idx",
+			optional: false,
+			codec: require_number.numberCodec
+		},
+		{
+			name: "hashtype",
+			wireKey: "hashtype",
+			optional: false,
+			codec: require_string.stringCodec
+		}
+	]
+};
+
+//#endregion
+exports.TransactionProofMeta = TransactionProofMeta;
+//# sourceMappingURL=transaction-proof.js.map

package/packages/algod_client/src/models/transaction-proof.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-proof.js","names":["TransactionProofMeta: ObjectModelMetadata<TransactionProof>","bytesCodec","numberCodec","stringCodec"],"sources":["../../../../../packages/algod_client/src/models/transaction-proof.ts"],"sourcesContent":["import type { ObjectModelMetadata } from '@algorandfoundation/algokit-common'\nimport { stringCodec, numberCodec, bytesCodec } from '@algorandfoundation/algokit-common'\n\n/**\n * Proof of transaction in a block.\n */\nexport type TransactionProof = {\n  /**\n   * Proof of transaction membership.\n   */\n  proof: Uint8Array\n\n  /**\n   * Hash of SignedTxnInBlock for verifying proof.\n   */\n  stibhash: Uint8Array\n\n  /**\n   * Represents the depth of the tree that is being proven, i.e. the number of edges from a leaf to the root.\n   */\n  treedepth: number\n\n  /**\n   * Index of the transaction in the block's payset.\n   */\n  idx: number\n\n  /**\n   * The type of hash function used to create the proof, must be one of:\n   * * sha512_256\n   * * sha256\n   */\n  hashtype: 'sha512_256' | 'sha256'\n}\n\nexport const TransactionProofMeta: ObjectModelMetadata<TransactionProof> = {\n  name: 'TransactionProof',\n  kind: 'object',\n  fields: [\n    {\n      name: 'proof',\n      wireKey: 'proof',\n      optional: false,\n      codec: bytesCodec,\n    },\n    {\n      name: 'stibhash',\n      wireKey: 'stibhash',\n      optional: false,\n      codec: bytesCodec,\n    },\n    {\n      name: 'treedepth',\n      wireKey: 'treedepth',\n      optional: false,\n      codec: numberCodec,\n    },\n    {\n      name: 'idx',\n      wireKey: 'idx',\n      optional: false,\n      codec: numberCodec,\n    },\n    {\n      name: 'hashtype',\n      wireKey: 'hashtype',\n      optional: false,\n      codec: stringCodec,\n    },\n  ],\n}\n"],"mappings":";;;;;AAmCA,MAAaA,uBAA8D;CACzE,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAOC;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAOA;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAOC;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAOA;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAOC;GACR;EACF;CACF"}

package/packages/algod_client/src/models/transaction-proof.mjs

@@ -0,0 +1,45 @@
+import { bytesCodec } from "../../../common/src/codecs/primitives/bytes.mjs";
+import { numberCodec } from "../../../common/src/codecs/primitives/number.mjs";
+import { stringCodec } from "../../../common/src/codecs/primitives/string.mjs";
+
+//#region packages/algod_client/src/models/transaction-proof.ts
+const TransactionProofMeta = {
+	name: "TransactionProof",
+	kind: "object",
+	fields: [
+		{
+			name: "proof",
+			wireKey: "proof",
+			optional: false,
+			codec: bytesCodec
+		},
+		{
+			name: "stibhash",
+			wireKey: "stibhash",
+			optional: false,
+			codec: bytesCodec
+		},
+		{
+			name: "treedepth",
+			wireKey: "treedepth",
+			optional: false,
+			codec: numberCodec
+		},
+		{
+			name: "idx",
+			wireKey: "idx",
+			optional: false,
+			codec: numberCodec
+		},
+		{
+			name: "hashtype",
+			wireKey: "hashtype",
+			optional: false,
+			codec: stringCodec
+		}
+	]
+};
+
+//#endregion
+export { TransactionProofMeta };
+//# sourceMappingURL=transaction-proof.mjs.map

package/packages/algod_client/src/models/transaction-proof.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-proof.mjs","names":["TransactionProofMeta: ObjectModelMetadata<TransactionProof>"],"sources":["../../../../../packages/algod_client/src/models/transaction-proof.ts"],"sourcesContent":["import type { ObjectModelMetadata } from '@algorandfoundation/algokit-common'\nimport { stringCodec, numberCodec, bytesCodec } from '@algorandfoundation/algokit-common'\n\n/**\n * Proof of transaction in a block.\n */\nexport type TransactionProof = {\n  /**\n   * Proof of transaction membership.\n   */\n  proof: Uint8Array\n\n  /**\n   * Hash of SignedTxnInBlock for verifying proof.\n   */\n  stibhash: Uint8Array\n\n  /**\n   * Represents the depth of the tree that is being proven, i.e. the number of edges from a leaf to the root.\n   */\n  treedepth: number\n\n  /**\n   * Index of the transaction in the block's payset.\n   */\n  idx: number\n\n  /**\n   * The type of hash function used to create the proof, must be one of:\n   * * sha512_256\n   * * sha256\n   */\n  hashtype: 'sha512_256' | 'sha256'\n}\n\nexport const TransactionProofMeta: ObjectModelMetadata<TransactionProof> = {\n  name: 'TransactionProof',\n  kind: 'object',\n  fields: [\n    {\n      name: 'proof',\n      wireKey: 'proof',\n      optional: false,\n      codec: bytesCodec,\n    },\n    {\n      name: 'stibhash',\n      wireKey: 'stibhash',\n      optional: false,\n      codec: bytesCodec,\n    },\n    {\n      name: 'treedepth',\n      wireKey: 'treedepth',\n      optional: false,\n      codec: numberCodec,\n    },\n    {\n      name: 'idx',\n      wireKey: 'idx',\n      optional: false,\n      codec: numberCodec,\n    },\n    {\n      name: 'hashtype',\n      wireKey: 'hashtype',\n      optional: false,\n      codec: stringCodec,\n    },\n  ],\n}\n"],"mappings":";;;;;AAmCA,MAAaA,uBAA8D;CACzE,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACF;CACF"}

package/packages/algod_client/src/models/version.d.ts

@@ -0,0 +1,16 @@
+import { BuildVersion } from "./build-version.js";
+
+//#region packages/algod_client/src/models/version.d.ts
+
+/**
+ * algod version information.
+ */
+type Version = {
+  build: BuildVersion;
+  genesisHashB64: Uint8Array;
+  genesisId: string;
+  versions: string[];
+};
+//#endregion
+export { Version };
+//# sourceMappingURL=version.d.ts.map

package/packages/algod_client/src/models/version.js

@@ -0,0 +1,41 @@
+const require_bytes = require('../../../common/src/codecs/primitives/bytes.js');
+const require_string = require('../../../common/src/codecs/primitives/string.js');
+const require_array = require('../../../common/src/codecs/composite/array.js');
+const require_object_model = require('../../../common/src/codecs/models/object-model.js');
+const require_build_version = require('./build-version.js');
+
+//#region packages/algod_client/src/models/version.ts
+const VersionMeta = {
+	name: "Version",
+	kind: "object",
+	fields: [
+		{
+			name: "build",
+			wireKey: "build",
+			optional: false,
+			codec: new require_object_model.ObjectModelCodec(require_build_version.BuildVersionMeta)
+		},
+		{
+			name: "genesisHashB64",
+			wireKey: "genesis_hash_b64",
+			optional: false,
+			codec: require_bytes.bytesCodec
+		},
+		{
+			name: "genesisId",
+			wireKey: "genesis_id",
+			optional: false,
+			codec: require_string.stringCodec
+		},
+		{
+			name: "versions",
+			wireKey: "versions",
+			optional: false,
+			codec: require_array.stringArrayCodec
+		}
+	]
+};
+
+//#endregion
+exports.VersionMeta = VersionMeta;
+//# sourceMappingURL=version.js.map

package/packages/algod_client/src/models/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","names":["VersionMeta: ObjectModelMetadata<Version>","ObjectModelCodec","BuildVersionMeta","bytesCodec","stringCodec","stringArrayCodec"],"sources":["../../../../../packages/algod_client/src/models/version.ts"],"sourcesContent":["import type { ObjectModelMetadata } from '@algorandfoundation/algokit-common'\nimport { stringCodec, bytesCodec, stringArrayCodec, ObjectModelCodec } from '@algorandfoundation/algokit-common'\nimport type { BuildVersion } from './build-version'\nimport { BuildVersionMeta } from './build-version'\n\n/**\n * algod version information.\n */\nexport type Version = {\n  build: BuildVersion\n  genesisHashB64: Uint8Array\n  genesisId: string\n  versions: string[]\n}\n\nexport const VersionMeta: ObjectModelMetadata<Version> = {\n  name: 'Version',\n  kind: 'object',\n  fields: [\n    {\n      name: 'build',\n      wireKey: 'build',\n      optional: false,\n      codec: new ObjectModelCodec(BuildVersionMeta),\n    },\n    {\n      name: 'genesisHashB64',\n      wireKey: 'genesis_hash_b64',\n      optional: false,\n      codec: bytesCodec,\n    },\n    {\n      name: 'genesisId',\n      wireKey: 'genesis_id',\n      optional: false,\n      codec: stringCodec,\n    },\n    {\n      name: 'versions',\n      wireKey: 'versions',\n      optional: false,\n      codec: stringArrayCodec,\n    },\n  ],\n}\n"],"mappings":";;;;;;;AAeA,MAAaA,cAA4C;CACvD,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO,IAAIC,sCAAiBC,uCAAiB;GAC9C;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAOC;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAOC;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAOC;GACR;EACF;CACF"}

package/packages/algod_client/src/models/version.mjs

@@ -0,0 +1,41 @@
+import { bytesCodec } from "../../../common/src/codecs/primitives/bytes.mjs";
+import { stringCodec } from "../../../common/src/codecs/primitives/string.mjs";
+import { stringArrayCodec } from "../../../common/src/codecs/composite/array.mjs";
+import { ObjectModelCodec } from "../../../common/src/codecs/models/object-model.mjs";
+import { BuildVersionMeta } from "./build-version.mjs";
+
+//#region packages/algod_client/src/models/version.ts
+const VersionMeta = {
+	name: "Version",
+	kind: "object",
+	fields: [
+		{
+			name: "build",
+			wireKey: "build",
+			optional: false,
+			codec: new ObjectModelCodec(BuildVersionMeta)
+		},
+		{
+			name: "genesisHashB64",
+			wireKey: "genesis_hash_b64",
+			optional: false,
+			codec: bytesCodec
+		},
+		{
+			name: "genesisId",
+			wireKey: "genesis_id",
+			optional: false,
+			codec: stringCodec
+		},
+		{
+			name: "versions",
+			wireKey: "versions",
+			optional: false,
+			codec: stringArrayCodec
+		}
+	]
+};
+
+//#endregion
+export { VersionMeta };
+//# sourceMappingURL=version.mjs.map

package/packages/algod_client/src/models/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","names":["VersionMeta: ObjectModelMetadata<Version>"],"sources":["../../../../../packages/algod_client/src/models/version.ts"],"sourcesContent":["import type { ObjectModelMetadata } from '@algorandfoundation/algokit-common'\nimport { stringCodec, bytesCodec, stringArrayCodec, ObjectModelCodec } from '@algorandfoundation/algokit-common'\nimport type { BuildVersion } from './build-version'\nimport { BuildVersionMeta } from './build-version'\n\n/**\n * algod version information.\n */\nexport type Version = {\n  build: BuildVersion\n  genesisHashB64: Uint8Array\n  genesisId: string\n  versions: string[]\n}\n\nexport const VersionMeta: ObjectModelMetadata<Version> = {\n  name: 'Version',\n  kind: 'object',\n  fields: [\n    {\n      name: 'build',\n      wireKey: 'build',\n      optional: false,\n      codec: new ObjectModelCodec(BuildVersionMeta),\n    },\n    {\n      name: 'genesisHashB64',\n      wireKey: 'genesis_hash_b64',\n      optional: false,\n      codec: bytesCodec,\n    },\n    {\n      name: 'genesisId',\n      wireKey: 'genesis_id',\n      optional: false,\n      codec: stringCodec,\n    },\n    {\n      name: 'versions',\n      wireKey: 'versions',\n      optional: false,\n      codec: stringArrayCodec,\n    },\n  ],\n}\n"],"mappings":";;;;;;;AAeA,MAAaA,cAA4C;CACvD,MAAM;CACN,MAAM;CACN,QAAQ;EACN;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO,IAAI,iBAAiB,iBAAiB;GAC9C;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACD;GACE,MAAM;GACN,SAAS;GACT,UAAU;GACV,OAAO;GACR;EACF;CACF"}

package/packages/common/src/address.d.ts

@@ -0,0 +1,71 @@
+//#region packages/common/src/address.d.ts
+
+declare const ALGORAND_ZERO_ADDRESS_STRING = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ";
+/** Symbol used for instanceof checks across packages (CJS/ESM) */
+declare const ADDR_SYMBOL: unique symbol;
+/**
+ * Represents an Algorand address
+ */
+declare class Address {
+  /**
+   * The binary form of the address. For standard accounts, this is the public key.
+   */
+  readonly publicKey: Uint8Array;
+  /** @internal */
+  [ADDR_SYMBOL]: boolean;
+  /**
+   * Create a new Address object from its binary form.
+   * @param publicKey - The binary form of the address. Must be 32 bytes.
+   */
+  constructor(publicKey: Uint8Array);
+  /**
+   * Check if the address is equal to another address.
+   */
+  equals(other: Address): boolean;
+  /**
+   * Compute the 4 byte checksum of the address.
+   */
+  checksum(): Uint8Array;
+  /**
+   * Encode the address into a string form.
+   */
+  toString(): string;
+  /**
+   * Decode an address from a string.
+   * @param address - The address to decode. Must be 58 characters long.
+   * @returns An Address object corresponding to the input string.
+   */
+  static fromString(address: string): Address;
+  /**
+   * Get the zero address.
+   */
+  static zeroAddress(): Address;
+  static [Symbol.hasInstance](obj: unknown): boolean;
+}
+interface Addressable {
+  addr: Readonly<Address>;
+}
+type ReadableAddress = Addressable | Address | string;
+declare function getAddress(addr: ReadableAddress): Address;
+declare function getOptionalAddress(addr: ReadableAddress | undefined): Address | undefined;
+/**
+ * Get the escrow address of an application.
+ * @param appID - The ID of the application.
+ * @returns The address corresponding to that application's escrow account.
+ */
+declare function getApplicationAddress(appID: number | bigint): Address;
+/**
+ * decodeAddress takes an Algorand address in string form and decodes it into a Uint8Array.
+ * @param address - an Algorand address with checksum.
+ * @returns the decoded form of the address's public key and checksum
+ */
+declare function decodeAddress(address: string): Address;
+/**
+ * encodeAddress takes an Algorand address as a Uint8Array and encodes it into a string with checksum.
+ * @param address - a raw Algorand address
+ * @returns the address and checksum encoded as a string.
+ */
+declare function encodeAddress(address: Uint8Array): string;
+//#endregion
+export { ALGORAND_ZERO_ADDRESS_STRING, Address, Addressable, ReadableAddress, decodeAddress, encodeAddress, getAddress, getApplicationAddress, getOptionalAddress };
+//# sourceMappingURL=address.d.ts.map

package/packages/common/src/address.js

@@ -0,0 +1,156 @@
+const require_rolldown_runtime = require('../../../_virtual/rolldown_runtime.js');
+const require_array = require('./array.js');
+const require_constants = require('./constants.js');
+let hi_base32 = require("hi-base32");
+hi_base32 = require_rolldown_runtime.__toESM(hi_base32);
+let js_sha512 = require("js-sha512");
+js_sha512 = require_rolldown_runtime.__toESM(js_sha512);
+
+//#region packages/common/src/address.ts
+const ALGORAND_ADDRESS_BYTE_LENGTH = 36;
+const ALGORAND_CHECKSUM_BYTE_LENGTH = 4;
+const ALGORAND_ADDRESS_LENGTH = 58;
+const ALGORAND_ZERO_ADDRESS_STRING = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ";
+const MALFORMED_ADDRESS_ERROR_MSG = "address seems to be malformed";
+const CHECKSUM_ADDRESS_ERROR_MSG = "wrong checksum for address";
+function checksumFromPublicKey(publicKey) {
+	return Uint8Array.from(js_sha512.default.sha512_256.array(publicKey).slice(require_constants.HASH_BYTES_LENGTH - require_constants.CHECKSUM_BYTE_LENGTH, require_constants.HASH_BYTES_LENGTH));
+}
+function genericHash(arr) {
+	return js_sha512.default.sha512_256.array(arr);
+}
+function bytesToHex(bytes) {
+	return Buffer.from(bytes).toString("hex");
+}
+function encodeUint64(num) {
+	if (!(typeof num === "bigint" || Number.isInteger(num)) || num < 0 || num > BigInt("0xffffffffffffffff")) throw new Error("Input is not a 64-bit unsigned integer");
+	const encoding = new Uint8Array(8);
+	new DataView(encoding.buffer).setBigUint64(0, BigInt(num));
+	return encoding;
+}
+/** Symbol used for instanceof checks across packages (CJS/ESM) */
+const ADDR_SYMBOL = Symbol.for("algokit_common:Address");
+/**
+* Represents an Algorand address
+*/
+var Address = class Address {
+	/**
+	* The binary form of the address. For standard accounts, this is the public key.
+	*/
+	publicKey;
+	/** @internal */
+	[ADDR_SYMBOL];
+	/**
+	* Create a new Address object from its binary form.
+	* @param publicKey - The binary form of the address. Must be 32 bytes.
+	*/
+	constructor(publicKey) {
+		this[ADDR_SYMBOL] = true;
+		if (publicKey.length !== ALGORAND_ADDRESS_BYTE_LENGTH - ALGORAND_CHECKSUM_BYTE_LENGTH) throw new Error(`${MALFORMED_ADDRESS_ERROR_MSG}: 0x${bytesToHex(publicKey)}, length ${publicKey.length}`);
+		this.publicKey = publicKey;
+	}
+	/**
+	* Check if the address is equal to another address.
+	*/
+	equals(other) {
+		return other instanceof Address && require_array.arrayEqual(this.publicKey, other.publicKey);
+	}
+	/**
+	* Compute the 4 byte checksum of the address.
+	*/
+	checksum() {
+		return checksumFromPublicKey(this.publicKey);
+	}
+	/**
+	* Encode the address into a string form.
+	*/
+	toString() {
+		return hi_base32.default.encode(require_array.concatArrays(this.publicKey, this.checksum())).slice(0, ALGORAND_ADDRESS_LENGTH);
+	}
+	/**
+	* Decode an address from a string.
+	* @param address - The address to decode. Must be 58 characters long.
+	* @returns An Address object corresponding to the input string.
+	*/
+	static fromString(address) {
+		if (typeof address !== "string") throw new Error(`${MALFORMED_ADDRESS_ERROR_MSG}: expected string, got ${typeof address}, ${address}`);
+		if (address.length !== ALGORAND_ADDRESS_LENGTH) throw new Error(`${MALFORMED_ADDRESS_ERROR_MSG}: expected length ${ALGORAND_ADDRESS_LENGTH}, got ${address.length}: ${address}`);
+		const decoded = hi_base32.default.decode.asBytes(address);
+		if (decoded.length !== ALGORAND_ADDRESS_BYTE_LENGTH) throw new Error(`${MALFORMED_ADDRESS_ERROR_MSG}: expected byte length ${ALGORAND_ADDRESS_BYTE_LENGTH}, got ${decoded.length}`);
+		const pk = new Uint8Array(decoded.slice(0, ALGORAND_ADDRESS_BYTE_LENGTH - ALGORAND_CHECKSUM_BYTE_LENGTH));
+		const cs = new Uint8Array(decoded.slice(ALGORAND_ADDRESS_BYTE_LENGTH - ALGORAND_CHECKSUM_BYTE_LENGTH, ALGORAND_ADDRESS_BYTE_LENGTH));
+		const checksum = checksumFromPublicKey(pk);
+		if (!require_array.arrayEqual(checksum, cs)) throw new Error(`${CHECKSUM_ADDRESS_ERROR_MSG}: ${address} (${cs}, ${checksum})`);
+		return new Address(pk);
+	}
+	/**
+	* Get the zero address.
+	*/
+	static zeroAddress() {
+		return new Address(new Uint8Array(ALGORAND_ADDRESS_BYTE_LENGTH - ALGORAND_CHECKSUM_BYTE_LENGTH));
+	}
+	static [Symbol.hasInstance](obj) {
+		return Boolean(obj && typeof obj === "object" && ADDR_SYMBOL in obj && obj[ADDR_SYMBOL]);
+	}
+};
+function getAddress(addr) {
+	if (typeof addr == "string") return Address.fromString(addr);
+	else if ("addr" in addr) return addr.addr;
+	else return addr;
+}
+function getOptionalAddress(addr) {
+	if (addr === void 0) return;
+	return getAddress(addr);
+}
+/**
+* isValidAddress checks if a string is a valid Algorand address.
+* @param address - an Algorand address with checksum.
+* @returns true if valid, false otherwise
+*/
+function isValidAddress(address) {
+	try {
+		Address.fromString(address);
+	} catch {
+		return false;
+	}
+	return true;
+}
+const APP_ID_PREFIX = new TextEncoder().encode("appID");
+/**
+* Get the escrow address of an application.
+* @param appID - The ID of the application.
+* @returns The address corresponding to that application's escrow account.
+*/
+function getApplicationAddress(appID) {
+	const hash = genericHash(require_array.concatArrays(APP_ID_PREFIX, encodeUint64(appID)));
+	return new Address(Uint8Array.from(hash));
+}
+/**
+* decodeAddress takes an Algorand address in string form and decodes it into a Uint8Array.
+* @param address - an Algorand address with checksum.
+* @returns the decoded form of the address's public key and checksum
+*/
+function decodeAddress(address) {
+	return Address.fromString(address);
+}
+/**
+* encodeAddress takes an Algorand address as a Uint8Array and encodes it into a string with checksum.
+* @param address - a raw Algorand address
+* @returns the address and checksum encoded as a string.
+*/
+function encodeAddress(address) {
+	return new Address(address).toString();
+}
+
+//#endregion
+exports.ALGORAND_ADDRESS_BYTE_LENGTH = ALGORAND_ADDRESS_BYTE_LENGTH;
+exports.ALGORAND_CHECKSUM_BYTE_LENGTH = ALGORAND_CHECKSUM_BYTE_LENGTH;
+exports.ALGORAND_ZERO_ADDRESS_STRING = ALGORAND_ZERO_ADDRESS_STRING;
+exports.Address = Address;
+exports.decodeAddress = decodeAddress;
+exports.encodeAddress = encodeAddress;
+exports.getAddress = getAddress;
+exports.getApplicationAddress = getApplicationAddress;
+exports.getOptionalAddress = getOptionalAddress;
+exports.isValidAddress = isValidAddress;
+//# sourceMappingURL=address.js.map

package/packages/common/src/address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.js","names":["sha512","HASH_BYTES_LENGTH","CHECKSUM_BYTE_LENGTH","arrayEqual","base32","concatArrays"],"sources":["../../../../packages/common/src/address.ts"],"sourcesContent":["import base32 from 'hi-base32'\nimport sha512 from 'js-sha512'\nimport { arrayEqual, concatArrays } from './array'\nimport { CHECKSUM_BYTE_LENGTH, HASH_BYTES_LENGTH } from './constants'\n\nexport const ALGORAND_ADDRESS_BYTE_LENGTH = 36\nexport const ALGORAND_CHECKSUM_BYTE_LENGTH = 4\nexport const ALGORAND_ADDRESS_LENGTH = 58\nexport const ALGORAND_ZERO_ADDRESS_STRING = 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAY5HFKQ'\n\nexport const MALFORMED_ADDRESS_ERROR_MSG = 'address seems to be malformed'\nexport const CHECKSUM_ADDRESS_ERROR_MSG = 'wrong checksum for address'\n\nexport function checksumFromPublicKey(publicKey: Uint8Array): Uint8Array {\n  return Uint8Array.from(sha512.sha512_256.array(publicKey).slice(HASH_BYTES_LENGTH - CHECKSUM_BYTE_LENGTH, HASH_BYTES_LENGTH))\n}\n\nfunction genericHash(arr: sha512.Message) {\n  return sha512.sha512_256.array(arr)\n}\n\nfunction bytesToHex(bytes: Uint8Array): string {\n  return Buffer.from(bytes).toString('hex')\n}\n\nexport function encodeUint64(num: number | bigint) {\n  const isInteger = typeof num === 'bigint' || Number.isInteger(num)\n\n  if (!isInteger || num < 0 || num > BigInt('0xffffffffffffffff')) {\n    throw new Error('Input is not a 64-bit unsigned integer')\n  }\n\n  const encoding = new Uint8Array(8)\n  const view = new DataView(encoding.buffer)\n  view.setBigUint64(0, BigInt(num))\n\n  return encoding\n}\n\n/** Symbol used for instanceof checks across packages (CJS/ESM) */\nconst ADDR_SYMBOL = Symbol.for('algokit_common:Address')\n\n/**\n * Represents an Algorand address\n */\nexport class Address {\n  /**\n   * The binary form of the address. For standard accounts, this is the public key.\n   */\n  public readonly publicKey: Uint8Array;\n\n  /** @internal */\n  [ADDR_SYMBOL]: boolean\n\n  /**\n   * Create a new Address object from its binary form.\n   * @param publicKey - The binary form of the address. Must be 32 bytes.\n   */\n  constructor(publicKey: Uint8Array) {\n    this[ADDR_SYMBOL] = true\n    if (publicKey.length !== ALGORAND_ADDRESS_BYTE_LENGTH - ALGORAND_CHECKSUM_BYTE_LENGTH)\n      throw new Error(`${MALFORMED_ADDRESS_ERROR_MSG}: 0x${bytesToHex(publicKey)}, length ${publicKey.length}`)\n    this.publicKey = publicKey\n  }\n\n  /**\n   * Check if the address is equal to another address.\n   */\n  equals(other: Address): boolean {\n    return other instanceof Address && arrayEqual(this.publicKey, other.publicKey)\n  }\n\n  /**\n   * Compute the 4 byte checksum of the address.\n   */\n  checksum(): Uint8Array {\n    return checksumFromPublicKey(this.publicKey)\n  }\n\n  /**\n   * Encode the address into a string form.\n   */\n  toString(): string {\n    const addr = base32.encode(concatArrays(this.publicKey, this.checksum()))\n    return addr.slice(0, ALGORAND_ADDRESS_LENGTH) // removing the extra '===='\n  }\n\n  /**\n   * Decode an address from a string.\n   * @param address - The address to decode. Must be 58 characters long.\n   * @returns An Address object corresponding to the input string.\n   */\n  static fromString(address: string): Address {\n    if (typeof address !== 'string') throw new Error(`${MALFORMED_ADDRESS_ERROR_MSG}: expected string, got ${typeof address}, ${address}`)\n    if (address.length !== ALGORAND_ADDRESS_LENGTH)\n      throw new Error(`${MALFORMED_ADDRESS_ERROR_MSG}: expected length ${ALGORAND_ADDRESS_LENGTH}, got ${address.length}: ${address}`)\n\n    // try to decode\n    const decoded = base32.decode.asBytes(address)\n    // Sanity check\n    if (decoded.length !== ALGORAND_ADDRESS_BYTE_LENGTH)\n      throw new Error(`${MALFORMED_ADDRESS_ERROR_MSG}: expected byte length ${ALGORAND_ADDRESS_BYTE_LENGTH}, got ${decoded.length}`)\n\n    // Find publickey and checksum\n    const pk = new Uint8Array(decoded.slice(0, ALGORAND_ADDRESS_BYTE_LENGTH - ALGORAND_CHECKSUM_BYTE_LENGTH))\n    const cs = new Uint8Array(decoded.slice(ALGORAND_ADDRESS_BYTE_LENGTH - ALGORAND_CHECKSUM_BYTE_LENGTH, ALGORAND_ADDRESS_BYTE_LENGTH))\n    const checksum = checksumFromPublicKey(pk)\n    // Check if the checksum and the address are equal\n    if (!arrayEqual(checksum, cs)) throw new Error(`${CHECKSUM_ADDRESS_ERROR_MSG}: ${address} (${cs}, ${checksum})`)\n\n    return new Address(pk)\n  }\n\n  /**\n   * Get the zero address.\n   */\n  static zeroAddress(): Address {\n    return new Address(new Uint8Array(ALGORAND_ADDRESS_BYTE_LENGTH - ALGORAND_CHECKSUM_BYTE_LENGTH))\n  }\n\n  static [Symbol.hasInstance](obj: unknown) {\n    return Boolean(obj && typeof obj === 'object' && ADDR_SYMBOL in obj && obj[ADDR_SYMBOL as keyof typeof obj])\n  }\n}\n\nexport interface Addressable {\n  addr: Readonly<Address>\n}\n\nexport type ReadableAddress = Addressable | Address | string\n\nexport function getAddress(addr: ReadableAddress): Address {\n  if (typeof addr == 'string') {\n    return Address.fromString(addr)\n  } else if ('addr' in addr) {\n    return addr.addr\n  } else {\n    return addr\n  }\n}\n\nexport function getOptionalAddress(addr: ReadableAddress | undefined): Address | undefined {\n  if (addr === undefined) {\n    return undefined\n  }\n  return getAddress(addr)\n}\n\n/**\n * isValidAddress checks if a string is a valid Algorand address.\n * @param address - an Algorand address with checksum.\n * @returns true if valid, false otherwise\n */\nexport function isValidAddress(address: string): boolean {\n  // Try to decode\n  try {\n    Address.fromString(address)\n  } catch {\n    return false\n  }\n  return true\n}\n\nconst APP_ID_PREFIX = new TextEncoder().encode('appID')\n\n/**\n * Get the escrow address of an application.\n * @param appID - The ID of the application.\n * @returns The address corresponding to that application's escrow account.\n */\nexport function getApplicationAddress(appID: number | bigint): Address {\n  const toBeSigned = concatArrays(APP_ID_PREFIX, encodeUint64(appID))\n  const hash = genericHash(toBeSigned)\n  return new Address(Uint8Array.from(hash))\n}\n\n/**\n * decodeAddress takes an Algorand address in string form and decodes it into a Uint8Array.\n * @param address - an Algorand address with checksum.\n * @returns the decoded form of the address's public key and checksum\n */\nexport function decodeAddress(address: string): Address {\n  return Address.fromString(address)\n}\n\n/**\n * encodeAddress takes an Algorand address as a Uint8Array and encodes it into a string with checksum.\n * @param address - a raw Algorand address\n * @returns the address and checksum encoded as a string.\n */\nexport function encodeAddress(address: Uint8Array): string {\n  return new Address(address).toString()\n}\n"],"mappings":";;;;;;;;;AAKA,MAAa,+BAA+B;AAC5C,MAAa,gCAAgC;AAC7C,MAAa,0BAA0B;AACvC,MAAa,+BAA+B;AAE5C,MAAa,8BAA8B;AAC3C,MAAa,6BAA6B;AAE1C,SAAgB,sBAAsB,WAAmC;AACvE,QAAO,WAAW,KAAKA,kBAAO,WAAW,MAAM,UAAU,CAAC,MAAMC,sCAAoBC,wCAAsBD,oCAAkB,CAAC;;AAG/H,SAAS,YAAY,KAAqB;AACxC,QAAOD,kBAAO,WAAW,MAAM,IAAI;;AAGrC,SAAS,WAAW,OAA2B;AAC7C,QAAO,OAAO,KAAK,MAAM,CAAC,SAAS,MAAM;;AAG3C,SAAgB,aAAa,KAAsB;AAGjD,KAAI,EAFc,OAAO,QAAQ,YAAY,OAAO,UAAU,IAAI,KAEhD,MAAM,KAAK,MAAM,OAAO,qBAAqB,CAC7D,OAAM,IAAI,MAAM,yCAAyC;CAG3D,MAAM,WAAW,IAAI,WAAW,EAAE;AAElC,CADa,IAAI,SAAS,SAAS,OAAO,CACrC,aAAa,GAAG,OAAO,IAAI,CAAC;AAEjC,QAAO;;;AAIT,MAAM,cAAc,OAAO,IAAI,yBAAyB;;;;AAKxD,IAAa,UAAb,MAAa,QAAQ;;;;CAInB,AAAgB;;CAGhB,CAAC;;;;;CAMD,YAAY,WAAuB;AACjC,OAAK,eAAe;AACpB,MAAI,UAAU,WAAW,+BAA+B,8BACtD,OAAM,IAAI,MAAM,GAAG,4BAA4B,MAAM,WAAW,UAAU,CAAC,WAAW,UAAU,SAAS;AAC3G,OAAK,YAAY;;;;;CAMnB,OAAO,OAAyB;AAC9B,SAAO,iBAAiB,WAAWG,yBAAW,KAAK,WAAW,MAAM,UAAU;;;;;CAMhF,WAAuB;AACrB,SAAO,sBAAsB,KAAK,UAAU;;;;;CAM9C,WAAmB;AAEjB,SADaC,kBAAO,OAAOC,2BAAa,KAAK,WAAW,KAAK,UAAU,CAAC,CAAC,CAC7D,MAAM,GAAG,wBAAwB;;;;;;;CAQ/C,OAAO,WAAW,SAA0B;AAC1C,MAAI,OAAO,YAAY,SAAU,OAAM,IAAI,MAAM,GAAG,4BAA4B,yBAAyB,OAAO,QAAQ,IAAI,UAAU;AACtI,MAAI,QAAQ,WAAW,wBACrB,OAAM,IAAI,MAAM,GAAG,4BAA4B,oBAAoB,wBAAwB,QAAQ,QAAQ,OAAO,IAAI,UAAU;EAGlI,MAAM,UAAUD,kBAAO,OAAO,QAAQ,QAAQ;AAE9C,MAAI,QAAQ,WAAW,6BACrB,OAAM,IAAI,MAAM,GAAG,4BAA4B,yBAAyB,6BAA6B,QAAQ,QAAQ,SAAS;EAGhI,MAAM,KAAK,IAAI,WAAW,QAAQ,MAAM,GAAG,+BAA+B,8BAA8B,CAAC;EACzG,MAAM,KAAK,IAAI,WAAW,QAAQ,MAAM,+BAA+B,+BAA+B,6BAA6B,CAAC;EACpI,MAAM,WAAW,sBAAsB,GAAG;AAE1C,MAAI,CAACD,yBAAW,UAAU,GAAG,CAAE,OAAM,IAAI,MAAM,GAAG,2BAA2B,IAAI,QAAQ,IAAI,GAAG,IAAI,SAAS,GAAG;AAEhH,SAAO,IAAI,QAAQ,GAAG;;;;;CAMxB,OAAO,cAAuB;AAC5B,SAAO,IAAI,QAAQ,IAAI,WAAW,+BAA+B,8BAA8B,CAAC;;CAGlG,QAAQ,OAAO,aAAa,KAAc;AACxC,SAAO,QAAQ,OAAO,OAAO,QAAQ,YAAY,eAAe,OAAO,IAAI,aAAiC;;;AAUhH,SAAgB,WAAW,MAAgC;AACzD,KAAI,OAAO,QAAQ,SACjB,QAAO,QAAQ,WAAW,KAAK;UACtB,UAAU,KACnB,QAAO,KAAK;KAEZ,QAAO;;AAIX,SAAgB,mBAAmB,MAAwD;AACzF,KAAI,SAAS,OACX;AAEF,QAAO,WAAW,KAAK;;;;;;;AAQzB,SAAgB,eAAe,SAA0B;AAEvD,KAAI;AACF,UAAQ,WAAW,QAAQ;SACrB;AACN,SAAO;;AAET,QAAO;;AAGT,MAAM,gBAAgB,IAAI,aAAa,CAAC,OAAO,QAAQ;;;;;;AAOvD,SAAgB,sBAAsB,OAAiC;CAErE,MAAM,OAAO,YADME,2BAAa,eAAe,aAAa,MAAM,CAAC,CAC/B;AACpC,QAAO,IAAI,QAAQ,WAAW,KAAK,KAAK,CAAC;;;;;;;AAQ3C,SAAgB,cAAc,SAA0B;AACtD,QAAO,QAAQ,WAAW,QAAQ;;;;;;;AAQpC,SAAgB,cAAc,SAA6B;AACzD,QAAO,IAAI,QAAQ,QAAQ,CAAC,UAAU"}