From d5354a30abd002d4cc89658c63e09e8497197b32 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 30 Apr 2025 20:47:34 +0000 Subject: [PATCH 1/4] chore(deps): bump the all group across 1 directory with 16 updates Bumps the all group with 16 updates in the / directory: | Package | From | To | | --- | --- | --- | | [@commitlint/cli](https://github.com/conventional-changelog/commitlint/tree/HEAD/@commitlint/cli) | `19.6.0` | `19.8.0` | | [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/HEAD/@commitlint/config-conventional) | `19.6.0` | `19.8.0` | | [@eslint/js](https://github.com/eslint/eslint/tree/HEAD/packages/js) | `9.15.0` | `9.25.1` | | [@tsconfig/node20](https://github.com/tsconfig/bases/tree/HEAD/bases) | `20.1.4` | `20.1.5` | | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) | `8.16.0` | `8.31.1` | | [algosdk](https://github.com/algorand/js-algorand-sdk) | `3.0.0` | `3.2.0` | | [eslint](https://github.com/eslint/eslint) | `9.15.0` | `9.25.1` | | [fast-glob](https://github.com/mrmlnc/fast-glob) | `3.3.2` | `3.3.3` | | [magic-string](https://github.com/rich-harris/magic-string) | `0.30.13` | `0.30.17` | | [prettier](https://github.com/prettier/prettier) | `3.3.3` | `3.5.3` | | [rollup](https://github.com/rollup/rollup) | `4.40.0` | `4.40.1` | | [semantic-release](https://github.com/semantic-release/semantic-release) | `24.2.0` | `24.2.3` | | [typedoc](https://github.com/TypeStrong/TypeDoc) | `0.25.13` | `0.28.3` | | [typescript](https://github.com/microsoft/TypeScript) | `5.4.5` | `5.8.3` | | [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/typescript-eslint) | `8.16.0` | `8.31.1` | | [vitest-fetch-mock](https://github.com/IanVS/vitest-fetch-mock) | `0.3.0` | `0.4.5` | Updates `@commitlint/cli` from 19.6.0 to 19.8.0 - [Release notes](https://github.com/conventional-changelog/commitlint/releases) - [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/cli/CHANGELOG.md) - [Commits](https://github.com/conventional-changelog/commitlint/commits/v19.8.0/@commitlint/cli) Updates `@commitlint/config-conventional` from 19.6.0 to 19.8.0 - [Release notes](https://github.com/conventional-changelog/commitlint/releases) - [Changelog](https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/config-conventional/CHANGELOG.md) - [Commits](https://github.com/conventional-changelog/commitlint/commits/v19.8.0/@commitlint/config-conventional) Updates `@eslint/js` from 9.15.0 to 9.25.1 - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/commits/v9.25.1/packages/js) Updates `@tsconfig/node20` from 20.1.4 to 20.1.5 - [Commits](https://github.com/tsconfig/bases/commits/HEAD/bases) Updates `@typescript-eslint/eslint-plugin` from 8.16.0 to 8.31.1 - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.31.1/packages/eslint-plugin) Updates `algosdk` from 3.0.0 to 3.2.0 - [Release notes](https://github.com/algorand/js-algorand-sdk/releases) - [Changelog](https://github.com/algorand/js-algorand-sdk/blob/main/CHANGELOG.md) - [Commits](https://github.com/algorand/js-algorand-sdk/compare/v3.0.0...v3.2.0) Updates `eslint` from 9.15.0 to 9.25.1 - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/compare/v9.15.0...v9.25.1) Updates `fast-glob` from 3.3.2 to 3.3.3 - [Release notes](https://github.com/mrmlnc/fast-glob/releases) - [Commits](https://github.com/mrmlnc/fast-glob/compare/3.3.2...3.3.3) Updates `magic-string` from 0.30.13 to 0.30.17 - [Changelog](https://github.com/Rich-Harris/magic-string/blob/master/CHANGELOG.md) - [Commits](https://github.com/rich-harris/magic-string/compare/v0.30.13...v0.30.17) Updates `prettier` from 3.3.3 to 3.5.3 - [Release notes](https://github.com/prettier/prettier/releases) - [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md) - [Commits](https://github.com/prettier/prettier/compare/3.3.3...3.5.3) Updates `rollup` from 4.40.0 to 4.40.1 - [Release notes](https://github.com/rollup/rollup/releases) - [Changelog](https://github.com/rollup/rollup/blob/master/CHANGELOG.md) - [Commits](https://github.com/rollup/rollup/compare/v4.40.0...v4.40.1) Updates `semantic-release` from 24.2.0 to 24.2.3 - [Release notes](https://github.com/semantic-release/semantic-release/releases) - [Commits](https://github.com/semantic-release/semantic-release/compare/v24.2.0...v24.2.3) Updates `typedoc` from 0.25.13 to 0.28.3 - [Release notes](https://github.com/TypeStrong/TypeDoc/releases) - [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md) - [Commits](https://github.com/TypeStrong/TypeDoc/compare/v0.25.13...v0.28.3) Updates `typescript` from 5.4.5 to 5.8.3 - [Release notes](https://github.com/microsoft/TypeScript/releases) - [Changelog](https://github.com/microsoft/TypeScript/blob/main/azure-pipelines.release-publish.yml) - [Commits](https://github.com/microsoft/TypeScript/compare/v5.4.5...v5.8.3) Updates `typescript-eslint` from 8.16.0 to 8.31.1 - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/typescript-eslint/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.31.1/packages/typescript-eslint) Updates `vitest-fetch-mock` from 0.3.0 to 0.4.5 - [Release notes](https://github.com/IanVS/vitest-fetch-mock/releases) - [Commits](https://github.com/IanVS/vitest-fetch-mock/compare/v0.3.0...v0.4.5) --- updated-dependencies: - dependency-name: "@commitlint/cli" dependency-version: 19.8.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: "@commitlint/config-conventional" dependency-version: 19.8.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: "@eslint/js" dependency-version: 9.25.1 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: "@tsconfig/node20" dependency-version: 20.1.5 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: all - dependency-name: "@typescript-eslint/eslint-plugin" dependency-version: 8.31.1 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: algosdk dependency-version: 3.2.0 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: eslint dependency-version: 9.25.1 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: fast-glob dependency-version: 3.3.3 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: all - dependency-name: magic-string dependency-version: 0.30.17 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: all - dependency-name: prettier dependency-version: 3.5.3 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: rollup dependency-version: 4.40.1 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: all - dependency-name: semantic-release dependency-version: 24.2.3 dependency-type: direct:development update-type: version-update:semver-patch dependency-group: all - dependency-name: typedoc dependency-version: 0.28.3 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: typescript dependency-version: 5.8.3 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: typescript-eslint dependency-version: 8.31.1 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all - dependency-name: vitest-fetch-mock dependency-version: 0.4.5 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: all ... Signed-off-by: dependabot[bot] --- package-lock.json | 994 +++++++++++++++++++++++++++------------------- package.json | 4 +- 2 files changed, 580 insertions(+), 418 deletions(-) diff --git a/package-lock.json b/package-lock.json index 9e498790..d9fff2e7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -41,13 +41,13 @@ "semantic-release": "^24.1.2", "tiny-invariant": "^1.3.1", "ts-node": "^10.9.1", - "typedoc": "^0.25.13", + "typedoc": "^0.28.3", "typedoc-plugin-markdown": "^3.17.1", "typescript": "^5.4.5", "typescript-eslint": "^8.16.0", "uuid": "^10.0.0", "vitest": "^2.1.2", - "vitest-fetch-mock": "^0.3.0" + "vitest-fetch-mock": "^0.4.5" }, "engines": { "node": ">=20.0" @@ -276,16 +276,17 @@ } }, "node_modules/@commitlint/cli": { - "version": "19.6.0", - "resolved": "https://registry.npmjs.org/@commitlint/cli/-/cli-19.6.0.tgz", - "integrity": "sha512-v17BgGD9w5KnthaKxXnEg6KLq6DYiAxyiN44TpiRtqyW8NSq+Kx99mkEG8Qo6uu6cI5eMzMojW2muJxjmPnF8w==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/cli/-/cli-19.8.0.tgz", + "integrity": "sha512-t/fCrLVu+Ru01h0DtlgHZXbHV2Y8gKocTR5elDOqIRUzQd0/6hpt2VIWOj9b3NDo7y4/gfxeR2zRtXq/qO6iUg==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/format": "^19.5.0", - "@commitlint/lint": "^19.6.0", - "@commitlint/load": "^19.5.0", - "@commitlint/read": "^19.5.0", - "@commitlint/types": "^19.5.0", + "@commitlint/format": "^19.8.0", + "@commitlint/lint": "^19.8.0", + "@commitlint/load": "^19.8.0", + "@commitlint/read": "^19.8.0", + "@commitlint/types": "^19.8.0", "tinyexec": "^0.3.0", "yargs": "^17.0.0" }, @@ -297,12 +298,13 @@ } }, "node_modules/@commitlint/config-conventional": { - "version": "19.6.0", - "resolved": "https://registry.npmjs.org/@commitlint/config-conventional/-/config-conventional-19.6.0.tgz", - "integrity": "sha512-DJT40iMnTYtBtUfw9ApbsLZFke1zKh6llITVJ+x9mtpHD08gsNXaIRqHTmwTZL3dNX5+WoyK7pCN/5zswvkBCQ==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/config-conventional/-/config-conventional-19.8.0.tgz", + "integrity": "sha512-9I2kKJwcAPwMoAj38hwqFXG0CzS2Kj+SAByPUQ0SlHTfb7VUhYVmo7G2w2tBrqmOf7PFd6MpZ/a1GQJo8na8kw==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/types": "^19.5.0", + "@commitlint/types": "^19.8.0", "conventional-changelog-conventionalcommits": "^7.0.2" }, "engines": { @@ -322,12 +324,13 @@ } }, "node_modules/@commitlint/config-validator": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/config-validator/-/config-validator-19.5.0.tgz", - "integrity": "sha512-CHtj92H5rdhKt17RmgALhfQt95VayrUo2tSqY9g2w+laAXyk7K/Ef6uPm9tn5qSIwSmrLjKaXK9eiNuxmQrDBw==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/config-validator/-/config-validator-19.8.0.tgz", + "integrity": "sha512-+r5ZvD/0hQC3w5VOHJhGcCooiAVdynFlCe2d6I9dU+PvXdV3O+fU4vipVg+6hyLbQUuCH82mz3HnT/cBQTYYuA==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/types": "^19.5.0", + "@commitlint/types": "^19.8.0", "ajv": "^8.11.0" }, "engines": { @@ -335,12 +338,13 @@ } }, "node_modules/@commitlint/ensure": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/ensure/-/ensure-19.5.0.tgz", - "integrity": "sha512-Kv0pYZeMrdg48bHFEU5KKcccRfKmISSm9MvgIgkpI6m+ohFTB55qZlBW6eYqh/XDfRuIO0x4zSmvBjmOwWTwkg==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/ensure/-/ensure-19.8.0.tgz", + "integrity": "sha512-kNiNU4/bhEQ/wutI1tp1pVW1mQ0QbAjfPRo5v8SaxoVV+ARhkB8Wjg3BSseNYECPzWWfg/WDqQGIfV1RaBFQZg==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/types": "^19.5.0", + "@commitlint/types": "^19.8.0", "lodash.camelcase": "^4.3.0", "lodash.kebabcase": "^4.1.1", "lodash.snakecase": "^4.1.1", @@ -352,21 +356,23 @@ } }, "node_modules/@commitlint/execute-rule": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/execute-rule/-/execute-rule-19.5.0.tgz", - "integrity": "sha512-aqyGgytXhl2ejlk+/rfgtwpPexYyri4t8/n4ku6rRJoRhGZpLFMqrZ+YaubeGysCP6oz4mMA34YSTaSOKEeNrg==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/execute-rule/-/execute-rule-19.8.0.tgz", + "integrity": "sha512-fuLeI+EZ9x2v/+TXKAjplBJWI9CNrHnyi5nvUQGQt4WRkww/d95oVRsc9ajpt4xFrFmqMZkd/xBQHZDvALIY7A==", "dev": true, + "license": "MIT", "engines": { "node": ">=v18" } }, "node_modules/@commitlint/format": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/format/-/format-19.5.0.tgz", - "integrity": "sha512-yNy088miE52stCI3dhG/vvxFo9e4jFkU1Mj3xECfzp/bIS/JUay4491huAlVcffOoMK1cd296q0W92NlER6r3A==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/format/-/format-19.8.0.tgz", + "integrity": "sha512-EOpA8IERpQstxwp/WGnDArA7S+wlZDeTeKi98WMOvaDLKbjptuHWdOYYr790iO7kTCif/z971PKPI2PkWMfOxg==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/types": "^19.5.0", + "@commitlint/types": "^19.8.0", "chalk": "^5.3.0" }, "engines": { @@ -374,10 +380,11 @@ } }, "node_modules/@commitlint/format/node_modules/chalk": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", - "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", + "version": "5.4.1", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.4.1.tgz", + "integrity": "sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w==", "dev": true, + "license": "MIT", "engines": { "node": "^12.17.0 || ^14.13 || >=16.0.0" }, @@ -386,12 +393,13 @@ } }, "node_modules/@commitlint/is-ignored": { - "version": "19.6.0", - "resolved": "https://registry.npmjs.org/@commitlint/is-ignored/-/is-ignored-19.6.0.tgz", - "integrity": "sha512-Ov6iBgxJQFR9koOupDPHvcHU9keFupDgtB3lObdEZDroiG4jj1rzky60fbQozFKVYRTUdrBGICHG0YVmRuAJmw==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/is-ignored/-/is-ignored-19.8.0.tgz", + "integrity": "sha512-L2Jv9yUg/I+jF3zikOV0rdiHUul9X3a/oU5HIXhAJLE2+TXTnEBfqYP9G5yMw/Yb40SnR764g4fyDK6WR2xtpw==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/types": "^19.5.0", + "@commitlint/types": "^19.8.0", "semver": "^7.6.0" }, "engines": { @@ -399,33 +407,35 @@ } }, "node_modules/@commitlint/lint": { - "version": "19.6.0", - "resolved": "https://registry.npmjs.org/@commitlint/lint/-/lint-19.6.0.tgz", - "integrity": "sha512-LRo7zDkXtcIrpco9RnfhOKeg8PAnE3oDDoalnrVU/EVaKHYBWYL1DlRR7+3AWn0JiBqD8yKOfetVxJGdEtZ0tg==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/lint/-/lint-19.8.0.tgz", + "integrity": "sha512-+/NZKyWKSf39FeNpqhfMebmaLa1P90i1Nrb1SrA7oSU5GNN/lksA4z6+ZTnsft01YfhRZSYMbgGsARXvkr/VLQ==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/is-ignored": "^19.6.0", - "@commitlint/parse": "^19.5.0", - "@commitlint/rules": "^19.6.0", - "@commitlint/types": "^19.5.0" + "@commitlint/is-ignored": "^19.8.0", + "@commitlint/parse": "^19.8.0", + "@commitlint/rules": "^19.8.0", + "@commitlint/types": "^19.8.0" }, "engines": { "node": ">=v18" } }, "node_modules/@commitlint/load": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/load/-/load-19.5.0.tgz", - "integrity": "sha512-INOUhkL/qaKqwcTUvCE8iIUf5XHsEPCLY9looJ/ipzi7jtGhgmtH7OOFiNvwYgH7mA8osUWOUDV8t4E2HAi4xA==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/load/-/load-19.8.0.tgz", + "integrity": "sha512-4rvmm3ff81Sfb+mcWT5WKlyOa+Hd33WSbirTVUer0wjS1Hv/Hzr07Uv1ULIV9DkimZKNyOwXn593c+h8lsDQPQ==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/config-validator": "^19.5.0", - "@commitlint/execute-rule": "^19.5.0", - "@commitlint/resolve-extends": "^19.5.0", - "@commitlint/types": "^19.5.0", + "@commitlint/config-validator": "^19.8.0", + "@commitlint/execute-rule": "^19.8.0", + "@commitlint/resolve-extends": "^19.8.0", + "@commitlint/types": "^19.8.0", "chalk": "^5.3.0", "cosmiconfig": "^9.0.0", - "cosmiconfig-typescript-loader": "^5.0.0", + "cosmiconfig-typescript-loader": "^6.1.0", "lodash.isplainobject": "^4.0.6", "lodash.merge": "^4.6.2", "lodash.uniq": "^4.5.0" @@ -435,10 +445,11 @@ } }, "node_modules/@commitlint/load/node_modules/chalk": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", - "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", + "version": "5.4.1", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.4.1.tgz", + "integrity": "sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w==", "dev": true, + "license": "MIT", "engines": { "node": "^12.17.0 || ^14.13 || >=16.0.0" }, @@ -447,21 +458,23 @@ } }, "node_modules/@commitlint/message": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/message/-/message-19.5.0.tgz", - "integrity": "sha512-R7AM4YnbxN1Joj1tMfCyBryOC5aNJBdxadTZkuqtWi3Xj0kMdutq16XQwuoGbIzL2Pk62TALV1fZDCv36+JhTQ==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/message/-/message-19.8.0.tgz", + "integrity": "sha512-qs/5Vi9bYjf+ZV40bvdCyBn5DvbuelhR6qewLE8Bh476F7KnNyLfdM/ETJ4cp96WgeeHo6tesA2TMXS0sh5X4A==", "dev": true, + "license": "MIT", "engines": { "node": ">=v18" } }, "node_modules/@commitlint/parse": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/parse/-/parse-19.5.0.tgz", - "integrity": "sha512-cZ/IxfAlfWYhAQV0TwcbdR1Oc0/r0Ik1GEessDJ3Lbuma/MRO8FRQX76eurcXtmhJC//rj52ZSZuXUg0oIX0Fw==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/parse/-/parse-19.8.0.tgz", + "integrity": "sha512-YNIKAc4EXvNeAvyeEnzgvm1VyAe0/b3Wax7pjJSwXuhqIQ1/t2hD3OYRXb6D5/GffIvaX82RbjD+nWtMZCLL7Q==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/types": "^19.5.0", + "@commitlint/types": "^19.8.0", "conventional-changelog-angular": "^7.0.0", "conventional-commits-parser": "^5.0.0" }, @@ -470,13 +483,14 @@ } }, "node_modules/@commitlint/read": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/read/-/read-19.5.0.tgz", - "integrity": "sha512-TjS3HLPsLsxFPQj6jou8/CZFAmOP2y+6V4PGYt3ihbQKTY1Jnv0QG28WRKl/d1ha6zLODPZqsxLEov52dhR9BQ==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/read/-/read-19.8.0.tgz", + "integrity": "sha512-6ywxOGYajcxK1y1MfzrOnwsXO6nnErna88gRWEl3qqOOP8MDu/DTeRkGLXBFIZuRZ7mm5yyxU5BmeUvMpNte5w==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/top-level": "^19.5.0", - "@commitlint/types": "^19.5.0", + "@commitlint/top-level": "^19.8.0", + "@commitlint/types": "^19.8.0", "git-raw-commits": "^4.0.0", "minimist": "^1.2.8", "tinyexec": "^0.3.0" @@ -486,13 +500,14 @@ } }, "node_modules/@commitlint/resolve-extends": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/resolve-extends/-/resolve-extends-19.5.0.tgz", - "integrity": "sha512-CU/GscZhCUsJwcKTJS9Ndh3AKGZTNFIOoQB2n8CmFnizE0VnEuJoum+COW+C1lNABEeqk6ssfc1Kkalm4bDklA==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/resolve-extends/-/resolve-extends-19.8.0.tgz", + "integrity": "sha512-CLanRQwuG2LPfFVvrkTrBR/L/DMy3+ETsgBqW1OvRxmzp/bbVJW0Xw23LnnExgYcsaFtos967lul1CsbsnJlzQ==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/config-validator": "^19.5.0", - "@commitlint/types": "^19.5.0", + "@commitlint/config-validator": "^19.8.0", + "@commitlint/types": "^19.8.0", "global-directory": "^4.0.1", "import-meta-resolve": "^4.0.0", "lodash.mergewith": "^4.6.2", @@ -503,34 +518,37 @@ } }, "node_modules/@commitlint/rules": { - "version": "19.6.0", - "resolved": "https://registry.npmjs.org/@commitlint/rules/-/rules-19.6.0.tgz", - "integrity": "sha512-1f2reW7lbrI0X0ozZMesS/WZxgPa4/wi56vFuJENBmed6mWq5KsheN/nxqnl/C23ioxpPO/PL6tXpiiFy5Bhjw==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/rules/-/rules-19.8.0.tgz", + "integrity": "sha512-IZ5IE90h6DSWNuNK/cwjABLAKdy8tP8OgGVGbXe1noBEX5hSsu00uRlLu6JuruiXjWJz2dZc+YSw3H0UZyl/mA==", "dev": true, + "license": "MIT", "dependencies": { - "@commitlint/ensure": "^19.5.0", - "@commitlint/message": "^19.5.0", - "@commitlint/to-lines": "^19.5.0", - "@commitlint/types": "^19.5.0" + "@commitlint/ensure": "^19.8.0", + "@commitlint/message": "^19.8.0", + "@commitlint/to-lines": "^19.8.0", + "@commitlint/types": "^19.8.0" }, "engines": { "node": ">=v18" } }, "node_modules/@commitlint/to-lines": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/to-lines/-/to-lines-19.5.0.tgz", - "integrity": "sha512-R772oj3NHPkodOSRZ9bBVNq224DOxQtNef5Pl8l2M8ZnkkzQfeSTr4uxawV2Sd3ui05dUVzvLNnzenDBO1KBeQ==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/to-lines/-/to-lines-19.8.0.tgz", + "integrity": "sha512-3CKLUw41Cur8VMjh16y8LcsOaKbmQjAKCWlXx6B0vOUREplp6em9uIVhI8Cv934qiwkbi2+uv+mVZPnXJi1o9A==", "dev": true, + "license": "MIT", "engines": { "node": ">=v18" } }, "node_modules/@commitlint/top-level": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/top-level/-/top-level-19.5.0.tgz", - "integrity": "sha512-IP1YLmGAk0yWrImPRRc578I3dDUI5A2UBJx9FbSOjxe9sTlzFiwVJ+zeMLgAtHMtGZsC8LUnzmW1qRemkFU4ng==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/top-level/-/top-level-19.8.0.tgz", + "integrity": "sha512-Rphgoc/omYZisoNkcfaBRPQr4myZEHhLPx2/vTXNLjiCw4RgfPR1wEgUpJ9OOmDCiv5ZyIExhprNLhteqH4FuQ==", "dev": true, + "license": "MIT", "dependencies": { "find-up": "^7.0.0" }, @@ -543,6 +561,7 @@ "resolved": "https://registry.npmjs.org/find-up/-/find-up-7.0.0.tgz", "integrity": "sha512-YyZM99iHrqLKjmt4LJDj58KI+fYyufRLBSYcqycxf//KpBk9FoewoGX0450m9nB44qrZnovzC2oeP5hUibxc/g==", "dev": true, + "license": "MIT", "dependencies": { "locate-path": "^7.2.0", "path-exists": "^5.0.0", @@ -560,6 +579,7 @@ "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-7.2.0.tgz", "integrity": "sha512-gvVijfZvn7R+2qyPX8mAuKcFGDf6Nc61GdvGafQsHL0sBIxfKzA+usWn4GFC/bk+QdwPUD4kWFJLhElipq+0VA==", "dev": true, + "license": "MIT", "dependencies": { "p-locate": "^6.0.0" }, @@ -575,6 +595,7 @@ "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-4.0.0.tgz", "integrity": "sha512-5b0R4txpzjPWVw/cXXUResoD4hb6U/x9BH08L7nw+GN1sezDzPdxeRvpc9c433fZhBan/wusjbCsqwqm4EIBIQ==", "dev": true, + "license": "MIT", "dependencies": { "yocto-queue": "^1.0.0" }, @@ -590,6 +611,7 @@ "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-6.0.0.tgz", "integrity": "sha512-wPrq66Llhl7/4AGC6I+cqxT07LhXvWL08LNXz1fENOw0Ap4sRZZ/gZpTTJ5jpurzzzfS2W/Ge9BY3LgLjCShcw==", "dev": true, + "license": "MIT", "dependencies": { "p-limit": "^4.0.0" }, @@ -605,15 +627,17 @@ "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-5.0.0.tgz", "integrity": "sha512-RjhtfwJOxzcFmNOi6ltcbcu4Iu+FL3zEj83dk4kAS+fVpTxXLO1b38RvJgT/0QwvV/L3aY9TAnyv0EOqW4GoMQ==", "dev": true, + "license": "MIT", "engines": { "node": "^12.20.0 || ^14.13.1 || >=16.0.0" } }, "node_modules/@commitlint/top-level/node_modules/yocto-queue": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.1.1.tgz", - "integrity": "sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.2.1.tgz", + "integrity": "sha512-AyeEbWOu/TAXdxlV9wmGcR0+yh2j3vYPGOECcIj2S7MkrLyC7ne+oye2BKTItt0ii2PHk4cDy+95+LshzbXnGg==", "dev": true, + "license": "MIT", "engines": { "node": ">=12.20" }, @@ -622,10 +646,11 @@ } }, "node_modules/@commitlint/types": { - "version": "19.5.0", - "resolved": "https://registry.npmjs.org/@commitlint/types/-/types-19.5.0.tgz", - "integrity": "sha512-DSHae2obMSMkAtTBSOulg5X7/z+rGLxcXQIkg3OmWvY6wifojge5uVMydfhUvs7yQj+V7jNmRZ2Xzl8GJyqRgg==", + "version": "19.8.0", + "resolved": "https://registry.npmjs.org/@commitlint/types/-/types-19.8.0.tgz", + "integrity": "sha512-LRjP623jPyf3Poyfb0ohMj8I3ORyBDOwXAgxxVPbSD0unJuW2mJWeiRfaQinjtccMqC5Wy1HOMfa4btKjbNxbg==", "dev": true, + "license": "MIT", "dependencies": { "@types/conventional-commits-parser": "^5.0.0", "chalk": "^5.3.0" @@ -1094,13 +1119,13 @@ } }, "node_modules/@eslint/config-array": { - "version": "0.19.0", - "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.19.0.tgz", - "integrity": "sha512-zdHg2FPIFNKPdcHWtiNT+jEFCHYVplAXRDlQDyqy0zGx/q2parwh7brGJSiTxRk/TSMkbM//zt/f5CHgyTyaSQ==", + "version": "0.20.0", + "resolved": "https://registry.npmjs.org/@eslint/config-array/-/config-array-0.20.0.tgz", + "integrity": "sha512-fxlS1kkIjx8+vy2SjuCB94q3htSNrufYTXubwiBFeaQHbH6Ipi43gFJq2zCMt6PHhImH3Xmr0NksKDvchWlpQQ==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@eslint/object-schema": "^2.1.4", + "@eslint/object-schema": "^2.1.6", "debug": "^4.3.1", "minimatch": "^3.1.2" }, @@ -1132,20 +1157,33 @@ "node": "*" } }, + "node_modules/@eslint/config-helpers": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.2.1.tgz", + "integrity": "sha512-RI17tsD2frtDu/3dmI7QRrD4bedNKPM08ziRYaC5AhkGrzIAJelm9kJU1TznK+apx6V+cqRz8tfpEeG3oIyjxw==", + "dev": true, + "license": "Apache-2.0", + "engines": { + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + } + }, "node_modules/@eslint/core": { - "version": "0.9.0", - "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.9.0.tgz", - "integrity": "sha512-7ATR9F0e4W85D/0w7cU0SNj7qkAexMG+bAHEZOjo9akvGuhHE2m7umzWzfnpa0XAg5Kxc1BWmtPMV67jJ+9VUg==", + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.13.0.tgz", + "integrity": "sha512-yfkgDw1KR66rkT5A8ci4irzDysN7FRpq3ttJolR88OqQikAWqwA8j5VZyas+vjyBNFIJ7MfybJ9plMILI2UrCw==", "dev": true, "license": "Apache-2.0", + "dependencies": { + "@types/json-schema": "^7.0.15" + }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, "node_modules/@eslint/eslintrc": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.2.0.tgz", - "integrity": "sha512-grOjVNN8P3hjJn/eIETF1wwd12DdnwFDoyceUJLYYdkpbwq3nLi+4fqrTAONx7XDALqlL220wC/RHSC/QTI/0w==", + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-3.3.1.tgz", + "integrity": "sha512-gtF186CXhIl1p4pJNGZw8Yc6RlshoePRvE0X91oPGb3vZ8pM3qOS9W9NGPat9LziaBV7XrJWGylNQXkGcnM3IQ==", "dev": true, "license": "MIT", "dependencies": { @@ -1215,9 +1253,9 @@ } }, "node_modules/@eslint/js": { - "version": "9.15.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.15.0.tgz", - "integrity": "sha512-tMTqrY+EzbXmKJR5ToI8lxu7jaN5EdmrBFJpQk5JmSlyLsx6o4t27r883K5xsLuCYCpfKBCGswMSWXsM+jB7lg==", + "version": "9.25.1", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.25.1.tgz", + "integrity": "sha512-dEIwmjntEx8u3Uvv+kr3PDeeArL8Hw07H9kyYxCjnM9pBjfEhk6uLXSchxxzgiwtRhhzVzqmUSDFBOi1TuZ7qg==", "dev": true, "license": "MIT", "engines": { @@ -1225,9 +1263,9 @@ } }, "node_modules/@eslint/object-schema": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.4.tgz", - "integrity": "sha512-BsWiH1yFGjXXS2yvrf5LyuoSIIbPrGUWob917o+BTKuZ7qJdxX8aJLRxs1fS9n6r7vESrq1OUqb68dANcFXuQQ==", + "version": "2.1.6", + "resolved": "https://registry.npmjs.org/@eslint/object-schema/-/object-schema-2.1.6.tgz", + "integrity": "sha512-RBMg5FRL0I0gs51M/guSAj5/e14VQ4tpZnQNWwuDT66P14I43ItmPfIZRhO9fUVIPOAQXU47atlywZ/czoqFPA==", "dev": true, "license": "Apache-2.0", "engines": { @@ -1235,18 +1273,33 @@ } }, "node_modules/@eslint/plugin-kit": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.2.3.tgz", - "integrity": "sha512-2b/g5hRmpbb1o4GnTZax9N9m0FXzz9OV42ZzI4rDDMDuHUqigAiQCEWChBWCY4ztAGVRjoWT19v0yMmc5/L5kA==", + "version": "0.2.8", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.2.8.tgz", + "integrity": "sha512-ZAoA40rNMPwSm+AeHpCq8STiNAwzWLJuP8Xv4CHIc9wv/PSuExjMrmjfYNj682vW0OOiZ1HKxzvjQr9XZIisQA==", "dev": true, "license": "Apache-2.0", "dependencies": { + "@eslint/core": "^0.13.0", "levn": "^0.4.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, + "node_modules/@gerrit0/mini-shiki": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.3.0.tgz", + "integrity": "sha512-frvArO0+s5Viq68uSod5SieLPVM2cLpXoQ1e07lURwgADXpL/MOypM7jPz9otks0g2DIe2YedDAeVrDyYJZRxA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/engine-oniguruma": "^3.3.0", + "@shikijs/langs": "^3.3.0", + "@shikijs/themes": "^3.3.0", + "@shikijs/types": "^3.3.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, "node_modules/@humanfs/core": { "version": "0.19.1", "resolved": "https://registry.npmjs.org/@humanfs/core/-/core-0.19.1.tgz", @@ -1299,9 +1352,9 @@ } }, "node_modules/@humanwhocodes/retry": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.4.1.tgz", - "integrity": "sha512-c7hNEllBlenFTHBky65mhq8WD2kbN9Q6gk0bTk8lSBvc554jpXSkST1iePudpt7+A/AQvuHs9EMqjHDXMY1lrA==", + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/@humanwhocodes/retry/-/retry-0.4.2.tgz", + "integrity": "sha512-xeO57FpIu4p1Ri3Jq/EXq4ClRm86dVF2z/+kvFnyqVYRavTZmaFaUBbWCOuuTh0o/g7DSsk6kc2vrS4Vl5oPOQ==", "dev": true, "license": "Apache-2.0", "engines": { @@ -1792,9 +1845,9 @@ } }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.40.0.tgz", - "integrity": "sha512-+Fbls/diZ0RDerhE8kyC6hjADCXA1K4yVNlH0EYfd2XjyH0UGgzaQ8MlT0pCXAThfxv3QUAczHaL+qSv1E4/Cg==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.40.1.tgz", + "integrity": "sha512-kxz0YeeCrRUHz3zyqvd7n+TVRlNyTifBsmnmNPtk3hQURUyG9eAB+usz6DAwagMusjx/zb3AjvDUvhFGDAexGw==", "cpu": [ "arm" ], @@ -1806,9 +1859,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.40.0.tgz", - "integrity": "sha512-PPA6aEEsTPRz+/4xxAmaoWDqh67N7wFbgFUJGMnanCFs0TV99M0M8QhhaSCks+n6EbQoFvLQgYOGXxlMGQe/6w==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.40.1.tgz", + "integrity": "sha512-PPkxTOisoNC6TpnDKatjKkjRMsdaWIhyuMkA4UsBXT9WEZY4uHezBTjs6Vl4PbqQQeu6oION1w2voYZv9yquCw==", "cpu": [ "arm64" ], @@ -1820,9 +1873,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.40.0.tgz", - "integrity": "sha512-GwYOcOakYHdfnjjKwqpTGgn5a6cUX7+Ra2HeNj/GdXvO2VJOOXCiYYlRFU4CubFM67EhbmzLOmACKEfvp3J1kQ==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.40.1.tgz", + "integrity": "sha512-VWXGISWFY18v/0JyNUy4A46KCFCb9NVsH+1100XP31lud+TzlezBbz24CYzbnA4x6w4hx+NYCXDfnvDVO6lcAA==", "cpu": [ "arm64" ], @@ -1834,9 +1887,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.40.0.tgz", - "integrity": "sha512-CoLEGJ+2eheqD9KBSxmma6ld01czS52Iw0e2qMZNpPDlf7Z9mj8xmMemxEucinev4LgHalDPczMyxzbq+Q+EtA==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.40.1.tgz", + "integrity": "sha512-nIwkXafAI1/QCS7pxSpv/ZtFW6TXcNUEHAIA9EIyw5OzxJZQ1YDrX+CL6JAIQgZ33CInl1R6mHet9Y/UZTg2Bw==", "cpu": [ "x64" ], @@ -1848,9 +1901,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-arm64": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.40.0.tgz", - "integrity": "sha512-r7yGiS4HN/kibvESzmrOB/PxKMhPTlz+FcGvoUIKYoTyGd5toHp48g1uZy1o1xQvybwwpqpe010JrcGG2s5nkg==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.40.1.tgz", + "integrity": "sha512-BdrLJ2mHTrIYdaS2I99mriyJfGGenSaP+UwGi1kB9BLOCu9SR8ZpbkmmalKIALnRw24kM7qCN0IOm6L0S44iWw==", "cpu": [ "arm64" ], @@ -1862,9 +1915,9 @@ ] }, "node_modules/@rollup/rollup-freebsd-x64": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.40.0.tgz", - "integrity": "sha512-mVDxzlf0oLzV3oZOr0SMJ0lSDd3xC4CmnWJ8Val8isp9jRGl5Dq//LLDSPFrasS7pSm6m5xAcKaw3sHXhBjoRw==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.40.1.tgz", + "integrity": "sha512-VXeo/puqvCG8JBPNZXZf5Dqq7BzElNJzHRRw3vjBE27WujdzuOPecDPc/+1DcdcTptNBep3861jNq0mYkT8Z6Q==", "cpu": [ "x64" ], @@ -1876,9 +1929,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.40.0.tgz", - "integrity": "sha512-y/qUMOpJxBMy8xCXD++jeu8t7kzjlOCkoxxajL58G62PJGBZVl/Gwpm7JK9+YvlB701rcQTzjUZ1JgUoPTnoQA==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.40.1.tgz", + "integrity": "sha512-ehSKrewwsESPt1TgSE/na9nIhWCosfGSFqv7vwEtjyAqZcvbGIg4JAcV7ZEh2tfj/IlfBeZjgOXm35iOOjadcg==", "cpu": [ "arm" ], @@ -1890,9 +1943,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.40.0.tgz", - "integrity": "sha512-GoCsPibtVdJFPv/BOIvBKO/XmwZLwaNWdyD8TKlXuqp0veo2sHE+A/vpMQ5iSArRUz/uaoj4h5S6Pn0+PdhRjg==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.40.1.tgz", + "integrity": "sha512-m39iO/aaurh5FVIu/F4/Zsl8xppd76S4qoID8E+dSRQvTyZTOI2gVk3T4oqzfq1PtcvOfAVlwLMK3KRQMaR8lg==", "cpu": [ "arm" ], @@ -1904,9 +1957,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.40.0.tgz", - "integrity": "sha512-L5ZLphTjjAD9leJzSLI7rr8fNqJMlGDKlazW2tX4IUF9P7R5TMQPElpH82Q7eNIDQnQlAyiNVfRPfP2vM5Avvg==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.40.1.tgz", + "integrity": "sha512-Y+GHnGaku4aVLSgrT0uWe2o2Rq8te9hi+MwqGF9r9ORgXhmHK5Q71N757u0F8yU1OIwUIFy6YiJtKjtyktk5hg==", "cpu": [ "arm64" ], @@ -1918,9 +1971,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.40.0.tgz", - "integrity": "sha512-ATZvCRGCDtv1Y4gpDIXsS+wfFeFuLwVxyUBSLawjgXK2tRE6fnsQEkE4csQQYWlBlsFztRzCnBvWVfcae/1qxQ==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.40.1.tgz", + "integrity": "sha512-jEwjn3jCA+tQGswK3aEWcD09/7M5wGwc6+flhva7dsQNRZZTe30vkalgIzV4tjkopsTS9Jd7Y1Bsj6a4lzz8gQ==", "cpu": [ "arm64" ], @@ -1932,9 +1985,9 @@ ] }, "node_modules/@rollup/rollup-linux-loongarch64-gnu": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.40.0.tgz", - "integrity": "sha512-wG9e2XtIhd++QugU5MD9i7OnpaVb08ji3P1y/hNbxrQ3sYEelKJOq1UJ5dXczeo6Hj2rfDEL5GdtkMSVLa/AOg==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loongarch64-gnu/-/rollup-linux-loongarch64-gnu-4.40.1.tgz", + "integrity": "sha512-ySyWikVhNzv+BV/IDCsrraOAZ3UaC8SZB67FZlqVwXwnFhPihOso9rPOxzZbjp81suB1O2Topw+6Ug3JNegejQ==", "cpu": [ "loong64" ], @@ -1946,9 +1999,9 @@ ] }, "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.40.0.tgz", - "integrity": "sha512-vgXfWmj0f3jAUvC7TZSU/m/cOE558ILWDzS7jBhiCAFpY2WEBn5jqgbqvmzlMjtp8KlLcBlXVD2mkTSEQE6Ixw==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.40.1.tgz", + "integrity": "sha512-BvvA64QxZlh7WZWqDPPdt0GH4bznuL6uOO1pmgPnnv86rpUpc8ZxgZwcEgXvo02GRIZX1hQ0j0pAnhwkhwPqWg==", "cpu": [ "ppc64" ], @@ -1960,9 +2013,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.40.0.tgz", - "integrity": "sha512-uJkYTugqtPZBS3Z136arevt/FsKTF/J9dEMTX/cwR7lsAW4bShzI2R0pJVw+hcBTWF4dxVckYh72Hk3/hWNKvA==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.40.1.tgz", + "integrity": "sha512-EQSP+8+1VuSulm9RKSMKitTav89fKbHymTf25n5+Yr6gAPZxYWpj3DzAsQqoaHAk9YX2lwEyAf9S4W8F4l3VBQ==", "cpu": [ "riscv64" ], @@ -1974,9 +2027,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-musl": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.40.0.tgz", - "integrity": "sha512-rKmSj6EXQRnhSkE22+WvrqOqRtk733x3p5sWpZilhmjnkHkpeCgWsFFo0dGnUGeA+OZjRl3+VYq+HyCOEuwcxQ==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.40.1.tgz", + "integrity": "sha512-n/vQ4xRZXKuIpqukkMXZt9RWdl+2zgGNx7Uda8NtmLJ06NL8jiHxUawbwC+hdSq1rrw/9CghCpEONor+l1e2gA==", "cpu": [ "riscv64" ], @@ -1988,9 +2041,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.40.0.tgz", - "integrity": "sha512-SpnYlAfKPOoVsQqmTFJ0usx0z84bzGOS9anAC0AZ3rdSo3snecihbhFTlJZ8XMwzqAcodjFU4+/SM311dqE5Sw==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.40.1.tgz", + "integrity": "sha512-h8d28xzYb98fMQKUz0w2fMc1XuGzLLjdyxVIbhbil4ELfk5/orZlSTpF/xdI9C8K0I8lCkq+1En2RJsawZekkg==", "cpu": [ "s390x" ], @@ -2002,9 +2055,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.40.0.tgz", - "integrity": "sha512-RcDGMtqF9EFN8i2RYN2W+64CdHruJ5rPqrlYw+cgM3uOVPSsnAQps7cpjXe9be/yDp8UC7VLoCoKC8J3Kn2FkQ==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.40.1.tgz", + "integrity": "sha512-XiK5z70PEFEFqcNj3/zRSz/qX4bp4QIraTy9QjwJAb/Z8GM7kVUsD0Uk8maIPeTyPCP03ChdI+VVmJriKYbRHQ==", "cpu": [ "x64" ], @@ -2016,9 +2069,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.40.0.tgz", - "integrity": "sha512-HZvjpiUmSNx5zFgwtQAV1GaGazT2RWvqeDi0hV+AtC8unqqDSsaFjPxfsO6qPtKRRg25SisACWnJ37Yio8ttaw==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.40.1.tgz", + "integrity": "sha512-2BRORitq5rQ4Da9blVovzNCMaUlyKrzMSvkVR0D4qPuOy/+pMCrh1d7o01RATwVy+6Fa1WBw+da7QPeLWU/1mQ==", "cpu": [ "x64" ], @@ -2030,9 +2083,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.40.0.tgz", - "integrity": "sha512-UtZQQI5k/b8d7d3i9AZmA/t+Q4tk3hOC0tMOMSq2GlMYOfxbesxG4mJSeDp0EHs30N9bsfwUvs3zF4v/RzOeTQ==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.40.1.tgz", + "integrity": "sha512-b2bcNm9Kbde03H+q+Jjw9tSfhYkzrDUf2d5MAd1bOJuVplXvFhWz7tRtWvD8/ORZi7qSCy0idW6tf2HgxSXQSg==", "cpu": [ "arm64" ], @@ -2044,9 +2097,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.40.0.tgz", - "integrity": "sha512-+m03kvI2f5syIqHXCZLPVYplP8pQch9JHyXKZ3AGMKlg8dCyr2PKHjwRLiW53LTrN/Nc3EqHOKxUxzoSPdKddA==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.40.1.tgz", + "integrity": "sha512-DfcogW8N7Zg7llVEfpqWMZcaErKfsj9VvmfSyRjCyo4BI3wPEfrzTtJkZG6gKP/Z92wFm6rz2aDO7/JfiR/whA==", "cpu": [ "ia32" ], @@ -2058,9 +2111,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.40.0.tgz", - "integrity": "sha512-lpPE1cLfP5oPzVjKMx10pgBmKELQnFJXHgvtHCtuJWOv8MxqdEIMNtgHgBFf7Ea2/7EuVwa9fodWUfXAlXZLZQ==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.40.1.tgz", + "integrity": "sha512-ECyOuDeH3C1I8jH2MK1RtBJW+YPMvSfT0a5NN0nHfQYnDSJ6tUiZH3gzwVP5/Kfh/+Tt7tpWVF9LXNTnhTJ3kA==", "cpu": [ "x64" ], @@ -2524,6 +2577,55 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.3.0.tgz", + "integrity": "sha512-l0vIw+GxeNU7uGnsu6B+Crpeqf+WTQ2Va71cHb5ZYWEVEPdfYwY5kXwYqRJwHrxz9WH+pjSpXQz+TJgAsrkA5A==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.3.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.3.0.tgz", + "integrity": "sha512-zt6Kf/7XpBQKSI9eqku+arLkAcDQ3NHJO6zFjiChI8w0Oz6Jjjay7pToottjQGjSDCFk++R85643WbyINcuL+g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.3.0" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.3.0.tgz", + "integrity": "sha512-tXeCvLXBnqq34B0YZUEaAD1lD4lmN6TOHAhnHacj4Owh7Ptb/rf5XCDeROZt2rEOk5yuka3OOW2zLqClV7/SOg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.3.0" + } + }, + "node_modules/@shikijs/types": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.3.0.tgz", + "integrity": "sha512-KPCGnHG6k06QG/2pnYGbFtFvpVJmC3uIpXrAiPrawETifujPBv0Se2oUxm5qYgjCvGJS9InKvjytOdN+bGuX+Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "dev": true, + "license": "MIT" + }, "node_modules/@sindresorhus/is": { "version": "4.6.0", "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-4.6.0.tgz", @@ -2600,9 +2702,9 @@ "dev": true }, "node_modules/@tsconfig/node20": { - "version": "20.1.4", - "resolved": "https://registry.npmjs.org/@tsconfig/node20/-/node20-20.1.4.tgz", - "integrity": "sha512-sqgsT69YFeLWf5NtJ4Xq/xAF8p4ZQHlmGW74Nu2tD4+g5fAsposc4ZfaaPixVu4y01BEiDCWLRDCvDM5JOsRxg==", + "version": "20.1.5", + "resolved": "https://registry.npmjs.org/@tsconfig/node20/-/node20-20.1.5.tgz", + "integrity": "sha512-Vm8e3WxDTqMGPU4GATF9keQAIy1Drd7bPwlgzKJnZtoOsTm1tduUTbDjg0W5qERvGuxPI2h9RbMufH0YdfBylA==", "dev": true, "license": "MIT" }, @@ -2622,6 +2724,16 @@ "dev": true, "license": "MIT" }, + "node_modules/@types/hast": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", + "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, "node_modules/@types/json-schema": { "version": "7.0.15", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", @@ -2656,6 +2768,13 @@ "integrity": "sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ==", "dev": true }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "dev": true, + "license": "MIT" + }, "node_modules/@types/uuid": { "version": "10.0.0", "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-10.0.0.tgz", @@ -2663,21 +2782,21 @@ "dev": true }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.16.0.tgz", - "integrity": "sha512-5YTHKV8MYlyMI6BaEG7crQ9BhSc8RxzshOReKwZwRWN0+XvvTOm+L/UYLCYxFpfwYuAAqhxiq4yae0CMFwbL7Q==", + "version": "8.31.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.31.1.tgz", + "integrity": "sha512-oUlH4h1ABavI4F0Xnl8/fOtML/eu8nI2A1nYd+f+55XI0BLu+RIqKoCiZKNo6DtqZBEQm5aNKA20G3Z5w3R6GQ==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "8.16.0", - "@typescript-eslint/type-utils": "8.16.0", - "@typescript-eslint/utils": "8.16.0", - "@typescript-eslint/visitor-keys": "8.16.0", + "@typescript-eslint/scope-manager": "8.31.1", + "@typescript-eslint/type-utils": "8.31.1", + "@typescript-eslint/utils": "8.31.1", + "@typescript-eslint/visitor-keys": "8.31.1", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", - "ts-api-utils": "^1.3.0" + "ts-api-utils": "^2.0.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2688,25 +2807,21 @@ }, "peerDependencies": { "@typescript-eslint/parser": "^8.0.0 || ^8.0.0-alpha.0", - "eslint": "^8.57.0 || ^9.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" } }, "node_modules/@typescript-eslint/parser": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.16.0.tgz", - "integrity": "sha512-D7DbgGFtsqIPIFMPJwCad9Gfi/hC0PWErRRHFnaCWoEDYi5tQUDiJCTmGUbBiLzjqAck4KcXt9Ayj0CNlIrF+w==", + "version": "8.31.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.31.1.tgz", + "integrity": "sha512-oU/OtYVydhXnumd0BobL9rkJg7wFJ9bFFPmSmB/bf/XWN85hlViji59ko6bSKBXyseT9V8l+CN1nwmlbiN0G7Q==", "dev": true, - "license": "BSD-2-Clause", + "license": "MIT", "dependencies": { - "@typescript-eslint/scope-manager": "8.16.0", - "@typescript-eslint/types": "8.16.0", - "@typescript-eslint/typescript-estree": "8.16.0", - "@typescript-eslint/visitor-keys": "8.16.0", + "@typescript-eslint/scope-manager": "8.31.1", + "@typescript-eslint/types": "8.31.1", + "@typescript-eslint/typescript-estree": "8.31.1", + "@typescript-eslint/visitor-keys": "8.31.1", "debug": "^4.3.4" }, "engines": { @@ -2717,23 +2832,19 @@ "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.16.0.tgz", - "integrity": "sha512-mwsZWubQvBki2t5565uxF0EYvG+FwdFb8bMtDuGQLdCCnGPrDEDvm1gtfynuKlnpzeBRqdFCkMf9jg1fnAK8sg==", + "version": "8.31.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.31.1.tgz", + "integrity": "sha512-BMNLOElPxrtNQMIsFHE+3P0Yf1z0dJqV9zLdDxN/xLlWMlXK/ApEsVEKzpizg9oal8bAT5Sc7+ocal7AC1HCVw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.16.0", - "@typescript-eslint/visitor-keys": "8.16.0" + "@typescript-eslint/types": "8.31.1", + "@typescript-eslint/visitor-keys": "8.31.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2744,16 +2855,16 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.16.0.tgz", - "integrity": "sha512-IqZHGG+g1XCWX9NyqnI/0CX5LL8/18awQqmkZSl2ynn8F76j579dByc0jhfVSnSnhf7zv76mKBQv9HQFKvDCgg==", + "version": "8.31.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.31.1.tgz", + "integrity": "sha512-fNaT/m9n0+dpSp8G/iOQ05GoHYXbxw81x+yvr7TArTuZuCA6VVKbqWYVZrV5dVagpDTtj/O8k5HBEE/p/HM5LA==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/typescript-estree": "8.16.0", - "@typescript-eslint/utils": "8.16.0", + "@typescript-eslint/typescript-estree": "8.31.1", + "@typescript-eslint/utils": "8.31.1", "debug": "^4.3.4", - "ts-api-utils": "^1.3.0" + "ts-api-utils": "^2.0.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2763,18 +2874,14 @@ "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" } }, "node_modules/@typescript-eslint/types": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.16.0.tgz", - "integrity": "sha512-NzrHj6thBAOSE4d9bsuRNMvk+BvaQvmY4dDglgkgGC0EW/tB3Kelnp3tAKH87GEwzoxgeQn9fNGRyFJM/xd+GQ==", + "version": "8.31.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.31.1.tgz", + "integrity": "sha512-SfepaEFUDQYRoA70DD9GtytljBePSj17qPxFHA/h3eg6lPTqGJ5mWOtbXCk1YrVU1cTJRd14nhaXWFu0l2troQ==", "dev": true, "license": "MIT", "engines": { @@ -2786,20 +2893,20 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.16.0.tgz", - "integrity": "sha512-E2+9IzzXMc1iaBy9zmo+UYvluE3TW7bCGWSF41hVWUE01o8nzr1rvOQYSxelxr6StUvRcTMe633eY8mXASMaNw==", + "version": "8.31.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.31.1.tgz", + "integrity": "sha512-kaA0ueLe2v7KunYOyWYtlf/QhhZb7+qh4Yw6Ni5kgukMIG+iP773tjgBiLWIXYumWCwEq3nLW+TUywEp8uEeag==", "dev": true, - "license": "BSD-2-Clause", + "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.16.0", - "@typescript-eslint/visitor-keys": "8.16.0", + "@typescript-eslint/types": "8.31.1", + "@typescript-eslint/visitor-keys": "8.31.1", "debug": "^4.3.4", "fast-glob": "^3.3.2", "is-glob": "^4.0.3", "minimatch": "^9.0.4", "semver": "^7.6.0", - "ts-api-utils": "^1.3.0" + "ts-api-utils": "^2.0.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2808,23 +2915,21 @@ "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "peerDependencies": { + "typescript": ">=4.8.4 <5.9.0" } }, "node_modules/@typescript-eslint/utils": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.16.0.tgz", - "integrity": "sha512-C1zRy/mOL8Pj157GiX4kaw7iyRLKfJXBR3L82hk5kS/GyHcOFmy4YUq/zfZti72I9wnuQtA/+xzft4wCC8PJdA==", + "version": "8.31.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.31.1.tgz", + "integrity": "sha512-2DSI4SNfF5T4oRveQ4nUrSjUqjMND0nLq9rEkz0gfGr3tg0S5KB6DhwR+WZPCjzkZl3cH+4x2ce3EsL50FubjQ==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "8.16.0", - "@typescript-eslint/types": "8.16.0", - "@typescript-eslint/typescript-estree": "8.16.0" + "@typescript-eslint/scope-manager": "8.31.1", + "@typescript-eslint/types": "8.31.1", + "@typescript-eslint/typescript-estree": "8.31.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -2834,22 +2939,18 @@ "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.16.0.tgz", - "integrity": "sha512-pq19gbaMOmFE3CbL0ZB8J8BFCo2ckfHBfaIsaOZgBIF4EoISJIdLX5xRhd0FGB0LlHReNRuzoJoMGpTjq8F2CQ==", + "version": "8.31.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.31.1.tgz", + "integrity": "sha512-I+/rgqOVBn6f0o7NDTmAPWWC6NuqhV174lfYvAm9fUaWeiefLdux9/YI3/nLugEn9L8fcSi0XmpKi/r5u0nmpw==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/types": "8.16.0", + "@typescript-eslint/types": "8.31.1", "eslint-visitor-keys": "^4.2.0" }, "engines": { @@ -3134,10 +3235,11 @@ } }, "node_modules/algosdk": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/algosdk/-/algosdk-3.0.0.tgz", - "integrity": "sha512-PIKZ/YvbBpCudduug4KSH1CY/pTotI7/ccbUIbXKtcI9Onevl+57E+K5X4ow4gsCdysZ8zVvSLdxuCcXvsmPOw==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/algosdk/-/algosdk-3.2.0.tgz", + "integrity": "sha512-iz7cRtv03vuYgQYp2IfLs+n512dxdjpalALZNiiFvreM7/oPmflfLkfD5dph/HUQwuJTomXx51LgiY19QP5ihg==", "dev": true, + "license": "MIT", "dependencies": { "algorand-msgpack": "^1.1.0", "hi-base32": "^0.5.1", @@ -3160,12 +3262,6 @@ "node": ">=8" } }, - "node_modules/ansi-sequence-parser": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz", - "integrity": "sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==", - "dev": true - }, "node_modules/ansi-styles": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", @@ -3762,6 +3858,7 @@ "resolved": "https://registry.npmjs.org/conventional-changelog-angular/-/conventional-changelog-angular-7.0.0.tgz", "integrity": "sha512-ROjNchA9LgfNMTTFSIWPzebCwOGFdgkEq45EnvvrmSLvCtAw0HSmrCs7/ty+wAeYUZyNay0YMUNYFTRL72PkBQ==", "dev": true, + "license": "ISC", "dependencies": { "compare-func": "^2.0.0" }, @@ -3826,6 +3923,7 @@ "resolved": "https://registry.npmjs.org/conventional-commits-parser/-/conventional-commits-parser-5.0.0.tgz", "integrity": "sha512-ZPMl0ZJbw74iS9LuX9YIAiW8pfM5p3yh2o/NbXHbkFuZzY5jvdi5jFycEOkmBW5H5I7nA+D6f3UcsCLP2vvSEA==", "dev": true, + "license": "MIT", "dependencies": { "is-text-path": "^2.0.0", "JSONStream": "^1.3.5", @@ -3884,20 +3982,21 @@ } }, "node_modules/cosmiconfig-typescript-loader": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/cosmiconfig-typescript-loader/-/cosmiconfig-typescript-loader-5.1.0.tgz", - "integrity": "sha512-7PtBB+6FdsOvZyJtlF3hEPpACq7RQX6BVGsgC7/lfVXnKMvNCu/XY3ykreqG5w/rBNdu2z8LCIKoF3kpHHdHlA==", + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/cosmiconfig-typescript-loader/-/cosmiconfig-typescript-loader-6.1.0.tgz", + "integrity": "sha512-tJ1w35ZRUiM5FeTzT7DtYWAFFv37ZLqSRkGi2oeCK1gPhvaWjkAtfXvLmvE1pRfxxp9aQo6ba/Pvg1dKj05D4g==", "dev": true, + "license": "MIT", "dependencies": { - "jiti": "^1.21.6" + "jiti": "^2.4.1" }, "engines": { - "node": ">=v16" + "node": ">=v18" }, "peerDependencies": { "@types/node": "*", - "cosmiconfig": ">=8.2", - "typescript": ">=4" + "cosmiconfig": ">=9", + "typescript": ">=5" } }, "node_modules/cp-file": { @@ -4040,6 +4139,7 @@ "resolved": "https://registry.npmjs.org/dargs/-/dargs-8.1.0.tgz", "integrity": "sha512-wAV9QHOsNbwnWdNW2FYvE1P56wtgSbM+3SZcdGiWQILwVjACCXDCI3Ai8QlCjMDB8YK5zySiXZYBiwGmNY3lnw==", "dev": true, + "license": "MIT", "engines": { "node": ">=12" }, @@ -4281,6 +4381,19 @@ "integrity": "sha512-5U0rVMU5Y2n2+ykNLQqMoqklN9ICBT/KsvC1Gz6vqHbz2AXXGkG+Pm5rMWk/8Vjrr/mY9985Hi8DYzn1F09Nyw==", "dev": true }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/env-ci": { "version": "11.0.0", "resolved": "https://registry.npmjs.org/env-ci/-/env-ci-11.0.0.tgz", @@ -4638,30 +4751,31 @@ } }, "node_modules/eslint": { - "version": "9.15.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.15.0.tgz", - "integrity": "sha512-7CrWySmIibCgT1Os28lUU6upBshZ+GxybLOrmRzi08kS8MBuO8QA7pXEgYgY5W8vK3e74xv0lpjo9DbaGU9Rkw==", + "version": "9.25.1", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.25.1.tgz", + "integrity": "sha512-E6Mtz9oGQWDCpV12319d59n4tx9zOTXSTmc8BLVxBx+G/0RdM5MvEEJLU9c0+aleoePYYgVTOsRblx433qmhWQ==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.12.1", - "@eslint/config-array": "^0.19.0", - "@eslint/core": "^0.9.0", - "@eslint/eslintrc": "^3.2.0", - "@eslint/js": "9.15.0", - "@eslint/plugin-kit": "^0.2.3", + "@eslint/config-array": "^0.20.0", + "@eslint/config-helpers": "^0.2.1", + "@eslint/core": "^0.13.0", + "@eslint/eslintrc": "^3.3.1", + "@eslint/js": "9.25.1", + "@eslint/plugin-kit": "^0.2.8", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", - "@humanwhocodes/retry": "^0.4.1", + "@humanwhocodes/retry": "^0.4.2", "@types/estree": "^1.0.6", "@types/json-schema": "^7.0.15", "ajv": "^6.12.4", "chalk": "^4.0.0", - "cross-spawn": "^7.0.5", + "cross-spawn": "^7.0.6", "debug": "^4.3.2", "escape-string-regexp": "^4.0.0", - "eslint-scope": "^8.2.0", + "eslint-scope": "^8.3.0", "eslint-visitor-keys": "^4.2.0", "espree": "^10.3.0", "esquery": "^1.5.0", @@ -4711,9 +4825,9 @@ } }, "node_modules/eslint-scope": { - "version": "8.2.0", - "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.2.0.tgz", - "integrity": "sha512-PHlWUfG6lvPc3yvP5A4PNyBL1W8fkDUccmI21JUu/+GKZBoH/W5u6usENXUrWFRsyoW5ACUjFGgAFQp5gUlb/A==", + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-8.3.0.tgz", + "integrity": "sha512-pUNxi75F8MJ/GdeKtVLSbYg4ZI34J6C0C7sbL4YOp2exGwen7ZsuBqKzUhXd0qMQ362yET3z+uPwKeg/0C2XCQ==", "dev": true, "license": "BSD-2-Clause", "dependencies": { @@ -4909,15 +5023,16 @@ "dev": true }, "node_modules/fast-glob": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", - "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", + "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", + "license": "MIT", "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", "glob-parent": "^5.1.2", "merge2": "^1.3.0", - "micromatch": "^4.0.4" + "micromatch": "^4.0.8" }, "engines": { "node": ">=8.6.0" @@ -5274,6 +5389,7 @@ "resolved": "https://registry.npmjs.org/git-raw-commits/-/git-raw-commits-4.0.0.tgz", "integrity": "sha512-ICsMM1Wk8xSGMowkOmPrzo2Fgmfo4bMHLNX6ytHjajRJUqvHOw/TFapQ+QG75c3X/tTDDhOSRPGC52dDbNM8FQ==", "dev": true, + "license": "MIT", "dependencies": { "dargs": "^8.0.0", "meow": "^12.0.1", @@ -5322,6 +5438,7 @@ "resolved": "https://registry.npmjs.org/global-directory/-/global-directory-4.0.1.tgz", "integrity": "sha512-wHTUcDUoZ1H5/0iVqEudYW4/kAlN5cZ3j/bXn0Dpbizl9iaUVeWSHqiOjsgk6OW2bkLclbBjzewBz6weQ1zA2Q==", "dev": true, + "license": "MIT", "dependencies": { "ini": "4.1.1" }, @@ -5337,6 +5454,7 @@ "resolved": "https://registry.npmjs.org/ini/-/ini-4.1.1.tgz", "integrity": "sha512-QQnnxNyfvmHFIsj7gkPcYymR8Jdw/o7mp5ZFihxn6h8Ci6fh3Dx4E1gPjpQEpIuPo9XVNY/ZUwh4BPMjGyL01g==", "dev": true, + "license": "ISC", "engines": { "node": "^14.17.0 || ^16.13.0 || >=18.0.0" } @@ -6031,6 +6149,7 @@ "resolved": "https://registry.npmjs.org/is-text-path/-/is-text-path-2.0.0.tgz", "integrity": "sha512-+oDTluR6WEjdXEJMnC2z6A4FRwFoYuvShVVEGsS7ewc0UTi2QtAKMDJuL4BDEVt+5T7MjFo12RP8ghOM75oKJw==", "dev": true, + "license": "MIT", "dependencies": { "text-extensions": "^2.0.0" }, @@ -6164,12 +6283,13 @@ } }, "node_modules/jiti": { - "version": "1.21.6", - "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.6.tgz", - "integrity": "sha512-2yTgeWTWzMWkHu6Jp9NKgePDaYHbntiwvYuuJLbbN9vl7DC9DvXKOB2BC3ZZ92D3cvV/aflH0osDfwpHepQ53w==", + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-2.4.2.tgz", + "integrity": "sha512-rg9zJN+G4n2nfJl5MW3BMygZX56zKPNVEYYqq7adpmMh4Jn2QNEwhvQlFy6jPVdcod7txZtKHWnyZiA3a0zP7A==", "dev": true, + "license": "MIT", "bin": { - "jiti": "bin/jiti.js" + "jiti": "lib/jiti-cli.mjs" } }, "node_modules/js-sha256": { @@ -6247,12 +6367,6 @@ "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", "dev": true }, - "node_modules/jsonc-parser": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.1.tgz", - "integrity": "sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA==", - "dev": true - }, "node_modules/jsonfile": { "version": "6.1.0", "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", @@ -6272,13 +6386,15 @@ "dev": true, "engines": [ "node >= 0.2.0" - ] + ], + "license": "MIT" }, "node_modules/JSONStream": { "version": "1.3.5", "resolved": "https://registry.npmjs.org/JSONStream/-/JSONStream-1.3.5.tgz", "integrity": "sha512-E+iruNOY8VV9s4JEbe1aNEm6MiszPRr/UfcHMz0TQh1BXSxHK+ASV1R6W4HpjBhSeS+54PIsAMCBmwD06LLsqQ==", "dev": true, + "license": "(MIT OR Apache-2.0)", "dependencies": { "jsonparse": "^1.2.0", "through": ">=2.2.7 <3" @@ -6331,6 +6447,16 @@ "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", "dev": true }, + "node_modules/linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "uc.micro": "^2.0.0" + } + }, "node_modules/load-json-file": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz", @@ -6393,7 +6519,8 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz", "integrity": "sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/lodash.capitalize": { "version": "4.2.1", @@ -6429,7 +6556,8 @@ "version": "4.1.1", "resolved": "https://registry.npmjs.org/lodash.kebabcase/-/lodash.kebabcase-4.1.1.tgz", "integrity": "sha512-N8XRTIMMqqDgSy4VLKPnJ/+hpGZN+PHQiJnSenYqPaVV/NCqEogTnAdZLQiGKhxX+JCs8waWq2t1XHWKOmlY8g==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/lodash.merge": { "version": "4.6.2", @@ -6441,19 +6569,22 @@ "version": "4.6.2", "resolved": "https://registry.npmjs.org/lodash.mergewith/-/lodash.mergewith-4.6.2.tgz", "integrity": "sha512-GK3g5RPZWTRSeLSpgP8Xhra+pnjBC56q9FZYe1d5RN3TJ35dbkGy3YqBSMbyCrlbi+CM9Z3Jk5yTL7RCsqboyQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/lodash.snakecase": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/lodash.snakecase/-/lodash.snakecase-4.1.1.tgz", "integrity": "sha512-QZ1d4xoBHYUeuouhEq3lk3Uq7ldgyFXGBhg04+oRLnIz8o9T65Eh+8YdroUwn846zchkA9yDsDl5CVVaV2nqYw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/lodash.startcase": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/lodash.startcase/-/lodash.startcase-4.4.0.tgz", "integrity": "sha512-+WKqsK294HMSc2jEbNgpHpd0JfIBhp7rEV4aqXWqFr6AlXov+SlcgB1Fv01y2kGe3Gc8nMW7VA0SrGuSkRfIEg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/lodash.truncate": { "version": "4.4.2", @@ -6465,7 +6596,8 @@ "version": "4.5.0", "resolved": "https://registry.npmjs.org/lodash.uniq/-/lodash.uniq-4.5.0.tgz", "integrity": "sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/lodash.uniqby": { "version": "4.7.0", @@ -6477,7 +6609,8 @@ "version": "4.3.1", "resolved": "https://registry.npmjs.org/lodash.upperfirst/-/lodash.upperfirst-4.3.1.tgz", "integrity": "sha512-sReKOYJIJf74dhJONhU4e0/shzi1trVbSWDOhKYE5XV2O+H7Sb2Dihwuc7xWxVl+DgFPyTqIN3zMfT9cq5iWDg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/loupe": { "version": "3.1.3", @@ -6492,10 +6625,11 @@ "dev": true }, "node_modules/magic-string": { - "version": "0.30.13", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.13.tgz", - "integrity": "sha512-8rYBO+MsWkgjDSOvLomYnzhdwEG51olQ4zL5KXnNJWV5MNmrb4rTZdrtkhxjnD/QyZUqR/Z/XDsUs/4ej2nx0g==", + "version": "0.30.17", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.17.tgz", + "integrity": "sha512-sNPKHvyjVf7gyjwS4xGTaW/mCnF8wnjtifKBEhxfZ7E/S8tQ0rssrwGNn6q8JH/ohItJfSQp9mBtQYuTlH5QnA==", "dev": true, + "license": "MIT", "dependencies": { "@jridgewell/sourcemap-codec": "^1.5.0" } @@ -6532,6 +6666,24 @@ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, + "node_modules/markdown-it": { + "version": "14.1.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.0.tgz", + "integrity": "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, "node_modules/marked": { "version": "12.0.1", "resolved": "https://registry.npmjs.org/marked/-/marked-12.0.1.tgz", @@ -6588,6 +6740,13 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, + "node_modules/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true, + "license": "MIT" + }, "node_modules/memorystream": { "version": "0.3.1", "resolved": "https://registry.npmjs.org/memorystream/-/memorystream-0.3.1.tgz", @@ -10289,10 +10448,11 @@ } }, "node_modules/prettier": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", - "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", + "version": "3.5.3", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.3.tgz", + "integrity": "sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==", "dev": true, + "license": "MIT", "bin": { "prettier": "bin/prettier.cjs" }, @@ -10339,6 +10499,16 @@ "node": ">=6" } }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, "node_modules/queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", @@ -10776,9 +10946,9 @@ } }, "node_modules/rollup": { - "version": "4.40.0", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.40.0.tgz", - "integrity": "sha512-Noe455xmA96nnqH5piFtLobsGbCij7Tu+tb3c1vYjNbTkfzGqXqQXG3wJaYXkRZuQ0vEYN4bhwg7QnIrqB5B+w==", + "version": "4.40.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.40.1.tgz", + "integrity": "sha512-C5VvvgCCyfyotVITIAv+4efVytl5F7wt+/I2i9q9GZcEXW9BP52YYOXC58igUi+LFZVHukErIIqQSWwv/M3WRw==", "dev": true, "license": "MIT", "dependencies": { @@ -10792,26 +10962,26 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.40.0", - "@rollup/rollup-android-arm64": "4.40.0", - "@rollup/rollup-darwin-arm64": "4.40.0", - "@rollup/rollup-darwin-x64": "4.40.0", - "@rollup/rollup-freebsd-arm64": "4.40.0", - "@rollup/rollup-freebsd-x64": "4.40.0", - "@rollup/rollup-linux-arm-gnueabihf": "4.40.0", - "@rollup/rollup-linux-arm-musleabihf": "4.40.0", - "@rollup/rollup-linux-arm64-gnu": "4.40.0", - "@rollup/rollup-linux-arm64-musl": "4.40.0", - "@rollup/rollup-linux-loongarch64-gnu": "4.40.0", - "@rollup/rollup-linux-powerpc64le-gnu": "4.40.0", - "@rollup/rollup-linux-riscv64-gnu": "4.40.0", - "@rollup/rollup-linux-riscv64-musl": "4.40.0", - "@rollup/rollup-linux-s390x-gnu": "4.40.0", - "@rollup/rollup-linux-x64-gnu": "4.40.0", - "@rollup/rollup-linux-x64-musl": "4.40.0", - "@rollup/rollup-win32-arm64-msvc": "4.40.0", - "@rollup/rollup-win32-ia32-msvc": "4.40.0", - "@rollup/rollup-win32-x64-msvc": "4.40.0", + "@rollup/rollup-android-arm-eabi": "4.40.1", + "@rollup/rollup-android-arm64": "4.40.1", + "@rollup/rollup-darwin-arm64": "4.40.1", + "@rollup/rollup-darwin-x64": "4.40.1", + "@rollup/rollup-freebsd-arm64": "4.40.1", + "@rollup/rollup-freebsd-x64": "4.40.1", + "@rollup/rollup-linux-arm-gnueabihf": "4.40.1", + "@rollup/rollup-linux-arm-musleabihf": "4.40.1", + "@rollup/rollup-linux-arm64-gnu": "4.40.1", + "@rollup/rollup-linux-arm64-musl": "4.40.1", + "@rollup/rollup-linux-loongarch64-gnu": "4.40.1", + "@rollup/rollup-linux-powerpc64le-gnu": "4.40.1", + "@rollup/rollup-linux-riscv64-gnu": "4.40.1", + "@rollup/rollup-linux-riscv64-musl": "4.40.1", + "@rollup/rollup-linux-s390x-gnu": "4.40.1", + "@rollup/rollup-linux-x64-gnu": "4.40.1", + "@rollup/rollup-linux-x64-musl": "4.40.1", + "@rollup/rollup-win32-arm64-msvc": "4.40.1", + "@rollup/rollup-win32-ia32-msvc": "4.40.1", + "@rollup/rollup-win32-x64-msvc": "4.40.1", "fsevents": "~2.3.2" } }, @@ -10885,10 +11055,11 @@ } }, "node_modules/semantic-release": { - "version": "24.2.0", - "resolved": "https://registry.npmjs.org/semantic-release/-/semantic-release-24.2.0.tgz", - "integrity": "sha512-fQfn6e/aYToRtVJYKqneFM1Rg3KP2gh3wSWtpYsLlz6uaPKlISrTzvYAFn+mYWo07F0X1Cz5ucU89AVE8X1mbg==", + "version": "24.2.3", + "resolved": "https://registry.npmjs.org/semantic-release/-/semantic-release-24.2.3.tgz", + "integrity": "sha512-KRhQG9cUazPavJiJEFIJ3XAMjgfd0fcK3B+T26qOl8L0UG5aZUjeRfREO0KM5InGtYwxqiiytkJrbcYoLDEv0A==", "dev": true, + "license": "MIT", "dependencies": { "@semantic-release/commit-analyzer": "^13.0.0-beta.1", "@semantic-release/error": "^4.0.0", @@ -10906,7 +11077,7 @@ "git-log-parser": "^1.2.0", "hook-std": "^3.0.0", "hosted-git-info": "^8.0.0", - "import-from-esm": "^1.3.1", + "import-from-esm": "^2.0.0", "lodash-es": "^4.17.21", "marked": "^12.0.0", "marked-terminal": "^7.0.0", @@ -11002,6 +11173,20 @@ "node": ">=18.18.0" } }, + "node_modules/semantic-release/node_modules/import-from-esm": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/import-from-esm/-/import-from-esm-2.0.0.tgz", + "integrity": "sha512-YVt14UZCgsX1vZQ3gKjkWVdBdHQ6eu3MPU1TBgL1H5orXe2+jWD006WCPPtOuwlQm10NuzOW5WawiF1Q9veW8g==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "^4.3.4", + "import-meta-resolve": "^4.0.0" + }, + "engines": { + "node": ">=18.20" + } + }, "node_modules/semantic-release/node_modules/is-stream": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-4.0.1.tgz", @@ -11204,18 +11389,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/shiki": { - "version": "0.14.7", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", - "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", - "dev": true, - "dependencies": { - "ansi-sequence-parser": "^1.1.0", - "jsonc-parser": "^3.2.0", - "vscode-oniguruma": "^1.7.0", - "vscode-textmate": "^8.0.0" - } - }, "node_modules/side-channel": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", @@ -11427,6 +11600,7 @@ "resolved": "https://registry.npmjs.org/split2/-/split2-4.2.0.tgz", "integrity": "sha512-UcjcJOWknrNkF6PLX83qcHM6KHgVKNkV62Y8a5uYDVv9ydGQVwAHMKqHdJje1VTWpljG0WYpCDhrCdAOYH4TWg==", "dev": true, + "license": "ISC", "engines": { "node": ">= 10.x" } @@ -11766,6 +11940,7 @@ "resolved": "https://registry.npmjs.org/text-extensions/-/text-extensions-2.4.0.tgz", "integrity": "sha512-te/NtwBwfiNRLf9Ijqx3T0nlqZiQ2XrrtBvu+cLL8ZRrGkO0NHTug8MYFKyoSrv/sHTaSKfilUkizV6XhxMJ3g==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" }, @@ -11798,7 +11973,8 @@ "version": "2.3.8", "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/time-span": { "version": "5.1.0", @@ -11889,15 +12065,16 @@ } }, "node_modules/ts-api-utils": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.4.1.tgz", - "integrity": "sha512-5RU2/lxTA3YUZxju61HO2U6EoZLvBLtmV2mbTvqyu4a/7s7RmJPT+1YekhMVsQhznRWk/czIwDUg+V8Q9ZuG4w==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz", + "integrity": "sha512-CUgTZL1irw8u29bzrOD/nH85jqyc74D6SshFgujOIA7osm2Rz7dYH77agkx7H4FBNxDq7Cjf+IjaX/8zwFW+ZQ==", "dev": true, + "license": "MIT", "engines": { - "node": ">=16" + "node": ">=18.12" }, "peerDependencies": { - "typescript": ">=4.2.0" + "typescript": ">=4.8.4" } }, "node_modules/ts-morph": { @@ -12053,24 +12230,27 @@ } }, "node_modules/typedoc": { - "version": "0.25.13", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.13.tgz", - "integrity": "sha512-pQqiwiJ+Z4pigfOnnysObszLiU3mVLWAExSPf+Mu06G/qsc3wzbuM56SZQvONhHLncLUhYzOVkjFFpFfL5AzhQ==", + "version": "0.28.3", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.3.tgz", + "integrity": "sha512-5svOCTfXvVSh6zbZKSQluZhR8yN2tKpTeHZxlmWpE6N5vc3R8k/jhg9nnD6n5tN9/ObuQTojkONrOxFdUFUG9w==", "dev": true, + "license": "Apache-2.0", "dependencies": { + "@gerrit0/mini-shiki": "^3.2.2", "lunr": "^2.3.9", - "marked": "^4.3.0", - "minimatch": "^9.0.3", - "shiki": "^0.14.7" + "markdown-it": "^14.1.0", + "minimatch": "^9.0.5", + "yaml": "^2.7.1" }, "bin": { "typedoc": "bin/typedoc" }, "engines": { - "node": ">= 16" + "node": ">= 18", + "pnpm": ">= 10" }, "peerDependencies": { - "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x" + "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x" } }, "node_modules/typedoc-plugin-markdown": { @@ -12085,23 +12265,12 @@ "typedoc": ">=0.24.0" } }, - "node_modules/typedoc/node_modules/marked": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", - "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", - "dev": true, - "bin": { - "marked": "bin/marked.js" - }, - "engines": { - "node": ">= 12" - } - }, "node_modules/typescript": { - "version": "5.4.5", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz", - "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==", + "version": "5.8.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", + "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", "dev": true, + "license": "Apache-2.0", "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -12111,15 +12280,15 @@ } }, "node_modules/typescript-eslint": { - "version": "8.16.0", - "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.16.0.tgz", - "integrity": "sha512-wDkVmlY6O2do4V+lZd0GtRfbtXbeD0q9WygwXXSJnC1xorE8eqyC2L1tJimqpSeFrOzRlYtWnUp/uzgHQOgfBQ==", + "version": "8.31.1", + "resolved": "https://registry.npmjs.org/typescript-eslint/-/typescript-eslint-8.31.1.tgz", + "integrity": "sha512-j6DsEotD/fH39qKzXTQRwYYWlt7D+0HmfpOK+DVhwJOFLcdmn92hq3mBb7HlKJHbjjI/gTOqEcc9d6JfpFf/VA==", "dev": true, "license": "MIT", "dependencies": { - "@typescript-eslint/eslint-plugin": "8.16.0", - "@typescript-eslint/parser": "8.16.0", - "@typescript-eslint/utils": "8.16.0" + "@typescript-eslint/eslint-plugin": "8.31.1", + "@typescript-eslint/parser": "8.31.1", + "@typescript-eslint/utils": "8.31.1" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -12129,14 +12298,17 @@ "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^8.57.0 || ^9.0.0" - }, - "peerDependenciesMeta": { - "typescript": { - "optional": true - } + "eslint": "^8.57.0 || ^9.0.0", + "typescript": ">=4.8.4 <5.9.0" } }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true, + "license": "MIT" + }, "node_modules/uglify-js": { "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", @@ -12423,46 +12595,23 @@ } }, "node_modules/vitest-fetch-mock": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/vitest-fetch-mock/-/vitest-fetch-mock-0.3.0.tgz", - "integrity": "sha512-g6upWcL8/32fXL43/5f4VHcocuwQIi9Fj5othcK9gPO8XqSEGtnIZdenr2IaipDr61ReRFt+vaOEgo8jiUUX5w==", + "version": "0.4.5", + "resolved": "https://registry.npmjs.org/vitest-fetch-mock/-/vitest-fetch-mock-0.4.5.tgz", + "integrity": "sha512-nhWdCQIGtaSEUVl96pMm0WggyDGPDv5FUy/Q9Hx3cs2RGmh3Q/uRsLClGbdG3kXBkJ3br5yTUjB2MeW25TwdOA==", "dev": true, - "dependencies": { - "cross-fetch": "^4.0.0" - }, + "license": "MIT", "engines": { - "node": ">=14.14.0" + "node": ">=18.0.0" }, "peerDependencies": { "vitest": ">=2.0.0" } }, - "node_modules/vitest-fetch-mock/node_modules/cross-fetch": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-4.0.0.tgz", - "integrity": "sha512-e4a5N8lVvuLgAWgnCrLr2PP0YyDOTHa9H/Rj54dirp61qXnNq46m82bRhNqIA5VccJtWBvPTFRV3TtvHUKPB1g==", - "dev": true, - "dependencies": { - "node-fetch": "^2.6.12" - } - }, "node_modules/vlq": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/vlq/-/vlq-2.0.4.tgz", "integrity": "sha512-aodjPa2wPQFkra1G8CzJBTHXhgk3EVSwxSWXNPr1fgdFLUb8kvLV1iEb6rFgasIsjP82HWI6dsb5Io26DDnasA==" }, - "node_modules/vscode-oniguruma": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", - "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", - "dev": true - }, - "node_modules/vscode-textmate": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", - "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", - "dev": true - }, "node_modules/webidl-conversions": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", @@ -12653,6 +12802,19 @@ "node": ">=10" } }, + "node_modules/yaml": { + "version": "2.7.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.7.1.tgz", + "integrity": "sha512-10ULxpnOCQXxJvBgxsn9ptjq6uviG/htZKk9veJGhlqn3w/DxQ631zFF+nlQXLwmImeS5amR2dl2U8sg6U9jsQ==", + "dev": true, + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/yargs": { "version": "17.7.2", "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz", diff --git a/package.json b/package.json index d3ae73ba..f8d1db60 100644 --- a/package.json +++ b/package.json @@ -96,13 +96,13 @@ "semantic-release": "^24.1.2", "tiny-invariant": "^1.3.1", "ts-node": "^10.9.1", - "typedoc": "^0.25.13", + "typedoc": "^0.28.3", "typedoc-plugin-markdown": "^3.17.1", "typescript": "^5.4.5", "typescript-eslint": "^8.16.0", "uuid": "^10.0.0", "vitest": "^2.1.2", - "vitest-fetch-mock": "^0.3.0" + "vitest-fetch-mock": "^0.4.5" }, "release": { "branches": [ From 9c7d213229255d020ac2c11bd2f2cf655c2c16db Mon Sep 17 00:00:00 2001 From: David Rojas Date: Tue, 6 May 2025 16:52:29 -0400 Subject: [PATCH 2/4] fix: type error in app-client --- src/types/app-client.ts | 117 +++++++++++----------------------------- 1 file changed, 30 insertions(+), 87 deletions(-) diff --git a/src/types/app-client.ts b/src/types/app-client.ts index f2aefdf4..8758fbc1 100644 --- a/src/types/app-client.ts +++ b/src/types/app-client.ts @@ -599,11 +599,7 @@ export class AppClient { if (!appMetadata) { throw new Error(`App not found for creator ${params.creatorAddress} and name ${params.appName ?? appSpec.name}`) } - return new AppClient({ - ...params, - algorand: params.algorand, - appId: appMetadata.appId, - }) + return new AppClient({ ...params, algorand: params.algorand, appId: appMetadata.appId }) } /** @@ -803,11 +799,7 @@ export class AppClient { * ``` */ public async getBoxValueFromABIType(name: BoxIdentifier, type: ABIType): Promise { - return await this._algorand.app.getBoxValueFromABIType({ - appId: this.appId, - boxName: name, - type, - }) + return await this._algorand.app.getBoxValueFromABIType({ appId: this.appId, boxName: name, type }) } /** @@ -886,10 +878,7 @@ export class AppClient { ) } - return { - approvalSourceMap: this._approvalSourceMap, - clearSourceMap: this._clearSourceMap, - } + return { approvalSourceMap: this._approvalSourceMap, clearSourceMap: this._clearSourceMap } } /** @@ -1064,10 +1053,7 @@ export class AppClient { } const approvalTemplate = Buffer.from(appSpec.source.approval, 'base64').toString('utf-8') - const compiledApproval = await appManager.compileTealTemplate(approvalTemplate, deployTimeParams, { - updatable, - deletable, - }) + const compiledApproval = await appManager.compileTealTemplate(approvalTemplate, deployTimeParams, { updatable, deletable }) const clearTemplate = Buffer.from(appSpec.source.clear, 'base64').toString('utf-8') const compiledClear = await appManager.compileTealTemplate(clearTemplate, deployTimeParams) @@ -1127,16 +1113,17 @@ export class AppClient { ) as ABIValue case 'method': { const method = this.getABIMethod(defaultValue.data) - const result = await this.send.call({ - method: defaultValue.data, - args: method.args.map(() => undefined), - sender, - }) + const result = await this.send.call({ method: defaultValue.data, args: method.args.map(() => undefined), sender }) if (result.return === undefined) { throw new Error('Default value method call did not return a value') } - if (typeof result.return === 'object' && !(result.return instanceof Uint8Array) && !Array.isArray(result.return)) { + if ( + typeof result.return === 'object' && + !(result.return instanceof Uint8Array) && + !Array.isArray(result.return) && + !(result.return instanceof Address) + ) { return getABITupleFromABIStruct(result.return, this._appSpec.structs[method.returns.struct!], this._appSpec.structs) } return result.return @@ -1180,10 +1167,7 @@ export class AppClient { /** Return params for an update call, including deploy-time TEAL template replacements and compilation if provided */ update: async (params?: AppClientBareCallParams & AppClientCompilationParams) => { return this.getBareParams( - { - ...params, - ...(await this.compile(params)), - }, + { ...params, ...(await this.compile(params)) }, OnApplicationComplete.UpdateApplicationOC, ) as AppUpdateParams }, @@ -1294,10 +1278,7 @@ export class AppClient { */ update: async (params: AppClientMethodCallParams & AppClientCompilationParams) => { return (await this.getABIParams( - { - ...params, - ...(await this.compile(params)), - }, + { ...params, ...(await this.compile(params)) }, OnApplicationComplete.UpdateApplicationOC, )) satisfies AppUpdateMethodCall }, @@ -1410,9 +1391,7 @@ export class AppClient { (params.onComplete === OnApplicationComplete.NoOpOC || !params.onComplete) && getArc56Method(params.method, this._appSpec).method.readonly ) { - const readonlyParams = { - ...params, - } + const readonlyParams = { ...params } // Read-only calls do not require fees to be paid, as they are only simulated on the network. // Therefore there is no value in calculating the minimum fee needed for a successful app call with inner transactions. @@ -1560,15 +1539,7 @@ export class AppClient { const sender = this.getSender(params.sender) const method = getArc56Method(params.method, this._appSpec) const args = await this.getABIArgsWithDefaultValues(params.method, params.args, sender) - return { - ...params, - appId: this._appId, - sender: sender, - signer: this.getSigner(params.sender, params.signer), - method, - onComplete, - args, - } + return { ...params, appId: this._appId, sender: sender, signer: this.getSigner(params.sender, params.signer), method, onComplete, args } } /** Make the given call and catch any errors, augmenting with debugging information before re-throwing. */ @@ -1661,12 +1632,8 @@ export class AppClient { private getStateMethods( stateGetter: () => Promise, - keyGetter: () => { - [name: string]: StorageKey - }, - mapGetter: () => { - [name: string]: StorageMap - }, + keyGetter: () => { [name: string]: StorageKey }, + mapGetter: () => { [name: string]: StorageMap }, ) { // eslint-disable-next-line @typescript-eslint/no-this-alias const that = this @@ -1830,10 +1797,7 @@ export class ApplicationClient { const approvalTemplate = Buffer.from(this.appSpec.source.approval, 'base64').toString('utf-8') const approval = replaceDeployTimeControlParams( performTemplateSubstitution(approvalTemplate, deployTimeParams ?? this.deployTimeParams), - { - updatable, - deletable, - }, + { updatable, deletable }, ) const approvalCompiled = await compileTeal(approval, this.algod) this._approvalSourceMap = approvalCompiled?.sourceMap @@ -1865,10 +1829,7 @@ export class ApplicationClient { ) } - return { - approvalSourceMap: this._approvalSourceMap, - clearSourceMap: this._clearSourceMap, - } + return { approvalSourceMap: this._approvalSourceMap, clearSourceMap: this._clearSourceMap } } /** @@ -1951,12 +1912,7 @@ export class ApplicationClient { from: sender, approvalProgram: approvalCompiled.compiledBase64ToBytes, clearStateProgram: clearCompiled.compiledBase64ToBytes, - metadata: { - name: this._appName, - version: version ?? '1.0', - updatable: compilation.updatable, - deletable: compilation.deletable, - }, + metadata: { name: this._appName, version: version ?? '1.0', updatable: compilation.updatable, deletable: compilation.deletable }, schema: { globalByteSlices: this.appSpec.state.global.num_byte_slices, globalInts: this.appSpec.state.global.num_uints, @@ -2242,12 +2198,7 @@ export class ApplicationClient { this.algod, sender ?? this.sender!, sendParams ?? {}, - { - receiver: ref.appAddress, - sender: getSenderAddress(sender ?? this.sender!), - amount: amount, - note: encodeTransactionNote(note), - }, + { receiver: ref.appAddress, sender: getSenderAddress(sender ?? this.sender!), amount: amount, note: encodeTransactionNote(note) }, (c) => c.payment, (c) => c.payment, this.params, @@ -2364,10 +2315,12 @@ export class ApplicationClient { const names = await this.getBoxNames() return await Promise.all( - names.filter(filter ?? ((_) => true)).map(async (boxName) => ({ - name: boxName, - value: await getAppBoxValueFromABIType({ appId: appRef.appId, boxName, type }, this.algod), - })), + names + .filter(filter ?? ((_) => true)) + .map(async (boxName) => ({ + name: boxName, + value: await getAppBoxValueFromABIType({ appId: appRef.appId, boxName, type }, this.algod), + })), ) } @@ -2411,11 +2364,7 @@ export class ApplicationClient { case 'abi-method': { const method = defaultValueStrategy.data as ABIMethodParams const result = await this.callOfType( - { - method: this.getABIMethodSignature(method), - methodArgs: method.args.map(() => undefined), - sender, - }, + { method: this.getABIMethodSignature(method), methodArgs: method.args.map(() => undefined), sender }, 'no_op', ) return result.return?.returnValue @@ -2491,18 +2440,12 @@ export class ApplicationClient { if (this.existingDeployments && this._appId === 0) { const app = this.existingDeployments.apps[this._appName] if (!app) { - return { - appId: 0, - appAddress: getApplicationAddress(0).toString(), - } + return { appId: 0, appAddress: getApplicationAddress(0).toString() } } return app } - return { - appId: this._appId, - appAddress: this._appAddress, - } as AppReference + return { appId: this._appId, appAddress: this._appAddress } as AppReference } /** From ec5fcc0e3f527271bf23e673c6e75684b34c8ae2 Mon Sep 17 00:00:00 2001 From: David Rojas Date: Thu, 8 May 2025 17:00:12 -0400 Subject: [PATCH 3/4] chore: updated vitest major version for npm audit failure --- package-lock.json | 409 +++++++++++++++++++++++++++++++--------------- package.json | 6 +- 2 files changed, 283 insertions(+), 132 deletions(-) diff --git a/package-lock.json b/package-lock.json index d9fff2e7..0df35525 100644 --- a/package-lock.json +++ b/package-lock.json @@ -23,7 +23,7 @@ "@tsconfig/node20": "^20.1.4", "@types/uuid": "^10.0.0", "@typescript-eslint/eslint-plugin": "^8.8.1", - "@vitest/coverage-v8": "^2.1.2", + "@vitest/coverage-v8": "^3.1.3", "algosdk": "^3.0.0", "better-npm-audit": "^3.11.0", "conventional-changelog-conventionalcommits": "8.0.0", @@ -46,7 +46,7 @@ "typescript": "^5.4.5", "typescript-eslint": "^8.16.0", "uuid": "^10.0.0", - "vitest": "^2.1.2", + "vitest": "^3.1.3", "vitest-fetch-mock": "^0.4.5" }, "engines": { @@ -260,10 +260,14 @@ } }, "node_modules/@bcoe/v8-coverage": { - "version": "0.2.3", - "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", - "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", - "dev": true + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-1.0.2.tgz", + "integrity": "sha512-6zABk/ECA/QYSCQ1NGiVwwbQerUCZ+TQbp64Q3AgmfNvurHH0j8TtXa1qbShXA6qqkpAj4V5W8pP6mLe1mcMqA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } }, "node_modules/@colors/colors": { "version": "1.5.0", @@ -701,6 +705,7 @@ "ppc64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "aix" @@ -717,6 +722,7 @@ "arm" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" @@ -733,6 +739,7 @@ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" @@ -749,6 +756,7 @@ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" @@ -765,6 +773,7 @@ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "darwin" @@ -781,6 +790,7 @@ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "darwin" @@ -797,6 +807,7 @@ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "freebsd" @@ -813,6 +824,7 @@ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "freebsd" @@ -829,6 +841,7 @@ "arm" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -845,6 +858,7 @@ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -861,6 +875,7 @@ "ia32" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -877,6 +892,7 @@ "loong64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -893,6 +909,7 @@ "mips64el" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -909,6 +926,7 @@ "ppc64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -925,6 +943,7 @@ "riscv64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -941,6 +960,7 @@ "s390x" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -957,6 +977,7 @@ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -973,6 +994,7 @@ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "netbsd" @@ -989,6 +1011,7 @@ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "netbsd" @@ -1005,6 +1028,7 @@ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "openbsd" @@ -1021,6 +1045,7 @@ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "openbsd" @@ -1037,6 +1062,7 @@ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "sunos" @@ -1053,6 +1079,7 @@ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" @@ -1069,6 +1096,7 @@ "ia32" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" @@ -1085,6 +1113,7 @@ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" @@ -2975,30 +3004,31 @@ } }, "node_modules/@vitest/coverage-v8": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-2.1.9.tgz", - "integrity": "sha512-Z2cOr0ksM00MpEfyVE8KXIYPEcBFxdbLSs56L8PO0QQMxt/6bDj45uQfxoc96v05KW3clk7vvgP0qfDit9DmfQ==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-3.1.3.tgz", + "integrity": "sha512-cj76U5gXCl3g88KSnf80kof6+6w+K4BjOflCl7t6yRJPDuCrHtVu0SgNYOUARJOL5TI8RScDbm5x4s1/P9bvpw==", "dev": true, + "license": "MIT", "dependencies": { "@ampproject/remapping": "^2.3.0", - "@bcoe/v8-coverage": "^0.2.3", - "debug": "^4.3.7", + "@bcoe/v8-coverage": "^1.0.2", + "debug": "^4.4.0", "istanbul-lib-coverage": "^3.2.2", "istanbul-lib-report": "^3.0.1", "istanbul-lib-source-maps": "^5.0.6", "istanbul-reports": "^3.1.7", - "magic-string": "^0.30.12", + "magic-string": "^0.30.17", "magicast": "^0.3.5", - "std-env": "^3.8.0", + "std-env": "^3.9.0", "test-exclude": "^7.0.1", - "tinyrainbow": "^1.2.0" + "tinyrainbow": "^2.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "@vitest/browser": "2.1.9", - "vitest": "2.1.9" + "@vitest/browser": "3.1.3", + "vitest": "3.1.3" }, "peerDependenciesMeta": { "@vitest/browser": { @@ -3035,36 +3065,38 @@ } }, "node_modules/@vitest/expect": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-2.1.9.tgz", - "integrity": "sha512-UJCIkTBenHeKT1TTlKMJWy1laZewsRIzYighyYiJKZreqtdxSos/S1t+ktRMQWu2CKqaarrkeszJx1cgC5tGZw==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.1.3.tgz", + "integrity": "sha512-7FTQQuuLKmN1Ig/h+h/GO+44Q1IlglPlR2es4ab7Yvfx+Uk5xsv+Ykk+MEt/M2Yn/xGmzaLKxGw2lgy2bwuYqg==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/spy": "2.1.9", - "@vitest/utils": "2.1.9", - "chai": "^5.1.2", - "tinyrainbow": "^1.2.0" + "@vitest/spy": "3.1.3", + "@vitest/utils": "3.1.3", + "chai": "^5.2.0", + "tinyrainbow": "^2.0.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/mocker": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-2.1.9.tgz", - "integrity": "sha512-tVL6uJgoUdi6icpxmdrn5YNo3g3Dxv+IHJBr0GXHaEdTcw3F+cPKnsXFhli6nO+f/6SDKPHEK1UN+k+TQv0Ehg==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.1.3.tgz", + "integrity": "sha512-PJbLjonJK82uCWHjzgBJZuR7zmAOrSvKk1QBxrennDIgtH4uK0TB1PvYmc0XBCigxxtiAVPfWtAdy4lpz8SQGQ==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/spy": "2.1.9", + "@vitest/spy": "3.1.3", "estree-walker": "^3.0.3", - "magic-string": "^0.30.12" + "magic-string": "^0.30.17" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "msw": "^2.4.9", - "vite": "^5.0.0" + "vite": "^5.0.0 || ^6.0.0" }, "peerDependenciesMeta": { "msw": { @@ -3080,54 +3112,59 @@ "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", "dev": true, + "license": "MIT", "dependencies": { "@types/estree": "^1.0.0" } }, "node_modules/@vitest/pretty-format": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-2.1.9.tgz", - "integrity": "sha512-KhRIdGV2U9HOUzxfiHmY8IFHTdqtOhIzCpd8WRdJiE7D/HUcZVD0EgQCVjm+Q9gkUXWgBvMmTtZgIG48wq7sOQ==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.1.3.tgz", + "integrity": "sha512-i6FDiBeJUGLDKADw2Gb01UtUNb12yyXAqC/mmRWuYl+m/U9GS7s8us5ONmGkGpUUo7/iAYzI2ePVfOZTYvUifA==", "dev": true, + "license": "MIT", "dependencies": { - "tinyrainbow": "^1.2.0" + "tinyrainbow": "^2.0.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/runner": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-2.1.9.tgz", - "integrity": "sha512-ZXSSqTFIrzduD63btIfEyOmNcBmQvgOVsPNPe0jYtESiXkhd8u2erDLnMxmGrDCwHCCHE7hxwRDCT3pt0esT4g==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.1.3.tgz", + "integrity": "sha512-Tae+ogtlNfFei5DggOsSUvkIaSuVywujMj6HzR97AHK6XK8i3BuVyIifWAm/sE3a15lF5RH9yQIrbXYuo0IFyA==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/utils": "2.1.9", - "pathe": "^1.1.2" + "@vitest/utils": "3.1.3", + "pathe": "^2.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/snapshot": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-2.1.9.tgz", - "integrity": "sha512-oBO82rEjsxLNJincVhLhaxxZdEtV0EFHMK5Kmx5sJ6H9L183dHECjiefOAdnqpIgT5eZwT04PoggUnW88vOBNQ==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.1.3.tgz", + "integrity": "sha512-XVa5OPNTYUsyqG9skuUkFzAeFnEzDp8hQu7kZ0N25B1+6KjGm4hWLtURyBbsIAOekfWQ7Wuz/N/XXzgYO3deWQ==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/pretty-format": "2.1.9", - "magic-string": "^0.30.12", - "pathe": "^1.1.2" + "@vitest/pretty-format": "3.1.3", + "magic-string": "^0.30.17", + "pathe": "^2.0.3" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/spy": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-2.1.9.tgz", - "integrity": "sha512-E1B35FwzXXTs9FHNK6bDszs7mtydNi5MIfUWpceJ8Xbfb1gBMscAnwLbEu+B44ed6W3XjL9/ehLPHR1fkf1KLQ==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.1.3.tgz", + "integrity": "sha512-x6w+ctOEmEXdWaa6TO4ilb7l9DxPR5bwEb6hILKuxfU1NqWT2mpJD9NJN7t3OTfxmVlOMrvtoFJGdgyzZ605lQ==", "dev": true, + "license": "MIT", "dependencies": { "tinyspy": "^3.0.2" }, @@ -3136,14 +3173,15 @@ } }, "node_modules/@vitest/utils": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-2.1.9.tgz", - "integrity": "sha512-v0psaMSkNJ3A2NMrUEHFRzJtDPFn+/VWZ5WxImB21T9fjucJRmS7xCS3ppEnARb9y11OAzaD+P2Ps+b+BGX5iQ==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.1.3.tgz", + "integrity": "sha512-2Ltrpht4OmHO9+c/nmHtF09HWiyWdworqnHIwjfvDyWjuwKbdkcS9AnhsDn+8E2RM4x++foD1/tNuLPVvWG1Rg==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/pretty-format": "2.1.9", - "loupe": "^3.1.2", - "tinyrainbow": "^1.2.0" + "@vitest/pretty-format": "3.1.3", + "loupe": "^3.1.3", + "tinyrainbow": "^2.0.0" }, "funding": { "url": "https://opencollective.com/vitest" @@ -3360,6 +3398,7 @@ "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", "dev": true, + "license": "MIT", "engines": { "node": ">=12" } @@ -3499,6 +3538,7 @@ "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -3536,6 +3576,7 @@ "resolved": "https://registry.npmjs.org/chai/-/chai-5.2.0.tgz", "integrity": "sha512-mCuXncKXk5iCLhfhwTc0izo0gtEmpz5CtG2y8GiOINBlMVS6v8TMRc5TaLWKS6692m9+dVVfzgeVxR5UxWHTYw==", "dev": true, + "license": "MIT", "dependencies": { "assertion-error": "^2.0.1", "check-error": "^2.1.1", @@ -3577,6 +3618,7 @@ "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.1.tgz", "integrity": "sha512-OAlb+T7V4Op9OwdkjmguYRqncdlx5JiofwOAUkmTF+jNdHwzTaTs4sRAGpzLF3oOz5xAyDGrPgeIDFQmDOTiJw==", "dev": true, + "license": "MIT", "engines": { "node": ">= 16" } @@ -4205,10 +4247,11 @@ "dev": true }, "node_modules/debug": { - "version": "4.3.7", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz", - "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==", + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", + "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==", "dev": true, + "license": "MIT", "dependencies": { "ms": "^2.1.3" }, @@ -4226,6 +4269,7 @@ "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=6" } @@ -4641,10 +4685,11 @@ } }, "node_modules/es-module-lexer": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.6.0.tgz", - "integrity": "sha512-qqnD1yMU6tk/jnaMosogGySTZP8YtUgAffA9nMN+E/rjxcfRQ6IEk7IiozUjgxKoFHBGjTLnrHB/YC45r/59EQ==", - "dev": true + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", + "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", + "dev": true, + "license": "MIT" }, "node_modules/es-object-atoms": { "version": "1.0.0", @@ -4695,6 +4740,7 @@ "integrity": "sha512-BXq5mqc8ltbaN34cDqWuYKyNhX8D/Z0J1xdtdQ8UcIIIyJyz+ZMKUt58tF3SrZ85jcfN/PZYhjR5uDQAYNVbuw==", "dev": true, "hasInstallScript": true, + "license": "MIT", "bin": { "esbuild": "bin/esbuild" }, @@ -4992,10 +5038,11 @@ } }, "node_modules/expect-type": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.1.0.tgz", - "integrity": "sha512-bFi65yM+xZgk+u/KRIpekdSYkTB5W1pEf0Lt8Q8Msh7b+eQ7LXVtIB1Bkm4fvclDEL1b2CZkMhv2mOeF8tMdkA==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.2.1.tgz", + "integrity": "sha512-/kP8CAwxzLVEeFrMm4kMmy4CCDlpipyA7MYLVrdJIkV0fYF0UaigQHRsxHiuY/GEea+bh4KSv3TIlgr+2UL6bw==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">=12.0.0" } @@ -6616,7 +6663,8 @@ "version": "3.1.3", "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.1.3.tgz", "integrity": "sha512-kkIp7XSkP78ZxJEsSxW3712C6teJVoeHHwgo9zJ380de7IYyJ2ISlxojcH2pC5OFLewESmnRi/+XCDIEEVyoug==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/lunr": { "version": "2.3.9", @@ -6873,9 +6921,9 @@ } }, "node_modules/nanoid": { - "version": "3.3.8", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.8.tgz", - "integrity": "sha512-WNLf5Sd8oZxOm+TzppcYk8gVOgP+l58xNy58D0nbUnOxOWRWvlcCV4kUF7ltmI6PsrLl/BgKEyS4mqsGChFN0w==", + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", "dev": true, "funding": [ { @@ -6883,6 +6931,7 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "bin": { "nanoid": "bin/nanoid.cjs" }, @@ -10216,16 +10265,18 @@ } }, "node_modules/pathe": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/pathe/-/pathe-1.1.2.tgz", - "integrity": "sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ==", - "dev": true + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", + "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", + "dev": true, + "license": "MIT" }, "node_modules/pathval": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.0.tgz", "integrity": "sha512-vE7JKRyES09KiunauX7nd2Q9/L7lhok4smP9RZTDeD4MVs72Dp2qNFVz39Nz5a0FVEW0BJR6C0DYrq6unoziZA==", "dev": true, + "license": "MIT", "engines": { "node": ">= 14.16" } @@ -10411,9 +10462,9 @@ } }, "node_modules/postcss": { - "version": "8.5.2", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.2.tgz", - "integrity": "sha512-MjOadfU3Ys9KYoX0AdkBlFEF1Vx37uCCeN4ZHnmwm9FfpbsGWMZeBLMmmpY+6Ocqod7mkdZ0DT31OlbsFrLlkA==", + "version": "8.5.3", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.3.tgz", + "integrity": "sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A==", "dev": true, "funding": [ { @@ -10429,6 +10480,7 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "dependencies": { "nanoid": "^3.3.8", "picocolors": "^1.1.1", @@ -11612,10 +11664,11 @@ "dev": true }, "node_modules/std-env": { - "version": "3.8.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.8.0.tgz", - "integrity": "sha512-Bc3YwwCB+OzldMxOXJIIvC6cPRWr/LxOp48CdQTOkPyk/t4JWWJbrilwBd7RJzKV8QW7tJkcgAmeuLLJugl5/w==", - "dev": true + "version": "3.9.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.9.0.tgz", + "integrity": "sha512-UGvjygr6F6tpH7o2qyqR6QYpwraIjKSdtzyBdyytFOHmPZY917kwdwLG0RbOjWOnKmnm3PeHjaoLLMie7kPLQw==", + "dev": true, + "license": "MIT" }, "node_modules/stream-combiner2": { "version": "1.1.1", @@ -12004,10 +12057,56 @@ "dev": true }, "node_modules/tinyexec": { - "version": "0.3.1", - "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.1.tgz", - "integrity": "sha512-WiCJLEECkO18gwqIp6+hJg0//p23HXp4S+gGtAKu3mI2F2/sXC4FvHvXvB0zJVVaTPhx1/tOwdbRsa1sOBIKqQ==", - "dev": true + "version": "0.3.2", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", + "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/tinyglobby": { + "version": "0.2.13", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.13.tgz", + "integrity": "sha512-mEwzpUgrLySlveBwEVDMKk5B57bhLPYovRfPAXD5gA/98Opn0rCDj3GtLwFvCvH5RK9uPCExUROW5NjDwvqkxw==", + "dev": true, + "license": "MIT", + "dependencies": { + "fdir": "^6.4.4", + "picomatch": "^4.0.2" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/tinyglobby/node_modules/fdir": { + "version": "6.4.4", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz", + "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/tinyglobby/node_modules/picomatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", + "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } }, "node_modules/tinypool": { "version": "1.0.2", @@ -12019,10 +12118,11 @@ } }, "node_modules/tinyrainbow": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-1.2.0.tgz", - "integrity": "sha512-weEDEq7Z5eTHPDh4xjX789+fHfF+P8boiFB+0vbWzpbnbsEr/GRaohi/uMKxg8RZMXnl1ItAi/IUHWMsjDV7kQ==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", + "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", "dev": true, + "license": "MIT", "engines": { "node": ">=14.0.0" } @@ -12032,6 +12132,7 @@ "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-3.0.2.tgz", "integrity": "sha512-n1cw8k1k0x4pgA2+9XrOkFydTerNcJ1zWCO5Nn9scWHTD+5tp8dghT2x1uduQePZTZgd3Tupf+x9BxJjeJi77Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=14.0.0" } @@ -12448,21 +12549,24 @@ } }, "node_modules/vite": { - "version": "5.4.18", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.18.tgz", - "integrity": "sha512-1oDcnEp3lVyHCuQ2YFelM4Alm2o91xNoMncRm1U7S+JdYfYOvbiGZ3/CxGttrOu2M/KcGz7cRC2DoNUA6urmMA==", + "version": "6.3.5", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.3.5.tgz", + "integrity": "sha512-cZn6NDFE7wdTpINgs++ZJ4N49W2vRp8LCKrn3Ob1kYNtOo21vfDoaV5GzBfLU4MovSAB8uNRm4jgzVQZ+mBzPQ==", "dev": true, "license": "MIT", "dependencies": { - "esbuild": "^0.21.3", - "postcss": "^8.4.43", - "rollup": "^4.20.0" + "esbuild": "^0.25.0", + "fdir": "^6.4.4", + "picomatch": "^4.0.2", + "postcss": "^8.5.3", + "rollup": "^4.34.9", + "tinyglobby": "^0.2.13" }, "bin": { "vite": "bin/vite.js" }, "engines": { - "node": "^18.0.0 || >=20.0.0" + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" }, "funding": { "url": "https://github.com/vitejs/vite?sponsor=1" @@ -12471,19 +12575,25 @@ "fsevents": "~2.3.3" }, "peerDependencies": { - "@types/node": "^18.0.0 || >=20.0.0", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "jiti": ">=1.21.0", "less": "*", "lightningcss": "^1.21.0", "sass": "*", "sass-embedded": "*", "stylus": "*", "sugarss": "*", - "terser": "^5.4.0" + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" }, "peerDependenciesMeta": { "@types/node": { "optional": true }, + "jiti": { + "optional": true + }, "less": { "optional": true }, @@ -12504,72 +12614,110 @@ }, "terser": { "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true } } }, "node_modules/vite-node": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-2.1.9.tgz", - "integrity": "sha512-AM9aQ/IPrW/6ENLQg3AGY4K1N2TGZdR5e4gu/MmmR2xR3Ll1+dib+nook92g4TV3PXVyeyxdWwtaCAiUL0hMxA==", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.1.3.tgz", + "integrity": "sha512-uHV4plJ2IxCl4u1up1FQRrqclylKAogbtBfOTwcuJ28xFi+89PZ57BRh+naIRvH70HPwxy5QHYzg1OrEaC7AbA==", "dev": true, + "license": "MIT", "dependencies": { "cac": "^6.7.14", - "debug": "^4.3.7", - "es-module-lexer": "^1.5.4", - "pathe": "^1.1.2", - "vite": "^5.0.0" + "debug": "^4.4.0", + "es-module-lexer": "^1.7.0", + "pathe": "^2.0.3", + "vite": "^5.0.0 || ^6.0.0" }, "bin": { "vite-node": "vite-node.mjs" }, "engines": { - "node": "^18.0.0 || >=20.0.0" + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, + "node_modules/vite/node_modules/fdir": { + "version": "6.4.4", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz", + "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/vite/node_modules/picomatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", + "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/vitest": { - "version": "2.1.9", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-2.1.9.tgz", - "integrity": "sha512-MSmPM9REYqDGBI8439mA4mWhV5sKmDlBKWIYbA3lRb2PTHACE0mgKwA8yQ2xq9vxDTuk4iPrECBAEW2aoFXY0Q==", - "dev": true, - "dependencies": { - "@vitest/expect": "2.1.9", - "@vitest/mocker": "2.1.9", - "@vitest/pretty-format": "^2.1.9", - "@vitest/runner": "2.1.9", - "@vitest/snapshot": "2.1.9", - "@vitest/spy": "2.1.9", - "@vitest/utils": "2.1.9", - "chai": "^5.1.2", - "debug": "^4.3.7", - "expect-type": "^1.1.0", - "magic-string": "^0.30.12", - "pathe": "^1.1.2", - "std-env": "^3.8.0", + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.1.3.tgz", + "integrity": "sha512-188iM4hAHQ0km23TN/adso1q5hhwKqUpv+Sd6p5sOuh6FhQnRNW3IsiIpvxqahtBabsJ2SLZgmGSpcYK4wQYJw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/expect": "3.1.3", + "@vitest/mocker": "3.1.3", + "@vitest/pretty-format": "^3.1.3", + "@vitest/runner": "3.1.3", + "@vitest/snapshot": "3.1.3", + "@vitest/spy": "3.1.3", + "@vitest/utils": "3.1.3", + "chai": "^5.2.0", + "debug": "^4.4.0", + "expect-type": "^1.2.1", + "magic-string": "^0.30.17", + "pathe": "^2.0.3", + "std-env": "^3.9.0", "tinybench": "^2.9.0", - "tinyexec": "^0.3.1", - "tinypool": "^1.0.1", - "tinyrainbow": "^1.2.0", - "vite": "^5.0.0", - "vite-node": "2.1.9", + "tinyexec": "^0.3.2", + "tinyglobby": "^0.2.13", + "tinypool": "^1.0.2", + "tinyrainbow": "^2.0.0", + "vite": "^5.0.0 || ^6.0.0", + "vite-node": "3.1.3", "why-is-node-running": "^2.3.0" }, "bin": { "vitest": "vitest.mjs" }, "engines": { - "node": "^18.0.0 || >=20.0.0" + "node": "^18.0.0 || ^20.0.0 || >=22.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "@edge-runtime/vm": "*", - "@types/node": "^18.0.0 || >=20.0.0", - "@vitest/browser": "2.1.9", - "@vitest/ui": "2.1.9", + "@types/debug": "^4.1.12", + "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@vitest/browser": "3.1.3", + "@vitest/ui": "3.1.3", "happy-dom": "*", "jsdom": "*" }, @@ -12577,6 +12725,9 @@ "@edge-runtime/vm": { "optional": true }, + "@types/debug": { + "optional": true + }, "@types/node": { "optional": true }, diff --git a/package.json b/package.json index f8d1db60..e99559bc 100644 --- a/package.json +++ b/package.json @@ -78,7 +78,7 @@ "@tsconfig/node20": "^20.1.4", "@types/uuid": "^10.0.0", "@typescript-eslint/eslint-plugin": "^8.8.1", - "@vitest/coverage-v8": "^2.1.2", + "@vitest/coverage-v8": "^3.1.3", "algosdk": "^3.0.0", "better-npm-audit": "^3.11.0", "conventional-changelog-conventionalcommits": "8.0.0", @@ -101,7 +101,7 @@ "typescript": "^5.4.5", "typescript-eslint": "^8.16.0", "uuid": "^10.0.0", - "vitest": "^2.1.2", + "vitest": "^3.1.3", "vitest-fetch-mock": "^0.4.5" }, "release": { @@ -171,4 +171,4 @@ "@semantic-release/github" ] } -} \ No newline at end of file +} From 8aec7900fedeb37e96087b737980b103ab34f010 Mon Sep 17 00:00:00 2001 From: David Rojas Date: Thu, 8 May 2025 17:43:30 -0400 Subject: [PATCH 4/4] chore: updated typedoc markdown plugin to major version due to minor verion bump of zero versioned typedoc --- docs/code/README.md | 96 +- docs/code/classes/testing.TestLogger.md | 272 -- .../code/classes/testing.TransactionLogger.md | 149 - .../classes/types_account.MultisigAccount.md | 186 - .../classes/types_account.SigningAccount.md | 153 - .../types_account_manager.AccountManager.md | 938 ----- ...ient_with_retry.AlgoHttpClientWithRetry.md | 200 - .../types_algorand_client.AlgorandClient.md | 767 ---- ...reator.AlgorandClientTransactionCreator.md | 1320 ------- ..._sender.AlgorandClientTransactionSender.md | 1510 -------- docs/code/classes/types_amount.AlgoAmount.md | 257 -- .../classes/types_app_arc56.Arc56Method.md | 259 -- .../classes/types_app_client.AppClient.md | 1450 -------- .../types_app_client.ApplicationClient.md | 887 ----- .../classes/types_app_deployer.AppDeployer.md | 225 -- .../classes/types_app_factory.AppFactory.md | 840 ----- .../classes/types_app_manager.AppManager.md | 623 ---- .../types_asset_manager.AssetManager.md | 221 -- ...s_async_event_emitter.AsyncEventEmitter.md | 244 -- .../types_client_manager.ClientManager.md | 1166 ------ .../types_composer.TransactionComposer.md | 1972 ---------- .../classes/types_config.UpdatableConfig.md | 274 -- ...penser_client.TestNetDispenserApiClient.md | 225 -- ...s_kmd_account_manager.KmdAccountManager.md | 182 - .../classes/types_logic_error.LogicError.md | 261 -- docs/code/enums/types_app.OnSchemaBreak.md | 51 - docs/code/enums/types_app.OnUpdate.md | 64 - .../code/enums/types_indexer.AccountStatus.md | 51 - .../types_indexer.ApplicationOnComplete.md | 78 - .../code/enums/types_indexer.SignatureType.md | 51 - .../enums/types_lifecycle_events.EventType.md | 32 - docs/code/index/README.md | 191 + docs/code/index/functions/algo.md | 25 + docs/code/index/functions/algos.md | 25 + docs/code/index/functions/assetBulkOptIn.md | 47 + docs/code/index/functions/assetBulkOptOut.md | 47 + docs/code/index/functions/assetOptIn.md | 43 + docs/code/index/functions/assetOptOut.md | 43 + docs/code/index/functions/callApp.md | 38 + .../code/index/functions/capTransactionFee.md | 37 + docs/code/index/functions/compileTeal.md | 37 + docs/code/index/functions/controlFees.md | 47 + docs/code/index/functions/createApp.md | 38 + docs/code/index/functions/createAsset.md | 43 + docs/code/index/functions/decodeAppState.md | 32 + docs/code/index/functions/deployApp.md | 51 + docs/code/index/functions/encodeLease.md | 41 + .../index/functions/encodeTransactionNote.md | 38 + docs/code/index/functions/ensureFunded.md | 53 + .../functions/executePaginatedRequest.md | 35 + .../index/functions/getABIMethodSignature.md | 31 + docs/code/index/functions/getABIReturn.md | 37 + .../code/index/functions/getABIReturnValue.md | 26 + docs/code/index/functions/getAccount.md | 238 ++ .../functions/getAccountAddressAsString.md | 29 + .../getAccountAddressAsUint8Array.md | 29 + .../functions/getAccountAssetInformation.md | 53 + .../getAccountConfigFromEnvironment.md | 36 + .../index/functions/getAccountInformation.md | 46 + docs/code/index/functions/getAlgoClient.md | 53 + .../index/functions/getAlgoIndexerClient.md | 52 + docs/code/index/functions/getAlgoKmdClient.md | 42 + .../code/index/functions/getAlgoNodeConfig.md | 35 + .../getAlgodConfigFromEnvironment.md | 21 + .../index/functions/getAppArgsForABICall.md | 37 + .../functions/getAppArgsForTransaction.md | 31 + docs/code/index/functions/getAppBoxNames.md | 36 + docs/code/index/functions/getAppBoxValue.md | 42 + .../functions/getAppBoxValueFromABIType.md | 36 + docs/code/index/functions/getAppBoxValues.md | 42 + .../functions/getAppBoxValuesFromABIType.md | 36 + docs/code/index/functions/getAppById.md | 37 + docs/code/index/functions/getAppClient.md | 69 + .../functions/getAppClientByCreatorAndName.md | 53 + docs/code/index/functions/getAppClientById.md | 52 + .../getAppDeploymentTransactionNote.md | 31 + .../code/index/functions/getAppGlobalState.md | 37 + docs/code/index/functions/getAppLocalState.md | 43 + .../index/functions/getAppOnCompleteAction.md | 35 + ...etAtomicTransactionComposerTransactions.md | 31 + docs/code/index/functions/getBoxReference.md | 31 + .../functions/getConfigFromEnvOrDefaults.md | 21 + .../index/functions/getCreatorAppsByName.md | 39 + .../functions/getDefaultLocalNetConfig.md | 29 + .../index/functions/getDispenserAccount.md | 38 + .../getIndexerConfigFromEnvironment.md | 21 + .../index/functions/getKmdWalletAccount.md | 58 + .../functions/getLocalNetDispenserAccount.md | 35 + .../functions/getOrCreateKmdWalletAccount.md | 57 + docs/code/index/functions/getSenderAddress.md | 32 + .../functions/getTestNetDispenserApiClient.md | 44 + .../index/functions/getTransactionParams.md | 37 + .../functions/getTransactionWithSigner.md | 42 + docs/code/index/functions/isLocalNet.md | 27 + docs/code/index/functions/isMainNet.md | 25 + docs/code/index/functions/isSchemaIsBroken.md | 39 + docs/code/index/functions/isTestNet.md | 25 + .../index/functions/lookupAccountByAddress.md | 36 + ...ookupAccountCreatedApplicationByAddress.md | 45 + .../index/functions/lookupAssetHoldings.md | 45 + .../index/functions/lookupTransactionById.md | 36 + docs/code/index/functions/microAlgo.md | 25 + docs/code/index/functions/microAlgos.md | 25 + docs/code/index/functions/mnemonicAccount.md | 32 + .../mnemonicAccountFromEnvironment.md | 65 + docs/code/index/functions/multisigAccount.md | 37 + ...erformAtomicTransactionComposerSimulate.md | 38 + .../functions/performTemplateSubstitution.md | 39 + .../performTemplateSubstitutionAndCompile.md | 51 + .../code/index/functions/persistSourceMaps.md | 29 + .../functions/populateAppCallResources.md | 34 + .../index/functions/prepareGroupForSending.md | 47 + docs/code/index/functions/randomAccount.md | 23 + docs/code/index/functions/rekeyAccount.md | 45 + docs/code/index/functions/rekeyedAccount.md | 37 + .../replaceDeployTimeControlParams.md | 49 + .../index/functions/searchTransactions.md | 39 + .../sendAtomicTransactionComposer.md | 33 + .../functions/sendGroupOfTransactions.md | 39 + docs/code/index/functions/sendTransaction.md | 50 + docs/code/index/functions/signTransaction.md | 39 + .../code/index/functions/stripTealComments.md | 31 + docs/code/index/functions/transactionFees.md | 25 + .../functions/transactionSignerAccount.md | 37 + docs/code/index/functions/transferAlgos.md | 43 + docs/code/index/functions/transferAsset.md | 43 + docs/code/index/functions/updateApp.md | 38 + .../index/functions/waitForConfirmation.md | 44 + docs/code/index/namespaces/indexer/README.md | 49 + .../index/type-aliases/AccountInformation.md | 23 + .../index/type-aliases/NumberConverter.md | 17 + .../type-aliases/SearchForTransactions.md | 11 + .../index/variables/ALGORAND_MIN_TX_FEE.md | 11 + docs/code/index/variables/Config.md | 13 + .../MAX_APP_CALL_ACCOUNT_REFERENCES.md | 11 + .../MAX_APP_CALL_FOREIGN_REFERENCES.md | 11 + .../variables/MAX_TRANSACTION_GROUP_SIZE.md | 11 + .../variables/getSenderTransactionSigner.md | 31 + .../interfaces/types_account.AccountConfig.md | 69 - .../types_account.TransactionSignerAccount.md | 34 - ...ypes_account_manager.EnsureFundedResult.md | 38 - .../interfaces/types_app.AppCallParams.md | 233 -- ...ypes_app.AppCallTransactionResultOfType.md | 108 - .../types_app.AppCompilationResult.md | 38 - .../interfaces/types_app.AppDeployMetadata.md | 72 - .../types_app.AppDeploymentParams.md | 305 -- docs/code/interfaces/types_app.AppLookup.md | 34 - docs/code/interfaces/types_app.AppMetadata.md | 174 - .../code/interfaces/types_app.AppReference.md | 44 - docs/code/interfaces/types_app.AppState.md | 11 - .../interfaces/types_app.AppStorageSchema.md | 77 - docs/code/interfaces/types_app.BoxName.md | 51 - .../code/interfaces/types_app.BoxReference.md | 42 - .../types_app.BoxValueRequestParams.md | 54 - .../types_app.BoxValuesRequestParams.md | 54 - .../code/interfaces/types_app.CompiledTeal.md | 77 - .../interfaces/types_app.CoreAppCallArgs.md | 98 - .../interfaces/types_app.CreateAppParams.md | 287 -- .../interfaces/types_app.RawAppCallArgs.md | 148 - .../types_app.TealTemplateParams.md | 13 - .../interfaces/types_app.UpdateAppParams.md | 274 -- .../types_app_arc56.Arc56Contract.md | 284 -- docs/code/interfaces/types_app_arc56.Event.md | 51 - .../code/interfaces/types_app_arc56.Method.md | 145 - .../types_app_arc56.ProgramSourceInfo.md | 38 - .../interfaces/types_app_arc56.StorageKey.md | 64 - .../interfaces/types_app_arc56.StorageMap.md | 64 - .../interfaces/types_app_arc56.StructField.md | 38 - .../types_app_client.AppClientCallABIArgs.md | 150 - ...ypes_app_client.AppClientCallCoreParams.md | 51 - ...s_app_client.AppClientCompilationParams.md | 49 - ...s_app_client.AppClientCompilationResult.md | 80 - ...ient.AppClientDeployCallInterfaceParams.md | 83 - ...es_app_client.AppClientDeployCoreParams.md | 111 - .../types_app_client.AppClientDeployParams.md | 239 -- .../types_app_client.AppClientParams.md | 120 - .../types_app_client.AppSourceMaps.md | 38 - .../types_app_client.FundAppAccountParams.md | 62 - .../types_app_client.ResolveAppById.md | 65 - .../types_app_client.ResolveAppByIdBase.md | 44 - .../types_app_client.SourceMapExport.md | 54 - .../types_app_deployer.AppLookup.md | 42 - .../types_app_deployer.AppMetadata.md | 164 - .../types_app_factory.AppFactoryParams.md | 145 - .../types_app_manager.AppInformation.md | 156 - .../types_app_manager.BoxReference.md | 38 - ...types_app_manager.BoxValueRequestParams.md | 51 - ...ypes_app_manager.BoxValuesRequestParams.md | 51 - .../interfaces/types_app_spec.AppSources.md | 38 - .../code/interfaces/types_app_spec.AppSpec.md | 90 - .../interfaces/types_app_spec.CallConfig.md | 77 - .../types_app_spec.DeclaredSchemaValueSpec.md | 64 - docs/code/interfaces/types_app_spec.Hint.md | 58 - .../types_app_spec.ReservedSchemaValueSpec.md | 51 - docs/code/interfaces/types_app_spec.Schema.md | 38 - .../interfaces/types_app_spec.SchemaSpec.md | 38 - .../types_app_spec.StateSchemaSpec.md | 38 - docs/code/interfaces/types_app_spec.Struct.md | 38 - .../types_asset.AssetBulkOptInOutParams.md | 105 - .../types_asset.AssetOptInParams.md | 224 -- .../types_asset.AssetOptOutParams.md | 268 -- .../types_asset.CreateAssetParams.md | 369 -- .../types_asset_manager.AssetInformation.md | 272 -- ...s_asset_manager.BulkAssetOptInOutResult.md | 38 - .../types_client_manager.AlgoSdkClients.md | 51 - .../types_client_manager.TypedAppClient.md | 84 - .../types_client_manager.TypedAppFactory.md | 39 - .../types_composer.BuiltTransactions.md | 51 - docs/code/interfaces/types_config.Config.md | 115 - .../types_debugging.AVMTracesEventData.md | 25 - ...ypes_debugging.TealSourceDebugEventData.md | 51 - ...pes_debugging.TealSourcesDebugEventData.md | 25 - ..._dispenser_client.DispenserFundResponse.md | 38 - ...dispenser_client.DispenserLimitResponse.md | 25 - ..._client.TestNetDispenserApiClientParams.md | 38 - ...ypes_indexer.LookupAssetHoldingsOptions.md | 51 - .../types_logic_error.LogicErrorDetails.md | 77 - .../types_network_client.AlgoClientConfig.md | 51 - .../types_network_client.AlgoConfig.md | 51 - .../types_network_client.NetworkDetails.md | 77 - .../types_testing.AlgoKitLogCaptureFixture.md | 72 - .../types_testing.AlgorandFixtureConfig.md | 149 - ...s_testing.AlgorandTestAutomationContext.md | 165 - .../types_testing.GetTestAccountParams.md | 65 - .../types_testing.LogSnapshotConfig.md | 80 - ...itionalAtomicTransactionComposerContext.md | 36 - ...saction.AtomicTransactionComposerToSend.md | 129 - ..._transaction.ConfirmedTransactionResult.md | 52 - ...transaction.ConfirmedTransactionResults.md | 88 - ...on.SendAtomicTransactionComposerResults.md | 92 - .../types_transaction.SendParams.md | 70 - ...types_transaction.SendTransactionParams.md | 135 - ...types_transaction.SendTransactionResult.md | 48 - ...ypes_transaction.SendTransactionResults.md | 49 - ...ypes_transaction.TransactionGroupToSend.md | 54 - .../types_transaction.TransactionToSign.md | 38 - .../types_transfer.AlgoRekeyParams.md | 222 -- .../types_transfer.AlgoTransferParams.md | 235 -- .../types_transfer.EnsureFundedParams.md | 248 -- .../types_transfer.EnsureFundedReturnType.md | 38 - .../types_transfer.TransferAssetParams.md | 261 -- docs/code/modules/index.indexer.md | 194 - docs/code/modules/index.md | 3245 ----------------- docs/code/modules/testing.md | 243 -- docs/code/modules/types_account.md | 100 - docs/code/modules/types_account_manager.md | 48 - .../modules/types_account_manager_spec.md | 3 - .../types_algo_http_client_with_retry.md | 9 - docs/code/modules/types_algorand_client.md | 9 - .../types_algorand_client_asset_spec.md | 3 - .../modules/types_algorand_client_spec.md | 3 - ...pes_algorand_client_transaction_creator.md | 9 - ...ypes_algorand_client_transaction_sender.md | 9 - .../types_algorand_client_transfer_spec.md | 3 - docs/code/modules/types_amount.md | 9 - docs/code/modules/types_amount_spec.md | 3 - docs/code/modules/types_app.md | 279 -- docs/code/modules/types_app_arc56.md | 346 -- docs/code/modules/types_app_client.md | 347 -- docs/code/modules/types_app_client_spec.md | 3 - docs/code/modules/types_app_deployer.md | 93 - docs/code/modules/types_app_factory.md | 124 - .../types_app_factory_and_client_spec.md | 3 - docs/code/modules/types_app_manager.md | 36 - docs/code/modules/types_app_spec.md | 170 - docs/code/modules/types_asset.md | 12 - docs/code/modules/types_asset_manager.md | 14 - .../code/modules/types_async_event_emitter.md | 44 - .../modules/types_async_event_emitter_spec.md | 3 - docs/code/modules/types_client_manager.md | 122 - .../code/modules/types_client_manager_spec.md | 3 - docs/code/modules/types_composer.md | 433 --- docs/code/modules/types_config.md | 13 - docs/code/modules/types_debugging.md | 79 - docs/code/modules/types_dispenser_client.md | 15 - .../modules/types_dispenser_client_spec.md | 3 - docs/code/modules/types_expand.md | 28 - docs/code/modules/types_indexer.md | 610 ---- .../code/modules/types_kmd_account_manager.md | 9 - docs/code/modules/types_lifecycle_events.md | 34 - docs/code/modules/types_logging.md | 93 - docs/code/modules/types_logic_error.md | 13 - docs/code/modules/types_network_client.md | 39 - docs/code/modules/types_testing.md | 14 - docs/code/modules/types_transaction.md | 91 - docs/code/modules/types_transfer.md | 13 - docs/code/testing/README.md | 22 + docs/code/testing/classes/TestLogger.md | 234 ++ .../code/testing/classes/TransactionLogger.md | 116 + .../code/testing/functions/algorandFixture.md | 108 + docs/code/testing/functions/getTestAccount.md | 79 + .../functions/runWhenIndexerCaughtUp.md | 41 + .../variables/algoKitLogCaptureFixture.md | 32 + .../code/types/account-manager.spec/README.md | 7 + docs/code/types/account-manager/README.md | 19 + .../account-manager/classes/AccountManager.md | 873 +++++ .../interfaces/EnsureFundedResult.md | 31 + .../variables/getAccountTransactionSigner.md | 32 + docs/code/types/account/README.md | 26 + .../types/account/classes/MultisigAccount.md | 159 + .../types/account/classes/SigningAccount.md | 109 + .../types/account/interfaces/AccountConfig.md | 56 + .../interfaces/TransactionSignerAccount.md | 27 + .../type-aliases/AccountAssetInformation.md | 53 + .../type-aliases/AccountInformation.md | 293 ++ .../account/variables/DISPENSER_ACCOUNT.md | 13 + .../algo-http-client-with-retry/README.md | 11 + .../classes/AlgoHttpClientWithRetry.md | 147 + .../README.md | 11 + .../AlgorandClientTransactionCreator.md | 1372 +++++++ .../README.md | 11 + .../AlgorandClientTransactionSender.md | 1212 ++++++ .../algorand-client.asset.spec/README.md | 7 + .../code/types/algorand-client.spec/README.md | 7 + .../algorand-client.transfer.spec/README.md | 7 + docs/code/types/algorand-client/README.md | 11 + .../algorand-client/classes/AlgorandClient.md | 593 +++ docs/code/types/amount.spec/README.md | 7 + docs/code/types/amount/README.md | 11 + docs/code/types/amount/classes/AlgoAmount.md | 213 ++ docs/code/types/app-arc56/README.md | 43 + .../types/app-arc56/classes/Arc56Method.md | 270 ++ .../app-arc56/functions/getABIDecodedValue.md | 40 + .../app-arc56/functions/getABIEncodedValue.md | 39 + .../functions/getABIStructFromABITuple.md | 43 + .../functions/getABITupleFromABIStruct.md | 37 + .../getABITupleTypeFromABIStructDefinition.md | 31 + .../app-arc56/functions/getArc56Method.md | 34 + .../functions/getArc56ReturnValue.md | 45 + .../app-arc56/interfaces/Arc56Contract.md | 345 ++ docs/code/types/app-arc56/interfaces/Event.md | 65 + .../code/types/app-arc56/interfaces/Method.md | 228 ++ .../app-arc56/interfaces/ProgramSourceInfo.md | 31 + .../types/app-arc56/interfaces/StorageKey.md | 51 + .../types/app-arc56/interfaces/StorageMap.md | 51 + .../types/app-arc56/interfaces/StructField.md | 31 + .../types/app-arc56/type-aliases/ABIStruct.md | 17 + .../types/app-arc56/type-aliases/ABIType.md | 13 + .../types/app-arc56/type-aliases/AVMBytes.md | 13 + .../types/app-arc56/type-aliases/AVMString.md | 13 + .../types/app-arc56/type-aliases/AVMType.md | 13 + .../types/app-arc56/type-aliases/AVMUint64.md | 13 + .../app-arc56/type-aliases/Arc56MethodArg.md | 13 + .../type-aliases/Arc56MethodReturnType.md | 13 + .../app-arc56/type-aliases/StructName.md | 13 + docs/code/types/app-client.spec/README.md | 7 + docs/code/types/app-client/README.md | 53 + .../types/app-client/classes/AppClient.md | 1367 +++++++ .../app-client/classes/ApplicationClient.md | 708 ++++ .../interfaces/AppClientCallABIArgs.md | 123 + .../interfaces/AppClientCallCoreParams.md | 41 + .../interfaces/AppClientCompilationParams.md | 39 + .../interfaces/AppClientCompilationResult.md | 65 + .../AppClientDeployCallInterfaceParams.md | 65 + .../interfaces/AppClientDeployCoreParams.md | 87 + .../interfaces/AppClientDeployParams.md | 195 + .../app-client/interfaces/AppClientParams.md | 95 + .../app-client/interfaces/AppSourceMaps.md | 31 + .../interfaces/FundAppAccountParams.md | 49 + .../app-client/interfaces/ResolveAppById.md | 53 + .../interfaces/ResolveAppByIdBase.md | 35 + .../app-client/interfaces/SourceMapExport.md | 41 + .../type-aliases/AppClientBareCallParams.md | 13 + .../type-aliases/AppClientCallArgs.md | 13 + .../type-aliases/AppClientCallParams.md | 13 + .../type-aliases/AppClientCallRawArgs.md | 11 + .../type-aliases/AppClientClearStateParams.md | 13 + .../type-aliases/AppClientCreateOnComplete.md | 23 + .../type-aliases/AppClientCreateParams.md | 21 + .../type-aliases/AppClientMethodCallParams.md | 13 + .../type-aliases/AppClientUpdateParams.md | 13 + .../app-client/type-aliases/AppDetails.md | 13 + .../app-client/type-aliases/AppDetailsBase.md | 44 + .../type-aliases/AppSpecAppDetails.md | 13 + .../type-aliases/AppSpecAppDetailsBase.md | 25 + .../AppSpecAppDetailsByCreatorAndName.md | 13 + .../type-aliases/AppSpecAppDetailsById.md | 13 + .../app-client/type-aliases/CallOnComplete.md | 23 + .../type-aliases/CloneAppClientParams.md | 13 + .../app-client/type-aliases/FundAppParams.md | 13 + .../ResolveAppByCreatorAndName.md | 21 + .../ResolveAppByCreatorAndNameBase.md | 45 + .../ResolveAppClientByCreatorAndName.md | 13 + .../type-aliases/ResolveAppClientByNetwork.md | 13 + docs/code/types/app-deployer/README.md | 25 + .../types/app-deployer/classes/AppDeployer.md | 236 ++ .../app-deployer/interfaces/AppLookup.md | 35 + .../app-deployer/interfaces/AppMetadata.md | 131 + .../type-aliases/AppDeployParams.md | 13 + .../type-aliases/AppDeployResult.md | 11 + .../type-aliases/DeployAppDeleteMethodCall.md | 13 + .../type-aliases/DeployAppDeleteParams.md | 13 + .../type-aliases/DeployAppUpdateMethodCall.md | 13 + .../type-aliases/DeployAppUpdateParams.md | 13 + .../app-factory-and-client.spec/README.md | 7 + docs/code/types/app-factory/README.md | 25 + .../types/app-factory/classes/AppFactory.md | 2002 ++++++++++ .../interfaces/AppFactoryParams.md | 117 + .../type-aliases/AppFactoryAppClientParams.md | 13 + .../AppFactoryCreateMethodCallParams.md | 13 + .../type-aliases/AppFactoryCreateParams.md | 13 + .../type-aliases/AppFactoryDeployParams.md | 13 + ...yResolveAppClientByCreatorAndNameParams.md | 13 + .../type-aliases/CreateOnComplete.md | 21 + .../app-factory/type-aliases/CreateSchema.md | 59 + docs/code/types/app-manager/README.md | 22 + .../types/app-manager/classes/AppManager.md | 624 ++++ .../app-manager/interfaces/AppInformation.md | 122 + .../app-manager/interfaces/BoxReference.md | 31 + .../interfaces/BoxValueRequestParams.md | 41 + .../interfaces/BoxValuesRequestParams.md | 41 + .../app-manager/type-aliases/BoxIdentifier.md | 17 + docs/code/types/app-spec/README.md | 35 + .../types/app-spec/functions/arc32ToArc56.md | 33 + .../types/app-spec/interfaces/AppSources.md | 31 + .../code/types/app-spec/interfaces/AppSpec.md | 71 + .../types/app-spec/interfaces/CallConfig.md | 61 + .../interfaces/DeclaredSchemaValueSpec.md | 51 + docs/code/types/app-spec/interfaces/Hint.md | 45 + .../interfaces/ReservedSchemaValueSpec.md | 41 + docs/code/types/app-spec/interfaces/Schema.md | 31 + .../types/app-spec/interfaces/SchemaSpec.md | 31 + .../app-spec/interfaces/StateSchemaSpec.md | 31 + docs/code/types/app-spec/interfaces/Struct.md | 31 + .../types/app-spec/type-aliases/ABIType.md | 13 + .../types/app-spec/type-aliases/AVMType.md | 13 + .../app-spec/type-aliases/CallConfigValue.md | 17 + .../app-spec/type-aliases/DefaultArgument.md | 69 + .../types/app-spec/type-aliases/FieldName.md | 13 + .../types/app-spec/type-aliases/HintSpec.md | 13 + .../app-spec/type-aliases/StateSchema.md | 33 + .../app-spec/type-aliases/StructElement.md | 13 + docs/code/types/app/README.md | 57 + .../types/app/enumerations/OnSchemaBreak.md | 41 + docs/code/types/app/enumerations/OnUpdate.md | 51 + .../types/app/interfaces/AppCallParams.md | 188 + .../AppCallTransactionResultOfType.md | 88 + .../app/interfaces/AppCompilationResult.md | 31 + .../types/app/interfaces/AppDeployMetadata.md | 56 + .../app/interfaces/AppDeploymentParams.md | 245 ++ docs/code/types/app/interfaces/AppLookup.md | 27 + docs/code/types/app/interfaces/AppMetadata.md | 139 + .../code/types/app/interfaces/AppReference.md | 35 + docs/code/types/app/interfaces/AppState.md | 15 + .../types/app/interfaces/AppStorageSchema.md | 61 + docs/code/types/app/interfaces/BoxName.md | 41 + .../code/types/app/interfaces/BoxReference.md | 35 + .../app/interfaces/BoxValueRequestParams.md | 44 + .../app/interfaces/BoxValuesRequestParams.md | 44 + .../code/types/app/interfaces/CompiledTeal.md | 61 + .../types/app/interfaces/CoreAppCallArgs.md | 77 + .../types/app/interfaces/CreateAppParams.md | 236 ++ .../types/app/interfaces/RawAppCallArgs.md | 121 + .../app/interfaces/TealTemplateParams.md | 17 + .../types/app/interfaces/UpdateAppParams.md | 226 ++ .../types/app/type-aliases/ABIAppCallArg.md | 13 + .../types/app/type-aliases/ABIAppCallArgs.md | 27 + docs/code/types/app/type-aliases/ABIReturn.md | 13 + .../types/app/type-aliases/AppCallArgs.md | 15 + .../type-aliases/AppCallTransactionResult.md | 13 + .../types/app/type-aliases/AppCallType.md | 26 + docs/code/types/app/type-aliases/AppReturn.md | 27 + .../types/app/type-aliases/BoxIdentifier.md | 20 + .../SendAppCreateTransactionResult.md | 13 + .../type-aliases/SendAppTransactionResult.md | 13 + .../SendAppUpdateTransactionResult.md | 13 + .../types/app/variables/ABI_RETURN_PREFIX.md | 13 + .../app/variables/APP_DEPLOY_NOTE_DAPP.md | 13 + .../types/app/variables/APP_PAGE_MAX_SIZE.md | 13 + .../app/variables/DELETABLE_TEMPLATE_NAME.md | 13 + .../app/variables/UPDATABLE_TEMPLATE_NAME.md | 13 + docs/code/types/asset-manager/README.md | 16 + .../asset-manager/classes/AssetManager.md | 209 ++ .../interfaces/AssetInformation.md | 223 ++ .../interfaces/BulkAssetOptInOutResult.md | 31 + docs/code/types/asset/README.md | 14 + .../interfaces/AssetBulkOptInOutParams.md | 83 + .../asset/interfaces/AssetOptInParams.md | 184 + .../asset/interfaces/AssetOptOutParams.md | 220 ++ .../asset/interfaces/CreateAssetParams.md | 297 ++ .../types/async-event-emitter.spec/README.md | 7 + docs/code/types/async-event-emitter/README.md | 15 + .../classes/AsyncEventEmitter.md | 225 ++ .../type-aliases/AsyncEventListener.md | 31 + docs/code/types/client-manager.spec/README.md | 7 + docs/code/types/client-manager/README.md | 28 + .../client-manager/classes/ClientManager.md | 1370 +++++++ .../interfaces/AlgoSdkClients.md | 41 + .../interfaces/TypedAppClient.md | 71 + .../interfaces/TypedAppFactory.md | 35 + .../ClientAppClientByNetworkParams.md | 13 + .../type-aliases/ClientAppClientParams.md | 13 + .../type-aliases/ClientAppFactoryParams.md | 13 + ...tResolveAppClientByCreatorAndNameParams.md | 13 + ...entTypedAppClientByCreatorAndNameParams.md | 13 + .../ClientTypedAppClientByNetworkParams.md | 13 + .../ClientTypedAppClientParams.md | 13 + .../ClientTypedAppFactoryParams.md | 13 + docs/code/types/composer/README.md | 50 + .../composer/classes/TransactionComposer.md | 1732 +++++++++ .../composer/interfaces/BuiltTransactions.md | 41 + .../type-aliases/AppCallMethodCall.md | 13 + .../composer/type-aliases/AppCallParams.md | 19 + .../type-aliases/AppCreateMethodCall.md | 13 + .../composer/type-aliases/AppCreateParams.md | 13 + .../type-aliases/AppDeleteMethodCall.md | 13 + .../composer/type-aliases/AppDeleteParams.md | 19 + .../composer/type-aliases/AppMethodCall.md | 39 + .../type-aliases/AppMethodCallParams.md | 19 + .../AppMethodCallTransactionArgument.md | 13 + .../type-aliases/AppUpdateMethodCall.md | 13 + .../composer/type-aliases/AppUpdateParams.md | 13 + .../type-aliases/AssetConfigParams.md | 73 + .../type-aliases/AssetCreateParams.md | 144 + .../type-aliases/AssetDestroyParams.md | 23 + .../type-aliases/AssetFreezeParams.md | 33 + .../composer/type-aliases/AssetOptInParams.md | 21 + .../type-aliases/AssetOptOutParams.md | 28 + .../type-aliases/AssetTransferParams.md | 51 + .../type-aliases/CommonAppCallParams.md | 60 + .../type-aliases/CommonTransactionParams.md | 133 + .../OfflineKeyRegistrationParams.md | 21 + .../OnlineKeyRegistrationParams.md | 51 + .../composer/type-aliases/PaymentParams.md | 35 + .../type-aliases/RawSimulateOptions.md | 14 + .../composer/type-aliases/SimulateOptions.md | 13 + .../SkipSignaturesSimulateOptions.md | 13 + .../type-aliases/TransactionComposerParams.md | 80 + docs/code/types/composer/type-aliases/Txn.md | 11 + .../variables/MAX_TRANSACTION_GROUP_SIZE.md | 11 + docs/code/types/config/README.md | 15 + .../types/config/classes/UpdatableConfig.md | 254 ++ docs/code/types/config/interfaces/Config.md | 90 + docs/code/types/debugging/README.md | 21 + .../interfaces/AVMTracesEventData.md | 21 + .../interfaces/TealSourceDebugEventData.md | 41 + .../interfaces/TealSourcesDebugEventData.md | 21 + .../types/debugging/variables/ALGOKIT_DIR.md | 13 + .../variables/DEFAULT_MAX_SEARCH_DEPTH.md | 13 + .../types/debugging/variables/SOURCES_DIR.md | 13 + .../debugging/variables/TEAL_FILE_EXT.md | 13 + .../debugging/variables/TEAL_SOURCEMAP_EXT.md | 13 + .../types/dispenser-client.spec/README.md | 7 + docs/code/types/dispenser-client/README.md | 17 + .../classes/TestNetDispenserApiClient.md | 160 + .../interfaces/DispenserFundResponse.md | 31 + .../interfaces/DispenserLimitResponse.md | 21 + .../TestNetDispenserApiClientParams.md | 31 + docs/code/types/expand/README.md | 11 + docs/code/types/expand/type-aliases/Expand.md | 20 + docs/code/types/indexer/README.md | 56 + .../indexer/enumerations/AccountStatus.md | 41 + .../enumerations/ApplicationOnComplete.md | 59 + .../indexer/enumerations/SignatureType.md | 41 + .../interfaces/LookupAssetHoldingsOptions.md | 41 + .../type-aliases/AccountLookupResult.md | 15 + .../type-aliases/AccountParticipation.md | 15 + .../indexer/type-aliases/AccountResult.md | 15 + .../indexer/type-aliases/AccountStateDelta.md | 15 + .../indexer/type-aliases/AppLocalState.md | 15 + .../ApplicationCreatedLookupResult.md | 15 + .../type-aliases/ApplicationLookupResult.md | 15 + .../indexer/type-aliases/ApplicationParams.md | 15 + .../indexer/type-aliases/ApplicationResult.md | 15 + .../ApplicationTransactionResult.md | 15 + .../type-aliases/AssetBalancesLookupResult.md | 15 + .../AssetConfigTransactionResult.md | 18 + .../AssetFreezeTransactionResult.md | 15 + .../indexer/type-aliases/AssetHolding.md | 15 + .../indexer/type-aliases/AssetLookupResult.md | 15 + .../types/indexer/type-aliases/AssetParams.md | 15 + .../types/indexer/type-aliases/AssetResult.md | 15 + .../AssetTransferTransactionResult.md | 15 + .../type-aliases/AssetsCreatedLookupResult.md | 15 + .../type-aliases/AssetsLookupResult.md | 15 + .../types/indexer/type-aliases/EvalDelta.md | 15 + .../indexer/type-aliases/EvalDeltaKeyValue.md | 15 + .../KeyRegistrationTransactionResult.md | 15 + .../type-aliases/LogicTransactionSignature.md | 19 + .../indexer/type-aliases/MerkleArrayProof.md | 49 + .../indexer/type-aliases/MiniAssetHolding.md | 15 + .../MultisigTransactionSignature.md | 15 + .../MultisigTransactionSubSignature.md | 15 + .../type-aliases/PaymentTransactionResult.md | 15 + .../types/indexer/type-aliases/StateDelta.md | 15 + .../StateProofTransactionResult.md | 21 + .../types/indexer/type-aliases/StateSchema.md | 20 + .../type-aliases/TransactionLookupResult.md | 15 + .../indexer/type-aliases/TransactionResult.md | 15 + .../type-aliases/TransactionSearchResults.md | 15 + .../type-aliases/TransactionSignature.md | 15 + docs/code/types/kmd-account-manager/README.md | 11 + .../classes/KmdAccountManager.md | 159 + docs/code/types/lifecycle-events/README.md | 15 + .../enumerations/EventType.md | 25 + .../type-aliases/EventDataMap.md | 31 + docs/code/types/logging/README.md | 19 + .../code/types/logging/type-aliases/Logger.md | 123 + .../types/logging/variables/consoleLogger.md | 13 + .../logging/variables/infoConsoleLogger.md | 11 + .../types/logging/variables/nullLogger.md | 13 + .../logging/variables/verboseConsoleLogger.md | 11 + .../logging/variables/warningConsoleLogger.md | 11 + docs/code/types/logic-error/README.md | 15 + .../types/logic-error/classes/LogicError.md | 229 ++ .../interfaces/LogicErrorDetails.md | 61 + docs/code/types/network-client/README.md | 17 + .../functions/genesisIdIsLocalNet.md | 27 + .../interfaces/AlgoClientConfig.md | 41 + .../network-client/interfaces/AlgoConfig.md | 41 + .../interfaces/NetworkDetails.md | 61 + docs/code/types/testing/README.md | 16 + .../interfaces/AlgoKitLogCaptureFixture.md | 53 + .../testing/interfaces/AlgorandFixture.md} | 96 +- .../interfaces/AlgorandFixtureConfig.md | 121 + .../AlgorandTestAutomationContext.md | 125 + .../interfaces/GetTestAccountParams.md | 51 + .../testing/interfaces/LogSnapshotConfig.md | 63 + docs/code/types/transaction/README.md | 29 + ...itionalAtomicTransactionComposerContext.md | 29 + .../AtomicTransactionComposerToSend.md | 105 + .../interfaces/ConfirmedTransactionResult.md | 43 + .../interfaces/ConfirmedTransactionResults.md | 71 + .../SendAtomicTransactionComposerResults.md | 74 + .../transaction/interfaces/SendParams.md | 55 + .../interfaces/SendTransactionParams.md | 102 + .../interfaces/SendTransactionResult.md | 37 + .../interfaces/SendTransactionResults.md | 38 + .../interfaces/TransactionGroupToSend.md | 44 + .../interfaces/TransactionToSign.md | 31 + .../type-aliases/Arc2TransactionNote.md | 13 + .../SendSingleTransactionResult.md | 13 + .../type-aliases/SendTransactionFrom.md | 21 + .../type-aliases/TransactionNote.md | 11 + .../type-aliases/TransactionNoteData.md | 11 + docs/code/types/transfer/README.md | 15 + .../transfer/interfaces/AlgoRekeyParams.md | 180 + .../transfer/interfaces/AlgoTransferParams.md | 190 + .../transfer/interfaces/EnsureFundedParams.md | 200 + .../interfaces/EnsureFundedReturnType.md | 31 + .../interfaces/TransferAssetParams.md | 210 ++ package-lock.json | 15 +- package.json | 2 +- typedoc.json | 2 +- 644 files changed, 32448 insertions(+), 31793 deletions(-) delete mode 100644 docs/code/classes/testing.TestLogger.md delete mode 100644 docs/code/classes/testing.TransactionLogger.md delete mode 100644 docs/code/classes/types_account.MultisigAccount.md delete mode 100644 docs/code/classes/types_account.SigningAccount.md delete mode 100644 docs/code/classes/types_account_manager.AccountManager.md delete mode 100644 docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md delete mode 100644 docs/code/classes/types_algorand_client.AlgorandClient.md delete mode 100644 docs/code/classes/types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md delete mode 100644 docs/code/classes/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md delete mode 100644 docs/code/classes/types_amount.AlgoAmount.md delete mode 100644 docs/code/classes/types_app_arc56.Arc56Method.md delete mode 100644 docs/code/classes/types_app_client.AppClient.md delete mode 100644 docs/code/classes/types_app_client.ApplicationClient.md delete mode 100644 docs/code/classes/types_app_deployer.AppDeployer.md delete mode 100644 docs/code/classes/types_app_factory.AppFactory.md delete mode 100644 docs/code/classes/types_app_manager.AppManager.md delete mode 100644 docs/code/classes/types_asset_manager.AssetManager.md delete mode 100644 docs/code/classes/types_async_event_emitter.AsyncEventEmitter.md delete mode 100644 docs/code/classes/types_client_manager.ClientManager.md delete mode 100644 docs/code/classes/types_composer.TransactionComposer.md delete mode 100644 docs/code/classes/types_config.UpdatableConfig.md delete mode 100644 docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md delete mode 100644 docs/code/classes/types_kmd_account_manager.KmdAccountManager.md delete mode 100644 docs/code/classes/types_logic_error.LogicError.md delete mode 100644 docs/code/enums/types_app.OnSchemaBreak.md delete mode 100644 docs/code/enums/types_app.OnUpdate.md delete mode 100644 docs/code/enums/types_indexer.AccountStatus.md delete mode 100644 docs/code/enums/types_indexer.ApplicationOnComplete.md delete mode 100644 docs/code/enums/types_indexer.SignatureType.md delete mode 100644 docs/code/enums/types_lifecycle_events.EventType.md create mode 100644 docs/code/index/README.md create mode 100644 docs/code/index/functions/algo.md create mode 100644 docs/code/index/functions/algos.md create mode 100644 docs/code/index/functions/assetBulkOptIn.md create mode 100644 docs/code/index/functions/assetBulkOptOut.md create mode 100644 docs/code/index/functions/assetOptIn.md create mode 100644 docs/code/index/functions/assetOptOut.md create mode 100644 docs/code/index/functions/callApp.md create mode 100644 docs/code/index/functions/capTransactionFee.md create mode 100644 docs/code/index/functions/compileTeal.md create mode 100644 docs/code/index/functions/controlFees.md create mode 100644 docs/code/index/functions/createApp.md create mode 100644 docs/code/index/functions/createAsset.md create mode 100644 docs/code/index/functions/decodeAppState.md create mode 100644 docs/code/index/functions/deployApp.md create mode 100644 docs/code/index/functions/encodeLease.md create mode 100644 docs/code/index/functions/encodeTransactionNote.md create mode 100644 docs/code/index/functions/ensureFunded.md create mode 100644 docs/code/index/functions/executePaginatedRequest.md create mode 100644 docs/code/index/functions/getABIMethodSignature.md create mode 100644 docs/code/index/functions/getABIReturn.md create mode 100644 docs/code/index/functions/getABIReturnValue.md create mode 100644 docs/code/index/functions/getAccount.md create mode 100644 docs/code/index/functions/getAccountAddressAsString.md create mode 100644 docs/code/index/functions/getAccountAddressAsUint8Array.md create mode 100644 docs/code/index/functions/getAccountAssetInformation.md create mode 100644 docs/code/index/functions/getAccountConfigFromEnvironment.md create mode 100644 docs/code/index/functions/getAccountInformation.md create mode 100644 docs/code/index/functions/getAlgoClient.md create mode 100644 docs/code/index/functions/getAlgoIndexerClient.md create mode 100644 docs/code/index/functions/getAlgoKmdClient.md create mode 100644 docs/code/index/functions/getAlgoNodeConfig.md create mode 100644 docs/code/index/functions/getAlgodConfigFromEnvironment.md create mode 100644 docs/code/index/functions/getAppArgsForABICall.md create mode 100644 docs/code/index/functions/getAppArgsForTransaction.md create mode 100644 docs/code/index/functions/getAppBoxNames.md create mode 100644 docs/code/index/functions/getAppBoxValue.md create mode 100644 docs/code/index/functions/getAppBoxValueFromABIType.md create mode 100644 docs/code/index/functions/getAppBoxValues.md create mode 100644 docs/code/index/functions/getAppBoxValuesFromABIType.md create mode 100644 docs/code/index/functions/getAppById.md create mode 100644 docs/code/index/functions/getAppClient.md create mode 100644 docs/code/index/functions/getAppClientByCreatorAndName.md create mode 100644 docs/code/index/functions/getAppClientById.md create mode 100644 docs/code/index/functions/getAppDeploymentTransactionNote.md create mode 100644 docs/code/index/functions/getAppGlobalState.md create mode 100644 docs/code/index/functions/getAppLocalState.md create mode 100644 docs/code/index/functions/getAppOnCompleteAction.md create mode 100644 docs/code/index/functions/getAtomicTransactionComposerTransactions.md create mode 100644 docs/code/index/functions/getBoxReference.md create mode 100644 docs/code/index/functions/getConfigFromEnvOrDefaults.md create mode 100644 docs/code/index/functions/getCreatorAppsByName.md create mode 100644 docs/code/index/functions/getDefaultLocalNetConfig.md create mode 100644 docs/code/index/functions/getDispenserAccount.md create mode 100644 docs/code/index/functions/getIndexerConfigFromEnvironment.md create mode 100644 docs/code/index/functions/getKmdWalletAccount.md create mode 100644 docs/code/index/functions/getLocalNetDispenserAccount.md create mode 100644 docs/code/index/functions/getOrCreateKmdWalletAccount.md create mode 100644 docs/code/index/functions/getSenderAddress.md create mode 100644 docs/code/index/functions/getTestNetDispenserApiClient.md create mode 100644 docs/code/index/functions/getTransactionParams.md create mode 100644 docs/code/index/functions/getTransactionWithSigner.md create mode 100644 docs/code/index/functions/isLocalNet.md create mode 100644 docs/code/index/functions/isMainNet.md create mode 100644 docs/code/index/functions/isSchemaIsBroken.md create mode 100644 docs/code/index/functions/isTestNet.md create mode 100644 docs/code/index/functions/lookupAccountByAddress.md create mode 100644 docs/code/index/functions/lookupAccountCreatedApplicationByAddress.md create mode 100644 docs/code/index/functions/lookupAssetHoldings.md create mode 100644 docs/code/index/functions/lookupTransactionById.md create mode 100644 docs/code/index/functions/microAlgo.md create mode 100644 docs/code/index/functions/microAlgos.md create mode 100644 docs/code/index/functions/mnemonicAccount.md create mode 100644 docs/code/index/functions/mnemonicAccountFromEnvironment.md create mode 100644 docs/code/index/functions/multisigAccount.md create mode 100644 docs/code/index/functions/performAtomicTransactionComposerSimulate.md create mode 100644 docs/code/index/functions/performTemplateSubstitution.md create mode 100644 docs/code/index/functions/performTemplateSubstitutionAndCompile.md create mode 100644 docs/code/index/functions/persistSourceMaps.md create mode 100644 docs/code/index/functions/populateAppCallResources.md create mode 100644 docs/code/index/functions/prepareGroupForSending.md create mode 100644 docs/code/index/functions/randomAccount.md create mode 100644 docs/code/index/functions/rekeyAccount.md create mode 100644 docs/code/index/functions/rekeyedAccount.md create mode 100644 docs/code/index/functions/replaceDeployTimeControlParams.md create mode 100644 docs/code/index/functions/searchTransactions.md create mode 100644 docs/code/index/functions/sendAtomicTransactionComposer.md create mode 100644 docs/code/index/functions/sendGroupOfTransactions.md create mode 100644 docs/code/index/functions/sendTransaction.md create mode 100644 docs/code/index/functions/signTransaction.md create mode 100644 docs/code/index/functions/stripTealComments.md create mode 100644 docs/code/index/functions/transactionFees.md create mode 100644 docs/code/index/functions/transactionSignerAccount.md create mode 100644 docs/code/index/functions/transferAlgos.md create mode 100644 docs/code/index/functions/transferAsset.md create mode 100644 docs/code/index/functions/updateApp.md create mode 100644 docs/code/index/functions/waitForConfirmation.md create mode 100644 docs/code/index/namespaces/indexer/README.md create mode 100644 docs/code/index/type-aliases/AccountInformation.md create mode 100644 docs/code/index/type-aliases/NumberConverter.md create mode 100644 docs/code/index/type-aliases/SearchForTransactions.md create mode 100644 docs/code/index/variables/ALGORAND_MIN_TX_FEE.md create mode 100644 docs/code/index/variables/Config.md create mode 100644 docs/code/index/variables/MAX_APP_CALL_ACCOUNT_REFERENCES.md create mode 100644 docs/code/index/variables/MAX_APP_CALL_FOREIGN_REFERENCES.md create mode 100644 docs/code/index/variables/MAX_TRANSACTION_GROUP_SIZE.md create mode 100644 docs/code/index/variables/getSenderTransactionSigner.md delete mode 100644 docs/code/interfaces/types_account.AccountConfig.md delete mode 100644 docs/code/interfaces/types_account.TransactionSignerAccount.md delete mode 100644 docs/code/interfaces/types_account_manager.EnsureFundedResult.md delete mode 100644 docs/code/interfaces/types_app.AppCallParams.md delete mode 100644 docs/code/interfaces/types_app.AppCallTransactionResultOfType.md delete mode 100644 docs/code/interfaces/types_app.AppCompilationResult.md delete mode 100644 docs/code/interfaces/types_app.AppDeployMetadata.md delete mode 100644 docs/code/interfaces/types_app.AppDeploymentParams.md delete mode 100644 docs/code/interfaces/types_app.AppLookup.md delete mode 100644 docs/code/interfaces/types_app.AppMetadata.md delete mode 100644 docs/code/interfaces/types_app.AppReference.md delete mode 100644 docs/code/interfaces/types_app.AppState.md delete mode 100644 docs/code/interfaces/types_app.AppStorageSchema.md delete mode 100644 docs/code/interfaces/types_app.BoxName.md delete mode 100644 docs/code/interfaces/types_app.BoxReference.md delete mode 100644 docs/code/interfaces/types_app.BoxValueRequestParams.md delete mode 100644 docs/code/interfaces/types_app.BoxValuesRequestParams.md delete mode 100644 docs/code/interfaces/types_app.CompiledTeal.md delete mode 100644 docs/code/interfaces/types_app.CoreAppCallArgs.md delete mode 100644 docs/code/interfaces/types_app.CreateAppParams.md delete mode 100644 docs/code/interfaces/types_app.RawAppCallArgs.md delete mode 100644 docs/code/interfaces/types_app.TealTemplateParams.md delete mode 100644 docs/code/interfaces/types_app.UpdateAppParams.md delete mode 100644 docs/code/interfaces/types_app_arc56.Arc56Contract.md delete mode 100644 docs/code/interfaces/types_app_arc56.Event.md delete mode 100644 docs/code/interfaces/types_app_arc56.Method.md delete mode 100644 docs/code/interfaces/types_app_arc56.ProgramSourceInfo.md delete mode 100644 docs/code/interfaces/types_app_arc56.StorageKey.md delete mode 100644 docs/code/interfaces/types_app_arc56.StorageMap.md delete mode 100644 docs/code/interfaces/types_app_arc56.StructField.md delete mode 100644 docs/code/interfaces/types_app_client.AppClientCallABIArgs.md delete mode 100644 docs/code/interfaces/types_app_client.AppClientCallCoreParams.md delete mode 100644 docs/code/interfaces/types_app_client.AppClientCompilationParams.md delete mode 100644 docs/code/interfaces/types_app_client.AppClientCompilationResult.md delete mode 100644 docs/code/interfaces/types_app_client.AppClientDeployCallInterfaceParams.md delete mode 100644 docs/code/interfaces/types_app_client.AppClientDeployCoreParams.md delete mode 100644 docs/code/interfaces/types_app_client.AppClientDeployParams.md delete mode 100644 docs/code/interfaces/types_app_client.AppClientParams.md delete mode 100644 docs/code/interfaces/types_app_client.AppSourceMaps.md delete mode 100644 docs/code/interfaces/types_app_client.FundAppAccountParams.md delete mode 100644 docs/code/interfaces/types_app_client.ResolveAppById.md delete mode 100644 docs/code/interfaces/types_app_client.ResolveAppByIdBase.md delete mode 100644 docs/code/interfaces/types_app_client.SourceMapExport.md delete mode 100644 docs/code/interfaces/types_app_deployer.AppLookup.md delete mode 100644 docs/code/interfaces/types_app_deployer.AppMetadata.md delete mode 100644 docs/code/interfaces/types_app_factory.AppFactoryParams.md delete mode 100644 docs/code/interfaces/types_app_manager.AppInformation.md delete mode 100644 docs/code/interfaces/types_app_manager.BoxReference.md delete mode 100644 docs/code/interfaces/types_app_manager.BoxValueRequestParams.md delete mode 100644 docs/code/interfaces/types_app_manager.BoxValuesRequestParams.md delete mode 100644 docs/code/interfaces/types_app_spec.AppSources.md delete mode 100644 docs/code/interfaces/types_app_spec.AppSpec.md delete mode 100644 docs/code/interfaces/types_app_spec.CallConfig.md delete mode 100644 docs/code/interfaces/types_app_spec.DeclaredSchemaValueSpec.md delete mode 100644 docs/code/interfaces/types_app_spec.Hint.md delete mode 100644 docs/code/interfaces/types_app_spec.ReservedSchemaValueSpec.md delete mode 100644 docs/code/interfaces/types_app_spec.Schema.md delete mode 100644 docs/code/interfaces/types_app_spec.SchemaSpec.md delete mode 100644 docs/code/interfaces/types_app_spec.StateSchemaSpec.md delete mode 100644 docs/code/interfaces/types_app_spec.Struct.md delete mode 100644 docs/code/interfaces/types_asset.AssetBulkOptInOutParams.md delete mode 100644 docs/code/interfaces/types_asset.AssetOptInParams.md delete mode 100644 docs/code/interfaces/types_asset.AssetOptOutParams.md delete mode 100644 docs/code/interfaces/types_asset.CreateAssetParams.md delete mode 100644 docs/code/interfaces/types_asset_manager.AssetInformation.md delete mode 100644 docs/code/interfaces/types_asset_manager.BulkAssetOptInOutResult.md delete mode 100644 docs/code/interfaces/types_client_manager.AlgoSdkClients.md delete mode 100644 docs/code/interfaces/types_client_manager.TypedAppClient.md delete mode 100644 docs/code/interfaces/types_client_manager.TypedAppFactory.md delete mode 100644 docs/code/interfaces/types_composer.BuiltTransactions.md delete mode 100644 docs/code/interfaces/types_config.Config.md delete mode 100644 docs/code/interfaces/types_debugging.AVMTracesEventData.md delete mode 100644 docs/code/interfaces/types_debugging.TealSourceDebugEventData.md delete mode 100644 docs/code/interfaces/types_debugging.TealSourcesDebugEventData.md delete mode 100644 docs/code/interfaces/types_dispenser_client.DispenserFundResponse.md delete mode 100644 docs/code/interfaces/types_dispenser_client.DispenserLimitResponse.md delete mode 100644 docs/code/interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md delete mode 100644 docs/code/interfaces/types_indexer.LookupAssetHoldingsOptions.md delete mode 100644 docs/code/interfaces/types_logic_error.LogicErrorDetails.md delete mode 100644 docs/code/interfaces/types_network_client.AlgoClientConfig.md delete mode 100644 docs/code/interfaces/types_network_client.AlgoConfig.md delete mode 100644 docs/code/interfaces/types_network_client.NetworkDetails.md delete mode 100644 docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md delete mode 100644 docs/code/interfaces/types_testing.AlgorandFixtureConfig.md delete mode 100644 docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md delete mode 100644 docs/code/interfaces/types_testing.GetTestAccountParams.md delete mode 100644 docs/code/interfaces/types_testing.LogSnapshotConfig.md delete mode 100644 docs/code/interfaces/types_transaction.AdditionalAtomicTransactionComposerContext.md delete mode 100644 docs/code/interfaces/types_transaction.AtomicTransactionComposerToSend.md delete mode 100644 docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md delete mode 100644 docs/code/interfaces/types_transaction.ConfirmedTransactionResults.md delete mode 100644 docs/code/interfaces/types_transaction.SendAtomicTransactionComposerResults.md delete mode 100644 docs/code/interfaces/types_transaction.SendParams.md delete mode 100644 docs/code/interfaces/types_transaction.SendTransactionParams.md delete mode 100644 docs/code/interfaces/types_transaction.SendTransactionResult.md delete mode 100644 docs/code/interfaces/types_transaction.SendTransactionResults.md delete mode 100644 docs/code/interfaces/types_transaction.TransactionGroupToSend.md delete mode 100644 docs/code/interfaces/types_transaction.TransactionToSign.md delete mode 100644 docs/code/interfaces/types_transfer.AlgoRekeyParams.md delete mode 100644 docs/code/interfaces/types_transfer.AlgoTransferParams.md delete mode 100644 docs/code/interfaces/types_transfer.EnsureFundedParams.md delete mode 100644 docs/code/interfaces/types_transfer.EnsureFundedReturnType.md delete mode 100644 docs/code/interfaces/types_transfer.TransferAssetParams.md delete mode 100644 docs/code/modules/index.indexer.md delete mode 100644 docs/code/modules/index.md delete mode 100644 docs/code/modules/testing.md delete mode 100644 docs/code/modules/types_account.md delete mode 100644 docs/code/modules/types_account_manager.md delete mode 100644 docs/code/modules/types_account_manager_spec.md delete mode 100644 docs/code/modules/types_algo_http_client_with_retry.md delete mode 100644 docs/code/modules/types_algorand_client.md delete mode 100644 docs/code/modules/types_algorand_client_asset_spec.md delete mode 100644 docs/code/modules/types_algorand_client_spec.md delete mode 100644 docs/code/modules/types_algorand_client_transaction_creator.md delete mode 100644 docs/code/modules/types_algorand_client_transaction_sender.md delete mode 100644 docs/code/modules/types_algorand_client_transfer_spec.md delete mode 100644 docs/code/modules/types_amount.md delete mode 100644 docs/code/modules/types_amount_spec.md delete mode 100644 docs/code/modules/types_app.md delete mode 100644 docs/code/modules/types_app_arc56.md delete mode 100644 docs/code/modules/types_app_client.md delete mode 100644 docs/code/modules/types_app_client_spec.md delete mode 100644 docs/code/modules/types_app_deployer.md delete mode 100644 docs/code/modules/types_app_factory.md delete mode 100644 docs/code/modules/types_app_factory_and_client_spec.md delete mode 100644 docs/code/modules/types_app_manager.md delete mode 100644 docs/code/modules/types_app_spec.md delete mode 100644 docs/code/modules/types_asset.md delete mode 100644 docs/code/modules/types_asset_manager.md delete mode 100644 docs/code/modules/types_async_event_emitter.md delete mode 100644 docs/code/modules/types_async_event_emitter_spec.md delete mode 100644 docs/code/modules/types_client_manager.md delete mode 100644 docs/code/modules/types_client_manager_spec.md delete mode 100644 docs/code/modules/types_composer.md delete mode 100644 docs/code/modules/types_config.md delete mode 100644 docs/code/modules/types_debugging.md delete mode 100644 docs/code/modules/types_dispenser_client.md delete mode 100644 docs/code/modules/types_dispenser_client_spec.md delete mode 100644 docs/code/modules/types_expand.md delete mode 100644 docs/code/modules/types_indexer.md delete mode 100644 docs/code/modules/types_kmd_account_manager.md delete mode 100644 docs/code/modules/types_lifecycle_events.md delete mode 100644 docs/code/modules/types_logging.md delete mode 100644 docs/code/modules/types_logic_error.md delete mode 100644 docs/code/modules/types_network_client.md delete mode 100644 docs/code/modules/types_testing.md delete mode 100644 docs/code/modules/types_transaction.md delete mode 100644 docs/code/modules/types_transfer.md create mode 100644 docs/code/testing/README.md create mode 100644 docs/code/testing/classes/TestLogger.md create mode 100644 docs/code/testing/classes/TransactionLogger.md create mode 100644 docs/code/testing/functions/algorandFixture.md create mode 100644 docs/code/testing/functions/getTestAccount.md create mode 100644 docs/code/testing/functions/runWhenIndexerCaughtUp.md create mode 100644 docs/code/testing/variables/algoKitLogCaptureFixture.md create mode 100644 docs/code/types/account-manager.spec/README.md create mode 100644 docs/code/types/account-manager/README.md create mode 100644 docs/code/types/account-manager/classes/AccountManager.md create mode 100644 docs/code/types/account-manager/interfaces/EnsureFundedResult.md create mode 100644 docs/code/types/account-manager/variables/getAccountTransactionSigner.md create mode 100644 docs/code/types/account/README.md create mode 100644 docs/code/types/account/classes/MultisigAccount.md create mode 100644 docs/code/types/account/classes/SigningAccount.md create mode 100644 docs/code/types/account/interfaces/AccountConfig.md create mode 100644 docs/code/types/account/interfaces/TransactionSignerAccount.md create mode 100644 docs/code/types/account/type-aliases/AccountAssetInformation.md create mode 100644 docs/code/types/account/type-aliases/AccountInformation.md create mode 100644 docs/code/types/account/variables/DISPENSER_ACCOUNT.md create mode 100644 docs/code/types/algo-http-client-with-retry/README.md create mode 100644 docs/code/types/algo-http-client-with-retry/classes/AlgoHttpClientWithRetry.md create mode 100644 docs/code/types/algorand-client-transaction-creator/README.md create mode 100644 docs/code/types/algorand-client-transaction-creator/classes/AlgorandClientTransactionCreator.md create mode 100644 docs/code/types/algorand-client-transaction-sender/README.md create mode 100644 docs/code/types/algorand-client-transaction-sender/classes/AlgorandClientTransactionSender.md create mode 100644 docs/code/types/algorand-client.asset.spec/README.md create mode 100644 docs/code/types/algorand-client.spec/README.md create mode 100644 docs/code/types/algorand-client.transfer.spec/README.md create mode 100644 docs/code/types/algorand-client/README.md create mode 100644 docs/code/types/algorand-client/classes/AlgorandClient.md create mode 100644 docs/code/types/amount.spec/README.md create mode 100644 docs/code/types/amount/README.md create mode 100644 docs/code/types/amount/classes/AlgoAmount.md create mode 100644 docs/code/types/app-arc56/README.md create mode 100644 docs/code/types/app-arc56/classes/Arc56Method.md create mode 100644 docs/code/types/app-arc56/functions/getABIDecodedValue.md create mode 100644 docs/code/types/app-arc56/functions/getABIEncodedValue.md create mode 100644 docs/code/types/app-arc56/functions/getABIStructFromABITuple.md create mode 100644 docs/code/types/app-arc56/functions/getABITupleFromABIStruct.md create mode 100644 docs/code/types/app-arc56/functions/getABITupleTypeFromABIStructDefinition.md create mode 100644 docs/code/types/app-arc56/functions/getArc56Method.md create mode 100644 docs/code/types/app-arc56/functions/getArc56ReturnValue.md create mode 100644 docs/code/types/app-arc56/interfaces/Arc56Contract.md create mode 100644 docs/code/types/app-arc56/interfaces/Event.md create mode 100644 docs/code/types/app-arc56/interfaces/Method.md create mode 100644 docs/code/types/app-arc56/interfaces/ProgramSourceInfo.md create mode 100644 docs/code/types/app-arc56/interfaces/StorageKey.md create mode 100644 docs/code/types/app-arc56/interfaces/StorageMap.md create mode 100644 docs/code/types/app-arc56/interfaces/StructField.md create mode 100644 docs/code/types/app-arc56/type-aliases/ABIStruct.md create mode 100644 docs/code/types/app-arc56/type-aliases/ABIType.md create mode 100644 docs/code/types/app-arc56/type-aliases/AVMBytes.md create mode 100644 docs/code/types/app-arc56/type-aliases/AVMString.md create mode 100644 docs/code/types/app-arc56/type-aliases/AVMType.md create mode 100644 docs/code/types/app-arc56/type-aliases/AVMUint64.md create mode 100644 docs/code/types/app-arc56/type-aliases/Arc56MethodArg.md create mode 100644 docs/code/types/app-arc56/type-aliases/Arc56MethodReturnType.md create mode 100644 docs/code/types/app-arc56/type-aliases/StructName.md create mode 100644 docs/code/types/app-client.spec/README.md create mode 100644 docs/code/types/app-client/README.md create mode 100644 docs/code/types/app-client/classes/AppClient.md create mode 100644 docs/code/types/app-client/classes/ApplicationClient.md create mode 100644 docs/code/types/app-client/interfaces/AppClientCallABIArgs.md create mode 100644 docs/code/types/app-client/interfaces/AppClientCallCoreParams.md create mode 100644 docs/code/types/app-client/interfaces/AppClientCompilationParams.md create mode 100644 docs/code/types/app-client/interfaces/AppClientCompilationResult.md create mode 100644 docs/code/types/app-client/interfaces/AppClientDeployCallInterfaceParams.md create mode 100644 docs/code/types/app-client/interfaces/AppClientDeployCoreParams.md create mode 100644 docs/code/types/app-client/interfaces/AppClientDeployParams.md create mode 100644 docs/code/types/app-client/interfaces/AppClientParams.md create mode 100644 docs/code/types/app-client/interfaces/AppSourceMaps.md create mode 100644 docs/code/types/app-client/interfaces/FundAppAccountParams.md create mode 100644 docs/code/types/app-client/interfaces/ResolveAppById.md create mode 100644 docs/code/types/app-client/interfaces/ResolveAppByIdBase.md create mode 100644 docs/code/types/app-client/interfaces/SourceMapExport.md create mode 100644 docs/code/types/app-client/type-aliases/AppClientBareCallParams.md create mode 100644 docs/code/types/app-client/type-aliases/AppClientCallArgs.md create mode 100644 docs/code/types/app-client/type-aliases/AppClientCallParams.md create mode 100644 docs/code/types/app-client/type-aliases/AppClientCallRawArgs.md create mode 100644 docs/code/types/app-client/type-aliases/AppClientClearStateParams.md create mode 100644 docs/code/types/app-client/type-aliases/AppClientCreateOnComplete.md create mode 100644 docs/code/types/app-client/type-aliases/AppClientCreateParams.md create mode 100644 docs/code/types/app-client/type-aliases/AppClientMethodCallParams.md create mode 100644 docs/code/types/app-client/type-aliases/AppClientUpdateParams.md create mode 100644 docs/code/types/app-client/type-aliases/AppDetails.md create mode 100644 docs/code/types/app-client/type-aliases/AppDetailsBase.md create mode 100644 docs/code/types/app-client/type-aliases/AppSpecAppDetails.md create mode 100644 docs/code/types/app-client/type-aliases/AppSpecAppDetailsBase.md create mode 100644 docs/code/types/app-client/type-aliases/AppSpecAppDetailsByCreatorAndName.md create mode 100644 docs/code/types/app-client/type-aliases/AppSpecAppDetailsById.md create mode 100644 docs/code/types/app-client/type-aliases/CallOnComplete.md create mode 100644 docs/code/types/app-client/type-aliases/CloneAppClientParams.md create mode 100644 docs/code/types/app-client/type-aliases/FundAppParams.md create mode 100644 docs/code/types/app-client/type-aliases/ResolveAppByCreatorAndName.md create mode 100644 docs/code/types/app-client/type-aliases/ResolveAppByCreatorAndNameBase.md create mode 100644 docs/code/types/app-client/type-aliases/ResolveAppClientByCreatorAndName.md create mode 100644 docs/code/types/app-client/type-aliases/ResolveAppClientByNetwork.md create mode 100644 docs/code/types/app-deployer/README.md create mode 100644 docs/code/types/app-deployer/classes/AppDeployer.md create mode 100644 docs/code/types/app-deployer/interfaces/AppLookup.md create mode 100644 docs/code/types/app-deployer/interfaces/AppMetadata.md create mode 100644 docs/code/types/app-deployer/type-aliases/AppDeployParams.md create mode 100644 docs/code/types/app-deployer/type-aliases/AppDeployResult.md create mode 100644 docs/code/types/app-deployer/type-aliases/DeployAppDeleteMethodCall.md create mode 100644 docs/code/types/app-deployer/type-aliases/DeployAppDeleteParams.md create mode 100644 docs/code/types/app-deployer/type-aliases/DeployAppUpdateMethodCall.md create mode 100644 docs/code/types/app-deployer/type-aliases/DeployAppUpdateParams.md create mode 100644 docs/code/types/app-factory-and-client.spec/README.md create mode 100644 docs/code/types/app-factory/README.md create mode 100644 docs/code/types/app-factory/classes/AppFactory.md create mode 100644 docs/code/types/app-factory/interfaces/AppFactoryParams.md create mode 100644 docs/code/types/app-factory/type-aliases/AppFactoryAppClientParams.md create mode 100644 docs/code/types/app-factory/type-aliases/AppFactoryCreateMethodCallParams.md create mode 100644 docs/code/types/app-factory/type-aliases/AppFactoryCreateParams.md create mode 100644 docs/code/types/app-factory/type-aliases/AppFactoryDeployParams.md create mode 100644 docs/code/types/app-factory/type-aliases/AppFactoryResolveAppClientByCreatorAndNameParams.md create mode 100644 docs/code/types/app-factory/type-aliases/CreateOnComplete.md create mode 100644 docs/code/types/app-factory/type-aliases/CreateSchema.md create mode 100644 docs/code/types/app-manager/README.md create mode 100644 docs/code/types/app-manager/classes/AppManager.md create mode 100644 docs/code/types/app-manager/interfaces/AppInformation.md create mode 100644 docs/code/types/app-manager/interfaces/BoxReference.md create mode 100644 docs/code/types/app-manager/interfaces/BoxValueRequestParams.md create mode 100644 docs/code/types/app-manager/interfaces/BoxValuesRequestParams.md create mode 100644 docs/code/types/app-manager/type-aliases/BoxIdentifier.md create mode 100644 docs/code/types/app-spec/README.md create mode 100644 docs/code/types/app-spec/functions/arc32ToArc56.md create mode 100644 docs/code/types/app-spec/interfaces/AppSources.md create mode 100644 docs/code/types/app-spec/interfaces/AppSpec.md create mode 100644 docs/code/types/app-spec/interfaces/CallConfig.md create mode 100644 docs/code/types/app-spec/interfaces/DeclaredSchemaValueSpec.md create mode 100644 docs/code/types/app-spec/interfaces/Hint.md create mode 100644 docs/code/types/app-spec/interfaces/ReservedSchemaValueSpec.md create mode 100644 docs/code/types/app-spec/interfaces/Schema.md create mode 100644 docs/code/types/app-spec/interfaces/SchemaSpec.md create mode 100644 docs/code/types/app-spec/interfaces/StateSchemaSpec.md create mode 100644 docs/code/types/app-spec/interfaces/Struct.md create mode 100644 docs/code/types/app-spec/type-aliases/ABIType.md create mode 100644 docs/code/types/app-spec/type-aliases/AVMType.md create mode 100644 docs/code/types/app-spec/type-aliases/CallConfigValue.md create mode 100644 docs/code/types/app-spec/type-aliases/DefaultArgument.md create mode 100644 docs/code/types/app-spec/type-aliases/FieldName.md create mode 100644 docs/code/types/app-spec/type-aliases/HintSpec.md create mode 100644 docs/code/types/app-spec/type-aliases/StateSchema.md create mode 100644 docs/code/types/app-spec/type-aliases/StructElement.md create mode 100644 docs/code/types/app/README.md create mode 100644 docs/code/types/app/enumerations/OnSchemaBreak.md create mode 100644 docs/code/types/app/enumerations/OnUpdate.md create mode 100644 docs/code/types/app/interfaces/AppCallParams.md create mode 100644 docs/code/types/app/interfaces/AppCallTransactionResultOfType.md create mode 100644 docs/code/types/app/interfaces/AppCompilationResult.md create mode 100644 docs/code/types/app/interfaces/AppDeployMetadata.md create mode 100644 docs/code/types/app/interfaces/AppDeploymentParams.md create mode 100644 docs/code/types/app/interfaces/AppLookup.md create mode 100644 docs/code/types/app/interfaces/AppMetadata.md create mode 100644 docs/code/types/app/interfaces/AppReference.md create mode 100644 docs/code/types/app/interfaces/AppState.md create mode 100644 docs/code/types/app/interfaces/AppStorageSchema.md create mode 100644 docs/code/types/app/interfaces/BoxName.md create mode 100644 docs/code/types/app/interfaces/BoxReference.md create mode 100644 docs/code/types/app/interfaces/BoxValueRequestParams.md create mode 100644 docs/code/types/app/interfaces/BoxValuesRequestParams.md create mode 100644 docs/code/types/app/interfaces/CompiledTeal.md create mode 100644 docs/code/types/app/interfaces/CoreAppCallArgs.md create mode 100644 docs/code/types/app/interfaces/CreateAppParams.md create mode 100644 docs/code/types/app/interfaces/RawAppCallArgs.md create mode 100644 docs/code/types/app/interfaces/TealTemplateParams.md create mode 100644 docs/code/types/app/interfaces/UpdateAppParams.md create mode 100644 docs/code/types/app/type-aliases/ABIAppCallArg.md create mode 100644 docs/code/types/app/type-aliases/ABIAppCallArgs.md create mode 100644 docs/code/types/app/type-aliases/ABIReturn.md create mode 100644 docs/code/types/app/type-aliases/AppCallArgs.md create mode 100644 docs/code/types/app/type-aliases/AppCallTransactionResult.md create mode 100644 docs/code/types/app/type-aliases/AppCallType.md create mode 100644 docs/code/types/app/type-aliases/AppReturn.md create mode 100644 docs/code/types/app/type-aliases/BoxIdentifier.md create mode 100644 docs/code/types/app/type-aliases/SendAppCreateTransactionResult.md create mode 100644 docs/code/types/app/type-aliases/SendAppTransactionResult.md create mode 100644 docs/code/types/app/type-aliases/SendAppUpdateTransactionResult.md create mode 100644 docs/code/types/app/variables/ABI_RETURN_PREFIX.md create mode 100644 docs/code/types/app/variables/APP_DEPLOY_NOTE_DAPP.md create mode 100644 docs/code/types/app/variables/APP_PAGE_MAX_SIZE.md create mode 100644 docs/code/types/app/variables/DELETABLE_TEMPLATE_NAME.md create mode 100644 docs/code/types/app/variables/UPDATABLE_TEMPLATE_NAME.md create mode 100644 docs/code/types/asset-manager/README.md create mode 100644 docs/code/types/asset-manager/classes/AssetManager.md create mode 100644 docs/code/types/asset-manager/interfaces/AssetInformation.md create mode 100644 docs/code/types/asset-manager/interfaces/BulkAssetOptInOutResult.md create mode 100644 docs/code/types/asset/README.md create mode 100644 docs/code/types/asset/interfaces/AssetBulkOptInOutParams.md create mode 100644 docs/code/types/asset/interfaces/AssetOptInParams.md create mode 100644 docs/code/types/asset/interfaces/AssetOptOutParams.md create mode 100644 docs/code/types/asset/interfaces/CreateAssetParams.md create mode 100644 docs/code/types/async-event-emitter.spec/README.md create mode 100644 docs/code/types/async-event-emitter/README.md create mode 100644 docs/code/types/async-event-emitter/classes/AsyncEventEmitter.md create mode 100644 docs/code/types/async-event-emitter/type-aliases/AsyncEventListener.md create mode 100644 docs/code/types/client-manager.spec/README.md create mode 100644 docs/code/types/client-manager/README.md create mode 100644 docs/code/types/client-manager/classes/ClientManager.md create mode 100644 docs/code/types/client-manager/interfaces/AlgoSdkClients.md create mode 100644 docs/code/types/client-manager/interfaces/TypedAppClient.md create mode 100644 docs/code/types/client-manager/interfaces/TypedAppFactory.md create mode 100644 docs/code/types/client-manager/type-aliases/ClientAppClientByNetworkParams.md create mode 100644 docs/code/types/client-manager/type-aliases/ClientAppClientParams.md create mode 100644 docs/code/types/client-manager/type-aliases/ClientAppFactoryParams.md create mode 100644 docs/code/types/client-manager/type-aliases/ClientResolveAppClientByCreatorAndNameParams.md create mode 100644 docs/code/types/client-manager/type-aliases/ClientTypedAppClientByCreatorAndNameParams.md create mode 100644 docs/code/types/client-manager/type-aliases/ClientTypedAppClientByNetworkParams.md create mode 100644 docs/code/types/client-manager/type-aliases/ClientTypedAppClientParams.md create mode 100644 docs/code/types/client-manager/type-aliases/ClientTypedAppFactoryParams.md create mode 100644 docs/code/types/composer/README.md create mode 100644 docs/code/types/composer/classes/TransactionComposer.md create mode 100644 docs/code/types/composer/interfaces/BuiltTransactions.md create mode 100644 docs/code/types/composer/type-aliases/AppCallMethodCall.md create mode 100644 docs/code/types/composer/type-aliases/AppCallParams.md create mode 100644 docs/code/types/composer/type-aliases/AppCreateMethodCall.md create mode 100644 docs/code/types/composer/type-aliases/AppCreateParams.md create mode 100644 docs/code/types/composer/type-aliases/AppDeleteMethodCall.md create mode 100644 docs/code/types/composer/type-aliases/AppDeleteParams.md create mode 100644 docs/code/types/composer/type-aliases/AppMethodCall.md create mode 100644 docs/code/types/composer/type-aliases/AppMethodCallParams.md create mode 100644 docs/code/types/composer/type-aliases/AppMethodCallTransactionArgument.md create mode 100644 docs/code/types/composer/type-aliases/AppUpdateMethodCall.md create mode 100644 docs/code/types/composer/type-aliases/AppUpdateParams.md create mode 100644 docs/code/types/composer/type-aliases/AssetConfigParams.md create mode 100644 docs/code/types/composer/type-aliases/AssetCreateParams.md create mode 100644 docs/code/types/composer/type-aliases/AssetDestroyParams.md create mode 100644 docs/code/types/composer/type-aliases/AssetFreezeParams.md create mode 100644 docs/code/types/composer/type-aliases/AssetOptInParams.md create mode 100644 docs/code/types/composer/type-aliases/AssetOptOutParams.md create mode 100644 docs/code/types/composer/type-aliases/AssetTransferParams.md create mode 100644 docs/code/types/composer/type-aliases/CommonAppCallParams.md create mode 100644 docs/code/types/composer/type-aliases/CommonTransactionParams.md create mode 100644 docs/code/types/composer/type-aliases/OfflineKeyRegistrationParams.md create mode 100644 docs/code/types/composer/type-aliases/OnlineKeyRegistrationParams.md create mode 100644 docs/code/types/composer/type-aliases/PaymentParams.md create mode 100644 docs/code/types/composer/type-aliases/RawSimulateOptions.md create mode 100644 docs/code/types/composer/type-aliases/SimulateOptions.md create mode 100644 docs/code/types/composer/type-aliases/SkipSignaturesSimulateOptions.md create mode 100644 docs/code/types/composer/type-aliases/TransactionComposerParams.md create mode 100644 docs/code/types/composer/type-aliases/Txn.md create mode 100644 docs/code/types/composer/variables/MAX_TRANSACTION_GROUP_SIZE.md create mode 100644 docs/code/types/config/README.md create mode 100644 docs/code/types/config/classes/UpdatableConfig.md create mode 100644 docs/code/types/config/interfaces/Config.md create mode 100644 docs/code/types/debugging/README.md create mode 100644 docs/code/types/debugging/interfaces/AVMTracesEventData.md create mode 100644 docs/code/types/debugging/interfaces/TealSourceDebugEventData.md create mode 100644 docs/code/types/debugging/interfaces/TealSourcesDebugEventData.md create mode 100644 docs/code/types/debugging/variables/ALGOKIT_DIR.md create mode 100644 docs/code/types/debugging/variables/DEFAULT_MAX_SEARCH_DEPTH.md create mode 100644 docs/code/types/debugging/variables/SOURCES_DIR.md create mode 100644 docs/code/types/debugging/variables/TEAL_FILE_EXT.md create mode 100644 docs/code/types/debugging/variables/TEAL_SOURCEMAP_EXT.md create mode 100644 docs/code/types/dispenser-client.spec/README.md create mode 100644 docs/code/types/dispenser-client/README.md create mode 100644 docs/code/types/dispenser-client/classes/TestNetDispenserApiClient.md create mode 100644 docs/code/types/dispenser-client/interfaces/DispenserFundResponse.md create mode 100644 docs/code/types/dispenser-client/interfaces/DispenserLimitResponse.md create mode 100644 docs/code/types/dispenser-client/interfaces/TestNetDispenserApiClientParams.md create mode 100644 docs/code/types/expand/README.md create mode 100644 docs/code/types/expand/type-aliases/Expand.md create mode 100644 docs/code/types/indexer/README.md create mode 100644 docs/code/types/indexer/enumerations/AccountStatus.md create mode 100644 docs/code/types/indexer/enumerations/ApplicationOnComplete.md create mode 100644 docs/code/types/indexer/enumerations/SignatureType.md create mode 100644 docs/code/types/indexer/interfaces/LookupAssetHoldingsOptions.md create mode 100644 docs/code/types/indexer/type-aliases/AccountLookupResult.md create mode 100644 docs/code/types/indexer/type-aliases/AccountParticipation.md create mode 100644 docs/code/types/indexer/type-aliases/AccountResult.md create mode 100644 docs/code/types/indexer/type-aliases/AccountStateDelta.md create mode 100644 docs/code/types/indexer/type-aliases/AppLocalState.md create mode 100644 docs/code/types/indexer/type-aliases/ApplicationCreatedLookupResult.md create mode 100644 docs/code/types/indexer/type-aliases/ApplicationLookupResult.md create mode 100644 docs/code/types/indexer/type-aliases/ApplicationParams.md create mode 100644 docs/code/types/indexer/type-aliases/ApplicationResult.md create mode 100644 docs/code/types/indexer/type-aliases/ApplicationTransactionResult.md create mode 100644 docs/code/types/indexer/type-aliases/AssetBalancesLookupResult.md create mode 100644 docs/code/types/indexer/type-aliases/AssetConfigTransactionResult.md create mode 100644 docs/code/types/indexer/type-aliases/AssetFreezeTransactionResult.md create mode 100644 docs/code/types/indexer/type-aliases/AssetHolding.md create mode 100644 docs/code/types/indexer/type-aliases/AssetLookupResult.md create mode 100644 docs/code/types/indexer/type-aliases/AssetParams.md create mode 100644 docs/code/types/indexer/type-aliases/AssetResult.md create mode 100644 docs/code/types/indexer/type-aliases/AssetTransferTransactionResult.md create mode 100644 docs/code/types/indexer/type-aliases/AssetsCreatedLookupResult.md create mode 100644 docs/code/types/indexer/type-aliases/AssetsLookupResult.md create mode 100644 docs/code/types/indexer/type-aliases/EvalDelta.md create mode 100644 docs/code/types/indexer/type-aliases/EvalDeltaKeyValue.md create mode 100644 docs/code/types/indexer/type-aliases/KeyRegistrationTransactionResult.md create mode 100644 docs/code/types/indexer/type-aliases/LogicTransactionSignature.md create mode 100644 docs/code/types/indexer/type-aliases/MerkleArrayProof.md create mode 100644 docs/code/types/indexer/type-aliases/MiniAssetHolding.md create mode 100644 docs/code/types/indexer/type-aliases/MultisigTransactionSignature.md create mode 100644 docs/code/types/indexer/type-aliases/MultisigTransactionSubSignature.md create mode 100644 docs/code/types/indexer/type-aliases/PaymentTransactionResult.md create mode 100644 docs/code/types/indexer/type-aliases/StateDelta.md create mode 100644 docs/code/types/indexer/type-aliases/StateProofTransactionResult.md create mode 100644 docs/code/types/indexer/type-aliases/StateSchema.md create mode 100644 docs/code/types/indexer/type-aliases/TransactionLookupResult.md create mode 100644 docs/code/types/indexer/type-aliases/TransactionResult.md create mode 100644 docs/code/types/indexer/type-aliases/TransactionSearchResults.md create mode 100644 docs/code/types/indexer/type-aliases/TransactionSignature.md create mode 100644 docs/code/types/kmd-account-manager/README.md create mode 100644 docs/code/types/kmd-account-manager/classes/KmdAccountManager.md create mode 100644 docs/code/types/lifecycle-events/README.md create mode 100644 docs/code/types/lifecycle-events/enumerations/EventType.md create mode 100644 docs/code/types/lifecycle-events/type-aliases/EventDataMap.md create mode 100644 docs/code/types/logging/README.md create mode 100644 docs/code/types/logging/type-aliases/Logger.md create mode 100644 docs/code/types/logging/variables/consoleLogger.md create mode 100644 docs/code/types/logging/variables/infoConsoleLogger.md create mode 100644 docs/code/types/logging/variables/nullLogger.md create mode 100644 docs/code/types/logging/variables/verboseConsoleLogger.md create mode 100644 docs/code/types/logging/variables/warningConsoleLogger.md create mode 100644 docs/code/types/logic-error/README.md create mode 100644 docs/code/types/logic-error/classes/LogicError.md create mode 100644 docs/code/types/logic-error/interfaces/LogicErrorDetails.md create mode 100644 docs/code/types/network-client/README.md create mode 100644 docs/code/types/network-client/functions/genesisIdIsLocalNet.md create mode 100644 docs/code/types/network-client/interfaces/AlgoClientConfig.md create mode 100644 docs/code/types/network-client/interfaces/AlgoConfig.md create mode 100644 docs/code/types/network-client/interfaces/NetworkDetails.md create mode 100644 docs/code/types/testing/README.md create mode 100644 docs/code/types/testing/interfaces/AlgoKitLogCaptureFixture.md rename docs/code/{interfaces/types_testing.AlgorandFixture.md => types/testing/interfaces/AlgorandFixture.md} (51%) create mode 100644 docs/code/types/testing/interfaces/AlgorandFixtureConfig.md create mode 100644 docs/code/types/testing/interfaces/AlgorandTestAutomationContext.md create mode 100644 docs/code/types/testing/interfaces/GetTestAccountParams.md create mode 100644 docs/code/types/testing/interfaces/LogSnapshotConfig.md create mode 100644 docs/code/types/transaction/README.md create mode 100644 docs/code/types/transaction/interfaces/AdditionalAtomicTransactionComposerContext.md create mode 100644 docs/code/types/transaction/interfaces/AtomicTransactionComposerToSend.md create mode 100644 docs/code/types/transaction/interfaces/ConfirmedTransactionResult.md create mode 100644 docs/code/types/transaction/interfaces/ConfirmedTransactionResults.md create mode 100644 docs/code/types/transaction/interfaces/SendAtomicTransactionComposerResults.md create mode 100644 docs/code/types/transaction/interfaces/SendParams.md create mode 100644 docs/code/types/transaction/interfaces/SendTransactionParams.md create mode 100644 docs/code/types/transaction/interfaces/SendTransactionResult.md create mode 100644 docs/code/types/transaction/interfaces/SendTransactionResults.md create mode 100644 docs/code/types/transaction/interfaces/TransactionGroupToSend.md create mode 100644 docs/code/types/transaction/interfaces/TransactionToSign.md create mode 100644 docs/code/types/transaction/type-aliases/Arc2TransactionNote.md create mode 100644 docs/code/types/transaction/type-aliases/SendSingleTransactionResult.md create mode 100644 docs/code/types/transaction/type-aliases/SendTransactionFrom.md create mode 100644 docs/code/types/transaction/type-aliases/TransactionNote.md create mode 100644 docs/code/types/transaction/type-aliases/TransactionNoteData.md create mode 100644 docs/code/types/transfer/README.md create mode 100644 docs/code/types/transfer/interfaces/AlgoRekeyParams.md create mode 100644 docs/code/types/transfer/interfaces/AlgoTransferParams.md create mode 100644 docs/code/types/transfer/interfaces/EnsureFundedParams.md create mode 100644 docs/code/types/transfer/interfaces/EnsureFundedReturnType.md create mode 100644 docs/code/types/transfer/interfaces/TransferAssetParams.md diff --git a/docs/code/README.md b/docs/code/README.md index 53ece411..3efead87 100644 --- a/docs/code/README.md +++ b/docs/code/README.md @@ -1,52 +1,52 @@ -@algorandfoundation/algokit-utils +**@algorandfoundation/algokit-utils** -# @algorandfoundation/algokit-utils +*** -## Table of contents +# @algorandfoundation/algokit-utils -### Modules +## Modules -- [index](modules/index.md) -- [testing](modules/testing.md) -- [types/account](modules/types_account.md) -- [types/account-manager](modules/types_account_manager.md) -- [types/account-manager.spec](modules/types_account_manager_spec.md) -- [types/algo-http-client-with-retry](modules/types_algo_http_client_with_retry.md) -- [types/algorand-client](modules/types_algorand_client.md) -- [types/algorand-client-transaction-creator](modules/types_algorand_client_transaction_creator.md) -- [types/algorand-client-transaction-sender](modules/types_algorand_client_transaction_sender.md) -- [types/algorand-client.asset.spec](modules/types_algorand_client_asset_spec.md) -- [types/algorand-client.spec](modules/types_algorand_client_spec.md) -- [types/algorand-client.transfer.spec](modules/types_algorand_client_transfer_spec.md) -- [types/amount](modules/types_amount.md) -- [types/amount.spec](modules/types_amount_spec.md) -- [types/app](modules/types_app.md) -- [types/app-arc56](modules/types_app_arc56.md) -- [types/app-client](modules/types_app_client.md) -- [types/app-client.spec](modules/types_app_client_spec.md) -- [types/app-deployer](modules/types_app_deployer.md) -- [types/app-factory](modules/types_app_factory.md) -- [types/app-factory-and-client.spec](modules/types_app_factory_and_client_spec.md) -- [types/app-manager](modules/types_app_manager.md) -- [types/app-spec](modules/types_app_spec.md) -- [types/asset](modules/types_asset.md) -- [types/asset-manager](modules/types_asset_manager.md) -- [types/async-event-emitter](modules/types_async_event_emitter.md) -- [types/async-event-emitter.spec](modules/types_async_event_emitter_spec.md) -- [types/client-manager](modules/types_client_manager.md) -- [types/client-manager.spec](modules/types_client_manager_spec.md) -- [types/composer](modules/types_composer.md) -- [types/config](modules/types_config.md) -- [types/debugging](modules/types_debugging.md) -- [types/dispenser-client](modules/types_dispenser_client.md) -- [types/dispenser-client.spec](modules/types_dispenser_client_spec.md) -- [types/expand](modules/types_expand.md) -- [types/indexer](modules/types_indexer.md) -- [types/kmd-account-manager](modules/types_kmd_account_manager.md) -- [types/lifecycle-events](modules/types_lifecycle_events.md) -- [types/logging](modules/types_logging.md) -- [types/logic-error](modules/types_logic_error.md) -- [types/network-client](modules/types_network_client.md) -- [types/testing](modules/types_testing.md) -- [types/transaction](modules/types_transaction.md) -- [types/transfer](modules/types_transfer.md) +- [index](index/README.md) +- [testing](testing/README.md) +- [types/account](types/account/README.md) +- [types/account-manager](types/account-manager/README.md) +- [types/account-manager.spec](types/account-manager.spec/README.md) +- [types/algo-http-client-with-retry](types/algo-http-client-with-retry/README.md) +- [types/algorand-client](types/algorand-client/README.md) +- [types/algorand-client-transaction-creator](types/algorand-client-transaction-creator/README.md) +- [types/algorand-client-transaction-sender](types/algorand-client-transaction-sender/README.md) +- [types/algorand-client.asset.spec](types/algorand-client.asset.spec/README.md) +- [types/algorand-client.spec](types/algorand-client.spec/README.md) +- [types/algorand-client.transfer.spec](types/algorand-client.transfer.spec/README.md) +- [types/amount](types/amount/README.md) +- [types/amount.spec](types/amount.spec/README.md) +- [types/app](types/app/README.md) +- [types/app-arc56](types/app-arc56/README.md) +- [types/app-client](types/app-client/README.md) +- [types/app-client.spec](types/app-client.spec/README.md) +- [types/app-deployer](types/app-deployer/README.md) +- [types/app-factory](types/app-factory/README.md) +- [types/app-factory-and-client.spec](types/app-factory-and-client.spec/README.md) +- [types/app-manager](types/app-manager/README.md) +- [types/app-spec](types/app-spec/README.md) +- [types/asset](types/asset/README.md) +- [types/asset-manager](types/asset-manager/README.md) +- [types/async-event-emitter](types/async-event-emitter/README.md) +- [types/async-event-emitter.spec](types/async-event-emitter.spec/README.md) +- [types/client-manager](types/client-manager/README.md) +- [types/client-manager.spec](types/client-manager.spec/README.md) +- [types/composer](types/composer/README.md) +- [types/config](types/config/README.md) +- [types/debugging](types/debugging/README.md) +- [types/dispenser-client](types/dispenser-client/README.md) +- [types/dispenser-client.spec](types/dispenser-client.spec/README.md) +- [types/expand](types/expand/README.md) +- [types/indexer](types/indexer/README.md) +- [types/kmd-account-manager](types/kmd-account-manager/README.md) +- [types/lifecycle-events](types/lifecycle-events/README.md) +- [types/logging](types/logging/README.md) +- [types/logic-error](types/logic-error/README.md) +- [types/network-client](types/network-client/README.md) +- [types/testing](types/testing/README.md) +- [types/transaction](types/transaction/README.md) +- [types/transfer](types/transfer/README.md) diff --git a/docs/code/classes/testing.TestLogger.md b/docs/code/classes/testing.TestLogger.md deleted file mode 100644 index fbe759b7..00000000 --- a/docs/code/classes/testing.TestLogger.md +++ /dev/null @@ -1,272 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [testing](../modules/testing.md) / TestLogger - -# Class: TestLogger - -[testing](../modules/testing.md).TestLogger - -Exposes an AlgoKit logger which captures log messages, while wrapping an original logger. -This is useful for automated testing. - -## Implements - -- [`Logger`](../modules/types_logging.md#logger) - -## Table of contents - -### Constructors - -- [constructor](testing.TestLogger.md#constructor) - -### Properties - -- [logs](testing.TestLogger.md#logs) -- [originalLogger](testing.TestLogger.md#originallogger) - -### Accessors - -- [capturedLogs](testing.TestLogger.md#capturedlogs) - -### Methods - -- [clear](testing.TestLogger.md#clear) -- [debug](testing.TestLogger.md#debug) -- [error](testing.TestLogger.md#error) -- [getLogSnapshot](testing.TestLogger.md#getlogsnapshot) -- [info](testing.TestLogger.md#info) -- [verbose](testing.TestLogger.md#verbose) -- [warn](testing.TestLogger.md#warn) - -## Constructors - -### constructor - -• **new TestLogger**(`originalLogger?`): [`TestLogger`](testing.TestLogger.md) - -Create a new test logger that wraps the given logger if provided. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `originalLogger?` | [`Logger`](../modules/types_logging.md#logger) | The optional original logger to wrap. | - -#### Returns - -[`TestLogger`](testing.TestLogger.md) - -#### Defined in - -[src/testing/test-logger.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L16) - -## Properties - -### logs - -• `Private` **logs**: `string`[] - -#### Defined in - -[src/testing/test-logger.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L10) - -___ - -### originalLogger - -• `Private` **originalLogger**: `undefined` \| [`Logger`](../modules/types_logging.md#logger) - -#### Defined in - -[src/testing/test-logger.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L9) - -## Accessors - -### capturedLogs - -• `get` **capturedLogs**(): `string`[] - -Returns all logs captured thus far. - -#### Returns - -`string`[] - -#### Defined in - -[src/testing/test-logger.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L22) - -## Methods - -### clear - -▸ **clear**(): `void` - -Clears all logs captured so far. - -#### Returns - -`void` - -#### Defined in - -[src/testing/test-logger.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L27) - -___ - -### debug - -▸ **debug**(`message`, `...optionalParams`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `...optionalParams` | `unknown`[] | - -#### Returns - -`void` - -#### Implementation of - -Logger.debug - -#### Defined in - -[src/testing/test-logger.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L89) - -___ - -### error - -▸ **error**(`message`, `...optionalParams`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `...optionalParams` | `unknown`[] | - -#### Returns - -`void` - -#### Implementation of - -Logger.error - -#### Defined in - -[src/testing/test-logger.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L73) - -___ - -### getLogSnapshot - -▸ **getLogSnapshot**(`config?`): `string` - -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 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config?` | [`LogSnapshotConfig`](../interfaces/types_testing.LogSnapshotConfig.md) | The snapshot configuration | - -#### Returns - -`string` - -The snapshotted logs. - -**`Example`** - -```typescript -const logger = new TestLogger() -... -expect(logger.getLogSnapshot()).toMatchSnapshot() -``` - -#### Defined in - -[src/testing/test-logger.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L47) - -___ - -### info - -▸ **info**(`message`, `...optionalParams`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `...optionalParams` | `unknown`[] | - -#### Returns - -`void` - -#### Implementation of - -Logger.info - -#### Defined in - -[src/testing/test-logger.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L81) - -___ - -### verbose - -▸ **verbose**(`message`, `...optionalParams`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `...optionalParams` | `unknown`[] | - -#### Returns - -`void` - -#### Implementation of - -Logger.verbose - -#### Defined in - -[src/testing/test-logger.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L85) - -___ - -### warn - -▸ **warn**(`message`, `...optionalParams`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `string` | -| `...optionalParams` | `unknown`[] | - -#### Returns - -`void` - -#### Implementation of - -Logger.warn - -#### Defined in - -[src/testing/test-logger.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L77) diff --git a/docs/code/classes/testing.TransactionLogger.md b/docs/code/classes/testing.TransactionLogger.md deleted file mode 100644 index 785d7e39..00000000 --- a/docs/code/classes/testing.TransactionLogger.md +++ /dev/null @@ -1,149 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [testing](../modules/testing.md) / TransactionLogger - -# Class: TransactionLogger - -[testing](../modules/testing.md).TransactionLogger - -Allows you to keep track of Algorand transaction IDs by wrapping an `Algodv2` in a proxy. -Useful for automated tests. - -## Table of contents - -### Constructors - -- [constructor](testing.TransactionLogger.md#constructor) - -### Properties - -- [\_sentTransactionIds](testing.TransactionLogger.md#_senttransactionids) - -### Accessors - -- [sentTransactionIds](testing.TransactionLogger.md#senttransactionids) - -### Methods - -- [capture](testing.TransactionLogger.md#capture) -- [clear](testing.TransactionLogger.md#clear) -- [logRawTransaction](testing.TransactionLogger.md#lograwtransaction) -- [waitForIndexer](testing.TransactionLogger.md#waitforindexer) - -## Constructors - -### constructor - -• **new TransactionLogger**(): [`TransactionLogger`](testing.TransactionLogger.md) - -#### Returns - -[`TransactionLogger`](testing.TransactionLogger.md) - -## Properties - -### \_sentTransactionIds - -• `Private` **\_sentTransactionIds**: `string`[] = `[]` - -#### Defined in - -[src/testing/transaction-logger.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L12) - -## Accessors - -### sentTransactionIds - -• `get` **sentTransactionIds**(): readonly `string`[] - -The list of transaction IDs that has been logged thus far. - -#### Returns - -readonly `string`[] - -#### Defined in - -[src/testing/transaction-logger.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L17) - -## Methods - -### capture - -▸ **capture**(`algod`): `AlgodClient` - -Return a proxy that wraps the given Algodv2 with this transaction logger. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `algod` | `AlgodClient` | The `Algodv2` to wrap | - -#### Returns - -`AlgodClient` - -The wrapped `Algodv2`, any transactions sent using this algod instance will be logged by this transaction logger - -#### Defined in - -[src/testing/transaction-logger.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L48) - -___ - -### clear - -▸ **clear**(): `void` - -Clear all logged IDs. - -#### Returns - -`void` - -#### Defined in - -[src/testing/transaction-logger.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L24) - -___ - -### logRawTransaction - -▸ **logRawTransaction**(`signedTransactions`): `void` - -The method that captures raw transactions and stores the transaction IDs. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signedTransactions` | `Uint8Array` \| `Uint8Array`[] | - -#### Returns - -`void` - -#### Defined in - -[src/testing/transaction-logger.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L31) - -___ - -### waitForIndexer - -▸ **waitForIndexer**(`indexer`): `Promise`\<`void`\> - -Wait until all logged transactions IDs appear in the given `Indexer`. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `indexer` | `IndexerClient` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/testing/transaction-logger.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L53) diff --git a/docs/code/classes/types_account.MultisigAccount.md b/docs/code/classes/types_account.MultisigAccount.md deleted file mode 100644 index 725db2af..00000000 --- a/docs/code/classes/types_account.MultisigAccount.md +++ /dev/null @@ -1,186 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/account](../modules/types_account.md) / MultisigAccount - -# Class: MultisigAccount - -[types/account](../modules/types_account.md).MultisigAccount - -Account wrapper that supports partial or full multisig signing. - -## Table of contents - -### Constructors - -- [constructor](types_account.MultisigAccount.md#constructor) - -### Properties - -- [\_addr](types_account.MultisigAccount.md#_addr) -- [\_params](types_account.MultisigAccount.md#_params) -- [\_signer](types_account.MultisigAccount.md#_signer) -- [\_signingAccounts](types_account.MultisigAccount.md#_signingaccounts) - -### Accessors - -- [addr](types_account.MultisigAccount.md#addr) -- [params](types_account.MultisigAccount.md#params) -- [signer](types_account.MultisigAccount.md#signer) -- [signingAccounts](types_account.MultisigAccount.md#signingaccounts) - -### Methods - -- [sign](types_account.MultisigAccount.md#sign) - -## Constructors - -### constructor - -• **new MultisigAccount**(`multisigParams`, `signingAccounts`): [`MultisigAccount`](types_account.MultisigAccount.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `multisigParams` | `MultisigMetadata` | -| `signingAccounts` | (`default` \| [`SigningAccount`](types_account.SigningAccount.md))[] | - -#### Returns - -[`MultisigAccount`](types_account.MultisigAccount.md) - -#### Defined in - -[src/types/account.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L46) - -## Properties - -### \_addr - -• **\_addr**: `Address` - -#### Defined in - -[src/types/account.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L23) - -___ - -### \_params - -• **\_params**: `MultisigMetadata` - -#### Defined in - -[src/types/account.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L21) - -___ - -### \_signer - -• **\_signer**: `TransactionSigner` - -#### Defined in - -[src/types/account.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L24) - -___ - -### \_signingAccounts - -• **\_signingAccounts**: (`default` \| [`SigningAccount`](types_account.SigningAccount.md))[] - -#### Defined in - -[src/types/account.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L22) - -## Accessors - -### addr - -• `get` **addr**(): `Readonly`\<`Address`\> - -The address of the multisig account - -#### Returns - -`Readonly`\<`Address`\> - -#### Defined in - -[src/types/account.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L37) - -___ - -### params - -• `get` **params**(): `Readonly`\<`MultisigMetadata`\> - -The parameters for the multisig account - -#### Returns - -`Readonly`\<`MultisigMetadata`\> - -#### Defined in - -[src/types/account.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L27) - -___ - -### signer - -• `get` **signer**(): `TransactionSigner` - -The transaction signer for the multisig account - -#### Returns - -`TransactionSigner` - -#### Defined in - -[src/types/account.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L42) - -___ - -### signingAccounts - -• `get` **signingAccounts**(): readonly (`default` \| [`SigningAccount`](types_account.SigningAccount.md))[] - -The list of accounts that are present to sign - -#### Returns - -readonly (`default` \| [`SigningAccount`](types_account.SigningAccount.md))[] - -#### Defined in - -[src/types/account.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L32) - -## Methods - -### sign - -▸ **sign**(`transaction`): `Uint8Array` - -Sign the given transaction - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transaction` | `Uint8Array` \| `Transaction` | Either a transaction object or a raw, partially signed transaction | - -#### Returns - -`Uint8Array` - -The transaction signed by the present signers - -**`Example`** - -```typescript -const signedTxn = multisigAccount.sign(myTransaction) -``` - -#### Defined in - -[src/types/account.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L65) diff --git a/docs/code/classes/types_account.SigningAccount.md b/docs/code/classes/types_account.SigningAccount.md deleted file mode 100644 index 69413114..00000000 --- a/docs/code/classes/types_account.SigningAccount.md +++ /dev/null @@ -1,153 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/account](../modules/types_account.md) / SigningAccount - -# Class: SigningAccount - -[types/account](../modules/types_account.md).SigningAccount - -Account wrapper that supports a rekeyed account - -## Implements - -- `default` - -## Table of contents - -### Constructors - -- [constructor](types_account.SigningAccount.md#constructor) - -### Properties - -- [\_account](types_account.SigningAccount.md#_account) -- [\_sender](types_account.SigningAccount.md#_sender) -- [\_signer](types_account.SigningAccount.md#_signer) - -### Accessors - -- [addr](types_account.SigningAccount.md#addr) -- [sender](types_account.SigningAccount.md#sender) -- [signer](types_account.SigningAccount.md#signer) -- [sk](types_account.SigningAccount.md#sk) - -## Constructors - -### constructor - -• **new SigningAccount**(`account`, `sender`): [`SigningAccount`](types_account.SigningAccount.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | `default` | -| `sender` | `undefined` \| `string` \| `Address` | - -#### Returns - -[`SigningAccount`](types_account.SigningAccount.md) - -#### Defined in - -[src/types/account.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L115) - -## Properties - -### \_account - -• `Private` **\_account**: `default` - -#### Defined in - -[src/types/account.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L80) - -___ - -### \_sender - -• `Private` **\_sender**: `Address` - -#### Defined in - -[src/types/account.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L82) - -___ - -### \_signer - -• `Private` **\_signer**: `TransactionSigner` - -#### Defined in - -[src/types/account.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L81) - -## Accessors - -### addr - -• `get` **addr**(): `Readonly`\<`Address`\> - -Algorand address of the sender - -#### Returns - -`Readonly`\<`Address`\> - -#### Implementation of - -Account.addr - -#### Defined in - -[src/types/account.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L87) - -___ - -### sender - -• `get` **sender**(): `default` - -Algorand account of the sender address and signer private key - -#### Returns - -`default` - -#### Defined in - -[src/types/account.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L108) - -___ - -### signer - -• `get` **signer**(): `TransactionSigner` - -Transaction signer for the underlying signing account - -#### Returns - -`TransactionSigner` - -#### Defined in - -[src/types/account.ts:101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L101) - -___ - -### sk - -• `get` **sk**(): `Readonly`\<`Uint8Array`\> - -Secret key belonging to the signer - -#### Returns - -`Readonly`\<`Uint8Array`\> - -#### Implementation of - -Account.sk - -#### Defined in - -[src/types/account.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L94) diff --git a/docs/code/classes/types_account_manager.AccountManager.md b/docs/code/classes/types_account_manager.AccountManager.md deleted file mode 100644 index b2174f68..00000000 --- a/docs/code/classes/types_account_manager.AccountManager.md +++ /dev/null @@ -1,938 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/account-manager](../modules/types_account_manager.md) / AccountManager - -# Class: AccountManager - -[types/account-manager](../modules/types_account_manager.md).AccountManager - -Creates and keeps track of signing accounts that can sign transactions for a sending address. - -## Table of contents - -### Constructors - -- [constructor](types_account_manager.AccountManager.md#constructor) - -### Properties - -- [\_accounts](types_account_manager.AccountManager.md#_accounts) -- [\_clientManager](types_account_manager.AccountManager.md#_clientmanager) -- [\_defaultSigner](types_account_manager.AccountManager.md#_defaultsigner) -- [\_kmdAccountManager](types_account_manager.AccountManager.md#_kmdaccountmanager) - -### Accessors - -- [kmd](types_account_manager.AccountManager.md#kmd) - -### Methods - -- [\_getComposer](types_account_manager.AccountManager.md#_getcomposer) -- [\_getEnsureFundedAmount](types_account_manager.AccountManager.md#_getensurefundedamount) -- [dispenserFromEnvironment](types_account_manager.AccountManager.md#dispenserfromenvironment) -- [ensureFunded](types_account_manager.AccountManager.md#ensurefunded) -- [ensureFundedFromEnvironment](types_account_manager.AccountManager.md#ensurefundedfromenvironment) -- [ensureFundedFromTestNetDispenserApi](types_account_manager.AccountManager.md#ensurefundedfromtestnetdispenserapi) -- [fromEnvironment](types_account_manager.AccountManager.md#fromenvironment) -- [fromKmd](types_account_manager.AccountManager.md#fromkmd) -- [fromMnemonic](types_account_manager.AccountManager.md#frommnemonic) -- [getAccount](types_account_manager.AccountManager.md#getaccount) -- [getInformation](types_account_manager.AccountManager.md#getinformation) -- [getSigner](types_account_manager.AccountManager.md#getsigner) -- [localNetDispenser](types_account_manager.AccountManager.md#localnetdispenser) -- [logicsig](types_account_manager.AccountManager.md#logicsig) -- [multisig](types_account_manager.AccountManager.md#multisig) -- [random](types_account_manager.AccountManager.md#random) -- [rekeyAccount](types_account_manager.AccountManager.md#rekeyaccount) -- [rekeyed](types_account_manager.AccountManager.md#rekeyed) -- [setDefaultSigner](types_account_manager.AccountManager.md#setdefaultsigner) -- [setSigner](types_account_manager.AccountManager.md#setsigner) -- [setSignerFromAccount](types_account_manager.AccountManager.md#setsignerfromaccount) -- [setSigners](types_account_manager.AccountManager.md#setsigners) -- [signerAccount](types_account_manager.AccountManager.md#signeraccount) - -## Constructors - -### constructor - -• **new AccountManager**(`clientManager`): [`AccountManager`](types_account_manager.AccountManager.md) - -Create a new account manager. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `clientManager` | [`ClientManager`](types_client_manager.ClientManager.md) | The ClientManager client to use for algod and kmd clients | - -#### Returns - -[`AccountManager`](types_account_manager.AccountManager.md) - -**`Example`** - -```typescript -const accountManager = new AccountManager(clientManager) -``` - -#### Defined in - -[src/types/account-manager.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L60) - -## Properties - -### \_accounts - -• `Private` **\_accounts**: `Object` = `{}` - -#### Index signature - -▪ [address: `string`]: [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -#### Defined in - -[src/types/account-manager.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L49) - -___ - -### \_clientManager - -• `Private` **\_clientManager**: [`ClientManager`](types_client_manager.ClientManager.md) - -#### Defined in - -[src/types/account-manager.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L47) - -___ - -### \_defaultSigner - -• `Private` `Optional` **\_defaultSigner**: `TransactionSigner` - -#### Defined in - -[src/types/account-manager.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L50) - -___ - -### \_kmdAccountManager - -• `Private` **\_kmdAccountManager**: [`KmdAccountManager`](types_kmd_account_manager.KmdAccountManager.md) - -#### Defined in - -[src/types/account-manager.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L48) - -## Accessors - -### kmd - -• `get` **kmd**(): [`KmdAccountManager`](types_kmd_account_manager.KmdAccountManager.md) - -KMD account manager that allows you to easily get and create accounts using KMD. - -#### Returns - -[`KmdAccountManager`](types_kmd_account_manager.KmdAccountManager.md) - -The `KmdAccountManager` instance. - -**`Example`** - -```typescript -const kmdManager = accountManager.kmd; -``` - -#### Defined in - -[src/types/account-manager.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L81) - -## Methods - -### \_getComposer - -▸ **_getComposer**(`getSuggestedParams?`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `getSuggestedParams?` | () => `Promise`\<`SuggestedParams`\> | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -#### Defined in - -[src/types/account-manager.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L65) - -___ - -### \_getEnsureFundedAmount - -▸ **_getEnsureFundedAmount**(`sender`, `minSpendingBalance`, `minFundingIncrement?`): `Promise`\<`undefined` \| [`AlgoAmount`](types_amount.AlgoAmount.md)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sender` | `Address` | -| `minSpendingBalance` | [`AlgoAmount`](types_amount.AlgoAmount.md) | -| `minFundingIncrement?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | - -#### Returns - -`Promise`\<`undefined` \| [`AlgoAmount`](types_amount.AlgoAmount.md)\> - -#### Defined in - -[src/types/account-manager.ts:528](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L528) - -___ - -### dispenserFromEnvironment - -▸ **dispenserFromEnvironment**(): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -Returns an account (with private key loaded) that can act as a dispenser from -environment variables, or against default LocalNet if no environment variables present. - -Note: requires a Node.js environment to execute. - -If present, it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC and optionally -process.env.DISPENSER_SENDER if it's a rekeyed account. - -#### Returns - -`Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -The account - -**`Example`** - -```typescript -const account = await accountManager.dispenserFromEnvironment() -``` - -#### Defined in - -[src/types/account-manager.ts:441](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L441) - -___ - -### ensureFunded - -▸ **ensureFunded**(`accountToFund`, `dispenserAccount`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\> - -Funds a given account using a dispenser account as a funding source such that -the given account has a certain amount of Algo free to spend (accounting for -Algo locked in minimum balance requirement). - -https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `accountToFund` | `string` \| `Address` | The account to fund | -| `dispenserAccount` | `string` \| `Address` | The account to use as a dispenser funding source | -| `minSpendingBalance` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) | -| `options?` | \{ `minFundingIncrement?`: [`AlgoAmount`](types_amount.AlgoAmount.md) } & [`SendParams`](../interfaces/types_transaction.SendParams.md) & `Omit`\<[`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams), ``"sender"``\> | Optional parameters to control the funding increment, transaction or execution of the transaction | - -#### Returns - -`Promise`\<`undefined` \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\> - -- The result of executing the dispensing transaction and the `amountFunded` if funds were needed. -- `undefined` if no funds were needed. - -**`Example`** - -```typescript -// Basic example -await accountManager.ensureFunded("ACCOUNTADDRESS", "DISPENSERADDRESS", algokit.algo(1)) -// With configuration -await accountManager.ensureFunded("ACCOUNTADDRESS", "DISPENSERADDRESS", algokit.algo(1), - { minFundingIncrement: algokit.algo(2), fee: (1000).microAlgo(), suppressLog: true } -) -``` - -#### Defined in - -[src/types/account-manager.ts:561](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L561) - -___ - -### ensureFundedFromEnvironment - -▸ **ensureFundedFromEnvironment**(`accountToFund`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\> - -Funds a given account using a dispenser account retrieved from the environment, -per the `dispenserFromEnvironment` method, as a funding source such that -the given account has a certain amount of Algo free to spend (accounting for -Algo locked in minimum balance requirement). - -**Note:** requires a Node.js environment to execute. - -The dispenser account is retrieved from the account mnemonic stored in -process.env.DISPENSER_MNEMONIC and optionally process.env.DISPENSER_SENDER -if it's a rekeyed account, or against default LocalNet if no environment variables present. - -https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `accountToFund` | `string` \| `Address` | The account to fund | -| `minSpendingBalance` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) | -| `options?` | \{ `minFundingIncrement?`: [`AlgoAmount`](types_amount.AlgoAmount.md) } & [`SendParams`](../interfaces/types_transaction.SendParams.md) & `Omit`\<[`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams), ``"sender"``\> | Optional parameters to control the funding increment, transaction or execution of the transaction | - -#### Returns - -`Promise`\<`undefined` \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\> - -- The result of executing the dispensing transaction and the `amountFunded` if funds were needed. -- `undefined` if no funds were needed. - -**`Example`** - -```typescript -// Basic example -await accountManager.ensureFundedFromEnvironment("ACCOUNTADDRESS", algokit.algo(1)) -// With configuration -await accountManager.ensureFundedFromEnvironment("ACCOUNTADDRESS", algokit.algo(1), - { minFundingIncrement: algokit.algo(2), fee: (1000).microAlgo(), suppressLog: true } -) -``` - -#### Defined in - -[src/types/account-manager.ts:623](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L623) - -___ - -### ensureFundedFromTestNetDispenserApi - -▸ **ensureFundedFromTestNetDispenserApi**(`accountToFund`, `dispenserClient`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\> - -Funds a given account using the TestNet Dispenser API as a funding source such that -the account has a certain amount of Algo free to spend (accounting for Algo locked -in minimum balance requirement). - -https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `accountToFund` | `string` \| `Address` | The account to fund | -| `dispenserClient` | [`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md) | The TestNet dispenser funding client | -| `minSpendingBalance` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) | -| `options?` | `Object` | Optional parameters to control the funding increment, transaction or execution of the transaction | -| `options.minFundingIncrement?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | - | - -#### Returns - -`Promise`\<`undefined` \| [`EnsureFundedResult`](../interfaces/types_account_manager.EnsureFundedResult.md)\> - -- The result of executing the dispensing transaction and the `amountFunded` if funds were needed. -- `undefined` if no funds were needed. - -**`Example`** - -```typescript -// Basic example -await accountManager.ensureFundedFromTestNetDispenserApi("ACCOUNTADDRESS", algorand.client.getTestNetDispenserFromEnvironment(), algokit.algo(1)) -// With configuration -await accountManager.ensureFundedFromTestNetDispenserApi("ACCOUNTADDRESS", algorand.client.getTestNetDispenserFromEnvironment(), algokit.algo(1), - { minFundingIncrement: algokit.algo(2) } -) -``` - -#### Defined in - -[src/types/account-manager.ts:679](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L679) - -___ - -### fromEnvironment - -▸ **fromEnvironment**(`name`, `fundWith?`): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -Tracks and returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier. - -Note: This function expects to run in a Node.js environment. - -## Convention: -* **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**, - never commit it into source control and ideally load it via a secret storage service rather than the file system. - If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts) -* **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you - -This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` | The name identifier of the account | -| `fundWith?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The optional amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account | - -#### Returns - -`Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -The account - -**`Example`** - -If you have a mnemonic secret loaded into `process.env.MY_ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: -```typescript -const account = await accountManager.fromEnvironment('MY_ACCOUNT') -``` - -If that code runs against LocalNet then a wallet called `MY_ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. -If not running against LocalNet then it will use proces.env.MY_ACCOUNT_MNEMONIC as the private key and (if present) process.env.MY_ACCOUNT_SENDER as the sender address. - -#### Defined in - -[src/types/account-manager.ts:334](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L334) - -___ - -### fromKmd - -▸ **fromKmd**(`name`, `predicate?`, `sender?`): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -Tracks and returns an Algorand account with private key loaded from the given KMD wallet (identified by name). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` | The name of the wallet to retrieve an account from | -| `predicate?` | (`account`: `Record`\<`string`, `any`\>) => `boolean` | An optional filter to use to find the account (otherwise it will return a random account from the wallet) | -| `sender?` | `string` \| `Address` | The optional sender address to use this signer for (aka a rekeyed account) | - -#### Returns - -`Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -The account - -**`Example`** - -```typescript -const defaultDispenserAccount = await accountManager.fromKmd('unencrypted-default-wallet', - a => a.status !== 'Offline' && a.amount > 1_000_000_000 -) -``` - -#### Defined in - -[src/types/account-manager.ts:370](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L370) - -___ - -### fromMnemonic - -▸ **fromMnemonic**(`mnemonicSecret`, `sender?`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) } - -Tracks and returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `mnemonicSecret` | `string` | The mnemonic secret representing the private key of an account; **Note: Be careful how the mnemonic is handled**, never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system. | -| `sender?` | `string` \| `Address` | The optional sender address to use this signer for (aka a rekeyed account) | - -#### Returns - -`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) } - -The account - -**`Example`** - -```typescript -const account = accountManager.fromMnemonic("mnemonic secret ...") -const rekeyedAccount = accountManager.fromMnemonic("mnemonic secret ...", "SENDERADDRESS...") -``` - -#### Defined in - -[src/types/account-manager.ts:286](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L286) - -___ - -### getAccount - -▸ **getAccount**(`sender`): [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -Returns the `TransactionSignerAccount` for the given sender address. - -If no signer has been registered for that address then an error is thrown. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| `Address` | The sender address | - -#### Returns - -[`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -The `TransactionSignerAccount` or throws an error if not found - -**`Example`** - -```typescript -const sender = accountManager.random() -// ... -// Returns the `TransactionSignerAccount` for `sender` that has previously been registered -const account = accountManager.getAccount(sender) -``` - -#### Defined in - -[src/types/account-manager.ts:222](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L222) - -___ - -### getInformation - -▸ **getInformation**(`sender`): `Promise`\<[`AccountInformation`](../modules/types_account.md#accountinformation)\> - -Returns the given sender account's current status, balance and spendable amounts. - -[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountinformation) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| `Address` | The account / address to look up | - -#### Returns - -`Promise`\<[`AccountInformation`](../modules/types_account.md#accountinformation)\> - -The account information - -**`Example`** - -```typescript -const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; -const accountInfo = await accountManager.getInformation(address); -``` - -#### Defined in - -[src/types/account-manager.ts:241](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L241) - -___ - -### getSigner - -▸ **getSigner**(`sender`): `TransactionSigner` - -Returns the `TransactionSigner` for the given sender address, ready to sign a transaction for that sender. - -If no signer has been registered for that address then the default signer is used if registered and -if not then an error is thrown. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| `Address` | The sender address | - -#### Returns - -`TransactionSigner` - -The `TransactionSigner` or throws an error if not found and no default signer is set - -**`Example`** - -```typescript -const signer = accountManager.getSigner("SENDERADDRESS") -``` - -#### Defined in - -[src/types/account-manager.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L202) - -___ - -### localNetDispenser - -▸ **localNetDispenser**(): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts). - -#### Returns - -`Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -The account - -**`Example`** - -```typescript -const account = await accountManager.localNetDispenser() -``` - -#### Defined in - -[src/types/account-manager.ts:460](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L460) - -___ - -### logicsig - -▸ **logicsig**(`program`, `args?`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `LogicSigAccount` } - -Tracks and returns an account that represents a logic signature. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `program` | `Uint8Array` | The bytes that make up the compiled logic signature | -| `args?` | `Uint8Array`[] | The (binary) arguments to pass into the logic signature | - -#### Returns - -`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `LogicSigAccount` } - -A logic signature account wrapper - -**`Example`** - -```typescript -const account = accountManager.logicsig(program, [new Uint8Array(3, ...)]) -``` - -#### Defined in - -[src/types/account-manager.ts:408](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L408) - -___ - -### multisig - -▸ **multisig**(`multisigParams`, `signingAccounts`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`MultisigAccount`](types_account.MultisigAccount.md) } - -Tracks and returns an account that supports partial or full multisig signing. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `multisigParams` | `MultisigMetadata` | The parameters that define the multisig account | -| `signingAccounts` | (`default` \| [`SigningAccount`](types_account.SigningAccount.md))[] | The signers that are currently present | - -#### Returns - -`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`MultisigAccount`](types_account.MultisigAccount.md) } - -A multisig account wrapper - -**`Example`** - -```typescript -const account = accountManager.multisig({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]}, - [(await accountManager.fromEnvironment('ACCOUNT1')).account]) -``` - -#### Defined in - -[src/types/account-manager.ts:393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L393) - -___ - -### random - -▸ **random**(): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `default` } - -Tracks and returns a new, random Algorand account with secret key loaded. - -#### Returns - -`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `default` } - -The account - -**`Example`** - -```typescript -const account = accountManager.random() -``` - -#### Defined in - -[src/types/account-manager.ts:421](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L421) - -___ - -### rekeyAccount - -▸ **rekeyAccount**(`account`, `rekeyTo`, `options?`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Rekey an account to a new address. - -**Note:** Please be careful with this function and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | `string` \| `Address` | The account to rekey | -| `rekeyTo` | `string` \| `Address` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The account address or signing account of the account that will be used to authorise transactions for the rekeyed account going forward. If a signing account is provided that will now be tracked as the signer for `account` in this `AccountManager` | -| `options?` | `Omit`\<[`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams), ``"sender"``\> & [`SendParams`](../interfaces/types_transaction.SendParams.md) | Any parameters to control the transaction or execution of the transaction | - -#### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -The result of the transaction and the transaction that was sent - -**`Example`** - -```typescript -await accountManager.rekeyAccount({account: "ACCOUNTADDRESS", rekeyTo: "NEWADDRESS"}) -``` - -**`Example`** - -```typescript -await accountManager.rekeyAccount({account: account1, rekeyTo: newSignerAccount}) -``` - -**`Example`** - -```typescript -await accountManager.rekeyAccount({ - account: "ACCOUNTADDRESS", - rekeyTo: "NEWADDRESS", - lease: 'lease', - note: 'note', - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Defined in - -[src/types/account-manager.ts:503](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L503) - -___ - -### rekeyed - -▸ **rekeyed**(`sender`, `account`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: \{ `addr`: `Address` ; `signer`: `TransactionSigner` = account.signer } } - -Tracks and returns an Algorand account that is a rekeyed version of the given account to a new sender. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| `Address` | The sender address to use as the new sender | -| `account` | [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The account to use as the signer for this new rekeyed account | - -#### Returns - -`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: \{ `addr`: `Address` ; `signer`: `TransactionSigner` = account.signer } } - -The account - -**`Example`** - -```typescript -const account = accountManager.fromMnemonic("mnemonic secret ...") -const rekeyedAccount = accountManager.rekeyed(account, "SENDERADDRESS...") -``` - -#### Defined in - -[src/types/account-manager.ts:303](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L303) - -___ - -### setDefaultSigner - -▸ **setDefaultSigner**(`signer`): [`AccountManager`](types_account_manager.AccountManager.md) - -Sets the default signer to use if no other signer is specified. - -If this isn't set an a transaction needs signing for a given sender -then an error will be thrown from `getSigner` / `getAccount`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `signer` | `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The signer to use, either a `TransactionSigner` or a `TransactionSignerAccount` | - -#### Returns - -[`AccountManager`](types_account_manager.AccountManager.md) - -The `AccountManager` so method calls can be chained - -**`Example`** - -```typescript -const signer = accountManager.random() // Can be anything that returns a `algosdk.TransactionSigner` or `TransactionSignerAccount` -accountManager.setDefaultSigner(signer) - -// When signing a transaction, if there is no signer registered for the sender then the default signer will be used -const signer = accountManager.getSigner("SENDERADDRESS") -``` - -#### Defined in - -[src/types/account-manager.ts:101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L101) - -___ - -### setSigner - -▸ **setSigner**(`sender`, `signer`): [`AccountManager`](types_account_manager.AccountManager.md) - -Tracks the given `algosdk.TransactionSigner` against the given sender address for later signing. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| `Address` | The sender address to use this signer for | -| `signer` | `TransactionSigner` | The `algosdk.TransactionSigner` to sign transactions with for the given sender | - -#### Returns - -[`AccountManager`](types_account_manager.AccountManager.md) - -The `AccountManager` instance for method chaining - -**`Example`** - -```typescript -const accountManager = new AccountManager(clientManager) - .setSigner("SENDERADDRESS", transactionSigner) -``` - -#### Defined in - -[src/types/account-manager.ts:165](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L165) - -___ - -### setSignerFromAccount - -▸ **setSignerFromAccount**(`account`): [`AccountManager`](types_account_manager.AccountManager.md) - -Tracks the given account for later signing. - -Note: If you are generating accounts via the various methods on `AccountManager` -(like `random`, `fromMnemonic`, `logicsig`, etc.) then they automatically get tracked. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`MultisigAccount`](types_account.MultisigAccount.md) \| `default` \| [`SigningAccount`](types_account.SigningAccount.md) \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) \| `LogicSigAccount` | The account to register, which can be a `TransactionSignerAccount` or a `algosdk.Account`, `algosdk.LogicSigAccount`, `SigningAccount` or `MultisigAccount` | - -#### Returns - -[`AccountManager`](types_account_manager.AccountManager.md) - -The `AccountManager` instance for method chaining - -**`Example`** - -```typescript -const accountManager = new AccountManager(clientManager) - .setSignerFromAccount(algosdk.generateAccount()) - .setSignerFromAccount(new algosdk.LogicSigAccount(program, args)) - .setSignerFromAccount(new SigningAccount(mnemonic, sender)) - .setSignerFromAccount(new MultisigAccount({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]}, [account1, account2])) - .setSignerFromAccount({addr: "SENDERADDRESS", signer: transactionSigner}) -``` - -#### Defined in - -[src/types/account-manager.ts:149](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L149) - -___ - -### setSigners - -▸ **setSigners**(`anotherAccountManager`, `overwriteExisting?`): [`AccountManager`](types_account_manager.AccountManager.md) - -Takes all registered signers from the given `AccountManager` and adds them to this `AccountManager`. - -This is useful for situations where you have multiple contexts you are building accounts in such as unit tests. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `anotherAccountManager` | [`AccountManager`](types_account_manager.AccountManager.md) | `undefined` | Another account manager with signers registered | -| `overwriteExisting` | `boolean` | `true` | Whether or not to overwrite any signers that have the same sender address with the ones in the other account manager or not (default: true) | - -#### Returns - -[`AccountManager`](types_account_manager.AccountManager.md) - -The `AccountManager` instance for method chaining - -**`Example`** - -```typescript -accountManager2.setSigners(accountManager1); -``` - -#### Defined in - -[src/types/account-manager.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L182) - -___ - -### signerAccount - -▸ **signerAccount**\<`T`\>(`account`): `Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `T` } - -Records the given account (that can sign) against the address of the provided account for later -retrieval and returns a `TransactionSignerAccount` along with the original account in an `account` property. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`MultisigAccount`](types_account.MultisigAccount.md) \| `default` \| [`SigningAccount`](types_account.SigningAccount.md) \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) \| `LogicSigAccount` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | `T` | - -#### Returns - -`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: `T` } - -#### Defined in - -[src/types/account-manager.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L111) diff --git a/docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md b/docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md deleted file mode 100644 index 810320b9..00000000 --- a/docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md +++ /dev/null @@ -1,200 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/algo-http-client-with-retry](../modules/types_algo_http_client_with_retry.md) / AlgoHttpClientWithRetry - -# Class: AlgoHttpClientWithRetry - -[types/algo-http-client-with-retry](../modules/types_algo_http_client_with_retry.md).AlgoHttpClientWithRetry - -A HTTP Client that wraps the Algorand SDK HTTP Client with retries - -## Hierarchy - -- `URLTokenBaseHTTPClient` - - ↳ **`AlgoHttpClientWithRetry`** - -## Table of contents - -### Constructors - -- [constructor](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md#constructor) - -### Properties - -- [MAX\_BACKOFF\_MS](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md#max_backoff_ms) -- [MAX\_TRIES](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md#max_tries) -- [RETRY\_ERROR\_CODES](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md#retry_error_codes) -- [RETRY\_STATUS\_CODES](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md#retry_status_codes) - -### Methods - -- [callWithRetry](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md#callwithretry) -- [delete](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md#delete) -- [get](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md#get) -- [post](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md#post) - -## Constructors - -### constructor - -• **new AlgoHttpClientWithRetry**(`tokenHeader`, `baseServer`, `port?`, `defaultHeaders?`): [`AlgoHttpClientWithRetry`](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `tokenHeader` | `TokenHeader` | -| `baseServer` | `string` | -| `port?` | `string` \| `number` | -| `defaultHeaders?` | `Record`\<`string`, `any`\> | - -#### Returns - -[`AlgoHttpClientWithRetry`](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md) - -#### Inherited from - -URLTokenBaseHTTPClient.constructor - -#### Defined in - -node_modules/algosdk/dist/types/client/urlTokenBaseHTTPClient.d.ts:27 - -## Properties - -### MAX\_BACKOFF\_MS - -▪ `Static` `Private` `Readonly` **MAX\_BACKOFF\_MS**: ``10000`` - -#### Defined in - -[src/types/algo-http-client-with-retry.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L8) - -___ - -### MAX\_TRIES - -▪ `Static` `Private` `Readonly` **MAX\_TRIES**: ``5`` - -#### Defined in - -[src/types/algo-http-client-with-retry.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L7) - -___ - -### RETRY\_ERROR\_CODES - -▪ `Static` `Private` `Readonly` **RETRY\_ERROR\_CODES**: `string`[] - -#### Defined in - -[src/types/algo-http-client-with-retry.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L13) - -___ - -### RETRY\_STATUS\_CODES - -▪ `Static` `Private` `Readonly` **RETRY\_STATUS\_CODES**: `number`[] - -#### Defined in - -[src/types/algo-http-client-with-retry.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L12) - -## Methods - -### callWithRetry - -▸ **callWithRetry**(`func`): `Promise`\<`BaseHTTPClientResponse`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `func` | () => `Promise`\<`BaseHTTPClientResponse`\> | - -#### Returns - -`Promise`\<`BaseHTTPClientResponse`\> - -#### Defined in - -[src/types/algo-http-client-with-retry.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L25) - -___ - -### delete - -▸ **delete**(`relativePath`, `data`, `query?`, `requestHeaders?`): `Promise`\<`BaseHTTPClientResponse`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `relativePath` | `string` | -| `data` | `Uint8Array` | -| `query?` | `Query`\<`string`\> | -| `requestHeaders` | `Record`\<`string`, `string`\> | - -#### Returns - -`Promise`\<`BaseHTTPClientResponse`\> - -#### Overrides - -URLTokenBaseHTTPClient.delete - -#### Defined in - -[src/types/algo-http-client-with-retry.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L100) - -___ - -### get - -▸ **get**(`relativePath`, `query?`, `requestHeaders?`): `Promise`\<`BaseHTTPClientResponse`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `relativePath` | `string` | -| `query?` | `Query`\<`string`\> | -| `requestHeaders` | `Record`\<`string`, `string`\> | - -#### Returns - -`Promise`\<`BaseHTTPClientResponse`\> - -#### Overrides - -URLTokenBaseHTTPClient.get - -#### Defined in - -[src/types/algo-http-client-with-retry.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L57) - -___ - -### post - -▸ **post**(`relativePath`, `data`, `query?`, `requestHeaders?`): `Promise`\<`BaseHTTPClientResponse`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `relativePath` | `string` | -| `data` | `Uint8Array` | -| `query?` | `Query`\<`string`\> | -| `requestHeaders` | `Record`\<`string`, `string`\> | - -#### Returns - -`Promise`\<`BaseHTTPClientResponse`\> - -#### Overrides - -URLTokenBaseHTTPClient.post - -#### Defined in - -[src/types/algo-http-client-with-retry.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L91) diff --git a/docs/code/classes/types_algorand_client.AlgorandClient.md b/docs/code/classes/types_algorand_client.AlgorandClient.md deleted file mode 100644 index f2ef1ad5..00000000 --- a/docs/code/classes/types_algorand_client.AlgorandClient.md +++ /dev/null @@ -1,767 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/algorand-client](../modules/types_algorand_client.md) / AlgorandClient - -# Class: AlgorandClient - -[types/algorand-client](../modules/types_algorand_client.md).AlgorandClient - -A client that brokers easy access to Algorand functionality. - -## Table of contents - -### Constructors - -- [constructor](types_algorand_client.AlgorandClient.md#constructor) - -### Properties - -- [\_accountManager](types_algorand_client.AlgorandClient.md#_accountmanager) -- [\_appDeployer](types_algorand_client.AlgorandClient.md#_appdeployer) -- [\_appManager](types_algorand_client.AlgorandClient.md#_appmanager) -- [\_assetManager](types_algorand_client.AlgorandClient.md#_assetmanager) -- [\_cachedSuggestedParams](types_algorand_client.AlgorandClient.md#_cachedsuggestedparams) -- [\_cachedSuggestedParamsExpiry](types_algorand_client.AlgorandClient.md#_cachedsuggestedparamsexpiry) -- [\_cachedSuggestedParamsTimeout](types_algorand_client.AlgorandClient.md#_cachedsuggestedparamstimeout) -- [\_clientManager](types_algorand_client.AlgorandClient.md#_clientmanager) -- [\_defaultValidityWindow](types_algorand_client.AlgorandClient.md#_defaultvaliditywindow) -- [\_transactionCreator](types_algorand_client.AlgorandClient.md#_transactioncreator) -- [\_transactionSender](types_algorand_client.AlgorandClient.md#_transactionsender) - -### Accessors - -- [account](types_algorand_client.AlgorandClient.md#account) -- [app](types_algorand_client.AlgorandClient.md#app) -- [appDeployer](types_algorand_client.AlgorandClient.md#appdeployer) -- [asset](types_algorand_client.AlgorandClient.md#asset) -- [client](types_algorand_client.AlgorandClient.md#client) -- [createTransaction](types_algorand_client.AlgorandClient.md#createtransaction) -- [send](types_algorand_client.AlgorandClient.md#send) - -### Methods - -- [getSuggestedParams](types_algorand_client.AlgorandClient.md#getsuggestedparams) -- [newGroup](types_algorand_client.AlgorandClient.md#newgroup) -- [setDefaultSigner](types_algorand_client.AlgorandClient.md#setdefaultsigner) -- [setDefaultValidityWindow](types_algorand_client.AlgorandClient.md#setdefaultvaliditywindow) -- [setSigner](types_algorand_client.AlgorandClient.md#setsigner) -- [setSignerFromAccount](types_algorand_client.AlgorandClient.md#setsignerfromaccount) -- [setSuggestedParamsCache](types_algorand_client.AlgorandClient.md#setsuggestedparamscache) -- [setSuggestedParamsCacheTimeout](types_algorand_client.AlgorandClient.md#setsuggestedparamscachetimeout) -- [defaultLocalNet](types_algorand_client.AlgorandClient.md#defaultlocalnet) -- [fromClients](types_algorand_client.AlgorandClient.md#fromclients) -- [fromConfig](types_algorand_client.AlgorandClient.md#fromconfig) -- [fromEnvironment](types_algorand_client.AlgorandClient.md#fromenvironment) -- [mainNet](types_algorand_client.AlgorandClient.md#mainnet) -- [testNet](types_algorand_client.AlgorandClient.md#testnet) - -## Constructors - -### constructor - -• **new AlgorandClient**(`config`): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | [`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md) \| [`AlgoSdkClients`](../interfaces/types_client_manager.AlgoSdkClients.md) | - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -#### Defined in - -[src/types/algorand-client.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L33) - -## Properties - -### \_accountManager - -• `Private` **\_accountManager**: [`AccountManager`](types_account_manager.AccountManager.md) - -#### Defined in - -[src/types/algorand-client.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L20) - -___ - -### \_appDeployer - -• `Private` **\_appDeployer**: [`AppDeployer`](types_app_deployer.AppDeployer.md) - -#### Defined in - -[src/types/algorand-client.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L22) - -___ - -### \_appManager - -• `Private` **\_appManager**: [`AppManager`](types_app_manager.AppManager.md) - -#### Defined in - -[src/types/algorand-client.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L21) - -___ - -### \_assetManager - -• `Private` **\_assetManager**: [`AssetManager`](types_asset_manager.AssetManager.md) - -#### Defined in - -[src/types/algorand-client.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L23) - -___ - -### \_cachedSuggestedParams - -• `Private` `Optional` **\_cachedSuggestedParams**: `SuggestedParams` - -#### Defined in - -[src/types/algorand-client.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L27) - -___ - -### \_cachedSuggestedParamsExpiry - -• `Private` `Optional` **\_cachedSuggestedParamsExpiry**: `Date` - -#### Defined in - -[src/types/algorand-client.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L28) - -___ - -### \_cachedSuggestedParamsTimeout - -• `Private` **\_cachedSuggestedParamsTimeout**: `number` = `3_000` - -#### Defined in - -[src/types/algorand-client.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L29) - -___ - -### \_clientManager - -• `Private` **\_clientManager**: [`ClientManager`](types_client_manager.ClientManager.md) - -#### Defined in - -[src/types/algorand-client.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L19) - -___ - -### \_defaultValidityWindow - -• `Private` **\_defaultValidityWindow**: `undefined` \| `bigint` = `undefined` - -#### Defined in - -[src/types/algorand-client.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L31) - -___ - -### \_transactionCreator - -• `Private` **\_transactionCreator**: [`AlgorandClientTransactionCreator`](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md) - -#### Defined in - -[src/types/algorand-client.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L25) - -___ - -### \_transactionSender - -• `Private` **\_transactionSender**: [`AlgorandClientTransactionSender`](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md) - -#### Defined in - -[src/types/algorand-client.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L24) - -## Accessors - -### account - -• `get` **account**(): [`AccountManager`](types_account_manager.AccountManager.md) - -Get or create accounts that can sign transactions. - -#### Returns - -[`AccountManager`](types_account_manager.AccountManager.md) - -The `AccountManager` instance. - -**`Example`** - -```ts -const accountManager = AlgorandClient.mainNet().account; -``` - -#### Defined in - -[src/types/algorand-client.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L175) - -___ - -### app - -• `get` **app**(): [`AppManager`](types_app_manager.AppManager.md) - -Methods for interacting with apps. - -#### Returns - -[`AppManager`](types_app_manager.AppManager.md) - -The `AppManager` instance. - -**`Example`** - -```ts -const appManager = AlgorandClient.mainNet().app; -``` - -#### Defined in - -[src/types/algorand-client.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L195) - -___ - -### appDeployer - -• `get` **appDeployer**(): [`AppDeployer`](types_app_deployer.AppDeployer.md) - -Methods for deploying apps and managing app deployment metadata. - -#### Returns - -[`AppDeployer`](types_app_deployer.AppDeployer.md) - -The `AppDeployer` instance. - -**`Example`** - -```ts -const deployer = AlgorandClient.mainNet().appDeployer; -``` - -#### Defined in - -[src/types/algorand-client.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L205) - -___ - -### asset - -• `get` **asset**(): [`AssetManager`](types_asset_manager.AssetManager.md) - -Methods for interacting with assets. - -#### Returns - -[`AssetManager`](types_asset_manager.AssetManager.md) - -The `AssetManager` instance. - -**`Example`** - -```ts -const assetManager = AlgorandClient.mainNet().asset; -``` - -#### Defined in - -[src/types/algorand-client.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L185) - -___ - -### client - -• `get` **client**(): [`ClientManager`](types_client_manager.ClientManager.md) - -Get clients, including algosdk clients and app clients. - -#### Returns - -[`ClientManager`](types_client_manager.ClientManager.md) - -The `ClientManager` instance. - -**`Example`** - -```ts -const clientManager = AlgorandClient.mainNet().client; -``` - -#### Defined in - -[src/types/algorand-client.ts:165](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L165) - -___ - -### createTransaction - -• `get` **createTransaction**(): [`AlgorandClientTransactionCreator`](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md) - -Methods for creating a transaction. - -#### Returns - -[`AlgorandClientTransactionCreator`](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md) - -The `AlgorandClientTransactionCreator` instance. - -**`Example`** - -```ts -const payment = await AlgorandClient.mainNet().createTransaction.payment({ - sender: "SENDERADDRESS", - receiver: "RECEIVERADDRESS", - amount: algo(1) -}) -``` - -#### Defined in - -[src/types/algorand-client.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L250) - -___ - -### send - -• `get` **send**(): [`AlgorandClientTransactionSender`](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md) - -Methods for sending a transaction. - -#### Returns - -[`AlgorandClientTransactionSender`](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md) - -The `AlgorandClientTransactionSender` instance. - -**`Example`** - -```ts -const result = await AlgorandClient.mainNet().send.payment({ - sender: "SENDERADDRESS", - receiver: "RECEIVERADDRESS", - amount: algo(1) -}) -``` - -#### Defined in - -[src/types/algorand-client.ts:236](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L236) - -## Methods - -### getSuggestedParams - -▸ **getSuggestedParams**(): `Promise`\<`SuggestedParams`\> - -Get suggested params for a transaction (either cached or from algod if the cache is stale or empty) - -#### Returns - -`Promise`\<`SuggestedParams`\> - -The suggested transaction parameters. - -**`Example`** - -```ts -const params = await AlgorandClient.mainNet().getSuggestedParams(); -``` - -#### Defined in - -[src/types/algorand-client.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L144) - -___ - -### newGroup - -▸ **newGroup**(): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Start a new `TransactionComposer` transaction group - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -A new instance of `TransactionComposer`. - -**`Example`** - -```ts -const composer = AlgorandClient.mainNet().newGroup(); -const result = await composer.addTransaction(payment).send() -``` - -#### Defined in - -[src/types/algorand-client.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L216) - -___ - -### setDefaultSigner - -▸ **setDefaultSigner**(`signer`): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Sets the default signer to use if no other signer is specified. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `signer` | `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The signer to use, either a `TransactionSigner` or a `TransactionSignerAccount` | - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -The `AlgorandClient` so method calls can be chained - -**`Example`** - -```typescript -const signer = new SigningAccount(account, account.addr) -const algorand = AlgorandClient.mainNet().setDefaultSigner(signer) -``` - -#### Defined in - -[src/types/algorand-client.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L67) - -___ - -### setDefaultValidityWindow - -▸ **setDefaultValidityWindow**(`validityWindow`): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Sets the default validity window for transactions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `validityWindow` | `number` \| `bigint` | The number of rounds between the first and last valid rounds | - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -The `AlgorandClient` so method calls can be chained - -**`Example`** - -```typescript -const algorand = AlgorandClient.mainNet().setDefaultValidityWindow(1000); -``` - -#### Defined in - -[src/types/algorand-client.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L52) - -___ - -### setSigner - -▸ **setSigner**(`sender`, `signer`): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Tracks the given signer against the given sender for later signing. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| `Address` | The sender address to use this signer for | -| `signer` | `TransactionSigner` | The signer to sign transactions with for the given sender | - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -The `AlgorandClient` so method calls can be chained - -**`Example`** - -```typescript -const signer = new SigningAccount(account, account.addr) -const algorand = AlgorandClient.mainNet().setSigner(signer.addr, signer.signer) -``` - -#### Defined in - -[src/types/algorand-client.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L103) - -___ - -### setSignerFromAccount - -▸ **setSignerFromAccount**(`account`): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Tracks the given account (object that encapsulates an address and a signer) for later signing. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | [`MultisigAccount`](types_account.MultisigAccount.md) \| `default` \| [`SigningAccount`](types_account.SigningAccount.md) \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) \| `LogicSigAccount` | The account to register, which can be a `TransactionSignerAccount` or a `algosdk.Account`, `algosdk.LogicSigAccount`, `SigningAccount` or `MultisigAccount` | - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -The `AlgorandClient` so method calls can be chained - -**`Example`** - -```typescript -const accountManager = AlgorandClient.mainNet() - .setSignerFromAccount(algosdk.generateAccount()) - .setSignerFromAccount(new algosdk.LogicSigAccount(program, args)) - .setSignerFromAccount(new SigningAccount(account, sender)) - .setSignerFromAccount(new MultisigAccount({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]}, [account1, account2])) - .setSignerFromAccount({addr: "SENDERADDRESS", signer: transactionSigner}) -``` - -#### Defined in - -[src/types/algorand-client.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L87) - -___ - -### setSuggestedParamsCache - -▸ **setSuggestedParamsCache**(`suggestedParams`, `until?`): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Sets a cache value to use for suggested transaction params. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `suggestedParams` | `SuggestedParams` | The suggested params to use | -| `until?` | `Date` | A date until which to cache, or if not specified then the timeout is used | - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -The `AlgorandClient` so method calls can be chained - -**`Example`** - -```typescript -const algorand = AlgorandClient.mainNet().setSuggestedParamsCache(suggestedParams, new Date(+new Date() + 3_600_000)) -``` - -#### Defined in - -[src/types/algorand-client.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L118) - -___ - -### setSuggestedParamsCacheTimeout - -▸ **setSuggestedParamsCacheTimeout**(`timeout`): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Sets the timeout for caching suggested params. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `timeout` | `number` | The timeout in milliseconds | - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -The `AlgorandClient` so method calls can be chained - -**`Example`** - -```typescript -const algorand = AlgorandClient.mainNet().setSuggestedParamsCacheTimeout(10_000) -``` - -#### Defined in - -[src/types/algorand-client.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L133) - -___ - -### defaultLocalNet - -▸ **defaultLocalNet**(): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Creates an `AlgorandClient` pointing at default LocalNet ports and API token. - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -An instance of the `AlgorandClient`. - -**`Example`** - -```ts -const algorand = AlgorandClient.defaultLocalNet(); -``` - -#### Defined in - -[src/types/algorand-client.ts:262](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L262) - -___ - -### fromClients - -▸ **fromClients**(`clients`): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Creates an `AlgorandClient` pointing to the given client(s). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `clients` | [`AlgoSdkClients`](../interfaces/types_client_manager.AlgoSdkClients.md) | The clients to use. | - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -An instance of the `AlgorandClient`. - -**`Example`** - -```ts -const algorand = AlgorandClient.fromClients({ algod, indexer, kmd }); -``` - -#### Defined in - -[src/types/algorand-client.ts:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L305) - -___ - -### fromConfig - -▸ **fromConfig**(`config`): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Creates an `AlgorandClient` from the given config. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config` | [`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md) | The config to use. | - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -An instance of the `AlgorandClient`. - -**`Example`** - -```ts -const client = AlgorandClient.fromConfig({ algodConfig, indexerConfig, kmdConfig }); -``` - -#### Defined in - -[src/types/algorand-client.ts:339](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L339) - -___ - -### fromEnvironment - -▸ **fromEnvironment**(): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Creates an `AlgorandClient` loading the configuration from environment variables. - -Retrieve configurations from environment variables when defined or get default LocalNet configuration if they aren't defined. - -Expects to be called from a Node.js environment. - -If `process.env.ALGOD_SERVER` is defined it will use that along with optional `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN`. - -If `process.env.INDEXER_SERVER` is defined it will use that along with optional `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`. - -If either aren't defined it will use the default LocalNet config. - -It will return a KMD configuration that uses `process.env.KMD_PORT` (or port 4002) if `process.env.ALGOD_SERVER` is defined, -otherwise it will use the default LocalNet config unless it detects testnet or mainnet. - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -An instance of the `AlgorandClient`. - -**`Example`** - -```ts -const client = AlgorandClient.fromEnvironment(); -``` - -#### Defined in - -[src/types/algorand-client.ts:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L328) - -___ - -### mainNet - -▸ **mainNet**(): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Creates an `AlgorandClient` pointing at MainNet using AlgoNode. - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -An instance of the `AlgorandClient`. - -**`Example`** - -```ts -const algorand = AlgorandClient.mainNet(); -``` - -#### Defined in - -[src/types/algorand-client.ts:290](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L290) - -___ - -### testNet - -▸ **testNet**(): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Creates an `AlgorandClient` pointing at TestNet using AlgoNode. - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -An instance of the `AlgorandClient`. - -**`Example`** - -```ts -const algorand = AlgorandClient.testNet(); -``` - -#### Defined in - -[src/types/algorand-client.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L276) diff --git a/docs/code/classes/types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md b/docs/code/classes/types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md deleted file mode 100644 index 3858b728..00000000 --- a/docs/code/classes/types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md +++ /dev/null @@ -1,1320 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/algorand-client-transaction-creator](../modules/types_algorand_client_transaction_creator.md) / AlgorandClientTransactionCreator - -# Class: AlgorandClientTransactionCreator - -[types/algorand-client-transaction-creator](../modules/types_algorand_client_transaction_creator.md).AlgorandClientTransactionCreator - -Orchestrates creating transactions for `AlgorandClient`. - -## Table of contents - -### Constructors - -- [constructor](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#constructor) - -### Properties - -- [\_newGroup](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#_newgroup) -- [appCall](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#appcall) -- [appCallMethodCall](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#appcallmethodcall) -- [appCreate](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#appcreate) -- [appCreateMethodCall](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#appcreatemethodcall) -- [appDelete](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#appdelete) -- [appDeleteMethodCall](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#appdeletemethodcall) -- [appUpdate](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#appupdate) -- [appUpdateMethodCall](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#appupdatemethodcall) -- [assetConfig](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#assetconfig) -- [assetCreate](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#assetcreate) -- [assetDestroy](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#assetdestroy) -- [assetFreeze](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#assetfreeze) -- [assetOptIn](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#assetoptin) -- [assetOptOut](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#assetoptout) -- [assetTransfer](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#assettransfer) -- [offlineKeyRegistration](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#offlinekeyregistration) -- [onlineKeyRegistration](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#onlinekeyregistration) -- [payment](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#payment) - -### Methods - -- [\_transaction](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#_transaction) -- [\_transactions](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md#_transactions) - -## Constructors - -### constructor - -• **new AlgorandClientTransactionCreator**(`newGroup`): [`AlgorandClientTransactionCreator`](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md) - -Creates a new `AlgorandClientTransactionCreator` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `newGroup` | () => [`TransactionComposer`](types_composer.TransactionComposer.md) | A lambda that starts a new `TransactionComposer` transaction group | - -#### Returns - -[`AlgorandClientTransactionCreator`](types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md) - -**`Example`** - -```typescript -const transactionCreator = new AlgorandClientTransactionCreator(() => new TransactionComposer()) -``` - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L19) - -## Properties - -### \_newGroup - -• `Private` **\_newGroup**: () => [`TransactionComposer`](types_composer.TransactionComposer.md) - -#### Type declaration - -▸ (): [`TransactionComposer`](types_composer.TransactionComposer.md) - -##### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L9) - -___ - -### appCall - -• **appCall**: (`params`: [`AppCallParams`](../modules/types_composer.md#appcallparams)) => `Promise`\<`Transaction`\> - -Create an application call transaction. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -await algorand.createTransaction.appCall({ sender: 'CREATORADDRESS' }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.appCall({ - sender: 'CREATORADDRESS', - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppCallParams`](../modules/types_composer.md#appcallparams) | The parameters for the app call transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:458](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L458) - -___ - -### appCallMethodCall - -• **appCallMethodCall**: (`params`: [`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -Create an application call with ABI method call transaction. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.createTransaction.appCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.createTransaction.appCallMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall) | The parameters for the app call transaction | - -##### Returns - -`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:653](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L653) - -___ - -### appCreate - -• **appCreate**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> - -Create an application create transaction. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -await algorand.createTransaction.appCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.appCreate({ - sender: 'CREATORADDRESS', - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - schema: { - globalInts: 1, - globalByteSlices: 2, - localInts: 3, - localByteSlices: 4 - }, - extraProgramPages: 1, - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters for the app creation transaction | -| `params.accountReferences?` | (`string` \| `Address`)[] | Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.appReferences?` | `bigint`[] | The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.approvalProgram` | `string` \| `Uint8Array` | The program to execute for all OnCompletes other than ClearState as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)). | -| `params.args?` | `Uint8Array`[] | Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). | -| `params.assetReferences?` | `bigint`[] | The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.boxReferences?` | ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] | Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). Either the name identifier (which will be set against app ID of `0` i.e. the current app), or a box identifier with the name identifier and app ID. | -| `params.clearStateProgram` | `string` \| `Uint8Array` | The program to execute for ClearState OnComplete as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)). | -| `params.extraFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. | -| `params.extraProgramPages?` | `number` | Number of extra pages required for the programs. Defaults to the number needed for the programs in this call if not specified. This is immutable once the app is created. | -| `params.firstValidRound?` | `bigint` | Set the first round this transaction is valid. If left undefined, the value from algod will be used. We recommend you only set this when you intentionally want this to be some time in the future. | -| `params.lastValidRound?` | `bigint` | The last round this transaction is valid. It is recommended to use `validityWindow` instead. | -| `params.lease?` | `string` \| `Uint8Array` | Prevent multiple transactions with the same lease being included within the validity window. A [lease](https://dev.algorand.co/concepts/transactions/leases) enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). | -| `params.maxFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. | -| `params.note?` | `string` \| `Uint8Array` | Note to attach to the transaction. Max of 1000 bytes. | -| `params.onComplete?` | `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` | The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. | -| `params.rekeyTo?` | `string` \| `Address` | Change the signing key of the sender to the given address. **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). | -| `params.schema?` | `Object` | The state schema for the app. This is immutable once the app is created. | -| `params.schema.globalByteSlices` | `number` | The number of byte slices saved in global state. | -| `params.schema.globalInts` | `number` | The number of integers saved in global state. | -| `params.schema.localByteSlices` | `number` | The number of byte slices saved in local state. | -| `params.schema.localInts` | `number` | The number of integers saved in local state. | -| `params.sender` | `string` \| `Address` | The address of the account sending the transaction. | -| `params.signer?` | `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given `sender` or use a default signer (if configured). | -| `params.staticFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. | -| `params.validityWindow?` | `number` \| `bigint` | How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:354](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L354) - -___ - -### appCreateMethodCall - -• **appCreateMethodCall**: (`params`: [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -Create an application create call with ABI method call transaction. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.createTransaction.appCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.createTransaction.appCreateMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - schema: { - globalInts: 1, - globalByteSlices: 2, - localInts: 3, - localByteSlices: 4 - }, - extraProgramPages: 1, - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) | The parameters for the app creation transaction | - -##### Returns - -`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L513) - -___ - -### appDelete - -• **appDelete**: (`params`: [`AppDeleteParams`](../modules/types_composer.md#appdeleteparams)) => `Promise`\<`Transaction`\> - -Create an application delete transaction. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -await algorand.createTransaction.appDelete({ sender: 'CREATORADDRESS' }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.appDelete({ - sender: 'CREATORADDRESS', - onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppDeleteParams`](../modules/types_composer.md#appdeleteparams) | The parameters for the app deletion transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:424](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L424) - -___ - -### appDeleteMethodCall - -• **appDeleteMethodCall**: (`params`: [`AppDeleteMethodCall`](../modules/types_composer.md#appdeletemethodcall)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -Create an application delete call with ABI method call transaction. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.createTransaction.appDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.createTransaction.appDeleteMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppDeleteMethodCall`](../modules/types_composer.md#appdeletemethodcall) | The parameters for the app deletion transaction | - -##### Returns - -`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:607](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L607) - -___ - -### appUpdate - -• **appUpdate**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> - -Create an application update transaction. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -await algorand.createTransaction.appUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.appUpdate({ - sender: 'CREATORADDRESS', - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters for the app update transaction | -| `params.accountReferences?` | (`string` \| `Address`)[] | Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.appId` | `bigint` | ID of the application; 0 if the application is being created. | -| `params.appReferences?` | `bigint`[] | The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.approvalProgram` | `string` \| `Uint8Array` | The program to execute for all OnCompletes other than ClearState as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array)) | -| `params.args?` | `Uint8Array`[] | Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). | -| `params.assetReferences?` | `bigint`[] | The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.boxReferences?` | ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] | Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). Either the name identifier (which will be set against app ID of `0` i.e. the current app), or a box identifier with the name identifier and app ID. | -| `params.clearStateProgram` | `string` \| `Uint8Array` | The program to execute for ClearState OnComplete as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array)) | -| `params.extraFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. | -| `params.firstValidRound?` | `bigint` | Set the first round this transaction is valid. If left undefined, the value from algod will be used. We recommend you only set this when you intentionally want this to be some time in the future. | -| `params.lastValidRound?` | `bigint` | The last round this transaction is valid. It is recommended to use `validityWindow` instead. | -| `params.lease?` | `string` \| `Uint8Array` | Prevent multiple transactions with the same lease being included within the validity window. A [lease](https://dev.algorand.co/concepts/transactions/leases) enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). | -| `params.maxFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. | -| `params.note?` | `string` \| `Uint8Array` | Note to attach to the transaction. Max of 1000 bytes. | -| `params.onComplete?` | `UpdateApplicationOC` | The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. | -| `params.rekeyTo?` | `string` \| `Address` | Change the signing key of the sender to the given address. **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). | -| `params.sender` | `string` \| `Address` | The address of the account sending the transaction. | -| `params.signer?` | `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given `sender` or use a default signer (if configured). | -| `params.staticFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. | -| `params.validityWindow?` | `number` \| `bigint` | How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:390](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L390) - -___ - -### appUpdateMethodCall - -• **appUpdateMethodCall**: (`params`: [`AppUpdateMethodCall`](../modules/types_composer.md#appupdatemethodcall)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -Create an application update call with ABI method call transaction. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.createTransaction.appUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.createTransaction.appUpdateMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppUpdateMethodCall`](../modules/types_composer.md#appupdatemethodcall) | The parameters for the app update transaction | - -##### Returns - -`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:561](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L561) - -___ - -### assetConfig - -• **assetConfig**: (`params`: [`AssetConfigParams`](../modules/types_composer.md#assetconfigparams)) => `Promise`\<`Transaction`\> - -Create an asset config transaction to reconfigure an existing Algorand Standard Asset. - -**Note:** The manager, reserve, freeze, and clawback addresses -are immutably empty if they are not set. If manager is not set then -all fields are immutable from that point forward. - -**`Example`** - -```typescript -await algorand.createTransaction.assetConfig({ sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.assetConfig({ - sender: 'MANAGERADDRESS', - assetId: 123456n, - manager: 'MANAGERADDRESS', - reserve: 'RESERVEADDRESS', - freeze: 'FREEZEADDRESS', - clawback: 'CLAWBACKADDRESS', - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetConfigParams`](../modules/types_composer.md#assetconfigparams) | The parameters for the asset config transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L151) - -___ - -### assetCreate - -• **assetCreate**: (`params`: [`AssetCreateParams`](../modules/types_composer.md#assetcreateparams)) => `Promise`\<`Transaction`\> - -Create a create Algorand Standard Asset transaction. - -The account that sends this transaction will automatically be -opted in to the asset and will hold all units after creation. - -**`Example`** - -```typescript -await algorand.createTransaction.assetCreate({ sender: "CREATORADDRESS", total: 100n}) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.assetCreate({ - sender: 'CREATORADDRESS', - total: 100n, - decimals: 2, - assetName: 'asset', - unitName: 'unit', - url: 'url', - metadataHash: 'metadataHash', - defaultFrozen: false, - manager: 'MANAGERADDRESS', - reserve: 'RESERVEADDRESS', - freeze: 'FREEZEADDRESS', - clawback: 'CLAWBACKADDRESS', - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetCreateParams`](../modules/types_composer.md#assetcreateparams) | The parameters for the asset creation transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L115) - -___ - -### assetDestroy - -• **assetDestroy**: (`params`: [`AssetDestroyParams`](../modules/types_composer.md#assetdestroyparams)) => `Promise`\<`Transaction`\> - -Create an Algorand Standard Asset destroy transaction. - -Created assets can be destroyed only by the asset manager account. -All of the assets must be owned by the creator of the asset before -the asset can be deleted. - -**`Example`** - -```typescript -await algorand.createTransaction.assetDestroy({ sender: "MANAGERADDRESS", assetId: 123456n }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.assetDestroy({ - sender: 'MANAGERADDRESS', - assetId: 123456n, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetDestroyParams`](../modules/types_composer.md#assetdestroyparams) | The parameters for the asset destroy transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:213](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L213) - -___ - -### assetFreeze - -• **assetFreeze**: (`params`: [`AssetFreezeParams`](../modules/types_composer.md#assetfreezeparams)) => `Promise`\<`Transaction`\> - -Create an Algorand Standard Asset freeze transaction. - -**`Example`** - -```typescript -await algorand.createTransaction.assetFreeze({ sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.assetFreeze({ - sender: 'MANAGERADDRESS', - assetId: 123456n, - account: 'ACCOUNTADDRESS', - frozen: true, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetFreezeParams`](../modules/types_composer.md#assetfreezeparams) | The parameters for the asset freeze transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L181) - -___ - -### assetOptIn - -• **assetOptIn**: (`params`: [`AssetOptInParams`](../modules/types_composer.md#assetoptinparams)) => `Promise`\<`Transaction`\> - -Create an Algorand Standard Asset opt-in transaction. - -**`Example`** - -```typescript -await algorand.createTransaction.assetOptIn({ sender: "SENDERADDRESS", assetId: 123456n }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.assetOptIn({ - sender: 'SENDERADDRESS', - assetId: 123456n, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetOptInParams`](../modules/types_composer.md#assetoptinparams) | The parameters for the asset opt-in transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:274](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L274) - -___ - -### assetOptOut - -• **assetOptOut**: (`params`: [`AssetOptOutParams`](../modules/types_composer.md#assetoptoutparams)) => `Promise`\<`Transaction`\> - -Create an asset opt-out transaction. - -*Note:* If the account has a balance of the asset, -it will lose those assets - -**`Example`** - -```typescript -await algorand.createTransaction.assetOptOut({ sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.assetOptOut({ sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.assetOptOut({ - sender: 'SENDERADDRESS', - assetId: 123456n, - creator: 'CREATORADDRESS', - ensureZeroBalance: true, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetOptOutParams`](../modules/types_composer.md#assetoptoutparams) | The parameters for the asset opt-out transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L311) - -___ - -### assetTransfer - -• **assetTransfer**: (`params`: [`AssetTransferParams`](../modules/types_composer.md#assettransferparams)) => `Promise`\<`Transaction`\> - -Create an Algorand Standard Asset transfer transaction. - -**`Example`** - -```typescript -await algorand.createTransaction.assetTransfer({ sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" }) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.assetTransfer({ - sender: 'CLAWBACKADDRESS', - assetId: 123456n, - amount: 1n, - receiver: 'RECEIVERADDRESS', - clawbackTarget: 'HOLDERADDRESS', - // This field needs to be used with caution - closeAssetTo: 'ADDRESSTOCLOSETO' - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetTransferParams`](../modules/types_composer.md#assettransferparams) | The parameters for the asset transfer transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:246](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L246) - -___ - -### offlineKeyRegistration - -• **offlineKeyRegistration**: (`params`: [`OfflineKeyRegistrationParams`](../modules/types_composer.md#offlinekeyregistrationparams)) => `Promise`\<`Transaction`\> - -Create an offline key registration transaction. - -**`Example`** - -```typescript -await algorand.createTransaction.offlineKeyRegistration({ - sender: 'SENDERADDRESS', -}) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.offlineKeyRegistration({ - sender: 'SENDERADDRESS', - lease: 'lease', - note: 'note', - // Use this with caution, it's generally better to use algorand.account.rekeyAccount - rekeyTo: 'REKEYTOADDRESS', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`OfflineKeyRegistrationParams`](../modules/types_composer.md#offlinekeyregistrationparams) | The parameters for the key registration transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:725](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L725) - -___ - -### onlineKeyRegistration - -• **onlineKeyRegistration**: (`params`: [`OnlineKeyRegistrationParams`](../modules/types_composer.md#onlinekeyregistrationparams)) => `Promise`\<`Transaction`\> - -Create an online key registration transaction. - -**`Example`** - -```typescript -await algorand.createTransaction.onlineKeyRegistration({ - sender: 'SENDERADDRESS', - voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), - selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), - stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), - voteFirst: 1n, - voteLast: 1000n, - voteKeyDilution: 1n, -}) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.onlineKeyRegistration({ - sender: 'SENDERADDRESS', - voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), - selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), - stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), - voteFirst: 1n, - voteLast: 1000n, - voteKeyDilution: 1n, - lease: 'lease', - note: 'note', - // Use this with caution, it's generally better to use algorand.account.rekeyAccount - rekeyTo: 'REKEYTOADDRESS', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`OnlineKeyRegistrationParams`](../modules/types_composer.md#onlinekeyregistrationparams) | The parameters for the key registration transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:695](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L695) - -___ - -### payment - -• **payment**: (`params`: [`PaymentParams`](../modules/types_composer.md#paymentparams)) => `Promise`\<`Transaction`\> - -Create a payment transaction to transfer Algo between accounts. - -**`Example`** - -```typescript -await algorand.createTransaction.payment({ - sender: 'SENDERADDRESS', - receiver: 'RECEIVERADDRESS', - amount: (4).algo(), -}) -``` - -**`Example`** - -```typescript -await algorand.createTransaction.payment({ - amount: (4).algo(), - receiver: 'RECEIVERADDRESS', - sender: 'SENDERADDRESS', - closeRemainderTo: 'CLOSEREMAINDERTOADDRESS', - lease: 'lease', - note: 'note', - // Use this with caution, it's generally better to use algorand.account.rekeyAccount - rekeyTo: 'REKEYTOADDRESS', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`PaymentParams`](../modules/types_composer.md#paymentparams) | The parameters for the payment transaction | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L74) - -## Methods - -### \_transaction - -▸ **_transaction**\<`T`\>(`c`): (`params`: `T`) => `Promise`\<`Transaction`\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) | - -#### Returns - -`fn` - -▸ (`params`): `Promise`\<`Transaction`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `T` | - -##### Returns - -`Promise`\<`Transaction`\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L23) - -___ - -### \_transactions - -▸ **_transactions**\<`T`\>(`c`): (`params`: `T`) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) | - -#### Returns - -`fn` - -▸ (`params`): `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `T` | - -##### Returns - -`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-creator.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L31) diff --git a/docs/code/classes/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md b/docs/code/classes/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md deleted file mode 100644 index fb104e9c..00000000 --- a/docs/code/classes/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md +++ /dev/null @@ -1,1510 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/algorand-client-transaction-sender](../modules/types_algorand_client_transaction_sender.md) / AlgorandClientTransactionSender - -# Class: AlgorandClientTransactionSender - -[types/algorand-client-transaction-sender](../modules/types_algorand_client_transaction_sender.md).AlgorandClientTransactionSender - -Orchestrates sending transactions for `AlgorandClient`. - -## Table of contents - -### Constructors - -- [constructor](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#constructor) - -### Properties - -- [\_appManager](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_appmanager) -- [\_assetManager](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_assetmanager) -- [\_newGroup](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_newgroup) -- [appCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appcall) -- [appCallMethodCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appcallmethodcall) -- [appCreate](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appcreate) -- [appCreateMethodCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appcreatemethodcall) -- [appDelete](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appdelete) -- [appDeleteMethodCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appdeletemethodcall) -- [appUpdate](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appupdate) -- [appUpdateMethodCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#appupdatemethodcall) -- [assetConfig](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetconfig) -- [assetDestroy](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetdestroy) -- [assetFreeze](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetfreeze) -- [assetOptIn](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetoptin) -- [assetTransfer](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assettransfer) -- [offlineKeyRegistration](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#offlinekeyregistration) -- [onlineKeyRegistration](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#onlinekeyregistration) -- [payment](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#payment) - -### Methods - -- [\_send](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_send) -- [\_sendAppCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_sendappcall) -- [\_sendAppCreateCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_sendappcreatecall) -- [\_sendAppUpdateCall](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#_sendappupdatecall) -- [assetCreate](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetcreate) -- [assetOptOut](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#assetoptout) -- [newGroup](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md#newgroup) - -## Constructors - -### constructor - -• **new AlgorandClientTransactionSender**(`newGroup`, `assetManager`, `appManager`): [`AlgorandClientTransactionSender`](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md) - -Creates a new `AlgorandClientSender` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `newGroup` | () => [`TransactionComposer`](types_composer.TransactionComposer.md) | A lambda that starts a new `TransactionComposer` transaction group | -| `assetManager` | [`AssetManager`](types_asset_manager.AssetManager.md) | An `AssetManager` instance | -| `appManager` | [`AppManager`](types_app_manager.AppManager.md) | An `AppManager` instance | - -#### Returns - -[`AlgorandClientTransactionSender`](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md) - -**`Example`** - -```typescript -const transactionSender = new AlgorandClientTransactionSender(() => new TransactionComposer(), assetManager, appManager) -``` - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L51) - -## Properties - -### \_appManager - -• `Private` **\_appManager**: [`AppManager`](types_app_manager.AppManager.md) - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L39) - -___ - -### \_assetManager - -• `Private` **\_assetManager**: [`AssetManager`](types_asset_manager.AssetManager.md) - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L38) - -___ - -### \_newGroup - -• `Private` **\_newGroup**: () => [`TransactionComposer`](types_composer.TransactionComposer.md) - -#### Type declaration - -▸ (): [`TransactionComposer`](types_composer.TransactionComposer.md) - -##### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L37) - -___ - -### appCall - -• **appCall**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `onComplete?`: `OnApplicationComplete` } & \{ `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `ClearStateOC` \| `DeleteApplicationOC` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Call a smart contract. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -await algorand.send.appCall({ sender: 'CREATORADDRESS' }) -``` - -**`Example`** - -```typescript -await algorand.send.appCall({ - sender: 'CREATORADDRESS', - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `onComplete?`: `OnApplicationComplete` } & \{ `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `ClearStateOC` \| `DeleteApplicationOC` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app call transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:731](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L731) - -___ - -### appCallMethodCall - -• **appCallMethodCall**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Call a smart contract via an ABI method. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.send.appCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.send.appCallMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app call transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:971](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L971) - -___ - -### appCreate - -• **appCreate**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Create a smart contract. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -const result = await algorand.send.appCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) -const createdAppId = result.appId -``` - -**`Example`** - -```typescript -await algorand.send.appCreate({ - sender: 'CREATORADDRESS', - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - schema: { - globalInts: 1, - globalByteSlices: 2, - localInts: 3, - localByteSlices: 4 - }, - extraProgramPages: 1, - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app creation transaction | - -##### Returns - -`Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:594](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L594) - -___ - -### appCreateMethodCall - -• **appCreateMethodCall**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Create a smart contract via an ABI method. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -const result = await algorand.send.appCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) -const createdAppId = result.appId -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.send.appCreateMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - schema: { - globalInts: 1, - globalByteSlices: 2, - localInts: 3, - localByteSlices: 4 - }, - extraProgramPages: 1, - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app creation transaction | - -##### Returns - -`Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:798](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L798) - -___ - -### appDelete - -• **appDelete**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `onComplete?`: `OnApplicationComplete` } & \{ `onComplete?`: `DeleteApplicationOC` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Delete a smart contract. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -await algorand.send.appDelete({ sender: 'CREATORADDRESS' }) -``` - -**`Example`** - -```typescript -await algorand.send.appDelete({ - sender: 'CREATORADDRESS', - onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `onComplete?`: `OnApplicationComplete` } & \{ `onComplete?`: `DeleteApplicationOC` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app deletion transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:686](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L686) - -___ - -### appDeleteMethodCall - -• **appDeleteMethodCall**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Delete a smart contract via an ABI method. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.send.appDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.send.appDeleteMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app deletion transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:914](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L914) - -___ - -### appUpdate - -• **appUpdate**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Update a smart contract. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -await algorand.send.appUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) -``` - -**`Example`** - -```typescript -await algorand.send.appUpdate({ - sender: 'CREATORADDRESS', - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app update transaction | - -##### Returns - -`Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:641](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L641) - -___ - -### appUpdateMethodCall - -• **appUpdateMethodCall**: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Update a smart contract via an ABI method. - -Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.send.appUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -await algorand.send.appUpdateMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: `ABIMethod` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the app update transaction | - -##### Returns - -`Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:857](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L857) - -___ - -### assetConfig - -• **assetConfig**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` ; `clawback?`: `string` \| `Address` ; `freeze?`: `string` \| `Address` ; `manager`: `undefined` \| `string` \| `Address` ; `reserve?`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Configure an existing Algorand Standard Asset. - -**Note:** The manager, reserve, freeze, and clawback addresses -are immutably empty if they are not set. If manager is not set then -all fields are immutable from that point forward. - -**`Example`** - -```typescript -await algorand.send.assetConfig({ sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" }) -``` - -**`Example`** - -```typescript -await algorand.send.assetConfig({ - sender: 'MANAGERADDRESS', - assetId: 123456n, - manager: 'MANAGERADDRESS', - reserve: 'RESERVEADDRESS', - freeze: 'FREEZEADDRESS', - clawback: 'CLAWBACKADDRESS', - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` ; `clawback?`: `string` \| `Address` ; `freeze?`: `string` \| `Address` ; `manager`: `undefined` \| `string` \| `Address` ; `reserve?`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset config transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L304) - -___ - -### assetDestroy - -• **assetDestroy**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Destroys an Algorand Standard Asset. - -Created assets can be destroyed only by the asset manager account. -All of the assets must be owned by the creator of the asset before -the asset can be deleted. - -**`Example`** - -```typescript -await algorand.send.assetDestroy({ sender: "MANAGERADDRESS", assetId: 123456n }) -``` - -**`Example`** - -```typescript -await algorand.send.assetDestroy({ - sender: 'MANAGERADDRESS', - assetId: 123456n, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset destroy transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:384](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L384) - -___ - -### assetFreeze - -• **assetFreeze**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `account`: `string` \| `Address` ; `assetId`: `bigint` ; `frozen`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Freeze or unfreeze an Algorand Standard Asset for an account. - -**`Example`** - -```typescript -await algorand.send.assetFreeze({ sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true }) -``` - -**`Example`** - -```typescript -await algorand.send.assetFreeze({ - sender: 'MANAGERADDRESS', - assetId: 123456n, - account: 'ACCOUNTADDRESS', - frozen: true, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `account`: `string` \| `Address` ; `assetId`: `bigint` ; `frozen`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset freeze transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L343) - -___ - -### assetOptIn - -• **assetOptIn**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Opt an account into an Algorand Standard Asset. - -**`Example`** - -```typescript -await algorand.send.assetOptIn({ sender: "SENDERADDRESS", assetId: 123456n }) -``` - -**`Example`** - -```typescript -await algorand.send.assetOptIn({ - sender: 'SENDERADDRESS', - assetId: 123456n, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset opt-in transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:464](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L464) - -___ - -### assetTransfer - -• **assetTransfer**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `amount`: `bigint` ; `assetId`: `bigint` ; `clawbackTarget?`: `string` \| `Address` ; `closeAssetTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Transfer an Algorand Standard Asset. - -**`Example`** - -```typescript -await algorand.send.assetTransfer({ sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" }) -``` - -**`Example`** - -```typescript -await algorand.send.assetTransfer({ - sender: 'CLAWBACKADDRESS', - assetId: 123456n, - amount: 1n, - receiver: 'RECEIVERADDRESS', - clawbackTarget: 'HOLDERADDRESS', - // This field needs to be used with caution - closeAssetTo: 'ADDRESSTOCLOSETO' - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `amount`: `bigint` ; `assetId`: `bigint` ; `clawbackTarget?`: `string` \| `Address` ; `closeAssetTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset transfer transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:426](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L426) - -___ - -### offlineKeyRegistration - -• **offlineKeyRegistration**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `preventAccountFromEverParticipatingAgain?`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Register an offline key. - -**`Example`** - -```typescript -const result = await algorand.send.offlineKeyRegistration({ - sender: 'SENDERADDRESS', -}) -``` - -**`Example`** - -```typescript -const result = await algorand.send.offlineKeyRegistration({ - sender: 'SENDERADDRESS', - lease: 'lease', - note: 'note', - // Use this with caution, it's generally better to use algorand.account.rekeyAccount - rekeyTo: 'REKEYTOADDRESS', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `preventAccountFromEverParticipatingAgain?`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the key registration transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:1050](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L1050) - -___ - -### onlineKeyRegistration - -• **onlineKeyRegistration**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `selectionKey`: `Uint8Array` ; `stateProofKey?`: `Uint8Array` ; `voteFirst`: `bigint` ; `voteKey`: `Uint8Array` ; `voteKeyDilution`: `bigint` ; `voteLast`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Register an online key. - -**`Example`** - -```typescript -const result = await algorand.send.onlineKeyRegistration({ - sender: 'SENDERADDRESS', - voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), - selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), - stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), - voteFirst: 1n, - voteLast: 1000n, - voteKeyDilution: 1n, -}) -``` - -**`Example`** - -```typescript -const result = await algorand.send.onlineKeyRegistration({ - sender: 'SENDERADDRESS', - voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), - selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), - stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), - voteFirst: 1n, - voteLast: 1000n, - voteKeyDilution: 1n, - lease: 'lease', - note: 'note', - // Use this with caution, it's generally better to use algorand.account.rekeyAccount - rekeyTo: 'REKEYTOADDRESS', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `selectionKey`: `Uint8Array` ; `stateProofKey?`: `Uint8Array` ; `voteFirst`: `bigint` ; `voteKey`: `Uint8Array` ; `voteKeyDilution`: `bigint` ; `voteLast`: `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the key registration transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:1017](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L1017) - -___ - -### payment - -• **payment**: (`params`: [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Send a payment transaction to transfer Algo between accounts. - -**`Example`** - -```typescript -const result = await algorand.send.payment({ - sender: 'SENDERADDRESS', - receiver: 'RECEIVERADDRESS', - amount: (4).algo(), -}) -``` - -**`Example`** - -```typescript -const result = await algorand.send.payment({ - amount: (4).algo(), - receiver: 'RECEIVERADDRESS', - sender: 'SENDERADDRESS', - closeRemainderTo: 'CLOSEREMAINDERTOADDRESS', - lease: 'lease', - note: 'note', - // Use this with caution, it's generally better to use algorand.account.rekeyAccount - rekeyTo: 'REKEYTOADDRESS', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Type declaration - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the payment transaction | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:204](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L204) - -## Methods - -### \_send - -▸ **_send**\<`T`\>(`c`, `log?`): (`params`: `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) | -| `log?` | `Object` | -| `log.postLog?` | (`params`: `T`, `result`: \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }) => `string` | -| `log.preLog?` | (`params`: `T`, `transaction`: `Transaction`) => `string` | - -#### Returns - -`fn` - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md) | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L68) - -___ - -### \_sendAppCall - -▸ **_sendAppCall**\<`T`\>(`c`, `log?`): (`params`: `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| [`AppCallParams`](../modules/types_composer.md#appcallparams) \| [`AppDeleteParams`](../modules/types_composer.md#appdeleteparams) \| [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) \| [`AppUpdateMethodCall`](../modules/types_composer.md#appupdatemethodcall) \| [`AppDeleteMethodCall`](../modules/types_composer.md#appdeletemethodcall) \| [`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) | -| `log?` | `Object` | -| `log.postLog?` | (`params`: `T`, `result`: \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }) => `string` | -| `log.preLog?` | (`params`: `T`, `transaction`: `Transaction`) => `string` | - -#### Returns - -`fn` - -▸ (`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md) | - -##### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L103) - -___ - -### \_sendAppCreateCall - -▸ **_sendAppCreateCall**\<`T`\>(`c`, `log?`): (`params`: `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) | -| `log?` | `Object` | -| `log.postLog?` | (`params`: `T`, `result`: \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }) => `string` | -| `log.preLog?` | (`params`: `T`, `transaction`: `Transaction`) => `string` | - -#### Returns - -`fn` - -▸ (`params`): `Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md) | - -##### Returns - -`Promise`\<\{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L146) - -___ - -### \_sendAppUpdateCall - -▸ **_sendAppUpdateCall**\<`T`\>(`c`, `log?`): (`params`: `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) \| [`AppUpdateMethodCall`](../modules/types_composer.md#appupdatemethodcall) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `c` | (`c`: [`TransactionComposer`](types_composer.TransactionComposer.md)) => (`params`: `T`) => [`TransactionComposer`](types_composer.TransactionComposer.md) | -| `log?` | `Object` | -| `log.postLog?` | (`params`: `T`, `result`: \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }) => `string` | -| `log.preLog?` | (`params`: `T`, `transaction`: `Transaction`) => `string` | - -#### Returns - -`fn` - -▸ (`params`): `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `T` & [`SendParams`](../interfaces/types_transaction.SendParams.md) | - -##### Returns - -`Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:127](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L127) - -___ - -### assetCreate - -▸ **assetCreate**(`params`): `Promise`\<\{ `assetId`: `bigint` ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Create a new Algorand Standard Asset. - -The account that sends this transaction will automatically be -opted in to the asset and will hold all units after creation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) & \{ `assetName?`: `string` ; `clawback?`: `string` \| `Address` ; `decimals?`: `number` ; `defaultFrozen?`: `boolean` ; `freeze?`: `string` \| `Address` ; `manager?`: `string` \| `Address` ; `metadataHash?`: `string` \| `Uint8Array` ; `reserve?`: `string` \| `Address` ; `total`: `bigint` ; `unitName?`: `string` ; `url?`: `string` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset creation transaction | - -#### Returns - -`Promise`\<\{ `assetId`: `bigint` ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -The result of the asset create transaction and the transaction that was sent - -**`Example`** - -```typescript -await algorand.send.assetCreate({ sender: "CREATORADDRESS", total: 100n}) -``` - -**`Example`** - -```typescript -await algorand.send.assetCreate({ - sender: 'CREATORADDRESS', - total: 100n, - decimals: 2, - assetName: 'asset', - unitName: 'unit', - url: 'url', - metadataHash: 'metadataHash', - defaultFrozen: false, - manager: 'MANAGERADDRESS', - reserve: 'RESERVEADDRESS', - freeze: 'FREEZEADDRESS', - clawback: 'CLAWBACKADDRESS', - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L255) - -___ - -### assetOptOut - -▸ **assetOptOut**(`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Opt an account out of an Algorand Standard Asset. - -*Note:* If the account has a balance of the asset, -it will not be able to opt-out unless `ensureZeroBalance` -is set to `false` (but then the account will lose the assets). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Omit`\<[`AssetOptOutParams`](../modules/types_composer.md#assetoptoutparams), ``"creator"``\> & \{ `creator?`: `string` \| `Address` ; `ensureZeroBalance`: `boolean` } & [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters for the asset opt-out transaction | - -#### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -The result of the asset opt-out transaction and the transaction that was sent - -**`Example`** - -```typescript -await algorand.send.assetOptOut({ sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true }) -``` - -**`Example`** - -```typescript -await algorand.send.assetOptOut({ sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true }) -``` - -**`Example`** - -```typescript -await algorand.send.assetOptOut({ - sender: 'SENDERADDRESS', - assetId: 123456n, - creator: 'CREATORADDRESS', - ensureZeroBalance: true, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:511](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L511) - -___ - -### newGroup - -▸ **newGroup**(): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Start a new `TransactionComposer` transaction group - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -A new instance of `TransactionComposer`. - -**`Example`** - -```ts -const composer = AlgorandClient.mainNet().send.newGroup(); -const result = await composer.addTransaction(payment).send() -``` - -#### Defined in - -[src/types/algorand-client-transaction-sender.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L64) diff --git a/docs/code/classes/types_amount.AlgoAmount.md b/docs/code/classes/types_amount.AlgoAmount.md deleted file mode 100644 index 10c47481..00000000 --- a/docs/code/classes/types_amount.AlgoAmount.md +++ /dev/null @@ -1,257 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/amount](../modules/types_amount.md) / AlgoAmount - -# Class: AlgoAmount - -[types/amount](../modules/types_amount.md).AlgoAmount - -Wrapper class to ensure safe, explicit conversion between µAlgo, Algo and numbers - -## Table of contents - -### Constructors - -- [constructor](types_amount.AlgoAmount.md#constructor) - -### Properties - -- [amountInMicroAlgo](types_amount.AlgoAmount.md#amountinmicroalgo) - -### Accessors - -- [algo](types_amount.AlgoAmount.md#algo) -- [algos](types_amount.AlgoAmount.md#algos) -- [microAlgo](types_amount.AlgoAmount.md#microalgo) -- [microAlgos](types_amount.AlgoAmount.md#microalgos) - -### Methods - -- [toString](types_amount.AlgoAmount.md#tostring) -- [valueOf](types_amount.AlgoAmount.md#valueof) -- [Algo](types_amount.AlgoAmount.md#algo-1) -- [Algos](types_amount.AlgoAmount.md#algos-1) -- [MicroAlgo](types_amount.AlgoAmount.md#microalgo-1) -- [MicroAlgos](types_amount.AlgoAmount.md#microalgos-1) - -## Constructors - -### constructor - -• **new AlgoAmount**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md) - -Create a new `AlgoAmount` instance. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `amount` | \{ `algos`: `number` \| `bigint` } \| \{ `algo`: `number` \| `bigint` } \| \{ `microAlgos`: `number` \| `bigint` } \| \{ `microAlgo`: `number` \| `bigint` } | An object specifying the amount in Algo or µALGO. Use the key 'algo' for Algo amounts and 'microAlgo' for µALGO. | - -#### Returns - -[`AlgoAmount`](types_amount.AlgoAmount.md) - -A new instance of `AlgoAmount` representing the specified amount. - -**`Example`** - -```typescript -const amount = new AlgoAmount({ algo: 5 }); -``` - -#### Defined in - -[src/types/amount.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L37) - -## Properties - -### amountInMicroAlgo - -• `Private` **amountInMicroAlgo**: `bigint` - -#### Defined in - -[src/types/amount.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L5) - -## Accessors - -### algo - -• `get` **algo**(): `number` - -Return the amount as a number in Algo - -#### Returns - -`number` - -#### Defined in - -[src/types/amount.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L23) - -___ - -### algos - -• `get` **algos**(): `number` - -Return the amount as a number in Algo - -#### Returns - -`number` - -#### Defined in - -[src/types/amount.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L18) - -___ - -### microAlgo - -• `get` **microAlgo**(): `bigint` - -Return the amount as a number in µAlgo - -#### Returns - -`bigint` - -#### Defined in - -[src/types/amount.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L13) - -___ - -### microAlgos - -• `get` **microAlgos**(): `bigint` - -Return the amount as a number in µAlgo - -#### Returns - -`bigint` - -#### Defined in - -[src/types/amount.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L8) - -## Methods - -### toString - -▸ **toString**(): `string` - -#### Returns - -`string` - -#### Defined in - -[src/types/amount.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L50) - -___ - -### valueOf - -▸ **valueOf**(): `number` - -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 - -#### Returns - -`number` - -#### Defined in - -[src/types/amount.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L58) - -___ - -### Algo - -▸ **Algo**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md) - -Create a `AlgoAmount` object representing the given number of Algo - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `amount` | `number` \| `bigint` | - -#### Returns - -[`AlgoAmount`](types_amount.AlgoAmount.md) - -#### Defined in - -[src/types/amount.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L68) - -___ - -### Algos - -▸ **Algos**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md) - -Create a `AlgoAmount` object representing the given number of Algo - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `amount` | `number` \| `bigint` | - -#### Returns - -[`AlgoAmount`](types_amount.AlgoAmount.md) - -#### Defined in - -[src/types/amount.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L63) - -___ - -### MicroAlgo - -▸ **MicroAlgo**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md) - -Create a `AlgoAmount` object representing the given number of µAlgo - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `amount` | `number` \| `bigint` | - -#### Returns - -[`AlgoAmount`](types_amount.AlgoAmount.md) - -#### Defined in - -[src/types/amount.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L78) - -___ - -### MicroAlgos - -▸ **MicroAlgos**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md) - -Create a `AlgoAmount` object representing the given number of µAlgo - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `amount` | `number` \| `bigint` | - -#### Returns - -[`AlgoAmount`](types_amount.AlgoAmount.md) - -#### Defined in - -[src/types/amount.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L73) diff --git a/docs/code/classes/types_app_arc56.Arc56Method.md b/docs/code/classes/types_app_arc56.Arc56Method.md deleted file mode 100644 index 75a66a2f..00000000 --- a/docs/code/classes/types_app_arc56.Arc56Method.md +++ /dev/null @@ -1,259 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-arc56](../modules/types_app_arc56.md) / Arc56Method - -# Class: Arc56Method - -[types/app-arc56](../modules/types_app_arc56.md).Arc56Method - -Wrapper around `algosdk.ABIMethod` that represents an ARC-56 ABI method. - -## Hierarchy - -- `ABIMethod` - - ↳ **`Arc56Method`** - -## Table of contents - -### Constructors - -- [constructor](types_app_arc56.Arc56Method.md#constructor) - -### Properties - -- [args](types_app_arc56.Arc56Method.md#args) -- [description](types_app_arc56.Arc56Method.md#description) -- [events](types_app_arc56.Arc56Method.md#events) -- [method](types_app_arc56.Arc56Method.md#method) -- [name](types_app_arc56.Arc56Method.md#name) -- [readonly](types_app_arc56.Arc56Method.md#readonly) -- [returns](types_app_arc56.Arc56Method.md#returns) - -### Methods - -- [getSelector](types_app_arc56.Arc56Method.md#getselector) -- [getSignature](types_app_arc56.Arc56Method.md#getsignature) -- [toJSON](types_app_arc56.Arc56Method.md#tojson) -- [txnCount](types_app_arc56.Arc56Method.md#txncount) -- [fromSignature](types_app_arc56.Arc56Method.md#fromsignature) - -## Constructors - -### constructor - -• **new Arc56Method**(`method`): [`Arc56Method`](types_app_arc56.Arc56Method.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `method` | [`Method`](../interfaces/types_app_arc56.Method.md) | - -#### Returns - -[`Arc56Method`](types_app_arc56.Arc56Method.md) - -#### Overrides - -algosdk.ABIMethod.constructor - -#### Defined in - -[src/types/app-arc56.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L26) - -## Properties - -### args - -• `Readonly` **args**: \{ `defaultValue?`: \{ `data`: `string` ; `source`: ``"method"`` \| ``"box"`` \| ``"global"`` \| ``"local"`` \| ``"literal"`` ; `type?`: `string` } ; `desc?`: `string` ; `name?`: `string` ; `struct?`: `string` ; `type`: `ABIArgumentType` }[] - -#### Overrides - -algosdk.ABIMethod.args - -#### Defined in - -[src/types/app-arc56.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L23) - -___ - -### description - -• `Optional` `Readonly` **description**: `string` - -#### Inherited from - -algosdk.ABIMethod.description - -#### Defined in - -node_modules/algosdk/dist/types/abi/method.d.ts:28 - -___ - -### events - -• `Optional` `Readonly` **events**: `ARC28Event`[] - -#### Inherited from - -algosdk.ABIMethod.events - -#### Defined in - -node_modules/algosdk/dist/types/abi/method.d.ts:38 - -___ - -### method - -• **method**: [`Method`](../interfaces/types_app_arc56.Method.md) - -#### Defined in - -[src/types/app-arc56.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L26) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Inherited from - -algosdk.ABIMethod.name - -#### Defined in - -node_modules/algosdk/dist/types/abi/method.d.ts:27 - -___ - -### readonly - -• `Optional` `Readonly` **readonly**: `boolean` - -#### Inherited from - -algosdk.ABIMethod.readonly - -#### Defined in - -node_modules/algosdk/dist/types/abi/method.d.ts:39 - -___ - -### returns - -• `Readonly` **returns**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `desc?` | `string` | Optional, user-friendly description for the return value | -| `struct?` | `string` | If the type is a struct, the name of the struct | -| `type` | `ABIReturnType` | - | - -#### Overrides - -algosdk.ABIMethod.returns - -#### Defined in - -[src/types/app-arc56.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L24) - -## Methods - -### getSelector - -▸ **getSelector**(): `Uint8Array` - -#### Returns - -`Uint8Array` - -#### Inherited from - -algosdk.ABIMethod.getSelector - -#### Defined in - -node_modules/algosdk/dist/types/abi/method.d.ts:42 - -___ - -### getSignature - -▸ **getSignature**(): `string` - -#### Returns - -`string` - -#### Inherited from - -algosdk.ABIMethod.getSignature - -#### Defined in - -node_modules/algosdk/dist/types/abi/method.d.ts:41 - -___ - -### toJSON - -▸ **toJSON**(): [`Method`](../interfaces/types_app_arc56.Method.md) - -#### Returns - -[`Method`](../interfaces/types_app_arc56.Method.md) - -#### Overrides - -algosdk.ABIMethod.toJSON - -#### Defined in - -[src/types/app-arc56.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L38) - -___ - -### txnCount - -▸ **txnCount**(): `number` - -#### Returns - -`number` - -#### Inherited from - -algosdk.ABIMethod.txnCount - -#### Defined in - -node_modules/algosdk/dist/types/abi/method.d.ts:43 - -___ - -### fromSignature - -▸ **fromSignature**(`signature`): `ABIMethod` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signature` | `string` | - -#### Returns - -`ABIMethod` - -#### Inherited from - -algosdk.ABIMethod.fromSignature - -#### Defined in - -node_modules/algosdk/dist/types/abi/method.d.ts:45 diff --git a/docs/code/classes/types_app_client.AppClient.md b/docs/code/classes/types_app_client.AppClient.md deleted file mode 100644 index 2853c55c..00000000 --- a/docs/code/classes/types_app_client.AppClient.md +++ /dev/null @@ -1,1450 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClient - -# Class: AppClient - -[types/app-client](../modules/types_app_client.md).AppClient - -ARC-56/ARC-32 application client that allows you to manage calls and -state for a specific deployed instance of an app (with a known app ID). - -## Table of contents - -### Constructors - -- [constructor](types_app_client.AppClient.md#constructor) - -### Properties - -- [\_algorand](types_app_client.AppClient.md#_algorand) -- [\_appAddress](types_app_client.AppClient.md#_appaddress) -- [\_appId](types_app_client.AppClient.md#_appid) -- [\_appName](types_app_client.AppClient.md#_appname) -- [\_appSpec](types_app_client.AppClient.md#_appspec) -- [\_approvalSourceMap](types_app_client.AppClient.md#_approvalsourcemap) -- [\_boxStateMethods](types_app_client.AppClient.md#_boxstatemethods) -- [\_clearSourceMap](types_app_client.AppClient.md#_clearsourcemap) -- [\_createTransactionsMethods](types_app_client.AppClient.md#_createtransactionsmethods) -- [\_defaultSender](types_app_client.AppClient.md#_defaultsender) -- [\_defaultSigner](types_app_client.AppClient.md#_defaultsigner) -- [\_globalStateMethods](types_app_client.AppClient.md#_globalstatemethods) -- [\_localStateMethods](types_app_client.AppClient.md#_localstatemethods) -- [\_paramsMethods](types_app_client.AppClient.md#_paramsmethods) -- [\_sendMethods](types_app_client.AppClient.md#_sendmethods) - -### Accessors - -- [algorand](types_app_client.AppClient.md#algorand) -- [appAddress](types_app_client.AppClient.md#appaddress) -- [appId](types_app_client.AppClient.md#appid) -- [appName](types_app_client.AppClient.md#appname) -- [appSpec](types_app_client.AppClient.md#appspec) -- [createTransaction](types_app_client.AppClient.md#createtransaction) -- [params](types_app_client.AppClient.md#params) -- [send](types_app_client.AppClient.md#send) -- [state](types_app_client.AppClient.md#state) - -### Methods - -- [clone](types_app_client.AppClient.md#clone) -- [compile](types_app_client.AppClient.md#compile) -- [exportSourceMaps](types_app_client.AppClient.md#exportsourcemaps) -- [exposeLogicError](types_app_client.AppClient.md#exposelogicerror) -- [fundAppAccount](types_app_client.AppClient.md#fundappaccount) -- [getABIArgsWithDefaultValues](types_app_client.AppClient.md#getabiargswithdefaultvalues) -- [getABIMethod](types_app_client.AppClient.md#getabimethod) -- [getABIParams](types_app_client.AppClient.md#getabiparams) -- [getBareCreateTransactionMethods](types_app_client.AppClient.md#getbarecreatetransactionmethods) -- [getBareParams](types_app_client.AppClient.md#getbareparams) -- [getBareParamsMethods](types_app_client.AppClient.md#getbareparamsmethods) -- [getBareSendMethods](types_app_client.AppClient.md#getbaresendmethods) -- [getBoxMethods](types_app_client.AppClient.md#getboxmethods) -- [getBoxNames](types_app_client.AppClient.md#getboxnames) -- [getBoxValue](types_app_client.AppClient.md#getboxvalue) -- [getBoxValueFromABIType](types_app_client.AppClient.md#getboxvaluefromabitype) -- [getBoxValues](types_app_client.AppClient.md#getboxvalues) -- [getBoxValuesFromABIType](types_app_client.AppClient.md#getboxvaluesfromabitype) -- [getGlobalState](types_app_client.AppClient.md#getglobalstate) -- [getLocalState](types_app_client.AppClient.md#getlocalstate) -- [getMethodCallCreateTransactionMethods](types_app_client.AppClient.md#getmethodcallcreatetransactionmethods) -- [getMethodCallParamsMethods](types_app_client.AppClient.md#getmethodcallparamsmethods) -- [getMethodCallSendMethods](types_app_client.AppClient.md#getmethodcallsendmethods) -- [getSender](types_app_client.AppClient.md#getsender) -- [getSigner](types_app_client.AppClient.md#getsigner) -- [getStateMethods](types_app_client.AppClient.md#getstatemethods) -- [handleCallErrors](types_app_client.AppClient.md#handlecallerrors) -- [importSourceMaps](types_app_client.AppClient.md#importsourcemaps) -- [processMethodCallReturn](types_app_client.AppClient.md#processmethodcallreturn) -- [compile](types_app_client.AppClient.md#compile-1) -- [exposeLogicError](types_app_client.AppClient.md#exposelogicerror-1) -- [fromCreatorAndName](types_app_client.AppClient.md#fromcreatorandname) -- [fromNetwork](types_app_client.AppClient.md#fromnetwork) -- [normaliseAppSpec](types_app_client.AppClient.md#normaliseappspec) - -## Constructors - -### constructor - -• **new AppClient**(`params`): [`AppClient`](types_app_client.AppClient.md) - -Create a new app client. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppClientParams`](../interfaces/types_app_client.AppClientParams.md) | The parameters to create the app client | - -#### Returns - -[`AppClient`](types_app_client.AppClient.md) - -The `AppClient` instance - -**`Example`** - -```typescript -const appClient = new AppClient({ - appId: 12345678n, - appSpec: appSpec, - algorand: AlgorandClient.mainNet(), -}) - -#### Defined in - -[src/types/app-client.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L513) - -## Properties - -### \_algorand - -• `Private` **\_algorand**: [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -#### Defined in - -[src/types/app-client.ts:480](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L480) - -___ - -### \_appAddress - -• `Private` **\_appAddress**: `Address` - -#### Defined in - -[src/types/app-client.ts:477](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L477) - -___ - -### \_appId - -• `Private` **\_appId**: `bigint` - -#### Defined in - -[src/types/app-client.ts:476](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L476) - -___ - -### \_appName - -• `Private` **\_appName**: `string` - -#### Defined in - -[src/types/app-client.ts:478](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L478) - -___ - -### \_appSpec - -• `Private` **\_appSpec**: [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -#### Defined in - -[src/types/app-client.ts:479](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L479) - -___ - -### \_approvalSourceMap - -• `Private` **\_approvalSourceMap**: `undefined` \| `ProgramSourceMap` - -#### Defined in - -[src/types/app-client.ts:484](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L484) - -___ - -### \_boxStateMethods - -• `Private` **\_boxStateMethods**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `getAll` | () => `Promise`\<`Record`\<`string`, `any`\>\> | - | -| `getMap` | (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `getMapValue` | (`mapName`: `string`, `key`: `any`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | -| `getValue` | (`name`: `string`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | - -#### Defined in - -[src/types/app-client.ts:489](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L489) - -___ - -### \_clearSourceMap - -• `Private` **\_clearSourceMap**: `undefined` \| `ProgramSourceMap` - -#### Defined in - -[src/types/app-client.ts:485](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L485) - -___ - -### \_createTransactionsMethods - -• `Private` **\_createTransactionsMethods**: \{ `call`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `closeOut`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `delete`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `fundAppAccount`: (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `optIn`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `update`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> } & \{ `bare`: \{ `call`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<`Transaction`\> ; `clearState`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `closeOut`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `delete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `optIn`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `update`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<`Transaction`\> } } - -#### Defined in - -[src/types/app-client.ts:494](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L494) - -___ - -### \_defaultSender - -• `Private` `Optional` **\_defaultSender**: `Address` - -#### Defined in - -[src/types/app-client.ts:481](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L481) - -___ - -### \_defaultSigner - -• `Private` `Optional` **\_defaultSigner**: `TransactionSigner` - -#### Defined in - -[src/types/app-client.ts:482](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L482) - -___ - -### \_globalStateMethods - -• `Private` **\_globalStateMethods**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `getAll` | () => `Promise`\<`Record`\<`string`, `any`\>\> | - | -| `getMap` | (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `getMapValue` | (`mapName`: `string`, `key`: `any`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | -| `getValue` | (`name`: `string`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | - -#### Defined in - -[src/types/app-client.ts:488](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L488) - -___ - -### \_localStateMethods - -• `Private` **\_localStateMethods**: (`address`: `string` \| `Address`) => \{ `getAll`: () => `Promise`\<`Record`\<`string`, `any`\>\> ; `getMap`: (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `getMapValue`: (`mapName`: `string`, `key`: `any`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> ; `getValue`: (`name`: `string`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> } - -#### Type declaration - -▸ (`address`): `Object` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Address` | - -##### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `getAll` | () => `Promise`\<`Record`\<`string`, `any`\>\> | - | -| `getMap` | (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `getMapValue` | (`mapName`: `string`, `key`: `any`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | -| `getValue` | (`name`: `string`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | - -#### Defined in - -[src/types/app-client.ts:487](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L487) - -___ - -### \_paramsMethods - -• `Private` **\_paramsMethods**: \{ `call`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> ; `closeOut`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> ; `delete`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppDeleteMethodCall`](../modules/types_composer.md#appdeletemethodcall)\> ; `fundAppAccount`: (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `receiver`: `Address` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } ; `optIn`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> ; `update`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `appId`: `bigint` ; `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... ; `appReferences?`: ... ; `approvalProgram`: ... ; `args?`: ... ; `assetReferences?`: ... ; `boxReferences?`: ... ; `clearStateProgram`: ... ; `extraFee?`: ... ; `extraProgramPages?`: ... ; `firstValidRound?`: ... ; `lastValidRound?`: ... ; `lease?`: ... ; `maxFee?`: ... ; `note?`: ... ; `onComplete?`: ... ; `rekeyTo?`: ... ; `schema?`: ... ; `sender`: ... ; `signer?`: ... ; `staticFee?`: ... ; `validityWindow?`: ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... ; `appId`: ... ; `appReferences?`: ... ; `approvalProgram`: ... ; `args?`: ... ; `assetReferences?`: ... ; `boxReferences?`: ... ; `clearStateProgram`: ... ; `extraFee?`: ... ; `firstValidRound?`: ... ; `lastValidRound?`: ... ; `lease?`: ... ; `maxFee?`: ... ; `note?`: ... ; `onComplete?`: ... ; `rekeyTo?`: ... ; `sender`: ... ; `signer?`: ... ; `staticFee?`: ... ; `validityWindow?`: ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` = sender; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> } & \{ `bare`: \{ `call`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `clearState`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `closeOut`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `delete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppDeleteParams`](../modules/types_composer.md#appdeleteparams) ; `optIn`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `update`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> } } - -#### Defined in - -[src/types/app-client.ts:491](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L491) - -___ - -### \_sendMethods - -• `Private` **\_sendMethods**: \{ `call`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `closeOut`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `delete`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `fundAppAccount`: (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `optIn`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `update`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> } & \{ `bare`: \{ `call`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `clearState`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `closeOut`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `delete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `optIn`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `update`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> } } - -#### Defined in - -[src/types/app-client.ts:497](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L497) - -## Accessors - -### algorand - -• `get` **algorand**(): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -A reference to the underlying `AlgorandClient` this app client is using. - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -#### Defined in - -[src/types/app-client.ts:678](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L678) - -___ - -### appAddress - -• `get` **appAddress**(): `Address` - -The app address of the app instance this client is linked to. - -#### Returns - -`Address` - -#### Defined in - -[src/types/app-client.ts:663](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L663) - -___ - -### appId - -• `get` **appId**(): `bigint` - -The ID of the app instance this client is linked to. - -#### Returns - -`bigint` - -#### Defined in - -[src/types/app-client.ts:658](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L658) - -___ - -### appName - -• `get` **appName**(): `string` - -The name of the app (from the ARC-32 / ARC-56 app spec or override). - -#### Returns - -`string` - -#### Defined in - -[src/types/app-client.ts:668](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L668) - -___ - -### appSpec - -• `get` **appSpec**(): [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -The ARC-56 app spec being used - -#### Returns - -[`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -#### Defined in - -[src/types/app-client.ts:673](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L673) - -___ - -### createTransaction - -• `get` **createTransaction**(): \{ `call`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `closeOut`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `delete`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `fundAppAccount`: (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `optIn`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `update`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> } & \{ `bare`: \{ `call`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<`Transaction`\> ; `clearState`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `closeOut`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `delete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `optIn`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `update`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<`Transaction`\> } } - -Create transactions for the current app - -#### Returns - -\{ `call`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `closeOut`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `delete`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `fundAppAccount`: (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `optIn`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> ; `update`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> } & \{ `bare`: \{ `call`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<`Transaction`\> ; `clearState`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `closeOut`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `delete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `optIn`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> ; `update`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<`Transaction`\> } } - -#### Defined in - -[src/types/app-client.ts:702](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L702) - -___ - -### params - -• `get` **params**(): \{ `call`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> ; `closeOut`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> ; `delete`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppDeleteMethodCall`](../modules/types_composer.md#appdeletemethodcall)\> ; `fundAppAccount`: (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `receiver`: `Address` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } ; `optIn`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> ; `update`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `appId`: `bigint` ; `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... ; `appReferences?`: ... ; `approvalProgram`: ... ; `args?`: ... ; `assetReferences?`: ... ; `boxReferences?`: ... ; `clearStateProgram`: ... ; `extraFee?`: ... ; `extraProgramPages?`: ... ; `firstValidRound?`: ... ; `lastValidRound?`: ... ; `lease?`: ... ; `maxFee?`: ... ; `note?`: ... ; `onComplete?`: ... ; `rekeyTo?`: ... ; `schema?`: ... ; `sender`: ... ; `signer?`: ... ; `staticFee?`: ... ; `validityWindow?`: ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... ; `appId`: ... ; `appReferences?`: ... ; `approvalProgram`: ... ; `args?`: ... ; `assetReferences?`: ... ; `boxReferences?`: ... ; `clearStateProgram`: ... ; `extraFee?`: ... ; `firstValidRound?`: ... ; `lastValidRound?`: ... ; `lease?`: ... ; `maxFee?`: ... ; `note?`: ... ; `onComplete?`: ... ; `rekeyTo?`: ... ; `sender`: ... ; `signer?`: ... ; `staticFee?`: ... ; `validityWindow?`: ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` = sender; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> } & \{ `bare`: \{ `call`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `clearState`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `closeOut`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `delete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppDeleteParams`](../modules/types_composer.md#appdeleteparams) ; `optIn`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `update`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> } } - -Get parameters to create transactions for the current app. - -A good mental model for this is that these parameters represent a deferred transaction creation. - -#### Returns - -\{ `call`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> ; `closeOut`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> ; `delete`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppDeleteMethodCall`](../modules/types_composer.md#appdeletemethodcall)\> ; `fundAppAccount`: (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `receiver`: `Address` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } ; `optIn`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> ; `update`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `appId`: `bigint` ; `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... ; `appReferences?`: ... ; `approvalProgram`: ... ; `args?`: ... ; `assetReferences?`: ... ; `boxReferences?`: ... ; `clearStateProgram`: ... ; `extraFee?`: ... ; `extraProgramPages?`: ... ; `firstValidRound?`: ... ; `lastValidRound?`: ... ; `lease?`: ... ; `maxFee?`: ... ; `note?`: ... ; `onComplete?`: ... ; `rekeyTo?`: ... ; `schema?`: ... ; `sender`: ... ; `signer?`: ... ; `staticFee?`: ... ; `validityWindow?`: ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... ; `appId`: ... ; `appReferences?`: ... ; `approvalProgram`: ... ; `args?`: ... ; `assetReferences?`: ... ; `boxReferences?`: ... ; `clearStateProgram`: ... ; `extraFee?`: ... ; `firstValidRound?`: ... ; `lastValidRound?`: ... ; `lease?`: ... ; `maxFee?`: ... ; `note?`: ... ; `onComplete?`: ... ; `rekeyTo?`: ... ; `sender`: ... ; `signer?`: ... ; `staticFee?`: ... ; `validityWindow?`: ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` = sender; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> } & \{ `bare`: \{ `call`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `clearState`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `closeOut`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `delete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppDeleteParams`](../modules/types_composer.md#appdeleteparams) ; `optIn`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) ; `update`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> } } - -**`Example`** - -```typescript -const myMethodCall = appClient.params.call({method: 'my_method', args: [123, 'hello']}) -// ... -await algorand.send.AppMethodCall(myMethodCall) -``` - -**`Example`** - -```typescript -const myMethodCall = appClient.params.call({method: 'my_method', args: [123, 'hello']}) -await appClient.send.call({method: 'my_method2', args: [myMethodCall]}) -``` - -#### Defined in - -[src/types/app-client.ts:697](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L697) - -___ - -### send - -• `get` **send**(): \{ `call`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `closeOut`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `delete`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `fundAppAccount`: (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `optIn`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `update`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> } & \{ `bare`: \{ `call`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `clearState`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `closeOut`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `delete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `optIn`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `update`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> } } - -Send transactions to the current app - -#### Returns - -\{ `call`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `closeOut`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `delete`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `fundAppAccount`: (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `optIn`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `update`: (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> } & \{ `bare`: \{ `call`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `clearState`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `closeOut`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `delete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `optIn`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> ; `update`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> } } - -#### Defined in - -[src/types/app-client.ts:707](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L707) - -___ - -### state - -• `get` **state**(): `Object` - -Get state (local, global, box) from the current app - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `box` | \{ `getAll`: () => `Promise`\<`Record`\<`string`, `any`\>\> ; `getMap`: (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `getMapValue`: (`mapName`: `string`, `key`: `any`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> ; `getValue`: (`name`: `string`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> } | Methods to access box storage for the current app | -| `box.getAll` | () => `Promise`\<`Record`\<`string`, `any`\>\> | - | -| `box.getMap` | (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `box.getMapValue` | (`mapName`: `string`, `key`: `any`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | -| `box.getValue` | (`name`: `string`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | -| `global` | \{ `getAll`: () => `Promise`\<`Record`\<`string`, `any`\>\> ; `getMap`: (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `getMapValue`: (`mapName`: `string`, `key`: `any`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> ; `getValue`: (`name`: `string`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> } | Methods to access global state for the current app | -| `global.getAll` | () => `Promise`\<`Record`\<`string`, `any`\>\> | - | -| `global.getMap` | (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `global.getMapValue` | (`mapName`: `string`, `key`: `any`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | -| `global.getValue` | (`name`: `string`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | -| `local` | (`address`: `string` \| `Address`) => \{ `getAll`: () => `Promise`\<`Record`\<`string`, `any`\>\> ; `getMap`: (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> ; `getMapValue`: (`mapName`: `string`, `key`: `any`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> ; `getValue`: (`name`: `string`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> } | - | - -#### Defined in - -[src/types/app-client.ts:712](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L712) - -## Methods - -### clone - -▸ **clone**(`params`): [`AppClient`](types_app_client.AppClient.md) - -Clone this app client with different params - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The params to use for the the cloned app client. Omit a param to keep the original value. Set a param to override the original value. Setting to undefined will clear the original value. | -| `params.appId?` | `bigint` | The ID of the app instance this client should make calls against. | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | - -#### Returns - -[`AppClient`](types_app_client.AppClient.md) - -A new app client with the altered params - -**`Example`** - -```typescript -const appClient2 = appClient.clone({ defaultSender: 'NEW_SENDER_ADDRESS' }) -``` - -#### Defined in - -[src/types/app-client.ts:566](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L566) - -___ - -### compile - -▸ **compile**(`compilation?`): `Promise`\<[`AppClientCompilationResult`](../interfaces/types_app_client.AppClientCompilationResult.md)\> - -Compiles the approval and clear state programs (if TEAL templates provided), -performing any provided deploy-time parameter replacement and stores -the source maps. - -If no TEAL templates provided it will use any byte code provided in the app spec. - -Will store any generated source maps for later use in debugging. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `compilation?` | [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) | Any compilation parameters to use | - -#### Returns - -`Promise`\<[`AppClientCompilationResult`](../interfaces/types_app_client.AppClientCompilationResult.md)\> - -The compiled code and any compilation results (including source maps) - -#### Defined in - -[src/types/app-client.ts:943](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L943) - -___ - -### exportSourceMaps - -▸ **exportSourceMaps**(): [`AppSourceMaps`](../interfaces/types_app_client.AppSourceMaps.md) - -Export the current source maps for the app. - -#### Returns - -[`AppSourceMaps`](../interfaces/types_app_client.AppSourceMaps.md) - -The source maps - -#### Defined in - -[src/types/app-client.ts:882](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L882) - -___ - -### exposeLogicError - -▸ **exposeLogicError**(`e`, `isClearStateProgram?`): `Promise`\<`Error`\> - -Takes an error that may include a logic error from a call to the current app and re-exposes the -error to include source code information via the source map and ARC-56 spec. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `e` | `Error` | The error to parse | -| `isClearStateProgram?` | `boolean` | Whether or not the code was running the clear state program (defaults to approval program) | - -#### Returns - -`Promise`\<`Error`\> - -The new error, or if there was no logic error or source map then the wrapped error with source details - -#### Defined in - -[src/types/app-client.ts:860](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L860) - -___ - -### fundAppAccount - -▸ **fundAppAccount**(`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -Funds Algo into the app account for this app. - -An alias for `appClient.send.fundAppAccount(params)`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters for the funding transaction | -| `params.amount` | [`AlgoAmount`](types_amount.AlgoAmount.md) | Amount to send | -| `params.closeRemainderTo?` | `string` \| `Address` | If given, close the sender account and send the remaining balance to this address *Warning:* Be careful with this parameter as it can lead to loss of funds if not used correctly. | -| `params.coverAppCallInnerTransactionFees?` | `boolean` | Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee | -| `params.extraFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. | -| `params.firstValidRound?` | `bigint` | Set the first round this transaction is valid. If left undefined, the value from algod will be used. We recommend you only set this when you intentionally want this to be some time in the future. | -| `params.lastValidRound?` | `bigint` | The last round this transaction is valid. It is recommended to use `validityWindow` instead. | -| `params.lease?` | `string` \| `Uint8Array` | Prevent multiple transactions with the same lease being included within the validity window. A [lease](https://dev.algorand.co/concepts/transactions/leases) enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). | -| `params.maxFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. | -| `params.maxRoundsToWaitForConfirmation?` | `number` | The number of rounds to wait for confirmation. By default until the latest lastValid has past. | -| `params.note?` | `string` \| `Uint8Array` | Note to attach to the transaction. Max of 1000 bytes. | -| `params.populateAppCallResources?` | `boolean` | Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. | -| `params.rekeyTo?` | `string` \| `Address` | Change the signing key of the sender to the given address. **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). | -| `params.sender?` | `string` \| `Address` | The optional sender to send the transaction from, will use the application client's default sender by default if specified | -| `params.signer?` | `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given `sender` or use a default signer (if configured). | -| `params.staticFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. | -| `params.suppressLog?` | `boolean` | Whether to suppress log messages from transaction send, default: do not suppress. | -| `params.validityWindow?` | `number` \| `bigint` | How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. | - -#### Returns - -`Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> - -The result of the funding - -**`Example`** - -```typescript -await appClient.fundAppAccount({ amount: algo(1) }) -``` - -#### Defined in - -[src/types/app-client.ts:741](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L741) - -___ - -### getABIArgsWithDefaultValues - -▸ **getABIArgsWithDefaultValues**(`methodNameOrSignature`, `args`, `sender`): `Promise`\<`undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[]\> - -Returns ABI method arguments ready for a method call params object with default values populated -and structs replaced with tuples. - -It does this by replacing any `undefined` values with the equivalent default value from the given ARC-56 app spec. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `methodNameOrSignature` | `string` | The method name or method signature to call if an ABI call is being emitted. e.g. `my_method` or `my_method(unit64,string)bytes` | -| `args` | `undefined` \| (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] | The arguments to the method with `undefined` for any that should be populated with a default value | -| `sender` | `string` \| `Address` | - | - -#### Returns - -`Promise`\<`undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[]\> - -#### Defined in - -[src/types/app-client.ts:1101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1101) - -___ - -### getABIMethod - -▸ **getABIMethod**(`methodNameOrSignature`): [`Arc56Method`](types_app_arc56.Arc56Method.md) - -Returns the ABI Method spec for the given method string for the app represented by this application client instance - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `methodNameOrSignature` | `string` | The method name or method signature to call if an ABI call is being emitted. e.g. `my_method` or `my_method(unit64,string)bytes` | - -#### Returns - -[`Arc56Method`](types_app_arc56.Arc56Method.md) - -A tuple with: [ARC-56 `Method`, algosdk `ABIMethod`] - -#### Defined in - -[src/types/app-client.ts:910](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L910) - -___ - -### getABIParams - -▸ **getABIParams**\<`TParams`, `TOnComplete`\>(`params`, `onComplete`): `Promise`\<`TParams` & \{ `appId`: `bigint` ; `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `TOnComplete` ; `sender`: `Address` = sender; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TParams` | extends `Object` | -| `TOnComplete` | extends `OnApplicationComplete` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `TParams` | -| `onComplete` | `TOnComplete` | - -#### Returns - -`Promise`\<`TParams` & \{ `appId`: `bigint` ; `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `TOnComplete` ; `sender`: `Address` = sender; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> - -#### Defined in - -[src/types/app-client.ts:1551](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1551) - -___ - -### getBareCreateTransactionMethods - -▸ **getBareCreateTransactionMethods**(): `Object` - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<`Transaction`\> | - | -| `clearState` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> | - | -| `closeOut` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> | - | -| `delete` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> | - | -| `optIn` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> | - | -| `update` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<`Transaction`\> | - | - -#### Defined in - -[src/types/app-client.ts:1213](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1213) - -___ - -### getBareParams - -▸ **getBareParams**\<`TParams`, `TOnComplete`\>(`params`, `onComplete`): `TParams` & \{ `appId`: `bigint` ; `onComplete`: `TOnComplete` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TParams` | extends `undefined` \| \{ `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | -| `TOnComplete` | extends `OnApplicationComplete` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `TParams` | -| `onComplete` | `TOnComplete` | - -#### Returns - -`TParams` & \{ `appId`: `bigint` ; `onComplete`: `TOnComplete` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } - -#### Defined in - -[src/types/app-client.ts:1538](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1538) - -___ - -### getBareParamsMethods - -▸ **getBareParamsMethods**(): `Object` - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => [`AppCallParams`](../modules/types_composer.md#appcallparams) | - | -| `clearState` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) | - | -| `closeOut` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) | - | -| `delete` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppDeleteParams`](../modules/types_composer.md#appdeleteparams) | - | -| `optIn` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => [`AppCallParams`](../modules/types_composer.md#appcallparams) | - | -| `update` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> | - | - -#### Defined in - -[src/types/app-client.ts:1178](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1178) - -___ - -### getBareSendMethods - -▸ **getBareSendMethods**(): `Object` - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> | - | -| `clearState` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> | - | -| `closeOut` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> | - | -| `delete` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> | - | -| `optIn` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> | - | -| `update` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> | - | - -#### Defined in - -[src/types/app-client.ts:1242](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1242) - -___ - -### getBoxMethods - -▸ **getBoxMethods**(): `Object` - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `getAll` | () => `Promise`\<`Record`\<`string`, `any`\>\> | - | -| `getMap` | (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `getMapValue` | (`mapName`: `string`, `key`: `any`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | -| `getValue` | (`name`: `string`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | - -#### Defined in - -[src/types/app-client.ts:1592](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1592) - -___ - -### getBoxNames - -▸ **getBoxNames**(): `Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\> - -Returns the names of all current boxes for the current app. - -#### Returns - -`Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\> - -The names of the boxes - -**`Example`** - -```typescript -const boxNames = await appClient.getBoxNames() -``` - -#### Defined in - -[src/types/app-client.ts:778](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L778) - -___ - -### getBoxValue - -▸ **getBoxValue**(`name`): `Promise`\<`Uint8Array`\> - -Returns the value of the given box for the current app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) | The identifier of the box to return | - -#### Returns - -`Promise`\<`Uint8Array`\> - -The current box value as a byte array - -**`Example`** - -```typescript -const boxValue = await appClient.getBoxValue('boxName') -``` - -#### Defined in - -[src/types/app-client.ts:791](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L791) - -___ - -### getBoxValueFromABIType - -▸ **getBoxValueFromABIType**(`name`, `type`): `Promise`\<`ABIValue`\> - -Returns the value of the given box for the current app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) | The identifier of the box to return | -| `type` | `ABIType` | | - -#### Returns - -`Promise`\<`ABIValue`\> - -The current box value as a byte array - -**`Example`** - -```typescript -const boxValue = await appClient.getBoxValueFromABIType('boxName', new ABIUintType(32)) -``` - -#### Defined in - -[src/types/app-client.ts:805](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L805) - -___ - -### getBoxValues - -▸ **getBoxValues**(`filter?`): `Promise`\<\{ `name`: [`BoxName`](../interfaces/types_app.BoxName.md) ; `value`: `Uint8Array` }[]\> - -Returns the values of all current boxes for the current app. -Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | (`name`: [`BoxName`](../interfaces/types_app.BoxName.md)) => `boolean` | Optional filter to filter which boxes' values are returned | - -#### Returns - -`Promise`\<\{ `name`: [`BoxName`](../interfaces/types_app.BoxName.md) ; `value`: `Uint8Array` }[]\> - -The (name, value) pair of the boxes with values as raw byte arrays - -**`Example`** - -```typescript -const boxValues = await appClient.getBoxValues() -``` - -#### Defined in - -[src/types/app-client.ts:823](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L823) - -___ - -### getBoxValuesFromABIType - -▸ **getBoxValuesFromABIType**(`type`, `filter?`): `Promise`\<\{ `name`: [`BoxName`](../interfaces/types_app.BoxName.md) ; `value`: `ABIValue` }[]\> - -Returns the values of all current boxes for the current app decoded using an ABI Type. -Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | `ABIType` | The ABI type to decode the values with | -| `filter?` | (`name`: [`BoxName`](../interfaces/types_app.BoxName.md)) => `boolean` | Optional filter to filter which boxes' values are returned | - -#### Returns - -`Promise`\<\{ `name`: [`BoxName`](../interfaces/types_app.BoxName.md) ; `value`: `ABIValue` }[]\> - -The (name, value) pair of the boxes with values as the ABI Value - -**`Example`** - -```typescript -const boxValues = await appClient.getBoxValuesFromABIType(new ABIUintType(32)) -``` - -#### Defined in - -[src/types/app-client.ts:843](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L843) - -___ - -### getGlobalState - -▸ **getGlobalState**(): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -Returns raw global state for the current app. - -#### Returns - -`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -The global state - -**`Example`** - -```typescript -const globalState = await appClient.getGlobalState() -``` - -#### Defined in - -[src/types/app-client.ts:753](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L753) - -___ - -### getLocalState - -▸ **getLocalState**(`address`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -Returns raw local state for the given account address. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `address` | `string` \| `Address` | The address of the account to get the local state for | - -#### Returns - -`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -The local state - -**`Example`** - -```typescript -const localState = await appClient.getLocalState('ACCOUNT_ADDRESS') -``` - -#### Defined in - -[src/types/app-client.ts:766](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L766) - -___ - -### getMethodCallCreateTransactionMethods - -▸ **getMethodCallCreateTransactionMethods**(): `Object` - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> | - | -| `closeOut` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> | - | -| `delete` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> | - | -| `fundAppAccount` | (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> | - | -| `optIn` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> | - | -| `update` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> | - | - -#### Defined in - -[src/types/app-client.ts:1467](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1467) - -___ - -### getMethodCallParamsMethods - -▸ **getMethodCallParamsMethods**(): `Object` - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete)) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> | - | -| `closeOut` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> | - | -| `delete` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppDeleteMethodCall`](../modules/types_composer.md#appdeletemethodcall)\> | - | -| `fundAppAccount` | (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `receiver`: `Address` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } | - | -| `optIn` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<[`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall)\> | - | -| `update` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md)) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `appId`: `bigint` ; `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... \| ... ; `appReferences?`: ... \| ... ; `approvalProgram`: ... \| ... ; `args?`: ... \| ... ; `assetReferences?`: ... \| ... ; `boxReferences?`: ... \| ... ; `clearStateProgram`: ... \| ... ; `extraFee?`: ... \| ... ; `extraProgramPages?`: ... \| ... ; `firstValidRound?`: ... \| ... ; `lastValidRound?`: ... \| ... ; `lease?`: ... \| ... \| ... ; `maxFee?`: ... \| ... ; `note?`: ... \| ... \| ... ; `onComplete?`: ... \| ... \| ... \| ... \| ... \| ... ; `rekeyTo?`: ... \| ... \| ... ; `schema?`: ... \| ... ; `sender`: ... \| ... ; `signer?`: ... \| ... \| ... ; `staticFee?`: ... \| ... ; `validityWindow?`: ... \| ... \| ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... \| ... ; `appId`: `bigint` ; `appReferences?`: ... \| ... ; `approvalProgram`: ... \| ... ; `args?`: ... \| ... ; `assetReferences?`: ... \| ... ; `boxReferences?`: ... \| ... ; `clearStateProgram`: ... \| ... ; `extraFee?`: ... \| ... ; `firstValidRound?`: ... \| ... ; `lastValidRound?`: ... \| ... ; `lease?`: ... \| ... \| ... ; `maxFee?`: ... \| ... ; `note?`: ... \| ... \| ... ; `onComplete?`: ... \| ... ; `rekeyTo?`: ... \| ... \| ... ; `sender`: ... \| ... ; `signer?`: ... \| ... \| ... ; `staticFee?`: ... \| ... ; `validityWindow?`: ... \| ... \| ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` = sender; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> | - | - -#### Defined in - -[src/types/app-client.ts:1275](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1275) - -___ - -### getMethodCallSendMethods - -▸ **getMethodCallSendMethods**(): `Object` - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`CallOnComplete`](../modules/types_app_client.md#calloncomplete) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `closeOut` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `delete` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `fundAppAccount` | (`params`: \{ `amount`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `coverAppCallInnerTransactionFees?`: `boolean` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `maxRoundsToWaitForConfirmation?`: `number` ; `note?`: `string` \| `Uint8Array` ; `populateAppCallResources?`: `boolean` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `suppressLog?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> | - | -| `optIn` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<`Omit`\<\{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `update` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] }\> | - | - -#### Defined in - -[src/types/app-client.ts:1337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1337) - -___ - -### getSender - -▸ **getSender**(`sender`): `Address` - -Returns the sender for a call, using the provided sender or using the `defaultSender` -if none provided and throws an error if neither provided - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sender` | `undefined` \| `string` \| `Address` | - -#### Returns - -`Address` - -#### Defined in - -[src/types/app-client.ts:1521](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1521) - -___ - -### getSigner - -▸ **getSigner**(`sender`, `signer`): `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -Returns the signer for a call, using the provided signer or the `defaultSigner` -if no signer was provided and the sender resolves to the default sender, the call will use default signer -or `undefined` otherwise (so the signer is resolved from `AlgorandClient`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sender` | `undefined` \| `string` \| `Address` | -| `signer` | `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | - -#### Returns - -`undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -#### Defined in - -[src/types/app-client.ts:1531](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1531) - -___ - -### getStateMethods - -▸ **getStateMethods**(`stateGetter`, `keyGetter`, `mapGetter`): `Object` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `stateGetter` | () => `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> | -| `keyGetter` | () => \{ `[name: string]`: [`StorageKey`](../interfaces/types_app_arc56.StorageKey.md); } | -| `mapGetter` | () => \{ `[name: string]`: [`StorageMap`](../interfaces/types_app_arc56.StorageMap.md); } | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `getAll` | () => `Promise`\<`Record`\<`string`, `any`\>\> | - | -| `getMap` | (`mapName`: `string`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct), `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\>\> | - | -| `getMapValue` | (`mapName`: `string`, `key`: `any`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | -| `getValue` | (`name`: `string`, `appState?`: [`AppState`](../interfaces/types_app.AppState.md)) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct)\> | - | - -#### Defined in - -[src/types/app-client.ts:1662](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1662) - -___ - -### handleCallErrors - -▸ **handleCallErrors**\<`TResult`\>(`call`): `Promise`\<`TResult`\> - -Make the given call and catch any errors, augmenting with debugging information before re-throwing. - -#### Type parameters - -| Name | -| :------ | -| `TResult` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `call` | () => `Promise`\<`TResult`\> | - -#### Returns - -`Promise`\<`TResult`\> - -#### Defined in - -[src/types/app-client.ts:1575](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1575) - -___ - -### importSourceMaps - -▸ **importSourceMaps**(`sourceMaps`): `void` - -Import source maps for the app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sourceMaps` | [`AppSourceMaps`](../interfaces/types_app_client.AppSourceMaps.md) | The source maps to import | - -#### Returns - -`void` - -#### Defined in - -[src/types/app-client.ts:899](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L899) - -___ - -### processMethodCallReturn - -▸ **processMethodCallReturn**\<`TReturn`, `TResult`\>(`result`, `method`): `Promise`\<`Omit`\<`TResult`, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`TReturn`\>\> - -Checks for decode errors on the SendAppTransactionResult and maps the return value to the specified type -on the ARC-56 method, replacing the `return` property with the decoded type. - -If the return type is an ARC-56 struct then the struct will be returned. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TReturn` | extends `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) | -| `TResult` | extends `Object` = \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `result` | `TResult` \| `Promise`\<`TResult`\> | The SendAppTransactionResult to be mapped | -| `method` | [`Arc56Method`](types_app_arc56.Arc56Method.md) | The method that was called | - -#### Returns - -`Promise`\<`Omit`\<`TResult`, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`TReturn`\>\> - -The smart contract response with an updated return value - -#### Defined in - -[src/types/app-client.ts:924](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L924) - -___ - -### compile - -▸ **compile**(`appSpec`, `appManager`, `compilation?`): `Promise`\<[`AppClientCompilationResult`](../interfaces/types_app_client.AppClientCompilationResult.md)\> - -Compiles the approval and clear state programs (if TEAL templates provided), -performing any provided deploy-time parameter replacement and returns -the compiled code and any compilation results (including source maps). - -If no TEAL templates provided it will use any byte code provided in the app spec. - -Will store any generated source maps for later use in debugging. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appSpec` | [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) | The app spec for the app | -| `appManager` | [`AppManager`](types_app_manager.AppManager.md) | The app manager to use for compilation | -| `compilation?` | [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) | Any compilation parameters to use | - -#### Returns - -`Promise`\<[`AppClientCompilationResult`](../interfaces/types_app_client.AppClientCompilationResult.md)\> - -The compiled code and any compilation results (including source maps) - -#### Defined in - -[src/types/app-client.ts:1048](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1048) - -___ - -### exposeLogicError - -▸ **exposeLogicError**(`e`, `appSpec`, `details`): `Error` - -Takes an error that may include a logic error from a call to the current app and re-exposes the -error to include source code information via the source map and ARC-56 spec. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `e` | `Error` | The error to parse | -| `appSpec` | [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) | The app spec for the app | -| `details` | `Object` | Additional information to inform the error | -| `details.approvalSourceInfo?` | [`ProgramSourceInfo`](../interfaces/types_app_arc56.ProgramSourceInfo.md) | ARC56 approval source info | -| `details.approvalSourceMap?` | `ProgramSourceMap` | Approval program source map | -| `details.clearSourceInfo?` | [`ProgramSourceInfo`](../interfaces/types_app_arc56.ProgramSourceInfo.md) | ARC56 clear source info | -| `details.clearSourceMap?` | `ProgramSourceMap` | Clear state program source map | -| `details.isClearStateProgram?` | `boolean` | Whether or not the code was running the clear state program (defaults to approval program) | -| `details.program?` | `Uint8Array` | program bytes | - -#### Returns - -`Error` - -The new error, or if there was no logic error or source map then the wrapped error with source details - -#### Defined in - -[src/types/app-client.ts:964](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L964) - -___ - -### fromCreatorAndName - -▸ **fromCreatorAndName**(`params`): `Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -Returns a new `AppClient` client, resolving the app by creator address and name -using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters to create the app client | -| `params.algorand` | [`AlgorandClient`](types_algorand_client.AlgorandClient.md) | An `AlgorandClient` instance | -| `params.appLookupCache?` | [`AppLookup`](../interfaces/types_app_deployer.AppLookup.md) | An optional cached app lookup that matches a name to on-chain details; either this is needed or indexer is required to be passed in to this `ClientManager` on construction. | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.appSpec` | `string` \| [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) \| [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) | The ARC-56 or ARC-32 application spec as either: * Parsed JSON ARC-56 `Contract` * Parsed JSON ARC-32 `AppSpec` * Raw JSON string (in either ARC-56 or ARC-32 format) | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.creatorAddress` | `string` \| `Address` | The address of the creator account for the app | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | -| `params.ignoreCache?` | `boolean` | Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value | - -#### Returns - -`Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -The `AppClient` instance - -**`Example`** - -```typescript -const appClient = await AppClient.fromCreatorAndName({ - creatorAddress: 'CREATOR_ADDRESS', - name: 'APP_NAME', - appSpec: appSpec, - algorand: AlgorandClient.mainNet(), -}) - -#### Defined in - -[src/types/app-client.ts:594](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L594) - -___ - -### fromNetwork - -▸ **fromNetwork**(`params`): `Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -Returns an `AppClient` instance for the current network based on -pre-determined network-specific app IDs specified in the ARC-56 app spec. - -If no IDs are in the app spec or the network isn't recognised, an error is thrown. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters to create the app client | -| `params.algorand` | [`AlgorandClient`](types_algorand_client.AlgorandClient.md) | An `AlgorandClient` instance | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.appSpec` | `string` \| [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) \| [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) | The ARC-56 or ARC-32 application spec as either: * Parsed JSON ARC-56 `Contract` * Parsed JSON ARC-32 `AppSpec` * Raw JSON string (in either ARC-56 or ARC-32 format) | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | - -#### Returns - -`Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -The `AppClient` instance - -**`Example`** - -```typescript -const appClient = await AppClient.fromNetwork({ - appSpec: appSpec, - algorand: AlgorandClient.mainNet(), -}) - -#### Defined in - -[src/types/app-client.ts:623](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L623) - -___ - -### normaliseAppSpec - -▸ **normaliseAppSpec**(`spec`): [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -Takes a string or parsed JSON object that could be ARC-32 or ARC-56 format and -normalises it into a parsed ARC-56 contract object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `spec` | `string` \| [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) \| [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) | The spec to normalise | - -#### Returns - -[`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -The normalised ARC-56 contract object - -**`Example`** - -```typescript -const arc56AppSpec = AppClient.normaliseAppSpec(appSpec) -``` - -#### Defined in - -[src/types/app-client.ts:651](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L651) diff --git a/docs/code/classes/types_app_client.ApplicationClient.md b/docs/code/classes/types_app_client.ApplicationClient.md deleted file mode 100644 index c084c99d..00000000 --- a/docs/code/classes/types_app_client.ApplicationClient.md +++ /dev/null @@ -1,887 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / ApplicationClient - -# Class: ApplicationClient - -[types/app-client](../modules/types_app_client.md).ApplicationClient - -**`Deprecated`** - -Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or -`algorand.client.getAppClientByCreatorAndName`. -If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, -which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. - -Application client - a class that wraps an ARC-0032 app spec and provides high productivity methods to deploy and call the app - -## Table of contents - -### Constructors - -- [constructor](types_app_client.ApplicationClient.md#constructor) - -### Properties - -- [\_appAddress](types_app_client.ApplicationClient.md#_appaddress) -- [\_appId](types_app_client.ApplicationClient.md#_appid) -- [\_appName](types_app_client.ApplicationClient.md#_appname) -- [\_approvalSourceMap](types_app_client.ApplicationClient.md#_approvalsourcemap) -- [\_clearSourceMap](types_app_client.ApplicationClient.md#_clearsourcemap) -- [\_creator](types_app_client.ApplicationClient.md#_creator) -- [algod](types_app_client.ApplicationClient.md#algod) -- [appSpec](types_app_client.ApplicationClient.md#appspec) -- [deployTimeParams](types_app_client.ApplicationClient.md#deploytimeparams) -- [existingDeployments](types_app_client.ApplicationClient.md#existingdeployments) -- [indexer](types_app_client.ApplicationClient.md#indexer) -- [params](types_app_client.ApplicationClient.md#params) -- [sender](types_app_client.ApplicationClient.md#sender) - -### Methods - -- [call](types_app_client.ApplicationClient.md#call) -- [callOfType](types_app_client.ApplicationClient.md#calloftype) -- [clearState](types_app_client.ApplicationClient.md#clearstate) -- [closeOut](types_app_client.ApplicationClient.md#closeout) -- [compile](types_app_client.ApplicationClient.md#compile) -- [create](types_app_client.ApplicationClient.md#create) -- [delete](types_app_client.ApplicationClient.md#delete) -- [deploy](types_app_client.ApplicationClient.md#deploy) -- [exportSourceMaps](types_app_client.ApplicationClient.md#exportsourcemaps) -- [exposeLogicError](types_app_client.ApplicationClient.md#exposelogicerror) -- [fundAppAccount](types_app_client.ApplicationClient.md#fundappaccount) -- [getABIMethod](types_app_client.ApplicationClient.md#getabimethod) -- [getABIMethodParams](types_app_client.ApplicationClient.md#getabimethodparams) -- [getABIMethodSignature](types_app_client.ApplicationClient.md#getabimethodsignature) -- [getAppReference](types_app_client.ApplicationClient.md#getappreference) -- [getBoxNames](types_app_client.ApplicationClient.md#getboxnames) -- [getBoxValue](types_app_client.ApplicationClient.md#getboxvalue) -- [getBoxValueFromABIType](types_app_client.ApplicationClient.md#getboxvaluefromabitype) -- [getBoxValues](types_app_client.ApplicationClient.md#getboxvalues) -- [getBoxValuesFromABIType](types_app_client.ApplicationClient.md#getboxvaluesfromabitype) -- [getCallArgs](types_app_client.ApplicationClient.md#getcallargs) -- [getGlobalState](types_app_client.ApplicationClient.md#getglobalstate) -- [getLocalState](types_app_client.ApplicationClient.md#getlocalstate) -- [importSourceMaps](types_app_client.ApplicationClient.md#importsourcemaps) -- [optIn](types_app_client.ApplicationClient.md#optin) -- [update](types_app_client.ApplicationClient.md#update) - -## Constructors - -### constructor - -• **new ApplicationClient**(`appDetails`, `algod`): [`ApplicationClient`](types_app_client.ApplicationClient.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appDetails` | [`AppSpecAppDetails`](../modules/types_app_client.md#appspecappdetails) | The details of the app | -| `algod` | `AlgodClient` | An algod instance | - -#### Returns - -[`ApplicationClient`](types_app_client.ApplicationClient.md) - -**`Deprecated`** - -Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or -`algorand.client.getAppClientByCreatorAndName`. -If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, -which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. - -Create a new ApplicationClient instance - -#### Defined in - -[src/types/app-client.ts:1789](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1789) - -## Properties - -### \_appAddress - -• `Private` **\_appAddress**: `string` - -#### Defined in - -[src/types/app-client.ts:1772](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1772) - -___ - -### \_appId - -• `Private` **\_appId**: `number` \| `bigint` - -#### Defined in - -[src/types/app-client.ts:1771](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1771) - -___ - -### \_appName - -• `Private` **\_appName**: `string` - -#### Defined in - -[src/types/app-client.ts:1774](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1774) - -___ - -### \_approvalSourceMap - -• `Private` **\_approvalSourceMap**: `undefined` \| `ProgramSourceMap` - -#### Defined in - -[src/types/app-client.ts:1776](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1776) - -___ - -### \_clearSourceMap - -• `Private` **\_clearSourceMap**: `undefined` \| `ProgramSourceMap` - -#### Defined in - -[src/types/app-client.ts:1777](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1777) - -___ - -### \_creator - -• `Private` **\_creator**: `undefined` \| `string` - -#### Defined in - -[src/types/app-client.ts:1773](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1773) - -___ - -### algod - -• `Private` **algod**: `AlgodClient` - -#### Defined in - -[src/types/app-client.ts:1763](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1763) - -___ - -### appSpec - -• `Private` **appSpec**: [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) - -#### Defined in - -[src/types/app-client.ts:1765](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1765) - -___ - -### deployTimeParams - -• `Private` `Optional` **deployTimeParams**: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) - -#### Defined in - -[src/types/app-client.ts:1769](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1769) - -___ - -### existingDeployments - -• `Private` **existingDeployments**: `undefined` \| [`AppLookup`](../interfaces/types_app.AppLookup.md) - -#### Defined in - -[src/types/app-client.ts:1768](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1768) - -___ - -### indexer - -• `Private` `Optional` **indexer**: `IndexerClient` - -#### Defined in - -[src/types/app-client.ts:1764](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1764) - -___ - -### params - -• `Private` **params**: `undefined` \| `SuggestedParams` - -#### Defined in - -[src/types/app-client.ts:1767](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1767) - -___ - -### sender - -• `Private` **sender**: `undefined` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -#### Defined in - -[src/types/app-client.ts:1766](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1766) - -## Methods - -### call - -▸ **call**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call?` | [`AppClientCallParams`](../modules/types_app_client.md#appclientcallparams) | The call details. | - -#### Returns - -`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -The result of the call - -**`Deprecated`** - -Use `appClient.send.call` or `appClient.createTransaction.call` from an `AppClient` instance instead. - -Issues a no_op (normal) call to the app. - -#### Defined in - -[src/types/app-client.ts:2112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2112) - -___ - -### callOfType - -▸ **callOfType**(`call?`, `callType`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | [`AppClientCallParams`](../modules/types_app_client.md#appclientcallparams) | The call details. | -| `callType` | ``"no_op"`` \| ``"opt_in"`` \| ``"close_out"`` \| ``"clear_state"`` \| ``"delete_application"`` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `ClearStateOC` \| `DeleteApplicationOC` | The call type | - -#### Returns - -`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -The result of the call - -**`Deprecated`** - -Use `appClient.send.call` or `appClient.createTransaction.call` from an `AppClient` instance instead. - -Issues a call to the app with the given call type. - -#### Defined in - -[src/types/app-client.ts:2194](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2194) - -___ - -### clearState - -▸ **clearState**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call?` | [`AppClientClearStateParams`](../modules/types_app_client.md#appclientclearstateparams) | The call details. | - -#### Returns - -`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -The result of the call - -**`Deprecated`** - -Use `appClient.send.clearState` or `appClient.createTransaction.clearState` from an `AppClient` instance instead. - -Issues a clear_state call to the app. - -#### Defined in - -[src/types/app-client.ts:2171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2171) - -___ - -### closeOut - -▸ **closeOut**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call?` | [`AppClientCallParams`](../modules/types_app_client.md#appclientcallparams) | The call details. | - -#### Returns - -`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -The result of the call - -**`Deprecated`** - -Use `appClient.send.closeOut` or `appClient.createTransaction.closeOut` from an `AppClient` instance instead. - -Issues a close_out call to the app. - -#### Defined in - -[src/types/app-client.ts:2160](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2160) - -___ - -### compile - -▸ **compile**(`compilation?`): `Promise`\<\{ `approvalCompiled`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `clearCompiled`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `compilation?` | [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) | The deploy-time parameters for the compilation | - -#### Returns - -`Promise`\<\{ `approvalCompiled`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `clearCompiled`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) }\> - -The compiled approval and clear state programs - -**`Deprecated`** - -Use `AppClient.compile()` instead. - -Compiles the approval and clear state programs and sets up the source map. - -#### Defined in - -[src/types/app-client.ts:1828](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1828) - -___ - -### create - -▸ **create**(`create?`): `Promise`\<\{ `appAddress`: `string` ; `appId`: `number` \| `bigint` ; `compiledApproval`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation?`: `PendingTransactionResponse` ; `confirmations?`: `PendingTransactionResponse`[] ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `create?` | [`AppClientCreateParams`](../modules/types_app_client.md#appclientcreateparams) | The parameters to create the app with | - -#### Returns - -`Promise`\<\{ `appAddress`: `string` ; `appId`: `number` \| `bigint` ; `compiledApproval`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation?`: `PendingTransactionResponse` ; `confirmations?`: `PendingTransactionResponse`[] ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] }\> - -The details of the created app, or the transaction to create it if `skipSending` and the compilation result - -**`Deprecated`** - -Use `create` from an `AppFactory` instance instead. - -Creates a smart contract app, returns the details of the created app. - -#### Defined in - -[src/types/app-client.ts:2007](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2007) - -___ - -### delete - -▸ **delete**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call?` | [`AppClientCallParams`](../modules/types_app_client.md#appclientcallparams) | The call details. | - -#### Returns - -`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -The result of the call - -**`Deprecated`** - -Use `appClient.send.delete` or `appClient.createTransaction.delete` from an `AppClient` instance instead. - -Issues a delete_application call to the app. - -#### Defined in - -[src/types/app-client.ts:2182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2182) - -___ - -### deploy - -▸ **deploy**(`deploy?`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"nothing"`` } \| \{ `appAddress`: `string` ; `appId`: `number` \| `bigint` ; `compiledApproval`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `number` ; `deletable?`: `boolean` ; `deleted`: `boolean` ; `name`: `string` ; `operationPerformed`: ``"update"`` \| ``"create"`` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `updatable?`: `boolean` ; `updatedRound`: `number` ; `version`: `string` } \| \{ `appAddress`: `string` ; `appId`: `number` \| `bigint` ; `compiledApproval`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `number` ; `deletable?`: `boolean` ; `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `deleteReturn?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `deleted`: `boolean` ; `name`: `string` ; `operationPerformed`: ``"replace"`` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `updatable?`: `boolean` ; `updatedRound`: `number` ; `version`: `string` }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `deploy?` | [`AppClientDeployParams`](../interfaces/types_app_client.AppClientDeployParams.md) | Deployment details | - -#### Returns - -`Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"nothing"`` } \| \{ `appAddress`: `string` ; `appId`: `number` \| `bigint` ; `compiledApproval`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `number` ; `deletable?`: `boolean` ; `deleted`: `boolean` ; `name`: `string` ; `operationPerformed`: ``"update"`` \| ``"create"`` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `updatable?`: `boolean` ; `updatedRound`: `number` ; `version`: `string` } \| \{ `appAddress`: `string` ; `appId`: `number` \| `bigint` ; `compiledApproval`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `number` ; `deletable?`: `boolean` ; `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `deleteReturn?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `deleted`: `boolean` ; `name`: `string` ; `operationPerformed`: ``"replace"`` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `updatable?`: `boolean` ; `updatedRound`: `number` ; `version`: `string` }\> - -The metadata and transaction result(s) of the deployment, or just the metadata if it didn't need to issue transactions - -**`Deprecated`** - -Use `deploy` from an `AppFactory` instance instead. - -Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions. - -To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md - -**Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created. - -**Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created. - -#### Defined in - -[src/types/app-client.ts:1896](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1896) - -___ - -### exportSourceMaps - -▸ **exportSourceMaps**(): [`AppSourceMaps`](../interfaces/types_app_client.AppSourceMaps.md) - -Export the current source maps for the app. - -#### Returns - -[`AppSourceMaps`](../interfaces/types_app_client.AppSourceMaps.md) - -The source maps - -#### Defined in - -[src/types/app-client.ts:1861](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1861) - -___ - -### exposeLogicError - -▸ **exposeLogicError**(`e`, `isClear?`): `Error` - -Takes an error that may include a logic error from a smart contract call and re-exposes the error to include source code information via the source map. -This is automatically used within `ApplicationClient` but if you pass `skipSending: true` e.g. if doing a group transaction - then you can use this in a try/catch block to get better debugging information. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `e` | `Error` | The error to parse | -| `isClear?` | `boolean` | Whether or not the code was running the clear state program | - -#### Returns - -`Error` - -The new error, or if there was no logic error or source map then the wrapped error with source details - -#### Defined in - -[src/types/app-client.ts:2516](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2516) - -___ - -### fundAppAccount - -▸ **fundAppAccount**(`fund`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md) \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & \{ `transactions`: `Transaction`[] }\> - -Funds Algo into the app account for this app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fund` | [`AlgoAmount`](types_amount.AlgoAmount.md) \| [`FundAppAccountParams`](../interfaces/types_app_client.FundAppAccountParams.md) | The parameters for the funding or the funding amount | - -#### Returns - -`Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md) \| \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } & \{ `transactions`: `Transaction`[] }\> - -The result of the funding - -#### Defined in - -[src/types/app-client.ts:2233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2233) - -___ - -### getABIMethod - -▸ **getABIMethod**(`method`): `undefined` \| `ABIMethod` - -Returns the ABI Method for the given method name string for the app represented by this application client instance - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `method` | `string` | Either the name of the method or the ABI method spec definition string | - -#### Returns - -`undefined` \| `ABIMethod` - -The ABI method for the given method - -#### Defined in - -[src/types/app-client.ts:2474](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2474) - -___ - -### getABIMethodParams - -▸ **getABIMethodParams**(`method`): `undefined` \| `ABIMethodParams` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `method` | `string` | Either the name of the method or the ABI method spec definition string | - -#### Returns - -`undefined` \| `ABIMethodParams` - -The ABI method params for the given method - -**`Deprecated`** - -Use `appClient.getABIMethod` instead. - -Returns the ABI Method parameters for the given method name string for the app represented by this application client instance - -#### Defined in - -[src/types/app-client.ts:2452](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2452) - -___ - -### getABIMethodSignature - -▸ **getABIMethodSignature**(`method`): `string` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `method` | `ABIMethodParams` \| `ABIMethod` | - -#### Returns - -`string` - -#### Defined in - -[src/types/app-client.ts:2532](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2532) - -___ - -### getAppReference - -▸ **getAppReference**(): `Promise`\<[`AppReference`](../interfaces/types_app.AppReference.md) \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md)\> - -#### Returns - -`Promise`\<[`AppReference`](../interfaces/types_app.AppReference.md) \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md)\> - -The app reference, or if deployed using the `deploy` method, the app metadata too - -**`Deprecated`** - -Use `appClient.appId` and `appClient.appAddress` from an `AppClient` instance instead. - -Gets the reference information for the current application instance. -`appId` will be 0 if it can't find an app. - -#### Defined in - -[src/types/app-client.ts:2486](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2486) - -___ - -### getBoxNames - -▸ **getBoxNames**(): `Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\> - -Returns the names of all current boxes for the current app. - -#### Returns - -`Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\> - -The names of the boxes - -#### Defined in - -[src/types/app-client.ts:2289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2289) - -___ - -### getBoxValue - -▸ **getBoxValue**(`name`): `Promise`\<`Uint8Array`\> - -Returns the value of the given box for the current app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` \| `Uint8Array` \| [`BoxName`](../interfaces/types_app.BoxName.md) | The name of the box to return either as a string, binary array or `BoxName` | - -#### Returns - -`Promise`\<`Uint8Array`\> - -The current box value as a byte array - -#### Defined in - -[src/types/app-client.ts:2304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2304) - -___ - -### getBoxValueFromABIType - -▸ **getBoxValueFromABIType**(`name`, `type`): `Promise`\<`ABIValue`\> - -Returns the value of the given box for the current app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` \| `Uint8Array` \| [`BoxName`](../interfaces/types_app.BoxName.md) | The name of the box to return either as a string, binary array or `BoxName` | -| `type` | `ABIType` | | - -#### Returns - -`Promise`\<`ABIValue`\> - -The current box value as a byte array - -#### Defined in - -[src/types/app-client.ts:2320](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2320) - -___ - -### getBoxValues - -▸ **getBoxValues**(`filter?`): `Promise`\<\{ `name`: [`BoxName`](../interfaces/types_app.BoxName.md) ; `value`: `Uint8Array` }[]\> - -Returns the values of all current boxes for the current app. -Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `filter?` | (`name`: [`BoxName`](../interfaces/types_app.BoxName.md)) => `boolean` | Optional filter to filter which boxes' values are returned | - -#### Returns - -`Promise`\<\{ `name`: [`BoxName`](../interfaces/types_app.BoxName.md) ; `value`: `Uint8Array` }[]\> - -The (name, value) pair of the boxes with values as raw byte arrays - -#### Defined in - -[src/types/app-client.ts:2336](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2336) - -___ - -### getBoxValuesFromABIType - -▸ **getBoxValuesFromABIType**(`type`, `filter?`): `Promise`\<\{ `name`: [`BoxName`](../interfaces/types_app.BoxName.md) ; `value`: `ABIValue` }[]\> - -Returns the values of all current boxes for the current app decoded using an ABI Type. -Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `type` | `ABIType` | The ABI type to decode the values with | -| `filter?` | (`name`: [`BoxName`](../interfaces/types_app.BoxName.md)) => `boolean` | Optional filter to filter which boxes' values are returned | - -#### Returns - -`Promise`\<\{ `name`: [`BoxName`](../interfaces/types_app.BoxName.md) ; `value`: `ABIValue` }[]\> - -The (name, value) pair of the boxes with values as the ABI Value - -#### Defined in - -[src/types/app-client.ts:2358](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2358) - -___ - -### getCallArgs - -▸ **getCallArgs**(`args`, `sender`): `Promise`\<`undefined` \| [`AppCallArgs`](../modules/types_app.md#appcallargs)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `args` | `undefined` \| [`AppClientCallArgs`](../modules/types_app_client.md#appclientcallargs) | The call args specific to this application client | -| `sender` | [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) | The sender of this call. Will be used to fetch any default argument values if applicable | - -#### Returns - -`Promise`\<`undefined` \| [`AppCallArgs`](../modules/types_app.md#appcallargs)\> - -The call args ready to pass into an app call - -**`Deprecated`** - -Use `appClient.params.*` from an `AppClient` instance instead. - -Returns the arguments for an app call for the given ABI method or raw method specification. - -#### Defined in - -[src/types/app-client.ts:2382](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2382) - -___ - -### getGlobalState - -▸ **getGlobalState**(): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -Returns global state for the current app. - -#### Returns - -`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -The global state - -#### Defined in - -[src/types/app-client.ts:2261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2261) - -___ - -### getLocalState - -▸ **getLocalState**(`account`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -Returns local state for the given account / account address. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) | - -#### Returns - -`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -The global state - -#### Defined in - -[src/types/app-client.ts:2275](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2275) - -___ - -### importSourceMaps - -▸ **importSourceMaps**(`sourceMaps`): `void` - -Import source maps for the app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sourceMaps` | [`AppSourceMaps`](../interfaces/types_app_client.AppSourceMaps.md) | The source maps to import | - -#### Returns - -`void` - -#### Defined in - -[src/types/app-client.ts:1878](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1878) - -___ - -### optIn - -▸ **optIn**(`call?`): `Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call?` | [`AppClientCallParams`](../modules/types_app_client.md#appclientcallparams) | The call details. | - -#### Returns - -`Promise`\<[`AppCallTransactionResult`](../modules/types_app.md#appcalltransactionresult)\> - -The result of the call - -**`Deprecated`** - -Use `appClient.send.optIn` or `appClient.createTransaction.optIn` from an `AppClient` instance instead. - -Issues a opt_in call to the app. - -#### Defined in - -[src/types/app-client.ts:2149](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2149) - -___ - -### update - -▸ **update**(`update?`): `Promise`\<\{ `compiledApproval`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation?`: `PendingTransactionResponse` ; `confirmations?`: `PendingTransactionResponse`[] ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `update?` | [`AppClientUpdateParams`](../modules/types_app_client.md#appclientupdateparams) | The parameters to update the app with | - -#### Returns - -`Promise`\<\{ `compiledApproval`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation?`: `PendingTransactionResponse` ; `confirmations?`: `PendingTransactionResponse`[] ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] }\> - -The transaction send result and the compilation result - -**`Deprecated`** - -Use `appClient.send.update` or `appClient.createTransaction.update` from an `AppClient` instance instead. - -Updates the smart contract app. - -#### Defined in - -[src/types/app-client.ts:2071](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2071) diff --git a/docs/code/classes/types_app_deployer.AppDeployer.md b/docs/code/classes/types_app_deployer.AppDeployer.md deleted file mode 100644 index c5c7f7f3..00000000 --- a/docs/code/classes/types_app_deployer.AppDeployer.md +++ /dev/null @@ -1,225 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-deployer](../modules/types_app_deployer.md) / AppDeployer - -# Class: AppDeployer - -[types/app-deployer](../modules/types_app_deployer.md).AppDeployer - -Allows management of deployment and deployment metadata of applications. - -## Table of contents - -### Constructors - -- [constructor](types_app_deployer.AppDeployer.md#constructor) - -### Properties - -- [\_appLookups](types_app_deployer.AppDeployer.md#_applookups) -- [\_appManager](types_app_deployer.AppDeployer.md#_appmanager) -- [\_indexer](types_app_deployer.AppDeployer.md#_indexer) -- [\_transactionSender](types_app_deployer.AppDeployer.md#_transactionsender) - -### Methods - -- [deploy](types_app_deployer.AppDeployer.md#deploy) -- [getCreatorAppsByName](types_app_deployer.AppDeployer.md#getcreatorappsbyname) -- [updateAppLookup](types_app_deployer.AppDeployer.md#updateapplookup) - -## Constructors - -### constructor - -• **new AppDeployer**(`appManager`, `transactionSender`, `indexer?`): [`AppDeployer`](types_app_deployer.AppDeployer.md) - -Creates an `AppManager` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appManager` | [`AppManager`](types_app_manager.AppManager.md) | An `AppManager` instance | -| `transactionSender` | [`AlgorandClientTransactionSender`](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md) | An `AlgorandClientTransactionSender` instance | -| `indexer?` | `IndexerClient` | An optional indexer instance; supply if you want to indexer to look up app metadata | - -#### Returns - -[`AppDeployer`](types_app_deployer.AppDeployer.md) - -**`Example`** - -```ts -const deployer = new AppDeployer(appManager, transactionSender, indexer) -``` - -#### Defined in - -[src/types/app-deployer.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L128) - -## Properties - -### \_appLookups - -• `Private` **\_appLookups**: `Map`\<`string`, [`AppLookup`](../interfaces/types_app_deployer.AppLookup.md)\> - -#### Defined in - -[src/types/app-deployer.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L116) - -___ - -### \_appManager - -• `Private` **\_appManager**: [`AppManager`](types_app_manager.AppManager.md) - -#### Defined in - -[src/types/app-deployer.ts:113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L113) - -___ - -### \_indexer - -• `Private` `Optional` **\_indexer**: `IndexerClient` - -#### Defined in - -[src/types/app-deployer.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L115) - -___ - -### \_transactionSender - -• `Private` **\_transactionSender**: [`AlgorandClientTransactionSender`](types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md) - -#### Defined in - -[src/types/app-deployer.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L114) - -## Methods - -### deploy - -▸ **deploy**(`deployment`): `Promise`\<[`AppDeployResult`](../modules/types_app_deployer.md#appdeployresult)\> - -Idempotently deploy (create if not exists, update if changed) an app against the given name for the given creator account, including deploy-time TEAL template placeholder substitutions (if specified). - -To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md - -**Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`. - -**Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created. - -**Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `deployment` | `Object` | The arguments to control the app deployment | -| `deployment.coverAppCallInnerTransactionFees?` | `boolean` | Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee | -| `deployment.createParams` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) | Create transaction parameters to use if a create needs to be issued as part of deployment | -| `deployment.deleteParams` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `ABIMethod` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } | Delete transaction parameters to use if a delete needs to be issued as part of deployment | -| `deployment.deployTimeParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any deploy-time parameters to replace in the TEAL code before compiling it (used if teal code is passed in as a string) | -| `deployment.existingDeployments?` | [`AppLookup`](../interfaces/types_app_deployer.AppLookup.md) | Optional cached value of the existing apps for the given creator; use this to avoid an indexer lookup | -| `deployment.ignoreCache?` | `boolean` | Whether or not to ignore the app metadata cache and force a lookup, default: use the cache * | -| `deployment.maxRoundsToWaitForConfirmation?` | `number` | The number of rounds to wait for confirmation. By default until the latest lastValid has past. | -| `deployment.metadata` | [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) | The deployment metadata | -| `deployment.onSchemaBreak?` | [`OnSchemaBreak`](../enums/types_app.OnSchemaBreak.md) \| ``"replace"`` \| ``"fail"`` \| ``"append"`` | What action to perform if a schema break (storage schema or extra pages change) is detected: * `fail` - Fail the deployment (throw an error, **default**) * `replace` - Delete the old app and create a new one * `append` - Deploy a new app and leave the old one as is | -| `deployment.onUpdate?` | ``"replace"`` \| ``"fail"`` \| ``"append"`` \| [`OnUpdate`](../enums/types_app.OnUpdate.md) \| ``"update"`` | What action to perform if a TEAL code update is detected: * `fail` - Fail the deployment (throw an error, **default**) * `update` - Update the app with the new TEAL code * `replace` - Delete the old app and create a new one * `append` - Deploy a new app and leave the old one as is | -| `deployment.populateAppCallResources?` | `boolean` | Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. | -| `deployment.suppressLog?` | `boolean` | Whether to suppress log messages from transaction send, default: do not suppress. | -| `deployment.updateParams` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (... \| ...)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `ABIMethod` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } | Update transaction parameters to use if an update needs to be issued as part of deployment | - -#### Returns - -`Promise`\<[`AppDeployResult`](../modules/types_app_deployer.md#appdeployresult)\> - -The result of the deployment - -**`Example`** - -```ts -const deployResult = await deployer.deploy({ - createParams: { - sender: 'SENDER_ADDRESS', - approvalProgram: 'APPROVAL PROGRAM', - clearStateProgram: 'CLEAR PROGRAM', - schema: { - globalByteSlices: 0, - globalInts: 0, - localByteSlices: 0, - localInts: 0 - } - }, - updateParams: { - sender: 'SENDER_ADDRESS' - }, - deleteParams: { - sender: 'SENDER_ADDRESS' - }, - metadata: { name: 'my_app', version: '2.0', updatable: false, deletable: false }, - onSchemaBreak: 'append', - onUpdate: 'append' - }) -``` - -#### Defined in - -[src/types/app-deployer.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L172) - -___ - -### getCreatorAppsByName - -▸ **getCreatorAppsByName**(`creatorAddress`, `ignoreCache?`): `Promise`\<[`AppLookup`](../interfaces/types_app_deployer.AppLookup.md)\> - -Returns a lookup of name => app metadata (id, address, ...metadata) for all apps created by the given account that have -an [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) `AppDeployNote` as the transaction -note of the app creation transaction. - -This function caches the result for the given creator account so that subsequent calls will not require an indexer lookup. - -If the `AppManager` instance wasn't created with an indexer client, this function will throw an error. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `creatorAddress` | `string` \| `Address` | The address of the account that is the creator of the apps you want to search for | -| `ignoreCache?` | `boolean` | Whether or not to ignore the cache and force a lookup, default: use the cache | - -#### Returns - -`Promise`\<[`AppLookup`](../interfaces/types_app_deployer.AppLookup.md)\> - -A name-based lookup of the app metadata - -**`Example`** - -```ts -const result = await deployer.getCreatorAppsByName(creator) - -#### Defined in - -[src/types/app-deployer.ts:495](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L495) - -___ - -### updateAppLookup - -▸ **updateAppLookup**(`sender`, `appMetadata`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sender` | `string` \| `Address` | -| `appMetadata` | [`AppMetadata`](../interfaces/types_app_deployer.AppMetadata.md) | - -#### Returns - -`void` - -#### Defined in - -[src/types/app-deployer.ts:469](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L469) diff --git a/docs/code/classes/types_app_factory.AppFactory.md b/docs/code/classes/types_app_factory.AppFactory.md deleted file mode 100644 index 4f94eb2a..00000000 --- a/docs/code/classes/types_app_factory.AppFactory.md +++ /dev/null @@ -1,840 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-factory](../modules/types_app_factory.md) / AppFactory - -# Class: AppFactory - -[types/app-factory](../modules/types_app_factory.md).AppFactory - -ARC-56/ARC-32 app factory that, for a given app spec, allows you to create -and deploy one or more app instances and to create one or more app clients -to interact with those (or other) app instances. - -## Table of contents - -### Constructors - -- [constructor](types_app_factory.AppFactory.md#constructor) - -### Properties - -- [\_algorand](types_app_factory.AppFactory.md#_algorand) -- [\_appName](types_app_factory.AppFactory.md#_appname) -- [\_appSpec](types_app_factory.AppFactory.md#_appspec) -- [\_approvalSourceMap](types_app_factory.AppFactory.md#_approvalsourcemap) -- [\_clearSourceMap](types_app_factory.AppFactory.md#_clearsourcemap) -- [\_defaultSender](types_app_factory.AppFactory.md#_defaultsender) -- [\_defaultSigner](types_app_factory.AppFactory.md#_defaultsigner) -- [\_deletable](types_app_factory.AppFactory.md#_deletable) -- [\_deployTimeParams](types_app_factory.AppFactory.md#_deploytimeparams) -- [\_paramsMethods](types_app_factory.AppFactory.md#_paramsmethods) -- [\_updatable](types_app_factory.AppFactory.md#_updatable) -- [\_version](types_app_factory.AppFactory.md#_version) -- [createTransaction](types_app_factory.AppFactory.md#createtransaction) -- [send](types_app_factory.AppFactory.md#send) - -### Accessors - -- [algorand](types_app_factory.AppFactory.md#algorand) -- [appName](types_app_factory.AppFactory.md#appname) -- [appSpec](types_app_factory.AppFactory.md#appspec) -- [params](types_app_factory.AppFactory.md#params) - -### Methods - -- [compile](types_app_factory.AppFactory.md#compile) -- [deploy](types_app_factory.AppFactory.md#deploy) -- [exportSourceMaps](types_app_factory.AppFactory.md#exportsourcemaps) -- [exposeLogicError](types_app_factory.AppFactory.md#exposelogicerror) -- [getABIParams](types_app_factory.AppFactory.md#getabiparams) -- [getAppClientByCreatorAndName](types_app_factory.AppFactory.md#getappclientbycreatorandname) -- [getAppClientById](types_app_factory.AppFactory.md#getappclientbyid) -- [getBareParams](types_app_factory.AppFactory.md#getbareparams) -- [getCreateABIArgsWithDefaultValues](types_app_factory.AppFactory.md#getcreateabiargswithdefaultvalues) -- [getDeployTimeControl](types_app_factory.AppFactory.md#getdeploytimecontrol) -- [getParamsMethods](types_app_factory.AppFactory.md#getparamsmethods) -- [getSender](types_app_factory.AppFactory.md#getsender) -- [getSigner](types_app_factory.AppFactory.md#getsigner) -- [handleCallErrors](types_app_factory.AppFactory.md#handlecallerrors) -- [importSourceMaps](types_app_factory.AppFactory.md#importsourcemaps) -- [parseMethodCallReturn](types_app_factory.AppFactory.md#parsemethodcallreturn) - -## Constructors - -### constructor - -• **new AppFactory**(`params`): [`AppFactory`](types_app_factory.AppFactory.md) - -Create a new app factory. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppFactoryParams`](../interfaces/types_app_factory.AppFactoryParams.md) | The parameters to create the app factory | - -#### Returns - -[`AppFactory`](types_app_factory.AppFactory.md) - -The `AppFactory` instance - -**`Example`** - -```typescript -const appFactory = new AppFactory({ - appSpec: appSpec, - algorand: AlgorandClient.mainNet(), -}) - -#### Defined in - -[src/types/app-factory.ts:197](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L197) - -## Properties - -### \_algorand - -• `Private` **\_algorand**: [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -#### Defined in - -[src/types/app-factory.ts:173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L173) - -___ - -### \_appName - -• `Private` **\_appName**: `string` - -#### Defined in - -[src/types/app-factory.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L172) - -___ - -### \_appSpec - -• `Private` **\_appSpec**: [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -#### Defined in - -[src/types/app-factory.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L171) - -___ - -### \_approvalSourceMap - -• `Private` **\_approvalSourceMap**: `undefined` \| `ProgramSourceMap` - -#### Defined in - -[src/types/app-factory.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L181) - -___ - -### \_clearSourceMap - -• `Private` **\_clearSourceMap**: `undefined` \| `ProgramSourceMap` - -#### Defined in - -[src/types/app-factory.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L182) - -___ - -### \_defaultSender - -• `Private` `Optional` **\_defaultSender**: `Address` - -#### Defined in - -[src/types/app-factory.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L175) - -___ - -### \_defaultSigner - -• `Private` `Optional` **\_defaultSigner**: `TransactionSigner` - -#### Defined in - -[src/types/app-factory.ts:176](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L176) - -___ - -### \_deletable - -• `Private` `Optional` **\_deletable**: `boolean` - -#### Defined in - -[src/types/app-factory.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L179) - -___ - -### \_deployTimeParams - -• `Private` `Optional` **\_deployTimeParams**: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) - -#### Defined in - -[src/types/app-factory.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L177) - -___ - -### \_paramsMethods - -• `Private` **\_paramsMethods**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bare` | \{ `create`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams`: `undefined` \| [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> ; `deployDelete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } ; `deployUpdate`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } } | - | -| `bare.create` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams`: `undefined` \| [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> | - | -| `bare.deployDelete` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | -| `bare.deployUpdate` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | -| `create` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` = compiled.approvalProgram; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` = compiled.clearStateProgram; `deletable?`: `boolean` ; `deployTimeParams`: `undefined` \| [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... \| ... ; `appReferences?`: ... \| ... ; `approvalProgram`: ... \| ... ; `args?`: ... \| ... ; `assetReferences?`: ... \| ... ; `boxReferences?`: ... \| ... ; `clearStateProgram`: ... \| ... ; `extraFee?`: ... \| ... ; `extraProgramPages?`: ... \| ... ; `firstValidRound?`: ... \| ... ; `lastValidRound?`: ... \| ... ; `lease?`: ... \| ... \| ... ; `maxFee?`: ... \| ... ; `note?`: ... \| ... \| ... ; `onComplete?`: ... \| ... \| ... \| ... \| ... \| ... ; `rekeyTo?`: ... \| ... \| ... ; `schema?`: ... \| ... ; `sender`: ... \| ... ; `signer?`: ... \| ... \| ... ; `staticFee?`: ... \| ... ; `validityWindow?`: ... \| ... \| ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... \| ... ; `appId`: `bigint` ; `appReferences?`: ... \| ... ; `approvalProgram`: ... \| ... ; `args?`: ... \| ... ; `assetReferences?`: ... \| ... ; `boxReferences?`: ... \| ... ; `clearStateProgram`: ... \| ... ; `extraFee?`: ... \| ... ; `firstValidRound?`: ... \| ... ; `lastValidRound?`: ... \| ... ; `lease?`: ... \| ... \| ... ; `maxFee?`: ... \| ... ; `note?`: ... \| ... \| ... ; `onComplete?`: ... \| ... ; `rekeyTo?`: ... \| ... \| ... ; `sender`: ... \| ... ; `signer?`: ... \| ... \| ... ; `staticFee?`: ... \| ... ; `validityWindow?`: ... \| ... \| ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> | - | -| `deployDelete` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: ... ; `globalInts`: ... ; `localByteSlices`: ... ; `localInts`: ... } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appId`: `bigint` ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | -| `deployUpdate` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: ... ; `globalInts`: ... ; `localByteSlices`: ... ; `localInts`: ... } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appId`: `bigint` ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | - -#### Defined in - -[src/types/app-factory.ts:184](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L184) - -___ - -### \_updatable - -• `Private` `Optional` **\_updatable**: `boolean` - -#### Defined in - -[src/types/app-factory.ts:178](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L178) - -___ - -### \_version - -• `Private` **\_version**: `string` - -#### Defined in - -[src/types/app-factory.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L174) - -___ - -### createTransaction - -• `Readonly` **createTransaction**: `Object` - -Create transactions for the current app - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bare` | \{ `create`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> } | Create bare (raw) transactions for the current app | -| `bare.create` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<`Transaction`\> | - | -| `create` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\> ; `signers`: `Map`\<`number`, `TransactionSigner`\> ; `transactions`: `Transaction`[] }\> | - | - -#### Defined in - -[src/types/app-factory.ts:245](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L245) - -___ - -### send - -• `Readonly` **send**: `Object` - -Send transactions to the current app - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bare` | \{ `create`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `appClient`: [`AppClient`](types_app_client.AppClient.md) ; `result`: \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return`: `undefined` = undefined; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } }\> } | Send bare (raw) transactions for the current app | -| `bare.create` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `appClient`: [`AppClient`](types_app_client.AppClient.md) ; `result`: \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return`: `undefined` = undefined; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } }\> | - | -| `create` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & [`SendParams`](../interfaces/types_transaction.SendParams.md)) => `Promise`\<\{ `appClient`: [`AppClient`](types_app_client.AppClient.md) ; `result`: \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } }\> | - | - -#### Defined in - -[src/types/app-factory.ts:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L273) - -## Accessors - -### algorand - -• `get` **algorand**(): [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -Return the algorand client this factory is using. - -#### Returns - -[`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -#### Defined in - -[src/types/app-factory.ts:221](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L221) - -___ - -### appName - -• `get` **appName**(): `string` - -The name of the app (from the ARC-32 / ARC-56 app spec or override). - -#### Returns - -`string` - -#### Defined in - -[src/types/app-factory.ts:211](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L211) - -___ - -### appSpec - -• `get` **appSpec**(): [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -The ARC-56 app spec being used - -#### Returns - -[`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -#### Defined in - -[src/types/app-factory.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L216) - -___ - -### params - -• `get` **params**(): `Object` - -Get parameters to create transactions (create and deploy related calls) for the current app. - -A good mental model for this is that these parameters represent a deferred transaction creation. - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bare` | \{ `create`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams`: `undefined` \| [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> ; `deployDelete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } ; `deployUpdate`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } } | - | -| `bare.create` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams`: `undefined` \| [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> | - | -| `bare.deployDelete` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | -| `bare.deployUpdate` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | -| `create` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` = compiled.approvalProgram; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` = compiled.clearStateProgram; `deletable?`: `boolean` ; `deployTimeParams`: `undefined` \| [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... \| ... ; `appReferences?`: ... \| ... ; `approvalProgram`: ... \| ... ; `args?`: ... \| ... ; `assetReferences?`: ... \| ... ; `boxReferences?`: ... \| ... ; `clearStateProgram`: ... \| ... ; `extraFee?`: ... \| ... ; `extraProgramPages?`: ... \| ... ; `firstValidRound?`: ... \| ... ; `lastValidRound?`: ... \| ... ; `lease?`: ... \| ... \| ... ; `maxFee?`: ... \| ... ; `note?`: ... \| ... \| ... ; `onComplete?`: ... \| ... \| ... \| ... \| ... \| ... ; `rekeyTo?`: ... \| ... \| ... ; `schema?`: ... \| ... ; `sender`: ... \| ... ; `signer?`: ... \| ... \| ... ; `staticFee?`: ... \| ... ; `validityWindow?`: ... \| ... \| ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... \| ... ; `appId`: `bigint` ; `appReferences?`: ... \| ... ; `approvalProgram`: ... \| ... ; `args?`: ... \| ... ; `assetReferences?`: ... \| ... ; `boxReferences?`: ... \| ... ; `clearStateProgram`: ... \| ... ; `extraFee?`: ... \| ... ; `firstValidRound?`: ... \| ... ; `lastValidRound?`: ... \| ... ; `lease?`: ... \| ... \| ... ; `maxFee?`: ... \| ... ; `note?`: ... \| ... \| ... ; `onComplete?`: ... \| ... ; `rekeyTo?`: ... \| ... \| ... ; `sender`: ... \| ... ; `signer?`: ... \| ... \| ... ; `staticFee?`: ... \| ... ; `validityWindow?`: ... \| ... \| ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> | - | -| `deployDelete` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: ... ; `globalInts`: ... ; `localByteSlices`: ... ; `localInts`: ... } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appId`: `bigint` ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | -| `deployUpdate` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: ... ; `globalInts`: ... ; `localByteSlices`: ... ; `localInts`: ... } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appId`: `bigint` ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | - -**`Example`** - -```typescript -const createAppParams = appFactory.params.create({method: 'create_method', args: [123, 'hello']}) -// ... -await algorand.send.AppCreateMethodCall(createAppParams) -``` - -**`Example`** - -```typescript -const createAppParams = appFactory.params.create({method: 'create_method', args: [123, 'hello']}) -await appClient.send.call({method: 'my_method', args: [createAppParams]}) -``` - -#### Defined in - -[src/types/app-factory.ts:240](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L240) - -## Methods - -### compile - -▸ **compile**(`compilation?`): `Promise`\<[`AppClientCompilationResult`](../interfaces/types_app_client.AppClientCompilationResult.md)\> - -Compiles the approval and clear state programs (if TEAL templates provided), -performing any provided deploy-time parameter replacement and stores -the source maps. - -If no TEAL templates provided it will use any byte code provided in the app spec. - -Will store any generated source maps for later use in debugging. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `compilation?` | [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) | Optional compilation parameters to use for the compilation | - -#### Returns - -`Promise`\<[`AppClientCompilationResult`](../interfaces/types_app_client.AppClientCompilationResult.md)\> - -The compilation result - -**`Example`** - -```typescript -const result = await factory.compile() -``` - -#### Defined in - -[src/types/app-factory.ts:615](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L615) - -___ - -### deploy - -▸ **deploy**(`params`): `Promise`\<\{ `appClient`: [`AppClient`](types_app_client.AppClient.md) ; `result`: \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `bigint` ; `deletable?`: `boolean` ; `deleteReturn`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `deleted`: `boolean` ; `groupId`: `string` ; `name`: `string` ; `operationPerformed`: ``"create"`` ; `return`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] ; `updatable?`: `boolean` ; `updatedRound`: `bigint` ; `version`: `string` } \| \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `bigint` ; `deletable?`: `boolean` ; `deleteReturn`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `deleted`: `boolean` ; `groupId`: `string` ; `name`: `string` ; `operationPerformed`: ``"update"`` ; `return`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] ; `updatable?`: `boolean` ; `updatedRound`: `bigint` ; `version`: `string` } \| \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `bigint` ; `deletable?`: `boolean` ; `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `deleteReturn`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `deleted`: `boolean` ; `groupId`: `string` ; `name`: `string` ; `operationPerformed`: ``"replace"`` ; `return`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] ; `updatable?`: `boolean` ; `updatedRound`: `bigint` ; `version`: `string` } \| \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `bigint` ; `deletable?`: `boolean` ; `deleteReturn`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `deleted`: `boolean` ; `name`: `string` ; `operationPerformed`: ``"nothing"`` ; `return`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `updatable?`: `boolean` ; `updatedRound`: `bigint` ; `version`: `string` } }\> - -Idempotently deploy (create if not exists, update if changed) an app against the given name for the given creator account, including deploy-time TEAL template placeholder substitutions (if specified). - -**Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`. - -**Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created. - -**Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The arguments to control the app deployment | -| `params.appName?` | `string` | Override the app name for this deployment | -| `params.coverAppCallInnerTransactionFees?` | `boolean` | Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee | -| `params.createParams?` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } | Create transaction parameters to use if a create needs to be issued as part of deployment | -| `params.deletable?` | `boolean` | Whether or not the contract should have deploy-time permanence control set. `undefined` = use AppFactory constructor value if set or base it on the app spec. | -| `params.deleteParams?` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } | Delete transaction parameters to use if a create needs to be issued as part of deployment | -| `params.deployTimeParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any deploy-time parameters to replace in the TEAL code before compiling it (used if teal code is passed in as a string) | -| `params.existingDeployments?` | [`AppLookup`](../interfaces/types_app_deployer.AppLookup.md) | Optional cached value of the existing apps for the given creator; use this to avoid an indexer lookup | -| `params.ignoreCache?` | `boolean` | Whether or not to ignore the app metadata cache and force a lookup, default: use the cache * | -| `params.maxRoundsToWaitForConfirmation?` | `number` | The number of rounds to wait for confirmation. By default until the latest lastValid has past. | -| `params.onSchemaBreak?` | [`OnSchemaBreak`](../enums/types_app.OnSchemaBreak.md) \| ``"replace"`` \| ``"fail"`` \| ``"append"`` | What action to perform if a schema break (storage schema or extra pages change) is detected: * `fail` - Fail the deployment (throw an error, **default**) * `replace` - Delete the old app and create a new one * `append` - Deploy a new app and leave the old one as is | -| `params.onUpdate?` | ``"replace"`` \| ``"fail"`` \| ``"append"`` \| [`OnUpdate`](../enums/types_app.OnUpdate.md) \| ``"update"`` | What action to perform if a TEAL code update is detected: * `fail` - Fail the deployment (throw an error, **default**) * `update` - Update the app with the new TEAL code * `replace` - Delete the old app and create a new one * `append` - Deploy a new app and leave the old one as is | -| `params.populateAppCallResources?` | `boolean` | Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. | -| `params.suppressLog?` | `boolean` | Whether to suppress log messages from transaction send, default: do not suppress. | -| `params.updatable?` | `boolean` | Whether or not the contract should have deploy-time immutability control set. `undefined` = use AppFactory constructor value if set or base it on the app spec. | -| `params.updateParams?` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } | Update transaction parameters to use if a create needs to be issued as part of deployment | - -#### Returns - -`Promise`\<\{ `appClient`: [`AppClient`](types_app_client.AppClient.md) ; `result`: \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `bigint` ; `deletable?`: `boolean` ; `deleteReturn`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `deleted`: `boolean` ; `groupId`: `string` ; `name`: `string` ; `operationPerformed`: ``"create"`` ; `return`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] ; `updatable?`: `boolean` ; `updatedRound`: `bigint` ; `version`: `string` } \| \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `bigint` ; `deletable?`: `boolean` ; `deleteReturn`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `deleted`: `boolean` ; `groupId`: `string` ; `name`: `string` ; `operationPerformed`: ``"update"`` ; `return`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] ; `updatable?`: `boolean` ; `updatedRound`: `bigint` ; `version`: `string` } \| \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `bigint` ; `deletable?`: `boolean` ; `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `deleteReturn`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `deleted`: `boolean` ; `groupId`: `string` ; `name`: `string` ; `operationPerformed`: ``"replace"`` ; `return`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] ; `updatable?`: `boolean` ; `updatedRound`: `bigint` ; `version`: `string` } \| \{ `appAddress`: `Address` ; `appId`: `bigint` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `createdMetadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `createdRound`: `bigint` ; `deletable?`: `boolean` ; `deleteReturn`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `deleted`: `boolean` ; `name`: `string` ; `operationPerformed`: ``"nothing"`` ; `return`: `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) ; `updatable?`: `boolean` ; `updatedRound`: `bigint` ; `version`: `string` } }\> - -The app client and the result of the deployment - -**`Example`** - -```ts -const { appClient, result } = await factory.deploy({ - createParams: { - sender: 'SENDER_ADDRESS', - approvalProgram: 'APPROVAL PROGRAM', - clearStateProgram: 'CLEAR PROGRAM', - schema: { - globalByteSlices: 0, - globalInts: 0, - localByteSlices: 0, - localInts: 0 - } - }, - updateParams: { - sender: 'SENDER_ADDRESS' - }, - deleteParams: { - sender: 'SENDER_ADDRESS' - }, - metadata: { name: 'my_app', version: '2.0', updatable: false, deletable: false }, - onSchemaBreak: 'append', - onUpdate: 'append' - }) -``` - -#### Defined in - -[src/types/app-factory.ts:372](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L372) - -___ - -### exportSourceMaps - -▸ **exportSourceMaps**(): [`AppSourceMaps`](../interfaces/types_app_client.AppSourceMaps.md) - -Export the current source maps for the app. - -#### Returns - -[`AppSourceMaps`](../interfaces/types_app_client.AppSourceMaps.md) - -The source maps - -#### Defined in - -[src/types/app-factory.ts:496](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L496) - -___ - -### exposeLogicError - -▸ **exposeLogicError**(`e`, `isClearStateProgram?`): `Error` - -Takes an error that may include a logic error from a call to the current app and re-exposes the -error to include source code information via the source map and ARC-56 spec. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `e` | `Error` | The error to parse | -| `isClearStateProgram?` | `boolean` | Whether or not the code was running the clear state program (defaults to approval program) | - -#### Returns - -`Error` - -The new error, or if there was no logic error or source map then the wrapped error with source details - -#### Defined in - -[src/types/app-factory.ts:484](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L484) - -___ - -### getABIParams - -▸ **getABIParams**\<`TParams`, `TOnComplete`\>(`params`, `onComplete`): `TParams` & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `TOnComplete` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TParams` | extends `Object` | -| `TOnComplete` | extends `OnApplicationComplete` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `TParams` | -| `onComplete` | `TOnComplete` | - -#### Returns - -`TParams` & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `TOnComplete` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } - -#### Defined in - -[src/types/app-factory.ts:640](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L640) - -___ - -### getAppClientByCreatorAndName - -▸ **getAppClientByCreatorAndName**(`params`): `Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -Returns a new `AppClient` client, resolving the app by creator address and name -using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note). - -Automatically populates appName, defaultSender and source maps from the factory -if not specified in the params. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters to create the app client | -| `params.appLookupCache?` | [`AppLookup`](../interfaces/types_app_deployer.AppLookup.md) | An optional cached app lookup that matches a name to on-chain details; either this is needed or indexer is required to be passed in to this `ClientManager` on construction. | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.creatorAddress` | `string` \| `Address` | The address of the creator account for the app | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | -| `params.ignoreCache?` | `boolean` | Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value | - -#### Returns - -`Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -The `AppClient` instance - -**`Example`** - -```typescript -const appClient = factory.getAppClientByCreatorAndName({ creatorAddress: 'CREATOR_ADDRESS', appName: 'my_app' }) -``` - -#### Defined in - -[src/types/app-factory.ts:465](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L465) - -___ - -### getAppClientById - -▸ **getAppClientById**(`params`): [`AppClient`](types_app_client.AppClient.md) - -Returns a new `AppClient` client for an app instance of the given ID. - -Automatically populates appName, defaultSender and source maps from the factory -if not specified in the params. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters to create the app client | -| `params.appId` | `bigint` | The ID of the app instance this client should make calls against. | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | - -#### Returns - -[`AppClient`](types_app_client.AppClient.md) - -The `AppClient` instance - -**`Example`** - -```typescript -const appClient = factory.getAppClientById({ appId: 12345n }) -``` - -#### Defined in - -[src/types/app-factory.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L439) - -___ - -### getBareParams - -▸ **getBareParams**\<`TParams`, `TOnComplete`\>(`params`, `onComplete`): `TParams` & \{ `onComplete`: `TOnComplete` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TParams` | extends `undefined` \| \{ `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | -| `TOnComplete` | extends `OnApplicationComplete` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `TParams` | -| `onComplete` | `TOnComplete` | - -#### Returns - -`TParams` & \{ `onComplete`: `TOnComplete` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } - -#### Defined in - -[src/types/app-factory.ts:628](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L628) - -___ - -### getCreateABIArgsWithDefaultValues - -▸ **getCreateABIArgsWithDefaultValues**(`methodNameOrSignature`, `args`): `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `methodNameOrSignature` | `string` | -| `args` | `undefined` \| (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] | - -#### Returns - -`undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: BoxIdentifier \| BoxReference[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] - -#### Defined in - -[src/types/app-factory.ts:659](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L659) - -___ - -### getDeployTimeControl - -▸ **getDeployTimeControl**(`control`): `undefined` \| `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `control` | ``"deletable"`` \| ``"updatable"`` | - -#### Returns - -`undefined` \| `boolean` - -#### Defined in - -[src/types/app-factory.ts:518](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L518) - -___ - -### getParamsMethods - -▸ **getParamsMethods**(): `Object` - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `bare` | \{ `create`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams`: `undefined` \| [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> ; `deployDelete`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } ; `deployUpdate`: (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } } | - | -| `bare.create` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` ; `compiledApproval?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `compiledClear?`: [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) ; `deletable?`: `boolean` ; `deployTimeParams`: `undefined` \| [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> | - | -| `bare.deployDelete` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | -| `bare.deployUpdate` | (`params?`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | -| `create` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `deletable?`: `boolean` ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` }) => `Promise`\<\{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `Uint8Array` = compiled.approvalProgram; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `Uint8Array` = compiled.clearStateProgram; `deletable?`: `boolean` ; `deployTimeParams`: `undefined` \| [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `updatable?`: `boolean` ; `validityWindow?`: `number` \| `bigint` } & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... \| ... ; `appReferences?`: ... \| ... ; `approvalProgram`: ... \| ... ; `args?`: ... \| ... ; `assetReferences?`: ... \| ... ; `boxReferences?`: ... \| ... ; `clearStateProgram`: ... \| ... ; `extraFee?`: ... \| ... ; `extraProgramPages?`: ... \| ... ; `firstValidRound?`: ... \| ... ; `lastValidRound?`: ... \| ... ; `lease?`: ... \| ... \| ... ; `maxFee?`: ... \| ... ; `note?`: ... \| ... \| ... ; `onComplete?`: ... \| ... \| ... \| ... \| ... \| ... ; `rekeyTo?`: ... \| ... \| ... ; `schema?`: ... \| ... ; `sender`: ... \| ... ; `signer?`: ... \| ... \| ... ; `staticFee?`: ... \| ... ; `validityWindow?`: ... \| ... \| ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ... \| ... ; `appId`: `bigint` ; `appReferences?`: ... \| ... ; `approvalProgram`: ... \| ... ; `args?`: ... \| ... ; `assetReferences?`: ... \| ... ; `boxReferences?`: ... \| ... ; `clearStateProgram`: ... \| ... ; `extraFee?`: ... \| ... ; `firstValidRound?`: ... \| ... ; `lastValidRound?`: ... \| ... ; `lease?`: ... \| ... \| ... ; `maxFee?`: ... \| ... ; `note?`: ... \| ... \| ... ; `onComplete?`: ... \| ... ; `rekeyTo?`: ... \| ... \| ... ; `sender`: ... \| ... ; `signer?`: ... \| ... \| ... ; `staticFee?`: ... \| ... ; `validityWindow?`: ... \| ... \| ... }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) }\> | - | -| `deployDelete` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: ... ; `globalInts`: ... ; `localByteSlices`: ... ; `localInts`: ... } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appId`: `bigint` ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `DeleteApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | -| `deployUpdate` | (`params`: \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }) => \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../modules/types_composer.md#appmethodcalltransactionargument) \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct))[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `method`: `string` ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `OnApplicationComplete` ; `rekeyTo?`: `string` \| `Address` ; `sender?`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } & \{ `args`: `undefined` \| (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: ... ; `globalInts`: ... ; `localByteSlices`: ... ; `localInts`: ... } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<\{ `accountReferences?`: ...[] ; `appId`: `bigint` ; `appReferences?`: ...[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: ...[] ; `assetReferences?`: ...[] ; `boxReferences?`: ...[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` }\> \| [`AppMethodCall`](../modules/types_composer.md#appmethodcall)\<[`AppMethodCallParams`](../modules/types_composer.md#appmethodcallparams)\>)[] ; `method`: [`Arc56Method`](types_app_arc56.Arc56Method.md) ; `onComplete`: `UpdateApplicationOC` ; `sender`: `Address` ; `signer`: `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) } | - | - -#### Defined in - -[src/types/app-factory.ts:532](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L532) - -___ - -### getSender - -▸ **getSender**(`sender`): `Address` - -Returns the sender for a call, using the `defaultSender` -if none provided and throws an error if neither provided - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sender` | `undefined` \| `string` \| `Address` | - -#### Returns - -`Address` - -#### Defined in - -[src/types/app-factory.ts:687](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L687) - -___ - -### getSigner - -▸ **getSigner**(`sender`, `signer`): `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -Returns the signer for a call, using the provided signer or the `defaultSigner` -if no signer was provided and the sender resolves to the default sender, the call will use default signer -or `undefined` otherwise (so the signer is resolved from `AlgorandClient`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sender` | `undefined` \| `string` \| `Address` | -| `signer` | `undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | - -#### Returns - -`undefined` \| `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -#### Defined in - -[src/types/app-factory.ts:697](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L697) - -___ - -### handleCallErrors - -▸ **handleCallErrors**\<`TResult`\>(`call`): `Promise`\<`TResult`\> - -Make the given call and catch any errors, augmenting with debugging information before re-throwing. - -#### Type parameters - -| Name | -| :------ | -| `TResult` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `call` | () => `Promise`\<`TResult`\> | - -#### Returns - -`Promise`\<`TResult`\> - -#### Defined in - -[src/types/app-factory.ts:592](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L592) - -___ - -### importSourceMaps - -▸ **importSourceMaps**(`sourceMaps`): `void` - -Import source maps for the app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sourceMaps` | [`AppSourceMaps`](../interfaces/types_app_client.AppSourceMaps.md) | The source maps to import | - -#### Returns - -`void` - -#### Defined in - -[src/types/app-factory.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L513) - -___ - -### parseMethodCallReturn - -▸ **parseMethodCallReturn**\<`TReturn`, `TResult`\>(`result`, `method`): `Promise`\<`Omit`\<`TResult`, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`TReturn`\>\> - -Checks for decode errors on the SendAppTransactionResult and maps the return value to the specified type -on the ARC-56 method. - -If the return type is a struct then the struct will be returned. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TReturn` | extends `undefined` \| `ABIValue` \| [`ABIStruct`](../modules/types_app_arc56.md#abistruct) | -| `TResult` | extends `Object` = \{ `confirmation`: `PendingTransactionResponse` ; `confirmations`: `PendingTransactionResponse`[] ; `groupId`: `string` ; `return?`: [`ABIReturn`](../modules/types_app.md#abireturn) ; `returns?`: [`ABIReturn`](../modules/types_app.md#abireturn)[] ; `transaction`: `Transaction` ; `transactions`: `Transaction`[] ; `txIds`: `string`[] } | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `result` | `TResult` \| `Promise`\<`TResult`\> | The SendAppTransactionResult to be mapped | -| `method` | [`Arc56Method`](types_app_arc56.Arc56Method.md) | The method that was called | - -#### Returns - -`Promise`\<`Omit`\<`TResult`, ``"return"``\> & [`AppReturn`](../modules/types_app.md#appreturn)\<`TReturn`\>\> - -The smart contract response with an updated return value - -#### Defined in - -[src/types/app-factory.ts:714](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L714) diff --git a/docs/code/classes/types_app_manager.AppManager.md b/docs/code/classes/types_app_manager.AppManager.md deleted file mode 100644 index 8d3649ed..00000000 --- a/docs/code/classes/types_app_manager.AppManager.md +++ /dev/null @@ -1,623 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-manager](../modules/types_app_manager.md) / AppManager - -# Class: AppManager - -[types/app-manager](../modules/types_app_manager.md).AppManager - -Allows management of application information. - -## Table of contents - -### Constructors - -- [constructor](types_app_manager.AppManager.md#constructor) - -### Properties - -- [\_algod](types_app_manager.AppManager.md#_algod) -- [\_compilationResults](types_app_manager.AppManager.md#_compilationresults) - -### Methods - -- [compileTeal](types_app_manager.AppManager.md#compileteal) -- [compileTealTemplate](types_app_manager.AppManager.md#compiletealtemplate) -- [getBoxNames](types_app_manager.AppManager.md#getboxnames) -- [getBoxValue](types_app_manager.AppManager.md#getboxvalue) -- [getBoxValueFromABIType](types_app_manager.AppManager.md#getboxvaluefromabitype) -- [getBoxValues](types_app_manager.AppManager.md#getboxvalues) -- [getBoxValuesFromABIType](types_app_manager.AppManager.md#getboxvaluesfromabitype) -- [getById](types_app_manager.AppManager.md#getbyid) -- [getCompilationResult](types_app_manager.AppManager.md#getcompilationresult) -- [getGlobalState](types_app_manager.AppManager.md#getglobalstate) -- [getLocalState](types_app_manager.AppManager.md#getlocalstate) -- [decodeAppState](types_app_manager.AppManager.md#decodeappstate) -- [getABIReturn](types_app_manager.AppManager.md#getabireturn) -- [getBoxReference](types_app_manager.AppManager.md#getboxreference) -- [replaceTealTemplateDeployTimeControlParams](types_app_manager.AppManager.md#replacetealtemplatedeploytimecontrolparams) -- [replaceTealTemplateParams](types_app_manager.AppManager.md#replacetealtemplateparams) -- [stripTealComments](types_app_manager.AppManager.md#striptealcomments) - -## Constructors - -### constructor - -• **new AppManager**(`algod`): [`AppManager`](types_app_manager.AppManager.md) - -Creates an `AppManager` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `algod` | `AlgodClient` | An algod instance | - -#### Returns - -[`AppManager`](types_app_manager.AppManager.md) - -#### Defined in - -[src/types/app-manager.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L106) - -## Properties - -### \_algod - -• `Private` **\_algod**: `AlgodClient` - -#### Defined in - -[src/types/app-manager.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L99) - -___ - -### \_compilationResults - -• `Private` **\_compilationResults**: `Record`\<`string`, [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> = `{}` - -#### Defined in - -[src/types/app-manager.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L100) - -## Methods - -### compileTeal - -▸ **compileTeal**(`tealCode`): `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> - -Compiles the given TEAL using algod and returns the result, including source map. - -The result of this compilation is also cached keyed by the TEAL - code so it can be retrieved via `getCompilationResult`. - -This function is re-entrant; it will only compile the same code once. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealCode` | `string` | The TEAL code | - -#### Returns - -`Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> - -The information about the compiled file - -**`Example`** - -```typescript -const compiled = await appManager.compileTeal(tealProgram) -``` - -#### Defined in - -[src/types/app-manager.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L125) - -___ - -### compileTealTemplate - -▸ **compileTealTemplate**(`tealTemplateCode`, `templateParams?`, `deploymentMetadata?`): `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> - -Performs template substitution of a teal template and compiles it, returning the compiled result. - -Looks for `TMPL_{parameter}` for template replacements and replaces AlgoKit deploy-time control parameters -if deployment metadata is specified. - -* `TMPL_UPDATABLE` for updatability / immutability control -* `TMPL_DELETABLE` for deletability / permanence control - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealTemplateCode` | `string` | The TEAL logic to compile | -| `templateParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any parameters to replace in the .teal file before compiling | -| `deploymentMetadata?` | `Object` | The deployment metadata the app will be deployed with | -| `deploymentMetadata.deletable?` | `boolean` | - | -| `deploymentMetadata.updatable?` | `boolean` | - | - -#### Returns - -`Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> - -The information about the compiled code - -**`Example`** - -```typescript -const compiled = await appManager.compileTealTemplate(tealTemplate, { TMPL_APP_ID: 12345n }, { updatable: true, deletable: false }) -``` - -#### Defined in - -[src/types/app-manager.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L161) - -___ - -### getBoxNames - -▸ **getBoxNames**(`appId`): `Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\> - -Returns the names of the current boxes for the given app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `bigint` | The ID of the app return box names for | - -#### Returns - -`Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\> - -The current box names - -**`Example`** - -```typescript -const boxNames = await appManager.getBoxNames(12353n); -``` - -#### Defined in - -[src/types/app-manager.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L263) - -___ - -### getBoxValue - -▸ **getBoxValue**(`appId`, `boxName`): `Promise`\<`Uint8Array`\> - -Returns the value of the given box name for the given app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `bigint` | The ID of the app return box names for | -| `boxName` | [`BoxName`](../interfaces/types_app.BoxName.md) \| [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) | The name of the box to return either as a string, binary array or `BoxName` | - -#### Returns - -`Promise`\<`Uint8Array`\> - -The current box value as a byte array - -**`Example`** - -```typescript -const boxValue = await appManager.getBoxValue(12353n, 'boxName'); -``` - -#### Defined in - -[src/types/app-manager.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L284) - -___ - -### getBoxValueFromABIType - -▸ **getBoxValueFromABIType**(`request`): `Promise`\<`ABIValue`\> - -Returns the value of the given box name for the given app decoded based on the given ABI type. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `request` | [`BoxValueRequestParams`](../interfaces/types_app_manager.BoxValueRequestParams.md) | The parameters for the box value request | - -#### Returns - -`Promise`\<`ABIValue`\> - -The current box value as an ABI value - -**`Example`** - -```typescript -const boxValue = await appManager.getBoxValueFromABIType({ appId: 12353n, boxName: 'boxName', type: new ABIUintType(32) }); -``` - -#### Defined in - -[src/types/app-manager.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L314) - -___ - -### getBoxValues - -▸ **getBoxValues**(`appId`, `boxNames`): `Promise`\<`Uint8Array`[]\> - -Returns the value of the given box names for the given app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `bigint` | The ID of the app return box names for | -| `boxNames` | ([`BoxName`](../interfaces/types_app.BoxName.md) \| [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier))[] | The names of the boxes to return either as a string, binary array or `BoxName` | - -#### Returns - -`Promise`\<`Uint8Array`[]\> - -The current box values as a byte array in the same order as the passed in box names - -**`Example`** - -```typescript -const boxValues = await appManager.getBoxValues(12353n, ['boxName1', 'boxName2']); -``` - -#### Defined in - -[src/types/app-manager.ts:301](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L301) - -___ - -### getBoxValuesFromABIType - -▸ **getBoxValuesFromABIType**(`request`): `Promise`\<`ABIValue`[]\> - -Returns the value of the given box names for the given app decoded based on the given ABI type. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `request` | [`BoxValuesRequestParams`](../interfaces/types_app_manager.BoxValuesRequestParams.md) | The parameters for the box value request | - -#### Returns - -`Promise`\<`ABIValue`[]\> - -The current box values as an ABI value in the same order as the passed in box names - -**`Example`** - -```typescript -const boxValues = await appManager.getBoxValuesFromABIType({ appId: 12353n, boxNames: ['boxName1', 'boxName2'], type: new ABIUintType(32) }); -``` - -#### Defined in - -[src/types/app-manager.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L329) - -___ - -### getById - -▸ **getById**(`appId`): `Promise`\<[`AppInformation`](../interfaces/types_app_manager.AppInformation.md)\> - -Returns the current app information for the app with the given ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `bigint` | The ID of the app | - -#### Returns - -`Promise`\<[`AppInformation`](../interfaces/types_app_manager.AppInformation.md)\> - -The app information - -**`Example`** - -```typescript -const appInfo = await appManager.getById(12353n); -``` - -#### Defined in - -[src/types/app-manager.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L202) - -___ - -### getCompilationResult - -▸ **getCompilationResult**(`tealCode`): `undefined` \| [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) - -Returns a previous compilation result. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealCode` | `string` | The TEAL code | - -#### Returns - -`undefined` \| [`CompiledTeal`](../interfaces/types_app.CompiledTeal.md) - -The information about the previously compiled file - or `undefined` if that TEAL code wasn't previously compiled - -**`Example`** - -```typescript -const compiled = appManager.getCompilationResult(tealProgram) -``` - -#### Defined in - -[src/types/app-manager.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L187) - -___ - -### getGlobalState - -▸ **getGlobalState**(`appId`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -Returns the current global state values for the given app ID and account address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `bigint` | The ID of the app to return global state for | - -#### Returns - -`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -The current global state for the given app - -**`Example`** - -```typescript -const globalState = await appManager.getGlobalState(12353n); -``` - -#### Defined in - -[src/types/app-manager.ts:229](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L229) - -___ - -### getLocalState - -▸ **getLocalState**(`appId`, `address`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -Returns the current local state values for the given app ID and account address - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `bigint` | The ID of the app to return local state for | -| `address` | `string` \| `Address` | The string address of the account to get local state for the given app | - -#### Returns - -`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -The current local state for the given (app, account) combination - -**`Example`** - -```typescript -const localState = await appManager.getLocalState(12353n, 'ACCOUNTADDRESS'); -``` - -#### Defined in - -[src/types/app-manager.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L244) - -___ - -### decodeAppState - -▸ **decodeAppState**(`state`): [`AppState`](../interfaces/types_app.AppState.md) - -Converts an array of global/local state values from the algod api to a more friendly -generic object keyed by the UTF-8 value of the key. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | \{ `key`: `Uint8Array` ; `value`: `TealValue` \| `EvalDelta` }[] | A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas` | - -#### Returns - -[`AppState`](../interfaces/types_app.AppState.md) - -An object keyeed by the UTF-8 representation of the key with various parsings of the values - -**`Example`** - -```typescript -const stateValues = AppManager.decodeAppState(state); -``` - -#### Defined in - -[src/types/app-manager.ts:361](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L361) - -___ - -### getABIReturn - -▸ **getABIReturn**(`confirmation`, `method`): `undefined` \| [`ABIReturn`](../modules/types_app.md#abireturn) - -Returns any ABI return values for the given app call arguments and transaction confirmation. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `confirmation` | `undefined` \| `PendingTransactionResponse` | The transaction confirmation from algod | -| `method` | `undefined` \| `ABIMethod` | The ABI method | - -#### Returns - -`undefined` \| [`ABIReturn`](../modules/types_app.md#abireturn) - -The return value for the method call - -**`Example`** - -```typescript -const returnValue = AppManager.getABIReturn(confirmation, ABIMethod.fromSignature('hello(string)void')); -``` - -#### Defined in - -[src/types/app-manager.ts:414](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L414) - -___ - -### getBoxReference - -▸ **getBoxReference**(`boxId`): `BoxReference` - -Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `boxId` | [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md) | The box to return a reference for | - -#### Returns - -`BoxReference` - -The box reference ready to pass into a `algosdk.Transaction` - -**`Example`** - -```typescript -const boxRef = AppManager.getBoxReference('boxName'); -``` - -#### Defined in - -[src/types/app-manager.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L343) - -___ - -### replaceTealTemplateDeployTimeControlParams - -▸ **replaceTealTemplateDeployTimeControlParams**(`tealTemplateCode`, `params`): `string` - -Replaces AlgoKit deploy-time deployment control parameters within the given TEAL template code. - -* `TMPL_UPDATABLE` for updatability / immutability control -* `TMPL_DELETABLE` for deletability / permanence control - -Note: If these values are defined, but the corresponding `TMPL_*` value - isn't in the teal code it will throw an exception. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealTemplateCode` | `string` | The TEAL template code to substitute | -| `params` | `Object` | The deploy-time deployment control parameter value to replace | -| `params.deletable?` | `boolean` | - | -| `params.updatable?` | `boolean` | - | - -#### Returns - -`string` - -The replaced TEAL code - -**`Example`** - -```typescript -const tealCode = AppManager.replaceTealTemplateDeployTimeControlParams(tealTemplate, { updatable: true, deletable: false }); -``` - -#### Defined in - -[src/types/app-manager.ts:448](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L448) - -___ - -### replaceTealTemplateParams - -▸ **replaceTealTemplateParams**(`tealTemplateCode`, `templateParams?`): `string` - -Performs template substitution of a teal file. - -Looks for `TMPL_{parameter}` for template replacements. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealTemplateCode` | `string` | The TEAL template code to make parameter replacements in | -| `templateParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any parameters to replace in the teal code | - -#### Returns - -`string` - -The TEAL code with replacements - -**`Example`** - -```typescript -const tealCode = AppManager.replaceTealTemplateParams(tealTemplate, { TMPL_APP_ID: 12345n }); -``` - -#### Defined in - -[src/types/app-manager.ts:483](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L483) - -___ - -### stripTealComments - -▸ **stripTealComments**(`tealCode`): `string` - -Remove comments from TEAL code (useful to reduce code size before compilation). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealCode` | `string` | The TEAL logic to strip | - -#### Returns - -`string` - -The TEAL without comments - -**`Example`** - -```typescript -const stripped = AppManager.stripTealComments(tealProgram); -``` - -#### Defined in - -[src/types/app-manager.ts:522](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L522) diff --git a/docs/code/classes/types_asset_manager.AssetManager.md b/docs/code/classes/types_asset_manager.AssetManager.md deleted file mode 100644 index 1c037bc3..00000000 --- a/docs/code/classes/types_asset_manager.AssetManager.md +++ /dev/null @@ -1,221 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/asset-manager](../modules/types_asset_manager.md) / AssetManager - -# Class: AssetManager - -[types/asset-manager](../modules/types_asset_manager.md).AssetManager - -Allows management of asset information. - -## Table of contents - -### Constructors - -- [constructor](types_asset_manager.AssetManager.md#constructor) - -### Properties - -- [\_algod](types_asset_manager.AssetManager.md#_algod) -- [\_newGroup](types_asset_manager.AssetManager.md#_newgroup) - -### Methods - -- [bulkOptIn](types_asset_manager.AssetManager.md#bulkoptin) -- [bulkOptOut](types_asset_manager.AssetManager.md#bulkoptout) -- [getAccountInformation](types_asset_manager.AssetManager.md#getaccountinformation) -- [getById](types_asset_manager.AssetManager.md#getbyid) - -## Constructors - -### constructor - -• **new AssetManager**(`algod`, `newGroup`): [`AssetManager`](types_asset_manager.AssetManager.md) - -Create a new asset manager. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `algod` | `AlgodClient` | An algod client | -| `newGroup` | () => [`TransactionComposer`](types_composer.TransactionComposer.md) | A function that creates a new `TransactionComposer` transaction group | - -#### Returns - -[`AssetManager`](types_asset_manager.AssetManager.md) - -**`Example`** - -```typescript -const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams})) -``` - -#### Defined in - -[src/types/asset-manager.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L151) - -## Properties - -### \_algod - -• `Private` **\_algod**: `AlgodClient` - -#### Defined in - -[src/types/asset-manager.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L139) - -___ - -### \_newGroup - -• `Private` **\_newGroup**: () => [`TransactionComposer`](types_composer.TransactionComposer.md) - -#### Type declaration - -▸ (): [`TransactionComposer`](types_composer.TransactionComposer.md) - -##### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -#### Defined in - -[src/types/asset-manager.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L140) - -## Methods - -### bulkOptIn - -▸ **bulkOptIn**(`account`, `assetIds`, `options?`): `Promise`\<[`BulkAssetOptInOutResult`](../interfaces/types_asset_manager.BulkAssetOptInOutResult.md)[]\> - -Opt an account in to a list of Algorand Standard Assets. - -Transactions will be sent in batches of 16 as transaction groups. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | `string` \| `Address` | The account to opt-in | -| `assetIds` | `bigint`[] | The list of asset IDs to opt-in to | -| `options?` | `Omit`\<[`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams), ``"sender"``\> & [`SendParams`](../interfaces/types_transaction.SendParams.md) | Any parameters to control the transaction or execution of the transaction | - -#### Returns - -`Promise`\<[`BulkAssetOptInOutResult`](../interfaces/types_asset_manager.BulkAssetOptInOutResult.md)[]\> - -An array of records matching asset ID to transaction ID of the opt in - -**`Example`** - -```typescript -// Basic example -assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n]) -// With configuration -assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true }) -``` - -#### Defined in - -[src/types/asset-manager.ts:233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L233) - -___ - -### bulkOptOut - -▸ **bulkOptOut**(`account`, `assetIds`, `options?`): `Promise`\<[`BulkAssetOptInOutResult`](../interfaces/types_asset_manager.BulkAssetOptInOutResult.md)[]\> - -Opt an account out of a list of Algorand Standard Assets. - -Transactions will be sent in batches of 16 as transaction groups. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | `string` \| `Address` | The account to opt-in | -| `assetIds` | `bigint`[] | The list of asset IDs to opt-out of | -| `options?` | `Omit`\<[`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams), ``"sender"``\> & [`SendParams`](../interfaces/types_transaction.SendParams.md) & \{ `ensureZeroBalance?`: `boolean` } | Any parameters to control the transaction or execution of the transaction | - -#### Returns - -`Promise`\<[`BulkAssetOptInOutResult`](../interfaces/types_asset_manager.BulkAssetOptInOutResult.md)[]\> - -An array of records matching asset ID to transaction ID of the opt in - -**`Example`** - -```typescript -// Basic example -assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n]) -// With configuration -assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true }) -``` - -#### Defined in - -[src/types/asset-manager.ts:283](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L283) - -___ - -### getAccountInformation - -▸ **getAccountInformation**(`sender`, `assetId`): `Promise`\<[`AccountAssetInformation`](../modules/types_account.md#accountassetinformation)\> - -Returns the given sender account's asset holding for a given asset. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| `Address` | The address of the sender/account to look up | -| `assetId` | `bigint` | The ID of the asset to return a holding for | - -#### Returns - -`Promise`\<[`AccountAssetInformation`](../modules/types_account.md#accountassetinformation)\> - -The account asset holding information - -**`Example`** - -```typescript -const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; -const assetId = 123345n; -const accountInfo = await assetManager.getAccountInformation(address, assetId); -``` - -[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation) - -#### Defined in - -[src/types/asset-manager.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L205) - -___ - -### getById - -▸ **getById**(`assetId`): `Promise`\<[`AssetInformation`](../interfaces/types_asset_manager.AssetInformation.md)\> - -Returns the current asset information for the asset with the given ID. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId` | `bigint` | The ID of the asset | - -#### Returns - -`Promise`\<[`AssetInformation`](../interfaces/types_asset_manager.AssetInformation.md)\> - -The asset information - -**`Example`** - -```typescript -const assetInfo = await assetManager.getById(12353n); -``` - -#### Defined in - -[src/types/asset-manager.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L167) diff --git a/docs/code/classes/types_async_event_emitter.AsyncEventEmitter.md b/docs/code/classes/types_async_event_emitter.AsyncEventEmitter.md deleted file mode 100644 index 1c739789..00000000 --- a/docs/code/classes/types_async_event_emitter.AsyncEventEmitter.md +++ /dev/null @@ -1,244 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/async-event-emitter](../modules/types_async_event_emitter.md) / AsyncEventEmitter - -# Class: AsyncEventEmitter - -[types/async-event-emitter](../modules/types_async_event_emitter.md).AsyncEventEmitter - -## Table of contents - -### Constructors - -- [constructor](types_async_event_emitter.AsyncEventEmitter.md#constructor) - -### Properties - -- [listenerMap](types_async_event_emitter.AsyncEventEmitter.md#listenermap) -- [listenerWrapperMap](types_async_event_emitter.AsyncEventEmitter.md#listenerwrappermap) -- [off](types_async_event_emitter.AsyncEventEmitter.md#off) - -### Methods - -- [emitAsync](types_async_event_emitter.AsyncEventEmitter.md#emitasync) -- [on](types_async_event_emitter.AsyncEventEmitter.md#on) -- [once](types_async_event_emitter.AsyncEventEmitter.md#once) -- [removeListener](types_async_event_emitter.AsyncEventEmitter.md#removelistener) - -## Constructors - -### constructor - -• **new AsyncEventEmitter**(): [`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Returns - -[`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -## Properties - -### listenerMap - -• `Private` **listenerMap**: `Record`\<`string` \| `symbol`, [`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<`unknown`\>[]\> = `{}` - -#### Defined in - -[src/types/async-event-emitter.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L7) - -___ - -### listenerWrapperMap - -• `Private` **listenerWrapperMap**: `WeakMap`\<[`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<`unknown`\>, [`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<`unknown`\>\> - -#### Defined in - -[src/types/async-event-emitter.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L6) - -___ - -### off - -• **off**: (`eventName`: `string` \| `symbol`, `listener`: [`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<`unknown`\>) => [`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Type declaration - -▸ (`eventName`, `listener`): [`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | [`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<`unknown`\> | - -##### Returns - -[`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Defined in - -[src/types/async-event-emitter.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L55) - -## Methods - -### emitAsync - -▸ **emitAsync**\<`K`\>(`eventName`, `event`): `Promise`\<`void`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends [`EventType`](../enums/types_lifecycle_events.EventType.md) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `K` | -| `event` | [`EventDataMap`](../modules/types_lifecycle_events.md#eventdatamap)[`K`] | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/types/async-event-emitter.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L9) - -▸ **emitAsync**(`eventName`, `event`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `event` | `unknown` | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/types/async-event-emitter.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L10) - -___ - -### on - -▸ **on**\<`K`\>(`eventName`, `listener`): [`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends [`EventType`](../enums/types_lifecycle_events.EventType.md) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `K` | -| `listener` | [`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<[`EventDataMap`](../modules/types_lifecycle_events.md#eventdatamap)[`K`]\> | - -#### Returns - -[`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Defined in - -[src/types/async-event-emitter.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L17) - -▸ **on**\<`T`\>(`eventName`, `listener`): [`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | [`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<`T`\> | - -#### Returns - -[`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Defined in - -[src/types/async-event-emitter.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L18) - -___ - -### once - -▸ **once**\<`K`\>(`eventName`, `listener`): [`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `K` | extends [`EventType`](../enums/types_lifecycle_events.EventType.md) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `K` | -| `listener` | [`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<[`EventDataMap`](../modules/types_lifecycle_events.md#eventdatamap)[`K`]\> | - -#### Returns - -[`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Defined in - -[src/types/async-event-emitter.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L25) - -▸ **once**\<`T`\>(`eventName`, `listener`): [`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | [`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<`T`\> | - -#### Returns - -[`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Defined in - -[src/types/async-event-emitter.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L26) - -___ - -### removeListener - -▸ **removeListener**(`eventName`, `listener`): [`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `listener` | [`AsyncEventListener`](../modules/types_async_event_emitter.md#asynceventlistener)\<`unknown`\> | - -#### Returns - -[`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Defined in - -[src/types/async-event-emitter.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L39) diff --git a/docs/code/classes/types_client_manager.ClientManager.md b/docs/code/classes/types_client_manager.ClientManager.md deleted file mode 100644 index c45d6aba..00000000 --- a/docs/code/classes/types_client_manager.ClientManager.md +++ /dev/null @@ -1,1166 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/client-manager](../modules/types_client_manager.md) / ClientManager - -# Class: ClientManager - -[types/client-manager](../modules/types_client_manager.md).ClientManager - -Exposes access to various API clients. - -## Table of contents - -### Constructors - -- [constructor](types_client_manager.ClientManager.md#constructor) - -### Properties - -- [\_algod](types_client_manager.ClientManager.md#_algod) -- [\_algorand](types_client_manager.ClientManager.md#_algorand) -- [\_getNetworkPromise](types_client_manager.ClientManager.md#_getnetworkpromise) -- [\_indexer](types_client_manager.ClientManager.md#_indexer) -- [\_kmd](types_client_manager.ClientManager.md#_kmd) - -### Accessors - -- [algod](types_client_manager.ClientManager.md#algod) -- [indexer](types_client_manager.ClientManager.md#indexer) -- [indexerIfPresent](types_client_manager.ClientManager.md#indexerifpresent) -- [kmd](types_client_manager.ClientManager.md#kmd) - -### Methods - -- [getAppClientByCreatorAndName](types_client_manager.ClientManager.md#getappclientbycreatorandname) -- [getAppClientById](types_client_manager.ClientManager.md#getappclientbyid) -- [getAppClientByNetwork](types_client_manager.ClientManager.md#getappclientbynetwork) -- [getAppFactory](types_client_manager.ClientManager.md#getappfactory) -- [getTestNetDispenser](types_client_manager.ClientManager.md#gettestnetdispenser) -- [getTestNetDispenserFromEnvironment](types_client_manager.ClientManager.md#gettestnetdispenserfromenvironment) -- [getTypedAppClientByCreatorAndName](types_client_manager.ClientManager.md#gettypedappclientbycreatorandname) -- [getTypedAppClientById](types_client_manager.ClientManager.md#gettypedappclientbyid) -- [getTypedAppClientByNetwork](types_client_manager.ClientManager.md#gettypedappclientbynetwork) -- [getTypedAppFactory](types_client_manager.ClientManager.md#gettypedappfactory) -- [isLocalNet](types_client_manager.ClientManager.md#islocalnet) -- [isMainNet](types_client_manager.ClientManager.md#ismainnet) -- [isTestNet](types_client_manager.ClientManager.md#istestnet) -- [network](types_client_manager.ClientManager.md#network) -- [genesisIdIsLocalNet](types_client_manager.ClientManager.md#genesisidislocalnet) -- [getAlgoNodeConfig](types_client_manager.ClientManager.md#getalgonodeconfig) -- [getAlgodClient](types_client_manager.ClientManager.md#getalgodclient) -- [getAlgodClientFromEnvironment](types_client_manager.ClientManager.md#getalgodclientfromenvironment) -- [getAlgodConfigFromEnvironment](types_client_manager.ClientManager.md#getalgodconfigfromenvironment) -- [getConfigFromEnvironmentOrLocalNet](types_client_manager.ClientManager.md#getconfigfromenvironmentorlocalnet) -- [getDefaultLocalNetConfig](types_client_manager.ClientManager.md#getdefaultlocalnetconfig) -- [getIndexerClient](types_client_manager.ClientManager.md#getindexerclient) -- [getIndexerClientFromEnvironment](types_client_manager.ClientManager.md#getindexerclientfromenvironment) -- [getIndexerConfigFromEnvironment](types_client_manager.ClientManager.md#getindexerconfigfromenvironment) -- [getKmdClient](types_client_manager.ClientManager.md#getkmdclient) -- [getKmdClientFromEnvironment](types_client_manager.ClientManager.md#getkmdclientfromenvironment) - -## Constructors - -### constructor - -• **new ClientManager**(`clientsOrConfig`, `algorandClient?`): [`ClientManager`](types_client_manager.ClientManager.md) - -algosdk clients or config for interacting with the official Algorand APIs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `clientsOrConfig` | [`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md) \| [`AlgoSdkClients`](../interfaces/types_client_manager.AlgoSdkClients.md) | The clients or config to use | -| `algorandClient?` | [`AlgorandClient`](types_algorand_client.AlgorandClient.md) | - | - -#### Returns - -[`ClientManager`](types_client_manager.ClientManager.md) - -**`Example`** - -```typescript -const clientManager = new ClientManager({ algod: algodClient }) -``` - -**`Example`** - -```typescript -const clientManager = new ClientManager({ algod: algodClient, indexer: indexerClient, kmd: kmdClient }) -``` - -**`Example`** - -```typescript -const clientManager = new ClientManager({ algodConfig }) -``` - -**`Example`** - -```typescript -const clientManager = new ClientManager({ algodConfig, indexerConfig, kmdConfig }) -``` - -#### Defined in - -[src/types/client-manager.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L74) - -## Properties - -### \_algod - -• `Private` **\_algod**: `AlgodClient` - -#### Defined in - -[src/types/client-manager.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L49) - -___ - -### \_algorand - -• `Private` `Optional` **\_algorand**: [`AlgorandClient`](types_algorand_client.AlgorandClient.md) - -#### Defined in - -[src/types/client-manager.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L52) - -___ - -### \_getNetworkPromise - -• `Private` **\_getNetworkPromise**: `undefined` \| `Promise`\<`SuggestedParams`\> - -#### Defined in - -[src/types/client-manager.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L125) - -___ - -### \_indexer - -• `Private` `Optional` **\_indexer**: `IndexerClient` - -#### Defined in - -[src/types/client-manager.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L50) - -___ - -### \_kmd - -• `Private` `Optional` **\_kmd**: `KmdClient` - -#### Defined in - -[src/types/client-manager.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L51) - -## Accessors - -### algod - -• `get` **algod**(): `AlgodClient` - -Returns an algosdk Algod API client. - -#### Returns - -`AlgodClient` - -The Algod client - -#### Defined in - -[src/types/client-manager.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L93) - -___ - -### indexer - -• `get` **indexer**(): `IndexerClient` - -Returns an algosdk Indexer API client or throws an error if it's not been provided. - -#### Returns - -`IndexerClient` - -The Indexer client - -**`Throws`** - -Error if no Indexer client is configured - -#### Defined in - -[src/types/client-manager.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L102) - -___ - -### indexerIfPresent - -• `get` **indexerIfPresent**(): `undefined` \| `IndexerClient` - -Returns an algosdk Indexer API client or `undefined` if it's not been provided. - -#### Returns - -`undefined` \| `IndexerClient` - -The Indexer client or `undefined` - -#### Defined in - -[src/types/client-manager.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L111) - -___ - -### kmd - -• `get` **kmd**(): `KmdClient` - -Returns an algosdk KMD API client or throws an error if it's not been provided. - -#### Returns - -`KmdClient` - -The KMD client - -**`Throws`** - -Error if no KMD client is configured - -#### Defined in - -[src/types/client-manager.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L120) - -## Methods - -### getAppClientByCreatorAndName - -▸ **getAppClientByCreatorAndName**(`params`): `Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app. -This method resolves the app ID by looking up the creator address and name -using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters to create the app client | -| `params.appLookupCache?` | [`AppLookup`](../interfaces/types_app_deployer.AppLookup.md) | An optional cached app lookup that matches a name to on-chain details; either this is needed or indexer is required to be passed in to this `ClientManager` on construction. | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.appSpec` | `string` \| [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) \| [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) | The ARC-56 or ARC-32 application spec as either: * Parsed JSON ARC-56 `Contract` * Parsed JSON ARC-32 `AppSpec` * Raw JSON string (in either ARC-56 or ARC-32 format) | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.creatorAddress` | `string` \| `Address` | The address of the creator account for the app | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | -| `params.ignoreCache?` | `boolean` | Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value | - -#### Returns - -`Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -The `AppClient` instance - -**`Example`** - -```typescript -const appClient = clientManager.getAppClientByCreatorAndName({ - appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}', - // appId resolved by looking for app ID of named app by this creator - creatorAddress: 'CREATORADDRESS', -}) -``` - -#### Defined in - -[src/types/client-manager.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L284) - -___ - -### getAppClientById - -▸ **getAppClientById**(`params`): [`AppClient`](types_app_client.AppClient.md) - -Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters to create the app client | -| `params.appId` | `bigint` | The ID of the app instance this client should make calls against. | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.appSpec` | `string` \| [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) \| [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) | The ARC-56 or ARC-32 application spec as either: * Parsed JSON ARC-56 `Contract` * Parsed JSON ARC-32 `AppSpec` * Raw JSON string (in either ARC-56 or ARC-32 format) | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | - -#### Returns - -[`AppClient`](types_app_client.AppClient.md) - -The `AppClient` instance - -**`Example`** - -```typescript -const appClient = clientManager.getAppClientById({ - appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}', - appId: 12345n, -}) -``` - -#### Defined in - -[src/types/client-manager.ts:307](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L307) - -___ - -### getAppClientByNetwork - -▸ **getAppClientByNetwork**(`params`): `Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -Returns a new `AppClient` client for managing calls and state for an ARC-56 app. -This method resolves the app ID for the current network based on -pre-determined network-specific app IDs specified in the ARC-56 app spec. - -If no IDs are in the app spec or the network isn't recognised, an error is thrown. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters to create the app client | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.appSpec` | `string` \| [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) \| [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) | The ARC-56 or ARC-32 application spec as either: * Parsed JSON ARC-56 `Contract` * Parsed JSON ARC-32 `AppSpec` * Raw JSON string (in either ARC-56 or ARC-32 format) | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | - -#### Returns - -`Promise`\<[`AppClient`](types_app_client.AppClient.md)\> - -The `AppClient` instance - -**`Example`** - -```typescript -const appClient = clientManager.getAppClientByNetwork({ - appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}', - // appId resolved by using ARC-56 spec to find app ID for current network -}) -``` - -#### Defined in - -[src/types/client-manager.ts:330](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L330) - -___ - -### getAppFactory - -▸ **getAppFactory**(`params`): [`AppFactory`](types_app_factory.AppFactory.md) - -Returns a new `AppFactory` client - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters to create the app factory | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name. | -| `params.appSpec` | `string` \| [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) \| [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) | The ARC-56 or ARC-32 application spec as either: * Parsed JSON ARC-56 `Contract` * Parsed JSON ARC-32 `AppSpec` * Raw JSON string (in either ARC-56 or ARC-32 format) | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | -| `params.deletable?` | `boolean` | Whether or not the contract should have deploy-time permanence control set, undefined = ignore. If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. Useful if you want to vend multiple contracts from the same factory without specifying this value for each call. | -| `params.deployTimeParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Optional deploy-time TEAL template replacement parameters. If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. Useful if you want to vend multiple contracts from the same factory without specifying this value for each call. | -| `params.updatable?` | `boolean` | Whether or not the contract should have deploy-time immutability control set, undefined = ignore. If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. Useful if you want to vend multiple contracts from the same factory without specifying this value for each call. | -| `params.version?` | `string` | The version of app that is / will be deployed; defaults to 1.0 | - -#### Returns - -[`AppFactory`](types_app_factory.AppFactory.md) - -The `AppFactory` instance - -**`Example`** - -```typescript -const factory = clientManager.getAppFactory({ - appSpec: '{/* ARC-56 or ARC-32 compatible JSON */}', -}) -``` - -**`Example`** - -```typescript -const factory = clientManager.getAppFactory({ - appSpec: parsedAppSpec_AppSpec_or_Arc56Contract, - defaultSender: "SENDERADDRESS", - appName: "OverriddenAppName", - version: "2.0.0", - updatable: true, - deletable: false, - deployTimeParams: { ONE: 1, TWO: 'value' } -}) -``` - -#### Defined in - -[src/types/client-manager.ts:261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L261) - -___ - -### getTestNetDispenser - -▸ **getTestNetDispenser**(`params`): [`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md) - -Returns a TestNet Dispenser API client. - -Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`TestNetDispenserApiClientParams`](../interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md) | An object containing parameters for the TestNetDispenserApiClient class. | - -#### Returns - -[`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md) - -An instance of the TestNetDispenserApiClient class. - -**`Example`** - -```ts -const client = clientManager.getTestNetDispenser( - { - authToken: 'your_auth_token', - requestTimeout: 15, - } -) -``` - -#### Defined in - -[src/types/client-manager.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L215) - -___ - -### getTestNetDispenserFromEnvironment - -▸ **getTestNetDispenserFromEnvironment**(`params?`): [`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md) - -Returns a TestNet Dispenser API client, loading the auth token from `process.env.ALGOKIT_DISPENSER_ACCESS_TOKEN`. - -Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params?` | `Omit`\<[`TestNetDispenserApiClientParams`](../interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md), ``"authToken"``\> | An object containing parameters for the TestNetDispenserApiClient class. | - -#### Returns - -[`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md) - -An instance of the TestNetDispenserApiClient class. - -**`Example`** - -```ts -const client = clientManager.getTestNetDispenserFromEnvironment( - { - requestTimeout: 15, - } -) -``` - -#### Defined in - -[src/types/client-manager.ts:234](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L234) - -___ - -### getTypedAppClientByCreatorAndName - -▸ **getTypedAppClientByCreatorAndName**\<`TClient`\>(`typedClient`, `params`): `Promise`\<`InstanceType`\<`TClient`\>\> - -Returns a new typed client, resolving the app by creator address and name. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TClient` | extends [`TypedAppClient`](../interfaces/types_client_manager.TypedAppClient.md)\<`InstanceType`\<`TClient`\>\> | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `typedClient` | `TClient` | The typed client type to use | -| `params` | `Object` | The params to resolve the app by creator address and name | -| `params.appLookupCache?` | [`AppLookup`](../interfaces/types_app_deployer.AppLookup.md) | An optional cached app lookup that matches a name to on-chain details; either this is needed or indexer is required to be passed in to this `ClientManager` on construction. | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.creatorAddress` | `string` \| `Address` | The address of the creator account for the app | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | -| `params.ignoreCache?` | `boolean` | Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value | - -#### Returns - -`Promise`\<`InstanceType`\<`TClient`\>\> - -The typed client instance - -**`Example`** - -```typescript -const appClient = clientManager.getTypedAppClientByCreatorAndName(MyContractClient, { - creatorAddress: "CREATORADDRESS", - defaultSender: alice, -}) -``` - -**`Example`** - -```typescript -const appClient = clientManager.getTypedAppClientByCreatorAndName(MyContractClient, { - creatorAddress: "CREATORADDRESS", - name: "contract-name", - defaultSender: alice, -}) -``` - -#### Defined in - -[src/types/client-manager.ts:358](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L358) - -___ - -### getTypedAppClientById - -▸ **getTypedAppClientById**\<`TClient`\>(`typedClient`, `params`): `InstanceType`\<`TClient`\> - -Returns a new typed client, resolving the app by app ID. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TClient` | extends [`TypedAppClient`](../interfaces/types_client_manager.TypedAppClient.md)\<`InstanceType`\<`TClient`\>\> | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `typedClient` | `TClient` | The typed client type to use | -| `params` | `Object` | The params to resolve the app by ID | -| `params.appId` | `bigint` | The ID of the app instance this client should make calls against. | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | - -#### Returns - -`InstanceType`\<`TClient`\> - -The typed client instance - -**`Example`** - -```typescript -const appClient = clientManager.getTypedAppClientById(MyContractClient, { - appId: 12345n, - defaultSender: alice, -}) -``` - -#### Defined in - -[src/types/client-manager.ts:382](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L382) - -___ - -### getTypedAppClientByNetwork - -▸ **getTypedAppClientByNetwork**\<`TClient`\>(`typedClient`, `params?`): `Promise`\<`InstanceType`\<`TClient`\>\> - -Returns a new typed client, resolves the app ID for the current network based on -pre-determined network-specific app IDs specified in the ARC-56 app spec. - -If no IDs are in the app spec or the network isn't recognised, an error is thrown. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TClient` | extends [`TypedAppClient`](../interfaces/types_client_manager.TypedAppClient.md)\<`InstanceType`\<`TClient`\>\> | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `typedClient` | `TClient` | The typed client type to use | -| `params?` | `Object` | The params to resolve the app by network | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name | -| `params.approvalSourceMap?` | `ProgramSourceMap` | Optional source map for the approval program | -| `params.clearSourceMap?` | `ProgramSourceMap` | Optional source map for the clear state program | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | - -#### Returns - -`Promise`\<`InstanceType`\<`TClient`\>\> - -The typed client instance - -**`Example`** - -```typescript -const appClient = clientManager.getTypedAppClientByNetwork(MyContractClient, { - defaultSender: alice, -}) -``` - -#### Defined in - -[src/types/client-manager.ts:408](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L408) - -___ - -### getTypedAppFactory - -▸ **getTypedAppFactory**\<`TClient`\>(`typedFactory`, `params?`): `TClient` - -Returns a new typed app factory. - -#### Type parameters - -| Name | -| :------ | -| `TClient` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `typedFactory` | [`TypedAppFactory`](../interfaces/types_client_manager.TypedAppFactory.md)\<`TClient`\> | The typed factory type to use | -| `params?` | `Object` | The params to resolve the factory by | -| `params.appName?` | `string` | Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name. | -| `params.defaultSender?` | `string` \| `Address` | Optional address to use for the account to use as the default sender for calls. | -| `params.defaultSigner?` | `TransactionSigner` | Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). | -| `params.deletable?` | `boolean` | Whether or not the contract should have deploy-time permanence control set, undefined = ignore. If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. Useful if you want to vend multiple contracts from the same factory without specifying this value for each call. | -| `params.deployTimeParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Optional deploy-time TEAL template replacement parameters. If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. Useful if you want to vend multiple contracts from the same factory without specifying this value for each call. | -| `params.updatable?` | `boolean` | Whether or not the contract should have deploy-time immutability control set, undefined = ignore. If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. Useful if you want to vend multiple contracts from the same factory without specifying this value for each call. | -| `params.version?` | `string` | The version of app that is / will be deployed; defaults to 1.0 | - -#### Returns - -`TClient` - -The typed client instance - -**`Example`** - -```typescript -const appFactory = clientManager.getTypedAppFactory(MyContractClient, { - sender: alice, -}) -``` - -#### Defined in - -[src/types/client-manager.ts:431](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L431) - -___ - -### isLocalNet - -▸ **isLocalNet**(): `Promise`\<`boolean`\> - -Returns true if the current network is LocalNet. - -#### Returns - -`Promise`\<`boolean`\> - -True if the current network is LocalNet. - -**`Example`** - -```typescript -const isLocalNet = await clientManager.isLocalNet() -``` - -#### Defined in - -[src/types/client-manager.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L171) - -___ - -### isMainNet - -▸ **isMainNet**(): `Promise`\<`boolean`\> - -Returns true if the current network is MainNet. - -#### Returns - -`Promise`\<`boolean`\> - -True if the current network is MainNet. - -**`Example`** - -```typescript -const isMainNet = await clientManager.isMainNet() -``` - -#### Defined in - -[src/types/client-manager.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L195) - -___ - -### isTestNet - -▸ **isTestNet**(): `Promise`\<`boolean`\> - -Returns true if the current network is TestNet. - -#### Returns - -`Promise`\<`boolean`\> - -True if the current network is TestNet. - -**`Example`** - -```typescript -const isTestNet = await clientManager.isTestNet() -``` - -#### Defined in - -[src/types/client-manager.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L183) - -___ - -### network - -▸ **network**(): `Promise`\<[`NetworkDetails`](../interfaces/types_network_client.NetworkDetails.md)\> - -Get details about the current network. - -#### Returns - -`Promise`\<[`NetworkDetails`](../interfaces/types_network_client.NetworkDetails.md)\> - -The current network details - -**`Example`** - -```typescript -const network = await networkClient.network() -const genesisId = network.genesisId -``` - -#### Defined in - -[src/types/client-manager.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L135) - -___ - -### genesisIdIsLocalNet - -▸ **genesisIdIsLocalNet**(`genesisId`): `boolean` - -Returns true if the given network genesisId is associated with a LocalNet network. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `genesisId` | `string` | The network genesis ID | - -#### Returns - -`boolean` - -Whether the given genesis ID is associated with a LocalNet network - -**`Example`** - -```typescript -const isLocalNet = ClientManager.genesisIdIsLocalNet('testnet-v1.0') -``` - -#### Defined in - -[src/types/client-manager.ts:159](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L159) - -___ - -### getAlgoNodeConfig - -▸ **getAlgoNodeConfig**(`network`, `config`): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -Returns the Algorand configuration to point to the free tier of the AlgoNode service. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `network` | ``"testnet"`` \| ``"mainnet"`` | Which network to connect to - TestNet or MainNet | -| `config` | ``"algod"`` \| ``"indexer"`` | Which algod config to return - Algod or Indexer | - -#### Returns - -[`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -The AlgoNode client configuration - -**`Example`** - -```typescript -const config = ClientManager.getAlgoNodeConfig('testnet', 'algod') -``` - -#### Defined in - -[src/types/client-manager.ts:545](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L545) - -___ - -### getAlgodClient - -▸ **getAlgodClient**(`config`): `AlgodClient` - -Returns an algod SDK client that automatically retries on idempotent calls. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config` | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) | The config of the client | - -#### Returns - -`AlgodClient` - -The Algod client - -**`Example`** - -```typescript - const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('testnet', 'algod')) - await algod.healthCheck().do() -``` - -**`Example`** - -```typescript - const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('mainnet', 'algod')) - await algod.healthCheck().do() -``` - -**`Example`** - -```typescript - const algod = ClientManager.getAlgodClient({server: 'http://localhost', port: '4001', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) - await algod.healthCheck().do() -``` - -#### Defined in - -[src/types/client-manager.ts:590](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L590) - -___ - -### getAlgodClientFromEnvironment - -▸ **getAlgodClientFromEnvironment**(): `AlgodClient` - -Returns an algod SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment). - -#### Returns - -`AlgodClient` - -The Algod client - -**`Example`** - -```typescript - // Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN - const algod = ClientManager.getAlgodClientFromEnvironment() - await algod.healthCheck().do() - ``` - -#### Defined in - -[src/types/client-manager.ts:608](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L608) - -___ - -### getAlgodConfigFromEnvironment - -▸ **getAlgodConfigFromEnvironment**(): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment) - -Expects `process.env.ALGOD_SERVER` to be defined, and you can also specify `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN`. - -#### Returns - -[`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -The Algod client configuration - -**`Throws`** - -Error if `process.env.ALGOD_SERVER` is not defined - -**`Example`** - -```typescript -const config = ClientManager.getAlgodConfigFromEnvironment() -``` - -#### Defined in - -[src/types/client-manager.ts:492](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L492) - -___ - -### getConfigFromEnvironmentOrLocalNet - -▸ **getConfigFromEnvironmentOrLocalNet**(): [`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md) - -Retrieve client configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment) - -If both `process.env.INDEXER_SERVER` and `process.env.ALGOD_SERVER` is defined it will use both along with optional `process.env.ALGOD_PORT`, `process.env.ALGOD_TOKEN`, `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`. - -If only `process.env.ALGOD_SERVER` is defined it will use this along with optional `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN` and leave indexer as `undefined`. - -If only `process.env.INDEXER_SERVER` is defined it will use the default (LocalNet) configuration for both algod and indexer. - -It will return a KMD configuration that uses `process.env.KMD_PORT` (or port 4002) if `process.env.ALGOD_SERVER` is defined, -otherwise it will use the default LocalNet config unless it detects testnet or mainnet. - -#### Returns - -[`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md) - -The config for algod, indexer and kmd - -**`Example`** - -```typescript -const config = ClientManager.getConfigFromEnvironmentOrLocalNet() -``` - -#### Defined in - -[src/types/client-manager.ts:456](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L456) - -___ - -### getDefaultLocalNetConfig - -▸ **getDefaultLocalNetConfig**(`configOrPort`): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -Returns the Algorand configuration to point to the default LocalNet. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `configOrPort` | `number` \| ``"algod"`` \| ``"indexer"`` \| ``"kmd"`` | Which algod config to return - algod, kmd, or indexer OR a port number | - -#### Returns - -[`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -The LocalNet client configuration - -**`Example`** - -```typescript -const config = ClientManager.getDefaultLocalNetConfig('algod') -``` - -#### Defined in - -[src/types/client-manager.ts:561](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L561) - -___ - -### getIndexerClient - -▸ **getIndexerClient**(`config`): `IndexerClient` - -Returns an indexer SDK client that automatically retries on idempotent calls - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config` | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) | The config of the client | - -#### Returns - -`IndexerClient` - -The Indexer client - -**`Example`** - -```typescript - const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('testnet', 'indexer')) - await indexer.makeHealthCheck().do() -``` - -**`Example`** - -```typescript - const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('mainnet', 'indexer')) - await indexer.makeHealthCheck().do() -``` - -**`Example`** - -```typescript - const indexer = ClientManager.getIndexerClient({server: 'http://localhost', port: '8980', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) - await indexer.makeHealthCheck().do() -``` - -#### Defined in - -[src/types/client-manager.ts:633](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L633) - -___ - -### getIndexerClientFromEnvironment - -▸ **getIndexerClientFromEnvironment**(): `IndexerClient` - -Returns an indexer SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment). - -#### Returns - -`IndexerClient` - -The Indexer client - -**`Example`** - -```typescript - // Uses process.env.INDEXER_SERVER, process.env.INDEXER_PORT and process.env.INDEXER_TOKEN - const indexer = ClientManager.getIndexerClientFromEnvironment() - await indexer.makeHealthCheck().do() - ``` - -#### Defined in - -[src/types/client-manager.ts:652](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L652) - -___ - -### getIndexerConfigFromEnvironment - -▸ **getIndexerConfigFromEnvironment**(): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment). - -Expects `process.env.INDEXER_SERVER` to be defined, and you can also specify `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`. - -#### Returns - -[`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -The Indexer client configuration - -**`Throws`** - -Error if `process.env.INDEXER_SERVER` is not defined - -**`Example`** - -```typescript -const config = ClientManager.getIndexerConfigFromEnvironment() -``` - -#### Defined in - -[src/types/client-manager.ts:519](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L519) - -___ - -### getKmdClient - -▸ **getKmdClient**(`config`): `KmdClient` - -Returns a KMD SDK client. - -KMD client allows you to export private keys, which is useful to (for instance) get the default account in a LocalNet network. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config` | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) | The config for the client | - -#### Returns - -`KmdClient` - -The KMD client - -**`Example`** - -```typescript - const kmd = ClientManager.getKmdClient({server: 'http://localhost', port: '4002', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) -``` - -#### Defined in - -[src/types/client-manager.ts:668](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L668) - -___ - -### getKmdClientFromEnvironment - -▸ **getKmdClientFromEnvironment**(): `KmdClient` - -Returns a KMD SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment). - -#### Returns - -`KmdClient` - -The KMD client - -**`Example`** - -```typescript - // Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN - const kmd = ClientManager.getKmdClientFromEnvironment() - ``` - -#### Defined in - -[src/types/client-manager.ts:683](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L683) diff --git a/docs/code/classes/types_composer.TransactionComposer.md b/docs/code/classes/types_composer.TransactionComposer.md deleted file mode 100644 index 211f3841..00000000 --- a/docs/code/classes/types_composer.TransactionComposer.md +++ /dev/null @@ -1,1972 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/composer](../modules/types_composer.md) / TransactionComposer - -# Class: TransactionComposer - -[types/composer](../modules/types_composer.md).TransactionComposer - -TransactionComposer helps you compose and execute transactions as a transaction group. - -## Table of contents - -### Constructors - -- [constructor](types_composer.TransactionComposer.md#constructor) - -### Properties - -- [algod](types_composer.TransactionComposer.md#algod) -- [appManager](types_composer.TransactionComposer.md#appmanager) -- [atc](types_composer.TransactionComposer.md#atc) -- [defaultValidityWindow](types_composer.TransactionComposer.md#defaultvaliditywindow) -- [defaultValidityWindowIsExplicit](types_composer.TransactionComposer.md#defaultvaliditywindowisexplicit) -- [getSigner](types_composer.TransactionComposer.md#getsigner) -- [getSuggestedParams](types_composer.TransactionComposer.md#getsuggestedparams) -- [txnMaxFees](types_composer.TransactionComposer.md#txnmaxfees) -- [txns](types_composer.TransactionComposer.md#txns) -- [NULL\_SIGNER](types_composer.TransactionComposer.md#null_signer) - -### Methods - -- [addAppCall](types_composer.TransactionComposer.md#addappcall) -- [addAppCallMethodCall](types_composer.TransactionComposer.md#addappcallmethodcall) -- [addAppCreate](types_composer.TransactionComposer.md#addappcreate) -- [addAppCreateMethodCall](types_composer.TransactionComposer.md#addappcreatemethodcall) -- [addAppDelete](types_composer.TransactionComposer.md#addappdelete) -- [addAppDeleteMethodCall](types_composer.TransactionComposer.md#addappdeletemethodcall) -- [addAppUpdate](types_composer.TransactionComposer.md#addappupdate) -- [addAppUpdateMethodCall](types_composer.TransactionComposer.md#addappupdatemethodcall) -- [addAssetConfig](types_composer.TransactionComposer.md#addassetconfig) -- [addAssetCreate](types_composer.TransactionComposer.md#addassetcreate) -- [addAssetDestroy](types_composer.TransactionComposer.md#addassetdestroy) -- [addAssetFreeze](types_composer.TransactionComposer.md#addassetfreeze) -- [addAssetOptIn](types_composer.TransactionComposer.md#addassetoptin) -- [addAssetOptOut](types_composer.TransactionComposer.md#addassetoptout) -- [addAssetTransfer](types_composer.TransactionComposer.md#addassettransfer) -- [addAtc](types_composer.TransactionComposer.md#addatc) -- [addOfflineKeyRegistration](types_composer.TransactionComposer.md#addofflinekeyregistration) -- [addOnlineKeyRegistration](types_composer.TransactionComposer.md#addonlinekeyregistration) -- [addPayment](types_composer.TransactionComposer.md#addpayment) -- [addTransaction](types_composer.TransactionComposer.md#addtransaction) -- [build](types_composer.TransactionComposer.md#build) -- [buildAppCall](types_composer.TransactionComposer.md#buildappcall) -- [buildAssetConfig](types_composer.TransactionComposer.md#buildassetconfig) -- [buildAssetCreate](types_composer.TransactionComposer.md#buildassetcreate) -- [buildAssetDestroy](types_composer.TransactionComposer.md#buildassetdestroy) -- [buildAssetFreeze](types_composer.TransactionComposer.md#buildassetfreeze) -- [buildAssetTransfer](types_composer.TransactionComposer.md#buildassettransfer) -- [buildAtc](types_composer.TransactionComposer.md#buildatc) -- [buildKeyReg](types_composer.TransactionComposer.md#buildkeyreg) -- [buildMethodCall](types_composer.TransactionComposer.md#buildmethodcall) -- [buildPayment](types_composer.TransactionComposer.md#buildpayment) -- [buildTransactions](types_composer.TransactionComposer.md#buildtransactions) -- [buildTxn](types_composer.TransactionComposer.md#buildtxn) -- [buildTxnWithSigner](types_composer.TransactionComposer.md#buildtxnwithsigner) -- [commonTxnBuildStep](types_composer.TransactionComposer.md#commontxnbuildstep) -- [count](types_composer.TransactionComposer.md#count) -- [execute](types_composer.TransactionComposer.md#execute) -- [rebuild](types_composer.TransactionComposer.md#rebuild) -- [send](types_composer.TransactionComposer.md#send) -- [simulate](types_composer.TransactionComposer.md#simulate) -- [arc2Note](types_composer.TransactionComposer.md#arc2note) - -## Constructors - -### constructor - -• **new TransactionComposer**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Create a `TransactionComposer`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`TransactionComposerParams`](../modules/types_composer.md#transactioncomposerparams) | The configuration for this composer | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The `TransactionComposer` instance - -#### Defined in - -[src/types/composer.ts:559](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L559) - -## Properties - -### algod - -• `Private` **algod**: `AlgodClient` - -The algod client used by the composer. - -#### Defined in - -[src/types/composer.ts:538](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L538) - -___ - -### appManager - -• `Private` **appManager**: [`AppManager`](types_app_manager.AppManager.md) - -#### Defined in - -[src/types/composer.ts:552](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L552) - -___ - -### atc - -• `Private` **atc**: `AtomicTransactionComposer` - -The ATC used to compose the group - -#### Defined in - -[src/types/composer.ts:527](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L527) - -___ - -### defaultValidityWindow - -• `Private` **defaultValidityWindow**: `bigint` - -The default transaction validity window - -#### Defined in - -[src/types/composer.ts:547](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L547) - -___ - -### defaultValidityWindowIsExplicit - -• `Private` **defaultValidityWindowIsExplicit**: `boolean` = `false` - -Whether the validity window was explicitly set on construction - -#### Defined in - -[src/types/composer.ts:550](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L550) - -___ - -### getSigner - -• `Private` **getSigner**: (`address`: `string` \| `Address`) => `TransactionSigner` - -A function that takes in an address and return a signer function for that address. - -#### Type declaration - -▸ (`address`): `TransactionSigner` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` \| `Address` | - -##### Returns - -`TransactionSigner` - -#### Defined in - -[src/types/composer.ts:544](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L544) - -___ - -### getSuggestedParams - -• `Private` **getSuggestedParams**: () => `Promise`\<`SuggestedParams`\> - -An async function that will return suggested params for the transaction. - -#### Type declaration - -▸ (): `Promise`\<`SuggestedParams`\> - -##### Returns - -`Promise`\<`SuggestedParams`\> - -#### Defined in - -[src/types/composer.ts:541](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L541) - -___ - -### txnMaxFees - -• `Private` **txnMaxFees**: `Map`\<`number`, [`AlgoAmount`](types_amount.AlgoAmount.md)\> - -Map of transaction index in the atc to a max logical fee. -This is set using the value of either maxFee or staticFee. - -#### Defined in - -[src/types/composer.ts:532](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L532) - -___ - -### txns - -• `Private` **txns**: [`Txn`](../modules/types_composer.md#txn)[] = `[]` - -Transactions that have not yet been composed - -#### Defined in - -[src/types/composer.ts:535](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L535) - -___ - -### NULL\_SIGNER - -▪ `Static` `Private` **NULL\_SIGNER**: `TransactionSigner` - -Signer used to represent a lack of signer - -#### Defined in - -[src/types/composer.ts:524](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L524) - -## Methods - -### addAppCall - -▸ **addAppCall**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an application call transaction to the transaction group. - -If you want to create or update an app use `addAppCreate` or `addAppUpdate`. - -Note: we recommend using app clients to make it easier to make app calls. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppCallParams`](../modules/types_composer.md#appcallparams) | The application call transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAppCall({ sender: 'CREATORADDRESS' }) -``` - -**`Example`** - -```typescript -composer.addAppCall({ - sender: 'CREATORADDRESS', - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:1046](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1046) - -___ - -### addAppCallMethodCall - -▸ **addAppCallMethodCall**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add a non-create/non-update ABI method application call transaction to the transaction group. - -Note: we recommend using app clients to make it easier to make app calls. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall) | The ABI method application call transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -composer.addAppCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -composer.addAppCallMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:1258](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1258) - -___ - -### addAppCreate - -▸ **addAppCreate**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an application create transaction to the transaction group. - -Note: we recommend using app clients to make it easier to make app calls. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The application create transaction parameters | -| `params.accountReferences?` | (`string` \| `Address`)[] | Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.appReferences?` | `bigint`[] | The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.approvalProgram` | `string` \| `Uint8Array` | The program to execute for all OnCompletes other than ClearState as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)). | -| `params.args?` | `Uint8Array`[] | Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). | -| `params.assetReferences?` | `bigint`[] | The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.boxReferences?` | ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] | Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). Either the name identifier (which will be set against app ID of `0` i.e. the current app), or a box identifier with the name identifier and app ID. | -| `params.clearStateProgram` | `string` \| `Uint8Array` | The program to execute for ClearState OnComplete as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)). | -| `params.extraFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. | -| `params.extraProgramPages?` | `number` | Number of extra pages required for the programs. Defaults to the number needed for the programs in this call if not specified. This is immutable once the app is created. | -| `params.firstValidRound?` | `bigint` | Set the first round this transaction is valid. If left undefined, the value from algod will be used. We recommend you only set this when you intentionally want this to be some time in the future. | -| `params.lastValidRound?` | `bigint` | The last round this transaction is valid. It is recommended to use `validityWindow` instead. | -| `params.lease?` | `string` \| `Uint8Array` | Prevent multiple transactions with the same lease being included within the validity window. A [lease](https://dev.algorand.co/concepts/transactions/leases) enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). | -| `params.maxFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. | -| `params.note?` | `string` \| `Uint8Array` | Note to attach to the transaction. Max of 1000 bytes. | -| `params.onComplete?` | `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` | The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. | -| `params.rekeyTo?` | `string` \| `Address` | Change the signing key of the sender to the given address. **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). | -| `params.schema?` | `Object` | The state schema for the app. This is immutable once the app is created. | -| `params.schema.globalByteSlices` | `number` | The number of byte slices saved in global state. | -| `params.schema.globalInts` | `number` | The number of integers saved in global state. | -| `params.schema.localByteSlices` | `number` | The number of byte slices saved in local state. | -| `params.schema.localInts` | `number` | The number of integers saved in local state. | -| `params.sender` | `string` \| `Address` | The address of the account sending the transaction. | -| `params.signer?` | `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given `sender` or use a default signer (if configured). | -| `params.staticFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. | -| `params.validityWindow?` | `number` \| `bigint` | How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAppCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) -``` - -**`Example`** - -```typescript -composer.addAppCreate({ - sender: 'CREATORADDRESS', - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - schema: { - globalInts: 1, - globalByteSlices: 2, - localInts: 3, - localByteSlices: 4 - }, - extraProgramPages: 1, - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), - // Signer only needed if you want to provide one, - // generally you'd register it with AlgorandClient - // against the sender and not need to pass it in - signer: transactionSigner, - maxRoundsToWaitForConfirmation: 5, - suppressLog: true, -}) -``` - -#### Defined in - -[src/types/composer.ts:925](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L925) - -___ - -### addAppCreateMethodCall - -▸ **addAppCreateMethodCall**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an ABI method create application call transaction to the transaction group. - -Note: we recommend using app clients to make it easier to make app calls. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) | The ABI create method application call transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -composer.addAppCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -composer.addAppCreateMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - schema: { - globalInts: 1, - globalByteSlices: 2, - localInts: 3, - localByteSlices: 4 - }, - extraProgramPages: 1, - onComplete: algosdk.OnApplicationComplete.OptInOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:1106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1106) - -___ - -### addAppDelete - -▸ **addAppDelete**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an application delete transaction to the transaction group. - -Note: we recommend using app clients to make it easier to make app calls. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppDeleteParams`](../modules/types_composer.md#appdeleteparams) | The application delete transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAppDelete({ sender: 'CREATORADDRESS' }) -``` - -**`Example`** - -```typescript -composer.addAppDelete({ - sender: 'CREATORADDRESS', - onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:1005](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1005) - -___ - -### addAppDeleteMethodCall - -▸ **addAppDeleteMethodCall**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an ABI method delete application call transaction to the transaction group. - -Note: we recommend using app clients to make it easier to make app calls. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppDeleteMethodCall`](../modules/types_composer.md#appdeletemethodcall) | The ABI delete method application call transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -composer.addAppDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -composer.addAppDeleteMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:1208](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1208) - -___ - -### addAppUpdate - -▸ **addAppUpdate**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an application update transaction to the transaction group. - -Note: we recommend using app clients to make it easier to make app calls. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The application update transaction parameters | -| `params.accountReferences?` | (`string` \| `Address`)[] | Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.appId` | `bigint` | ID of the application; 0 if the application is being created. | -| `params.appReferences?` | `bigint`[] | The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.approvalProgram` | `string` \| `Uint8Array` | The program to execute for all OnCompletes other than ClearState as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array)) | -| `params.args?` | `Uint8Array`[] | Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). | -| `params.assetReferences?` | `bigint`[] | The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). | -| `params.boxReferences?` | ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] | Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). Either the name identifier (which will be set against app ID of `0` i.e. the current app), or a box identifier with the name identifier and app ID. | -| `params.clearStateProgram` | `string` \| `Uint8Array` | The program to execute for ClearState OnComplete as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array)) | -| `params.extraFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. | -| `params.firstValidRound?` | `bigint` | Set the first round this transaction is valid. If left undefined, the value from algod will be used. We recommend you only set this when you intentionally want this to be some time in the future. | -| `params.lastValidRound?` | `bigint` | The last round this transaction is valid. It is recommended to use `validityWindow` instead. | -| `params.lease?` | `string` \| `Uint8Array` | Prevent multiple transactions with the same lease being included within the validity window. A [lease](https://dev.algorand.co/concepts/transactions/leases) enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). | -| `params.maxFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. | -| `params.note?` | `string` \| `Uint8Array` | Note to attach to the transaction. Max of 1000 bytes. | -| `params.onComplete?` | `UpdateApplicationOC` | The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. | -| `params.rekeyTo?` | `string` \| `Address` | Change the signing key of the sender to the given address. **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). | -| `params.sender` | `string` \| `Address` | The address of the account sending the transaction. | -| `params.signer?` | `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given `sender` or use a default signer (if configured). | -| `params.staticFee?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. | -| `params.validityWindow?` | `number` \| `bigint` | How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAppUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) -``` - -**`Example`** - -```typescript -composer.addAppUpdate({ - sender: 'CREATORADDRESS', - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:966](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L966) - -___ - -### addAppUpdateMethodCall - -▸ **addAppUpdateMethodCall**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an ABI method update application call transaction to the transaction group. - -Note: we recommend using app clients to make it easier to make app calls. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppUpdateMethodCall`](../modules/types_composer.md#appupdatemethodcall) | The ABI update method application call transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -composer.addAppUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) -``` - -**`Example`** - -```typescript -const method = new ABIMethod({ - name: 'method', - args: [{ name: 'arg1', type: 'string' }], - returns: { type: 'string' }, -}) -composer.addAppUpdateMethodCall({ - sender: 'CREATORADDRESS', - method: method, - args: ["arg1_value"], - approvalProgram: "TEALCODE", - clearStateProgram: "TEALCODE", - onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, - args: [new Uint8Array(1, 2, 3, 4)] - accountReferences: ["ACCOUNT_1"] - appReferences: [123n, 1234n] - assetReferences: [12345n] - boxReferences: ["box1", {appId: 1234n, name: "box2"}] - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:1158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1158) - -___ - -### addAssetConfig - -▸ **addAssetConfig**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an asset config transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetConfigParams`](../modules/types_composer.md#assetconfigparams) | The asset config transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAssetConfig({ sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" }) -``` - -**`Example`** - -```typescript -composer.addAssetConfig({ - sender: 'MANAGERADDRESS', - assetId: 123456n, - manager: 'MANAGERADDRESS', - reserve: 'RESERVEADDRESS', - freeze: 'FREEZEADDRESS', - clawback: 'CLAWBACKADDRESS', - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) - -#### Defined in - -[src/types/composer.ts:698](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L698) - -___ - -### addAssetCreate - -▸ **addAssetCreate**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an asset create transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetCreateParams`](../modules/types_composer.md#assetcreateparams) | The asset create transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAssetCreate({ sender: "CREATORADDRESS", total: 100n}) -``` - -**`Example`** - -```typescript -composer.addAssetCreate({ - sender: 'CREATORADDRESS', - total: 100n, - decimals: 2, - assetName: 'asset', - unitName: 'unit', - url: 'url', - metadataHash: 'metadataHash', - defaultFrozen: false, - manager: 'MANAGERADDRESS', - reserve: 'RESERVEADDRESS', - freeze: 'FREEZEADDRESS', - clawback: 'CLAWBACKADDRESS', - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) - -#### Defined in - -[src/types/composer.ts:663](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L663) - -___ - -### addAssetDestroy - -▸ **addAssetDestroy**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an asset destroy transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetDestroyParams`](../modules/types_composer.md#assetdestroyparams) | The asset destroy transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAssetDestroy({ sender: "MANAGERADDRESS", assetId: 123456n }) -``` - -**`Example`** - -```typescript -composer.addAssetDestroy({ - sender: 'MANAGERADDRESS', - assetId: 123456n, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:764](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L764) - -___ - -### addAssetFreeze - -▸ **addAssetFreeze**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an asset freeze transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetFreezeParams`](../modules/types_composer.md#assetfreezeparams) | The asset freeze transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAssetFreeze({ sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true }) -``` - -**`Example`** - -```typescript -composer.addAssetFreeze({ - sender: 'MANAGERADDRESS', - assetId: 123456n, - account: 'ACCOUNTADDRESS', - frozen: true, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:732](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L732) - -___ - -### addAssetOptIn - -▸ **addAssetOptIn**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an asset opt-in transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetOptInParams`](../modules/types_composer.md#assetoptinparams) | The asset opt-in transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAssetOptIn({ sender: "SENDERADDRESS", assetId: 123456n }) -``` - -**`Example`** - -```typescript -composer.addAssetOptIn({ - sender: 'SENDERADDRESS', - assetId: 123456n, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:833](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L833) - -___ - -### addAssetOptOut - -▸ **addAssetOptOut**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an asset opt-out transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetOptOutParams`](../modules/types_composer.md#assetoptoutparams) | The asset opt-out transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAssetOptOut({ sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true }) -``` - -**`Example`** - -```typescript -composer.addAssetOptOut({ sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true }) -``` - -**`Example`** - -```typescript -composer.addAssetOptOut({ - sender: 'SENDERADDRESS', - assetId: 123456n, - creator: 'CREATORADDRESS', - ensureZeroBalance: true, - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:871](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L871) - -___ - -### addAssetTransfer - -▸ **addAssetTransfer**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an asset transfer transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AssetTransferParams`](../modules/types_composer.md#assettransferparams) | The asset transfer transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addAssetTransfer({ sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" }) -``` - -**`Example`** - -```typescript -composer.addAssetTransfer({ - sender: 'CLAWBACKADDRESS', - assetId: 123456n, - amount: 1n, - receiver: 'RECEIVERADDRESS', - clawbackTarget: 'HOLDERADDRESS', - // This field needs to be used with caution - closeAssetTo: 'ADDRESSTOCLOSETO' - lease: 'lease', - note: 'note', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:801](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L801) - -___ - -### addAtc - -▸ **addAtc**(`atc`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add the transactions within an `AtomicTransactionComposer` to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `atc` | `AtomicTransactionComposer` | The `AtomicTransactionComposer` to build transactions from and add to the group | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -const atc = new AtomicTransactionComposer() - .addPayment({ sender: 'SENDERADDRESS', receiver: 'RECEIVERADDRESS', amount: 1000n }) -composer.addAtc(atc) -``` - -#### Defined in - -[src/types/composer.ts:1356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1356) - -___ - -### addOfflineKeyRegistration - -▸ **addOfflineKeyRegistration**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an offline key registration transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`OfflineKeyRegistrationParams`](../modules/types_composer.md#offlinekeyregistrationparams) | The offline key registration transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addOfflineKeyRegistration({ - sender: 'SENDERADDRESS', -}) -``` - -**`Example`** - -```typescript -composer.addOfflineKeyRegistration({ - sender: 'SENDERADDRESS', - lease: 'lease', - note: 'note', - // Use this with caution, it's generally better to use algorand.account.rekeyAccount - rekeyTo: 'REKEYTOADDRESS', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:1339](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1339) - -___ - -### addOnlineKeyRegistration - -▸ **addOnlineKeyRegistration**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add an online key registration transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`OnlineKeyRegistrationParams`](../modules/types_composer.md#onlinekeyregistrationparams) | The online key registration transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addOnlineKeyRegistration({ - sender: 'SENDERADDRESS', - voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), - selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), - stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), - voteFirst: 1n, - voteLast: 1000n, - voteKeyDilution: 1n, -}) -``` - -**`Example`** - -```typescript -composer.addOnlineKeyRegistration({ - sender: 'SENDERADDRESS', - voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), - selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), - stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), - voteFirst: 1n, - voteLast: 1000n, - voteKeyDilution: 1n, - lease: 'lease', - note: 'note', - // Use this with caution, it's generally better to use algorand.account.rekeyAccount - rekeyTo: 'REKEYTOADDRESS', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) -``` - -#### Defined in - -[src/types/composer.ts:1304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1304) - -___ - -### addPayment - -▸ **addPayment**(`params`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add a payment transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`PaymentParams`](../modules/types_composer.md#paymentparams) | The payment transaction parameters | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addPayment({ - sender: 'SENDERADDRESS', - receiver: 'RECEIVERADDRESS', - amount: (4).algo(), -}) -``` - -**`Example`** - -```typescript -composer.addPayment({ - amount: (4).algo(), - receiver: 'RECEIVERADDRESS', - sender: 'SENDERADDRESS', - closeRemainderTo: 'CLOSEREMAINDERTOADDRESS', - lease: 'lease', - note: 'note', - // Use this with caution, it's generally better to use algorand.account.rekeyAccount - rekeyTo: 'REKEYTOADDRESS', - // You wouldn't normally set this field - firstValidRound: 1000n, - validityWindow: 10, - extraFee: (1000).microAlgo(), - staticFee: (1000).microAlgo(), - // Max fee doesn't make sense with extraFee AND staticFee - // already specified, but here for completeness - maxFee: (3000).microAlgo(), -}) - -#### Defined in - -[src/types/composer.ts:622](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L622) - -___ - -### addTransaction - -▸ **addTransaction**(`transaction`, `signer?`): [`TransactionComposer`](types_composer.TransactionComposer.md) - -Add a pre-built transaction to the transaction group. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transaction` | `Transaction` | The pre-built transaction | -| `signer?` | `TransactionSigner` | Optional signer override for the transaction | - -#### Returns - -[`TransactionComposer`](types_composer.TransactionComposer.md) - -The composer so you can chain method calls - -**`Example`** - -```typescript -composer.addTransaction(txn) -``` - -#### Defined in - -[src/types/composer.ts:579](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L579) - -___ - -### build - -▸ **build**(): `Promise`\<\{ `atc`: `AtomicTransactionComposer` ; `methodCalls`: `any` ; `transactions`: `TransactionWithSigner`[] }\> - -Compose all of the transactions in a single atomic transaction group and an atomic transaction composer. - -You can then use the transactions standalone, or use the composer to execute or simulate the transactions. - -Once this method is called, no further transactions will be able to be added. -You can safely call this method multiple times to get the same result. - -#### Returns - -`Promise`\<\{ `atc`: `AtomicTransactionComposer` ; `methodCalls`: `any` ; `transactions`: `TransactionWithSigner`[] }\> - -The built atomic transaction composer, the transactions and any corresponding method calls - -**`Example`** - -```typescript -const { atc, transactions, methodCalls } = await composer.build() -``` - -#### Defined in - -[src/types/composer.ts:1886](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1886) - -___ - -### buildAppCall - -▸ **buildAppCall**(`params`, `suggestedParams`): `Promise`\<`TransactionWithContext`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | \{ `accountReferences?`: (`string` \| `Address`)[] ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `extraProgramPages?`: `number` ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `approvalProgram`: `string` \| `Uint8Array` ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) \| [`BoxReference`](../interfaces/types_app_manager.BoxReference.md))[] ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `firstValidRound?`: `bigint` ; `lastValidRound?`: `bigint` ; `lease?`: `string` \| `Uint8Array` ; `maxFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `note?`: `string` \| `Uint8Array` ; `onComplete?`: `UpdateApplicationOC` ; `rekeyTo?`: `string` \| `Address` ; `sender`: `string` \| `Address` ; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) ; `staticFee?`: [`AlgoAmount`](types_amount.AlgoAmount.md) ; `validityWindow?`: `number` \| `bigint` } \| [`AppCallParams`](../modules/types_composer.md#appcallparams) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`Promise`\<`TransactionWithContext`\> - -#### Defined in - -[src/types/composer.ts:1695](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1695) - -___ - -### buildAssetConfig - -▸ **buildAssetConfig**(`params`, `suggestedParams`): `TransactionWithContext` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`AssetConfigParams`](../modules/types_composer.md#assetconfigparams) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`TransactionWithContext` - -#### Defined in - -[src/types/composer.ts:1652](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1652) - -___ - -### buildAssetCreate - -▸ **buildAssetCreate**(`params`, `suggestedParams`): `TransactionWithContext` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`AssetCreateParams`](../modules/types_composer.md#assetcreateparams) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`TransactionWithContext` - -#### Defined in - -[src/types/composer.ts:1634](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1634) - -___ - -### buildAssetDestroy - -▸ **buildAssetDestroy**(`params`, `suggestedParams`): `TransactionWithContext` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`AssetDestroyParams`](../modules/types_composer.md#assetdestroyparams) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`TransactionWithContext` - -#### Defined in - -[src/types/composer.ts:1665](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1665) - -___ - -### buildAssetFreeze - -▸ **buildAssetFreeze**(`params`, `suggestedParams`): `TransactionWithContext` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`AssetFreezeParams`](../modules/types_composer.md#assetfreezeparams) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`TransactionWithContext` - -#### Defined in - -[src/types/composer.ts:1673](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1673) - -___ - -### buildAssetTransfer - -▸ **buildAssetTransfer**(`params`, `suggestedParams`): `TransactionWithContext` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`AssetTransferParams`](../modules/types_composer.md#assettransferparams) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`TransactionWithContext` - -#### Defined in - -[src/types/composer.ts:1683](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1683) - -___ - -### buildAtc - -▸ **buildAtc**(`atc`): `TransactionWithSignerAndContext`[] - -Build an ATC and return transactions ready to be incorporated into a broader set of transactions this composer is composing - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `atc` | `AtomicTransactionComposer` | - -#### Returns - -`TransactionWithSignerAndContext`[] - -#### Defined in - -[src/types/composer.ts:1362](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1362) - -___ - -### buildKeyReg - -▸ **buildKeyReg**(`params`, `suggestedParams`): `TransactionWithContext` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`OnlineKeyRegistrationParams`](../modules/types_composer.md#onlinekeyregistrationparams) \| [`OfflineKeyRegistrationParams`](../modules/types_composer.md#offlinekeyregistrationparams) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`TransactionWithContext` - -#### Defined in - -[src/types/composer.ts:1746](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1746) - -___ - -### buildMethodCall - -▸ **buildMethodCall**(`params`, `suggestedParams`, `includeSigner`): `Promise`\<`TransactionWithSignerAndContext`[]\> - -Builds an ABI method call transaction and any other associated transactions represented in the ABI args. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`AppCreateMethodCall`](../modules/types_composer.md#appcreatemethodcall) \| [`AppUpdateMethodCall`](../modules/types_composer.md#appupdatemethodcall) \| [`AppCallMethodCall`](../modules/types_composer.md#appcallmethodcall) | - | -| `suggestedParams` | `SuggestedParams` | - | -| `includeSigner` | `boolean` | Whether to include the actual signer for the transactions. If you are just building transactions without signers yet then set this to `false`. | - -#### Returns - -`Promise`\<`TransactionWithSignerAndContext`[]\> - -#### Defined in - -[src/types/composer.ts:1442](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1442) - -___ - -### buildPayment - -▸ **buildPayment**(`params`, `suggestedParams`): `TransactionWithContext` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`PaymentParams`](../modules/types_composer.md#paymentparams) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`TransactionWithContext` - -#### Defined in - -[src/types/composer.ts:1624](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1624) - -___ - -### buildTransactions - -▸ **buildTransactions**(): `Promise`\<[`BuiltTransactions`](../interfaces/types_composer.BuiltTransactions.md)\> - -Compose all of the transactions without signers and return the transaction objects directly along with any ABI method calls. - -#### Returns - -`Promise`\<[`BuiltTransactions`](../interfaces/types_composer.BuiltTransactions.md)\> - -The array of built transactions and any corresponding method calls - -**`Example`** - -```typescript -const { transactions, methodCalls, signers } = await composer.buildTransactions() -``` - -#### Defined in - -[src/types/composer.ts:1828](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1828) - -___ - -### buildTxn - -▸ **buildTxn**(`txn`, `suggestedParams`): `Promise`\<`TransactionWithContext`[]\> - -Builds all transaction types apart from `txnWithSigner`, `atc` and `methodCall` since those ones can have custom signers that need to be retrieved. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `txn` | [`Txn`](../modules/types_composer.md#txn) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`Promise`\<`TransactionWithContext`[]\> - -#### Defined in - -[src/types/composer.ts:1769](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1769) - -___ - -### buildTxnWithSigner - -▸ **buildTxnWithSigner**(`txn`, `suggestedParams`): `Promise`\<`TransactionWithSignerAndContext`[]\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `txn` | [`Txn`](../modules/types_composer.md#txn) | -| `suggestedParams` | `SuggestedParams` | - -#### Returns - -`Promise`\<`TransactionWithSignerAndContext`[]\> - -#### Defined in - -[src/types/composer.ts:1796](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1796) - -___ - -### commonTxnBuildStep - -▸ **commonTxnBuildStep**\<`TParams`\>(`buildTxn`, `params`, `txnParams`): `TransactionWithContext` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TParams` | extends `CommonTransactionParams` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `buildTxn` | (`params`: `TParams`) => `Transaction` | -| `params` | [`CommonTransactionParams`](../modules/types_composer.md#commontransactionparams) | -| `txnParams` | `TParams` | - -#### Returns - -`TransactionWithContext` - -#### Defined in - -[src/types/composer.ts:1384](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1384) - -___ - -### count - -▸ **count**(): `Promise`\<`number`\> - -Get the number of transactions currently added to this composer. - -#### Returns - -`Promise`\<`number`\> - -The number of transactions currently added to this composer - -#### Defined in - -[src/types/composer.ts:1869](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1869) - -___ - -### execute - -▸ **execute**(`params?`): `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params?` | [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters to control execution with | - -#### Returns - -`Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md)\> - -The execution result - -**`Deprecated`** - -Use `send` instead. - -Compose the atomic transaction group and send it to the network - -An alias for `composer.send(params)`. - -#### Defined in - -[src/types/composer.ts:1980](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1980) - -___ - -### rebuild - -▸ **rebuild**(): `Promise`\<\{ `atc`: `AtomicTransactionComposer` ; `methodCalls`: `any` ; `transactions`: `TransactionWithSigner`[] }\> - -Rebuild the group, discarding any previously built transactions. -This will potentially cause new signers and suggested params to be used if the callbacks return a new value compared to the first build. - -#### Returns - -`Promise`\<\{ `atc`: `AtomicTransactionComposer` ; `methodCalls`: `any` ; `transactions`: `TransactionWithSigner`[] }\> - -The newly built atomic transaction composer and the transactions - -**`Example`** - -```typescript -const { atc, transactions, methodCalls } = await composer.rebuild() -``` - -#### Defined in - -[src/types/composer.ts:1925](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1925) - -___ - -### send - -▸ **send**(`params?`): `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md)\> - -Compose the atomic transaction group and send it to the network. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params?` | [`SendParams`](../interfaces/types_transaction.SendParams.md) | The parameters to control execution with | - -#### Returns - -`Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md)\> - -The execution result - -**`Example`** - -```typescript -const result = await composer.send() -``` - -#### Defined in - -[src/types/composer.ts:1939](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1939) - -___ - -### simulate - -▸ **simulate**(): `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) & \{ `simulateResponse`: `SimulateResponse` }\> - -Compose the atomic transaction group and simulate sending it to the network - -#### Returns - -`Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) & \{ `simulateResponse`: `SimulateResponse` }\> - -The simulation result - -**`Example`** - -```typescript -const result = await composer.simulate() -``` - -#### Defined in - -[src/types/composer.ts:1992](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1992) - -▸ **simulate**(`options`): `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) & \{ `simulateResponse`: `SimulateResponse` }\> - -Compose the atomic transaction group and simulate sending it to the network - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options` | `Object` | - | -| `options.allowMoreLogging?` | `boolean` | - | -| `options.allowUnnamedResources?` | `boolean` | - | -| `options.execTraceConfig?` | `SimulateTraceConfig` | - | -| `options.extraOpcodeBudget?` | `number` \| `bigint` | - | -| `options.round?` | `number` \| `bigint` | - | -| `options.skipSignatures` | `boolean` | Whether or not to skip signatures for all built transactions and use an empty signer instead. This will set `fixSigners` and `allowEmptySignatures` when sending the request to the algod API. | - -#### Returns - -`Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) & \{ `simulateResponse`: `SimulateResponse` }\> - -The simulation result - -**`Example`** - -```typescript -const result = await composer.simulate({ - skipSignatures: true, -}) -``` - -#### Defined in - -[src/types/composer.ts:2003](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L2003) - -▸ **simulate**(`options`): `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) & \{ `simulateResponse`: `SimulateResponse` }\> - -Compose the atomic transaction group and simulate sending it to the network - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Object` | -| `options.allowEmptySignatures?` | `boolean` | -| `options.allowMoreLogging?` | `boolean` | -| `options.allowUnnamedResources?` | `boolean` | -| `options.execTraceConfig?` | `SimulateTraceConfig` | -| `options.extraOpcodeBudget?` | `number` \| `bigint` | -| `options.fixSigners?` | `boolean` | -| `options.round?` | `number` \| `bigint` | - -#### Returns - -`Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) & \{ `simulateResponse`: `SimulateResponse` }\> - -The simulation result - -**`Example`** - -```typescript -const result = await composer.simulate({ - extraOpcodeBudget: 1000, -}) -``` - -#### Defined in - -[src/types/composer.ts:2016](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L2016) - -___ - -### arc2Note - -▸ **arc2Note**(`note`): `Uint8Array` - -Create an encoded transaction note that follows the ARC-2 spec. - -https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `note` | [`Arc2TransactionNote`](../modules/types_transaction.md#arc2transactionnote) | The ARC-2 transaction note data | - -#### Returns - -`Uint8Array` - -The binary encoded transaction note - -#### Defined in - -[src/types/composer.ts:2093](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L2093) diff --git a/docs/code/classes/types_config.UpdatableConfig.md b/docs/code/classes/types_config.UpdatableConfig.md deleted file mode 100644 index 87718225..00000000 --- a/docs/code/classes/types_config.UpdatableConfig.md +++ /dev/null @@ -1,274 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/config](../modules/types_config.md) / UpdatableConfig - -# Class: UpdatableConfig - -[types/config](../modules/types_config.md).UpdatableConfig - -Updatable AlgoKit config - -## Implements - -- `Readonly`\<[`Config`](../interfaces/types_config.Config.md)\> - -## Table of contents - -### Constructors - -- [constructor](types_config.UpdatableConfig.md#constructor) - -### Properties - -- [config](types_config.UpdatableConfig.md#config) - -### Accessors - -- [debug](types_config.UpdatableConfig.md#debug) -- [events](types_config.UpdatableConfig.md#events) -- [logger](types_config.UpdatableConfig.md#logger) -- [maxSearchDepth](types_config.UpdatableConfig.md#maxsearchdepth) -- [populateAppCallResources](types_config.UpdatableConfig.md#populateappcallresources) -- [projectRoot](types_config.UpdatableConfig.md#projectroot) -- [traceAll](types_config.UpdatableConfig.md#traceall) -- [traceBufferSizeMb](types_config.UpdatableConfig.md#tracebuffersizemb) - -### Methods - -- [configure](types_config.UpdatableConfig.md#configure) -- [getLogger](types_config.UpdatableConfig.md#getlogger) -- [withDebug](types_config.UpdatableConfig.md#withdebug) - -## Constructors - -### constructor - -• **new UpdatableConfig**(): [`UpdatableConfig`](types_config.UpdatableConfig.md) - -#### Returns - -[`UpdatableConfig`](types_config.UpdatableConfig.md) - -#### Defined in - -[src/types/config.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L90) - -## Properties - -### config - -• `Private` **config**: [`Config`](../interfaces/types_config.Config.md) - -#### Defined in - -[src/types/config.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L29) - -## Accessors - -### debug - -• `get` **debug**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -Readonly.debug - -#### Defined in - -[src/types/config.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L39) - -___ - -### events - -• `get` **events**(): [`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Returns - -[`AsyncEventEmitter`](types_async_event_emitter.AsyncEventEmitter.md) - -#### Implementation of - -Readonly.events - -#### Defined in - -[src/types/config.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L59) - -___ - -### logger - -• `get` **logger**(): [`Logger`](../modules/types_logging.md#logger) - -#### Returns - -[`Logger`](../modules/types_logging.md#logger) - -#### Implementation of - -Readonly.logger - -#### Defined in - -[src/types/config.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L35) - -___ - -### maxSearchDepth - -• `get` **maxSearchDepth**(): `number` - -#### Returns - -`number` - -#### Implementation of - -Readonly.maxSearchDepth - -#### Defined in - -[src/types/config.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L55) - -___ - -### populateAppCallResources - -• `get` **populateAppCallResources**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -Readonly.populateAppCallResources - -#### Defined in - -[src/types/config.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L31) - -___ - -### projectRoot - -• `get` **projectRoot**(): ``null`` \| `string` - -#### Returns - -``null`` \| `string` - -#### Implementation of - -Readonly.projectRoot - -#### Defined in - -[src/types/config.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L43) - -___ - -### traceAll - -• `get` **traceAll**(): `boolean` - -#### Returns - -`boolean` - -#### Implementation of - -Readonly.traceAll - -#### Defined in - -[src/types/config.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L47) - -___ - -### traceBufferSizeMb - -• `get` **traceBufferSizeMb**(): `number` - -#### Returns - -`number` - -#### Implementation of - -Readonly.traceBufferSizeMb - -#### Defined in - -[src/types/config.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L51) - -## Methods - -### configure - -▸ **configure**(`newConfig`): `void` - -Update the AlgoKit configuration with your own configuration settings - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `newConfig` | `Partial`\<[`Config`](../interfaces/types_config.Config.md)\> | Partial or complete config to replace | - -#### Returns - -`void` - -#### Defined in - -[src/types/config.ts:107](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L107) - -___ - -### getLogger - -▸ **getLogger**(`returnNullLogger?`): [`Logger`](../modules/types_logging.md#logger) - -Returns the current logger, or the null logger if true is passed in to `returnNullLogger` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `returnNullLogger?` | `boolean` | Whether or not to return the null logger | - -#### Returns - -[`Logger`](../modules/types_logging.md#logger) - -The requested logger - -#### Defined in - -[src/types/config.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L68) - -___ - -### withDebug - -▸ **withDebug**(`lambda`): `void` - -Temporarily run with debug set to true. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `lambda` | () => `unknown` | A lambda expression with code to run with debug config set to true | - -#### Returns - -`void` - -#### Defined in - -[src/types/config.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L80) diff --git a/docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md b/docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md deleted file mode 100644 index 54cb73d5..00000000 --- a/docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md +++ /dev/null @@ -1,225 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/dispenser-client](../modules/types_dispenser_client.md) / TestNetDispenserApiClient - -# Class: TestNetDispenserApiClient - -[types/dispenser-client](../modules/types_dispenser_client.md).TestNetDispenserApiClient - -`TestNetDispenserApiClient` is a class that provides methods to interact with the [Algorand TestNet Dispenser API](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md). -It allows you to fund an address with Algo, refund a transaction, and get the funding limit for the Algo asset. - -The class requires an authentication token and a request timeout to be initialized. The authentication token can be provided -either directly as a parameter or through an `ALGOKIT_DISPENSER_ACCESS_TOKEN` environment variable. If neither is provided, an error is thrown. - -The request timeout can be provided as a parameter. If not provided, a default value is used. - -**`Method`** - -fund - Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo. - -**`Method`** - -refund - Sends a refund request to the dispenser API for the specified refundTxnId. - -**`Method`** - -limit - Sends a request to the dispenser API to get the funding limit for the Algo asset. - -**`Example`** - -```typescript -const client = new TestNetDispenserApiClient({ authToken: 'your_auth_token', requestTimeout: 30 }); -const fundResponse = await client.fund('your_address', 100); -const limitResponse = await client.getLimit(); -await client.refund('your_transaction_id'); -``` - -**`Throws`** - -If neither the environment variable 'ALGOKIT_DISPENSER_ACCESS_TOKEN' nor the authToken parameter were provided. - -## Table of contents - -### Constructors - -- [constructor](types_dispenser_client.TestNetDispenserApiClient.md#constructor) - -### Properties - -- [\_authToken](types_dispenser_client.TestNetDispenserApiClient.md#_authtoken) -- [\_requestTimeout](types_dispenser_client.TestNetDispenserApiClient.md#_requesttimeout) - -### Accessors - -- [authToken](types_dispenser_client.TestNetDispenserApiClient.md#authtoken) -- [requestTimeout](types_dispenser_client.TestNetDispenserApiClient.md#requesttimeout) - -### Methods - -- [fund](types_dispenser_client.TestNetDispenserApiClient.md#fund) -- [getLimit](types_dispenser_client.TestNetDispenserApiClient.md#getlimit) -- [processDispenserRequest](types_dispenser_client.TestNetDispenserApiClient.md#processdispenserrequest) -- [refund](types_dispenser_client.TestNetDispenserApiClient.md#refund) - -## Constructors - -### constructor - -• **new TestNetDispenserApiClient**(`params?`): [`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params?` | [`TestNetDispenserApiClientParams`](../interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md) | - -#### Returns - -[`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md) - -#### Defined in - -[src/types/dispenser-client.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L76) - -## Properties - -### \_authToken - -• `Private` **\_authToken**: `string` - -#### Defined in - -[src/types/dispenser-client.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L73) - -___ - -### \_requestTimeout - -• `Private` **\_requestTimeout**: `number` - -#### Defined in - -[src/types/dispenser-client.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L74) - -## Accessors - -### authToken - -• `get` **authToken**(): `string` - -The authentication token used for API requests. - -#### Returns - -`string` - -#### Defined in - -[src/types/dispenser-client.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L92) - -___ - -### requestTimeout - -• `get` **requestTimeout**(): `number` - -The timeout for API requests, in seconds. - -#### Returns - -`number` - -#### Defined in - -[src/types/dispenser-client.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L96) - -## Methods - -### fund - -▸ **fund**(`address`, `amount`): `Promise`\<[`DispenserFundResponse`](../interfaces/types_dispenser_client.DispenserFundResponse.md)\> - -Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `address` | `string` \| `Address` | The address to fund. | -| `amount` | `number` \| `bigint` | The amount of µAlgo to fund. | - -#### Returns - -`Promise`\<[`DispenserFundResponse`](../interfaces/types_dispenser_client.DispenserFundResponse.md)\> - -DispenserFundResponse: An object containing the transaction ID and funded amount. - -#### Defined in - -[src/types/dispenser-client.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L158) - -___ - -### getLimit - -▸ **getLimit**(): `Promise`\<[`DispenserLimitResponse`](../interfaces/types_dispenser_client.DispenserLimitResponse.md)\> - -Sends a request to the dispenser API to get the funding limit for the Algo asset. - -#### Returns - -`Promise`\<[`DispenserLimitResponse`](../interfaces/types_dispenser_client.DispenserLimitResponse.md)\> - -DispenserLimitResponse: An object containing the funding limit amount. - -#### Defined in - -[src/types/dispenser-client.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L188) - -___ - -### processDispenserRequest - -▸ **processDispenserRequest**(`authToken`, `urlSuffix`, `body?`, `method?`): `Promise`\<`Response`\> - -Processes a dispenser API request. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `authToken` | `string` | `undefined` | The authentication token. | -| `urlSuffix` | `string` | `undefined` | The URL suffix for the API request. | -| `body` | ``null`` \| `Record`\<`string`, `string` \| `number`\> | `null` | The request body. | -| `method` | `string` | `'POST'` | The HTTP method. | - -#### Returns - -`Promise`\<`Response`\> - -The API response. - -#### Defined in - -[src/types/dispenser-client.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L110) - -___ - -### refund - -▸ **refund**(`refundTxnId`): `Promise`\<`void`\> - -Sends a refund request to the dispenser API for the specified refundTxnId. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `refundTxnId` | `string` | The transaction ID to refund. | - -#### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/types/dispenser-client.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L179) diff --git a/docs/code/classes/types_kmd_account_manager.KmdAccountManager.md b/docs/code/classes/types_kmd_account_manager.KmdAccountManager.md deleted file mode 100644 index 9e9ca620..00000000 --- a/docs/code/classes/types_kmd_account_manager.KmdAccountManager.md +++ /dev/null @@ -1,182 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/kmd-account-manager](../modules/types_kmd_account_manager.md) / KmdAccountManager - -# Class: KmdAccountManager - -[types/kmd-account-manager](../modules/types_kmd_account_manager.md).KmdAccountManager - -Provides abstractions over a [KMD](https://github.com/algorand/go-algorand/blob/master/daemon/kmd/README.md) instance -that makes it easier to get and manage accounts using KMD. - -## Table of contents - -### Constructors - -- [constructor](types_kmd_account_manager.KmdAccountManager.md#constructor) - -### Properties - -- [\_clientManager](types_kmd_account_manager.KmdAccountManager.md#_clientmanager) -- [\_kmd](types_kmd_account_manager.KmdAccountManager.md#_kmd) - -### Methods - -- [getLocalNetDispenserAccount](types_kmd_account_manager.KmdAccountManager.md#getlocalnetdispenseraccount) -- [getOrCreateWalletAccount](types_kmd_account_manager.KmdAccountManager.md#getorcreatewalletaccount) -- [getWalletAccount](types_kmd_account_manager.KmdAccountManager.md#getwalletaccount) -- [kmd](types_kmd_account_manager.KmdAccountManager.md#kmd) - -## Constructors - -### constructor - -• **new KmdAccountManager**(`clientManager`): [`KmdAccountManager`](types_kmd_account_manager.KmdAccountManager.md) - -Create a new KMD manager. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `clientManager` | [`ClientManager`](types_client_manager.ClientManager.md) | A ClientManager client to use for algod and kmd clients | - -#### Returns - -[`KmdAccountManager`](types_kmd_account_manager.KmdAccountManager.md) - -#### Defined in - -[src/types/kmd-account-manager.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L18) - -## Properties - -### \_clientManager - -• `Private` **\_clientManager**: `Omit`\<[`ClientManager`](types_client_manager.ClientManager.md), ``"kmd"``\> - -#### Defined in - -[src/types/kmd-account-manager.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L11) - -___ - -### \_kmd - -• `Private` `Optional` **\_kmd**: ``null`` \| `KmdClient` - -#### Defined in - -[src/types/kmd-account-manager.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L12) - -## Methods - -### getLocalNetDispenserAccount - -▸ **getLocalNetDispenserAccount**(): `Promise`\<[`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts). - -#### Returns - -`Promise`\<[`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -The default LocalNet dispenser account - -**`Example`** - -```typescript -const dispenser = await kmdAccountManager.getLocalNetDispenserAccount() -``` - -#### Defined in - -[src/types/kmd-account-manager.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L186) - -___ - -### getOrCreateWalletAccount - -▸ **getOrCreateWalletAccount**(`name`, `fundWith?`): `Promise`\<[`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -Gets an account with private key loaded from a KMD wallet of the given name, or alternatively creates one with funds in it via a KMD wallet of the given name. - -This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet). - -This significantly speeds up local dev time and improves experience since you can write code that *just works* first go without manual config in a fresh LocalNet. - -If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development! - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name` | `string` | The name of the wallet to retrieve / create | -| `fundWith?` | [`AlgoAmount`](types_amount.AlgoAmount.md) | The number of Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account | - -#### Returns - -`Promise`\<[`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -An Algorand account with private key loaded - either one that already existed in the given KMD wallet, or a new one that is funded for you - -**`Example`** - -```typescript -// Idempotently get (if exists) or create (if it doesn't exist yet) an account by name using KMD -// if creating it then fund it with 2 ALGO from the default dispenser account -const newAccount = await kmdAccountManager.getOrCreateWalletAccount('account1', (2).algo()) -// This will return the same account as above since the name matches -const existingAccount = await kmdAccountManager.getOrCreateWalletAccount('account1') -``` - -#### Defined in - -[src/types/kmd-account-manager.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L135) - -___ - -### getWalletAccount - -▸ **getWalletAccount**(`walletName`, `predicate?`, `sender?`): `Promise`\<`undefined` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -Returns an Algorand signing account with private key loaded from the given KMD wallet (identified by name). - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `walletName` | `string` | The name of the wallet to retrieve an account from | -| `predicate?` | (`account`: `Record`\<`string`, `any`\>) => `boolean` | An optional filter to use to find the account (otherwise it will return a random account from the wallet) | -| `sender?` | `string` \| `Address` | The optional sender address to use this signer for (aka a rekeyed account) | - -#### Returns - -`Promise`\<`undefined` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\> - -The signing account (with private key loaded) or undefined if no matching wallet or account was found - -**`Example`** - -```typescript -const defaultDispenserAccount = await kmdAccountManager.getWalletAccount( - 'unencrypted-default-wallet', - a => a.status !== 'Offline' && a.amount > 1_000_000_000 -) -``` - -#### Defined in - -[src/types/kmd-account-manager.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L62) - -___ - -### kmd - -▸ **kmd**(): `Promise`\<`KmdClient`\> - -#### Returns - -`Promise`\<`KmdClient`\> - -#### Defined in - -[src/types/kmd-account-manager.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L27) diff --git a/docs/code/classes/types_logic_error.LogicError.md b/docs/code/classes/types_logic_error.LogicError.md deleted file mode 100644 index 38c287bc..00000000 --- a/docs/code/classes/types_logic_error.LogicError.md +++ /dev/null @@ -1,261 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/logic-error](../modules/types_logic_error.md) / LogicError - -# Class: LogicError - -[types/logic-error](../modules/types_logic_error.md).LogicError - -Wraps key functionality around processing logic errors - -## Hierarchy - -- `Error` - - ↳ **`LogicError`** - -## Table of contents - -### Constructors - -- [constructor](types_logic_error.LogicError.md#constructor) - -### Properties - -- [cause](types_logic_error.LogicError.md#cause) -- [led](types_logic_error.LogicError.md#led) -- [lines](types_logic_error.LogicError.md#lines) -- [message](types_logic_error.LogicError.md#message) -- [name](types_logic_error.LogicError.md#name) -- [program](types_logic_error.LogicError.md#program) -- [stack](types_logic_error.LogicError.md#stack) -- [teal\_line](types_logic_error.LogicError.md#teal_line) -- [prepareStackTrace](types_logic_error.LogicError.md#preparestacktrace) -- [stackTraceLimit](types_logic_error.LogicError.md#stacktracelimit) - -### Methods - -- [captureStackTrace](types_logic_error.LogicError.md#capturestacktrace) -- [parseLogicError](types_logic_error.LogicError.md#parselogicerror) - -## Constructors - -### constructor - -• **new LogicError**(`errorDetails`, `program`, `getLineForPc`): [`LogicError`](types_logic_error.LogicError.md) - -Create a new logic error object. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `errorDetails` | [`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md) | The details of the logic error | -| `program` | `string`[] | The TEAL source code, split by line | -| `getLineForPc` | (`pc`: `number`) => `undefined` \| `number` | The source map of the TEAL source code | - -#### Returns - -[`LogicError`](types_logic_error.LogicError.md) - -#### Overrides - -Error.constructor - -#### Defined in - -[src/types/logic-error.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L52) - -## Properties - -### cause - -• `Optional` **cause**: `unknown` - -#### Inherited from - -Error.cause - -#### Defined in - -node_modules/typescript/lib/lib.es2022.error.d.ts:24 - -___ - -### led - -• **led**: [`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md) - -#### Defined in - -[src/types/logic-error.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L40) - -___ - -### lines - -• **lines**: `number` = `5` - -#### Defined in - -[src/types/logic-error.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L42) - -___ - -### message - -• **message**: `string` - -#### Inherited from - -Error.message - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1077 - -___ - -### name - -• **name**: `string` - -#### Inherited from - -Error.name - -#### Defined in - -node_modules/typescript/lib/lib.es5.d.ts:1076 - -___ - -### program - -• **program**: `string`[] - -#### Defined in - -[src/types/logic-error.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L41) - -___ - -### stack - -• `Optional` **stack**: `string` - -#### Overrides - -Error.stack - -#### Defined in - -[src/types/logic-error.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L44) - -___ - -### teal\_line - -• **teal\_line**: `number` = `0` - -#### Defined in - -[src/types/logic-error.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L43) - -___ - -### prepareStackTrace - -▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` - -Optional override for formatting stack traces - -**`See`** - -https://v8.dev/docs/stack-trace-api#customizing-stack-traces - -#### Type declaration - -▸ (`err`, `stackTraces`): `any` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `err` | `Error` | -| `stackTraces` | `CallSite`[] | - -##### Returns - -`any` - -#### Inherited from - -Error.prepareStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:28 - -___ - -### stackTraceLimit - -▪ `Static` **stackTraceLimit**: `number` - -#### Inherited from - -Error.stackTraceLimit - -#### Defined in - -node_modules/@types/node/globals.d.ts:30 - -## Methods - -### captureStackTrace - -▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` - -Create .stack property on a target object - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `targetObject` | `object` | -| `constructorOpt?` | `Function` | - -#### Returns - -`void` - -#### Inherited from - -Error.captureStackTrace - -#### Defined in - -node_modules/@types/node/globals.d.ts:21 - -___ - -### parseLogicError - -▸ **parseLogicError**(`error`): `undefined` \| [`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md) - -Takes an error message and parses out the details of any logic errors in there. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `error` | `any` | The error message to parse | - -#### Returns - -`undefined` \| [`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md) - -The logic error details if any, or undefined - -#### Defined in - -[src/types/logic-error.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L26) diff --git a/docs/code/enums/types_app.OnSchemaBreak.md b/docs/code/enums/types_app.OnSchemaBreak.md deleted file mode 100644 index a8ede69e..00000000 --- a/docs/code/enums/types_app.OnSchemaBreak.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / OnSchemaBreak - -# Enumeration: OnSchemaBreak - -[types/app](../modules/types_app.md).OnSchemaBreak - -What action to perform when deploying an app and a breaking schema change is detected - -## Table of contents - -### Enumeration Members - -- [AppendApp](types_app.OnSchemaBreak.md#appendapp) -- [Fail](types_app.OnSchemaBreak.md#fail) -- [ReplaceApp](types_app.OnSchemaBreak.md#replaceapp) - -## Enumeration Members - -### AppendApp - -• **AppendApp** = ``2`` - -Create a new app - -#### Defined in - -[src/types/app.ts:306](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L306) - -___ - -### Fail - -• **Fail** = ``0`` - -Fail the deployment - -#### Defined in - -[src/types/app.ts:302](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L302) - -___ - -### ReplaceApp - -• **ReplaceApp** = ``1`` - -Delete the app and create a new one in its place - -#### Defined in - -[src/types/app.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L304) diff --git a/docs/code/enums/types_app.OnUpdate.md b/docs/code/enums/types_app.OnUpdate.md deleted file mode 100644 index 88a32ca2..00000000 --- a/docs/code/enums/types_app.OnUpdate.md +++ /dev/null @@ -1,64 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / OnUpdate - -# Enumeration: OnUpdate - -[types/app](../modules/types_app.md).OnUpdate - -What action to perform when deploying an app and an update is detected in the TEAL code - -## Table of contents - -### Enumeration Members - -- [AppendApp](types_app.OnUpdate.md#appendapp) -- [Fail](types_app.OnUpdate.md#fail) -- [ReplaceApp](types_app.OnUpdate.md#replaceapp) -- [UpdateApp](types_app.OnUpdate.md#updateapp) - -## Enumeration Members - -### AppendApp - -• **AppendApp** = ``3`` - -Create a new app - -#### Defined in - -[src/types/app.ts:296](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L296) - -___ - -### Fail - -• **Fail** = ``0`` - -Fail the deployment - -#### Defined in - -[src/types/app.ts:290](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L290) - -___ - -### ReplaceApp - -• **ReplaceApp** = ``2`` - -Delete the app and create a new one in its place - -#### Defined in - -[src/types/app.ts:294](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L294) - -___ - -### UpdateApp - -• **UpdateApp** = ``1`` - -Update the app - -#### Defined in - -[src/types/app.ts:292](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L292) diff --git a/docs/code/enums/types_indexer.AccountStatus.md b/docs/code/enums/types_indexer.AccountStatus.md deleted file mode 100644 index 76e09389..00000000 --- a/docs/code/enums/types_indexer.AccountStatus.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/indexer](../modules/types_indexer.md) / AccountStatus - -# Enumeration: AccountStatus - -[types/indexer](../modules/types_indexer.md).AccountStatus - -Delegation status of the account - -## Table of contents - -### Enumeration Members - -- [NotParticipating](types_indexer.AccountStatus.md#notparticipating) -- [Offline](types_indexer.AccountStatus.md#offline) -- [Online](types_indexer.AccountStatus.md#online) - -## Enumeration Members - -### NotParticipating - -• **NotParticipating** = ``"NotParticipating"`` - -Indicates that the associated account is neither a delegator nor a delegate - -#### Defined in - -[src/types/indexer.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L195) - -___ - -### Offline - -• **Offline** = ``"Offline"`` - -Indicates that the associated account is delegated - -#### Defined in - -[src/types/indexer.ts:191](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L191) - -___ - -### Online - -• **Online** = ``"Online"`` - -Indicates that the associated account used as part of the delegation pool - -#### Defined in - -[src/types/indexer.ts:193](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L193) diff --git a/docs/code/enums/types_indexer.ApplicationOnComplete.md b/docs/code/enums/types_indexer.ApplicationOnComplete.md deleted file mode 100644 index 140a5286..00000000 --- a/docs/code/enums/types_indexer.ApplicationOnComplete.md +++ /dev/null @@ -1,78 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/indexer](../modules/types_indexer.md) / ApplicationOnComplete - -# Enumeration: ApplicationOnComplete - -[types/indexer](../modules/types_indexer.md).ApplicationOnComplete - -Defines the what additional actions occur with the transaction https://dev.algorand.co/reference/rest-apis/indexer/#oncompletion - -## Table of contents - -### Enumeration Members - -- [clear](types_indexer.ApplicationOnComplete.md#clear) -- [closeout](types_indexer.ApplicationOnComplete.md#closeout) -- [delete](types_indexer.ApplicationOnComplete.md#delete) -- [noop](types_indexer.ApplicationOnComplete.md#noop) -- [optin](types_indexer.ApplicationOnComplete.md#optin) -- [update](types_indexer.ApplicationOnComplete.md#update) - -## Enumeration Members - -### clear - -• **clear** = ``"clear"`` - -#### Defined in - -[src/types/indexer.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L170) - -___ - -### closeout - -• **closeout** = ``"closeout"`` - -#### Defined in - -[src/types/indexer.ts:169](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L169) - -___ - -### delete - -• **delete** = ``"delete"`` - -#### Defined in - -[src/types/indexer.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L172) - -___ - -### noop - -• **noop** = ``"noop"`` - -#### Defined in - -[src/types/indexer.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L167) - -___ - -### optin - -• **optin** = ``"optin"`` - -#### Defined in - -[src/types/indexer.ts:168](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L168) - -___ - -### update - -• **update** = ``"update"`` - -#### Defined in - -[src/types/indexer.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L171) diff --git a/docs/code/enums/types_indexer.SignatureType.md b/docs/code/enums/types_indexer.SignatureType.md deleted file mode 100644 index b92d337c..00000000 --- a/docs/code/enums/types_indexer.SignatureType.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/indexer](../modules/types_indexer.md) / SignatureType - -# Enumeration: SignatureType - -[types/indexer](../modules/types_indexer.md).SignatureType - -Type of signature used by an account - -## Table of contents - -### Enumeration Members - -- [lsig](types_indexer.SignatureType.md#lsig) -- [msig](types_indexer.SignatureType.md#msig) -- [sig](types_indexer.SignatureType.md#sig) - -## Enumeration Members - -### lsig - -• **lsig** = ``"lsig"`` - -Logic signature - -#### Defined in - -[src/types/indexer.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L185) - -___ - -### msig - -• **msig** = ``"msig"`` - -Multisig - -#### Defined in - -[src/types/indexer.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L183) - -___ - -### sig - -• **sig** = ``"sig"`` - -Normal signature - -#### Defined in - -[src/types/indexer.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L181) diff --git a/docs/code/enums/types_lifecycle_events.EventType.md b/docs/code/enums/types_lifecycle_events.EventType.md deleted file mode 100644 index cac1b952..00000000 --- a/docs/code/enums/types_lifecycle_events.EventType.md +++ /dev/null @@ -1,32 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/lifecycle-events](../modules/types_lifecycle_events.md) / EventType - -# Enumeration: EventType - -[types/lifecycle-events](../modules/types_lifecycle_events.md).EventType - -## Table of contents - -### Enumeration Members - -- [AppCompiled](types_lifecycle_events.EventType.md#appcompiled) -- [TxnGroupSimulated](types_lifecycle_events.EventType.md#txngroupsimulated) - -## Enumeration Members - -### AppCompiled - -• **AppCompiled** = ``"AppCompiled"`` - -#### Defined in - -[src/types/lifecycle-events.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/lifecycle-events.ts#L5) - -___ - -### TxnGroupSimulated - -• **TxnGroupSimulated** = ``"TxnGroupSimulated"`` - -#### Defined in - -[src/types/lifecycle-events.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/lifecycle-events.ts#L4) diff --git a/docs/code/index/README.md b/docs/code/index/README.md new file mode 100644 index 00000000..d0fb62b3 --- /dev/null +++ b/docs/code/index/README.md @@ -0,0 +1,191 @@ +[**@algorandfoundation/algokit-utils**](../README.md) + +*** + +[@algorandfoundation/algokit-utils](../README.md) / index + +# index + +## Namespaces + +- [indexer](namespaces/indexer/README.md) + +## Type Aliases + +- [~~AccountInformation~~](type-aliases/AccountInformation.md) +- [NumberConverter](type-aliases/NumberConverter.md) +- [SearchForTransactions](type-aliases/SearchForTransactions.md) + +## Variables + +- [ALGORAND\_MIN\_TX\_FEE](variables/ALGORAND_MIN_TX_FEE.md) +- [Config](variables/Config.md) +- [~~getSenderTransactionSigner~~](variables/getSenderTransactionSigner.md) +- [MAX\_APP\_CALL\_ACCOUNT\_REFERENCES](variables/MAX_APP_CALL_ACCOUNT_REFERENCES.md) +- [MAX\_APP\_CALL\_FOREIGN\_REFERENCES](variables/MAX_APP_CALL_FOREIGN_REFERENCES.md) +- [MAX\_TRANSACTION\_GROUP\_SIZE](variables/MAX_TRANSACTION_GROUP_SIZE.md) + +## Functions + +- [algo](functions/algo.md) +- [algos](functions/algos.md) +- [~~assetBulkOptIn~~](functions/assetBulkOptIn.md) +- [~~assetBulkOptOut~~](functions/assetBulkOptOut.md) +- [~~assetOptIn~~](functions/assetOptIn.md) +- [~~assetOptOut~~](functions/assetOptOut.md) +- [~~callApp~~](functions/callApp.md) +- [~~capTransactionFee~~](functions/capTransactionFee.md) +- [~~compileTeal~~](functions/compileTeal.md) +- [~~controlFees~~](functions/controlFees.md) +- [~~createApp~~](functions/createApp.md) +- [~~createAsset~~](functions/createAsset.md) +- [~~decodeAppState~~](functions/decodeAppState.md) +- [~~deployApp~~](functions/deployApp.md) +- [encodeLease](functions/encodeLease.md) +- [~~encodeTransactionNote~~](functions/encodeTransactionNote.md) +- [~~ensureFunded~~](functions/ensureFunded.md) +- [executePaginatedRequest](functions/executePaginatedRequest.md) +- [~~getABIMethodSignature~~](functions/getABIMethodSignature.md) +- [~~getABIReturn~~](functions/getABIReturn.md) +- [getABIReturnValue](functions/getABIReturnValue.md) +- [~~getAccount~~](functions/getAccount.md) +- [~~getAccountAddressAsString~~](functions/getAccountAddressAsString.md) +- [~~getAccountAddressAsUint8Array~~](functions/getAccountAddressAsUint8Array.md) +- [~~getAccountAssetInformation~~](functions/getAccountAssetInformation.md) +- [~~getAccountConfigFromEnvironment~~](functions/getAccountConfigFromEnvironment.md) +- [~~getAccountInformation~~](functions/getAccountInformation.md) +- [~~getAlgoClient~~](functions/getAlgoClient.md) +- [~~getAlgodConfigFromEnvironment~~](functions/getAlgodConfigFromEnvironment.md) +- [~~getAlgoIndexerClient~~](functions/getAlgoIndexerClient.md) +- [~~getAlgoKmdClient~~](functions/getAlgoKmdClient.md) +- [~~getAlgoNodeConfig~~](functions/getAlgoNodeConfig.md) +- [~~getAppArgsForABICall~~](functions/getAppArgsForABICall.md) +- [~~getAppArgsForTransaction~~](functions/getAppArgsForTransaction.md) +- [~~getAppBoxNames~~](functions/getAppBoxNames.md) +- [~~getAppBoxValue~~](functions/getAppBoxValue.md) +- [~~getAppBoxValueFromABIType~~](functions/getAppBoxValueFromABIType.md) +- [~~getAppBoxValues~~](functions/getAppBoxValues.md) +- [~~getAppBoxValuesFromABIType~~](functions/getAppBoxValuesFromABIType.md) +- [~~getAppById~~](functions/getAppById.md) +- [~~getAppClient~~](functions/getAppClient.md) +- [~~getAppClientByCreatorAndName~~](functions/getAppClientByCreatorAndName.md) +- [~~getAppClientById~~](functions/getAppClientById.md) +- [~~getAppDeploymentTransactionNote~~](functions/getAppDeploymentTransactionNote.md) +- [~~getAppGlobalState~~](functions/getAppGlobalState.md) +- [~~getAppLocalState~~](functions/getAppLocalState.md) +- [~~getAppOnCompleteAction~~](functions/getAppOnCompleteAction.md) +- [~~getAtomicTransactionComposerTransactions~~](functions/getAtomicTransactionComposerTransactions.md) +- [~~getBoxReference~~](functions/getBoxReference.md) +- [~~getConfigFromEnvOrDefaults~~](functions/getConfigFromEnvOrDefaults.md) +- [~~getCreatorAppsByName~~](functions/getCreatorAppsByName.md) +- [~~getDefaultLocalNetConfig~~](functions/getDefaultLocalNetConfig.md) +- [~~getDispenserAccount~~](functions/getDispenserAccount.md) +- [~~getIndexerConfigFromEnvironment~~](functions/getIndexerConfigFromEnvironment.md) +- [~~getKmdWalletAccount~~](functions/getKmdWalletAccount.md) +- [~~getLocalNetDispenserAccount~~](functions/getLocalNetDispenserAccount.md) +- [~~getOrCreateKmdWalletAccount~~](functions/getOrCreateKmdWalletAccount.md) +- [~~getSenderAddress~~](functions/getSenderAddress.md) +- [~~getTestNetDispenserApiClient~~](functions/getTestNetDispenserApiClient.md) +- [~~getTransactionParams~~](functions/getTransactionParams.md) +- [~~getTransactionWithSigner~~](functions/getTransactionWithSigner.md) +- [~~isLocalNet~~](functions/isLocalNet.md) +- [~~isMainNet~~](functions/isMainNet.md) +- [~~isSchemaIsBroken~~](functions/isSchemaIsBroken.md) +- [~~isTestNet~~](functions/isTestNet.md) +- [~~lookupAccountByAddress~~](functions/lookupAccountByAddress.md) +- [lookupAccountCreatedApplicationByAddress](functions/lookupAccountCreatedApplicationByAddress.md) +- [lookupAssetHoldings](functions/lookupAssetHoldings.md) +- [~~lookupTransactionById~~](functions/lookupTransactionById.md) +- [microAlgo](functions/microAlgo.md) +- [microAlgos](functions/microAlgos.md) +- [~~mnemonicAccount~~](functions/mnemonicAccount.md) +- [~~mnemonicAccountFromEnvironment~~](functions/mnemonicAccountFromEnvironment.md) +- [~~multisigAccount~~](functions/multisigAccount.md) +- [performAtomicTransactionComposerSimulate](functions/performAtomicTransactionComposerSimulate.md) +- [~~performTemplateSubstitution~~](functions/performTemplateSubstitution.md) +- [~~performTemplateSubstitutionAndCompile~~](functions/performTemplateSubstitutionAndCompile.md) +- [~~persistSourceMaps~~](functions/persistSourceMaps.md) +- [populateAppCallResources](functions/populateAppCallResources.md) +- [prepareGroupForSending](functions/prepareGroupForSending.md) +- [~~randomAccount~~](functions/randomAccount.md) +- [~~rekeyAccount~~](functions/rekeyAccount.md) +- [~~rekeyedAccount~~](functions/rekeyedAccount.md) +- [~~replaceDeployTimeControlParams~~](functions/replaceDeployTimeControlParams.md) +- [searchTransactions](functions/searchTransactions.md) +- [sendAtomicTransactionComposer](functions/sendAtomicTransactionComposer.md) +- [~~sendGroupOfTransactions~~](functions/sendGroupOfTransactions.md) +- [~~sendTransaction~~](functions/sendTransaction.md) +- [~~signTransaction~~](functions/signTransaction.md) +- [~~stripTealComments~~](functions/stripTealComments.md) +- [transactionFees](functions/transactionFees.md) +- [~~transactionSignerAccount~~](functions/transactionSignerAccount.md) +- [~~transferAlgos~~](functions/transferAlgos.md) +- [~~transferAsset~~](functions/transferAsset.md) +- [~~updateApp~~](functions/updateApp.md) +- [waitForConfirmation](functions/waitForConfirmation.md) + +## References + +### ALGOKIT\_DIR + +Re-exports [ALGOKIT_DIR](../types/debugging/variables/ALGOKIT_DIR.md) + +*** + +### AlgorandClient + +Re-exports [AlgorandClient](../types/algorand-client/classes/AlgorandClient.md) + +*** + +### AVMTracesEventData + +Re-exports [AVMTracesEventData](../types/debugging/interfaces/AVMTracesEventData.md) + +*** + +### DEFAULT\_MAX\_SEARCH\_DEPTH + +Re-exports [DEFAULT_MAX_SEARCH_DEPTH](../types/debugging/variables/DEFAULT_MAX_SEARCH_DEPTH.md) + +*** + +### EventDataMap + +Re-exports [EventDataMap](../types/lifecycle-events/type-aliases/EventDataMap.md) + +*** + +### EventType + +Re-exports [EventType](../types/lifecycle-events/enumerations/EventType.md) + +*** + +### SOURCES\_DIR + +Re-exports [SOURCES_DIR](../types/debugging/variables/SOURCES_DIR.md) + +*** + +### TEAL\_FILE\_EXT + +Re-exports [TEAL_FILE_EXT](../types/debugging/variables/TEAL_FILE_EXT.md) + +*** + +### TEAL\_SOURCEMAP\_EXT + +Re-exports [TEAL_SOURCEMAP_EXT](../types/debugging/variables/TEAL_SOURCEMAP_EXT.md) + +*** + +### TealSourceDebugEventData + +Re-exports [TealSourceDebugEventData](../types/debugging/interfaces/TealSourceDebugEventData.md) + +*** + +### TealSourcesDebugEventData + +Re-exports [TealSourcesDebugEventData](../types/debugging/interfaces/TealSourcesDebugEventData.md) diff --git a/docs/code/index/functions/algo.md b/docs/code/index/functions/algo.md new file mode 100644 index 00000000..250ff183 --- /dev/null +++ b/docs/code/index/functions/algo.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / algo + +# Function: algo() + +> **algo**(`algos`): [`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +Defined in: [src/amount.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L68) + +Returns an amount of Algo using AlgoAmount + +## Parameters + +### algos + +The amount of Algo + +`number` | `bigint` + +## Returns + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) diff --git a/docs/code/index/functions/algos.md b/docs/code/index/functions/algos.md new file mode 100644 index 00000000..90133849 --- /dev/null +++ b/docs/code/index/functions/algos.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / algos + +# Function: algos() + +> **algos**(`algos`): [`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +Defined in: [src/amount.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L61) + +Returns an amount of Algo using AlgoAmount + +## Parameters + +### algos + +The amount of Algo + +`number` | `bigint` + +## Returns + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) diff --git a/docs/code/index/functions/assetBulkOptIn.md b/docs/code/index/functions/assetBulkOptIn.md new file mode 100644 index 00000000..b7190ed7 --- /dev/null +++ b/docs/code/index/functions/assetBulkOptIn.md @@ -0,0 +1,47 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / assetBulkOptIn + +# Function: ~~assetBulkOptIn()~~ + +> **assetBulkOptIn**(`optIn`, `algod`): `Promise`\<`Record`\<`number`, `string`\>\> + +Defined in: [src/asset.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L130) + +## Parameters + +### optIn + +[`AssetBulkOptInOutParams`](../../types/asset/interfaces/AssetBulkOptInOutParams.md) + +The bulk opt-in request. + +### algod + +`AlgodClient` + +An instance of the Algodv2 class from the `algosdk` library. + +## Returns + +`Promise`\<`Record`\<`number`, `string`\>\> + +A record object where the keys are the asset IDs and the values are the corresponding transaction IDs for successful opt-ins. + +## Deprecated + +use `algorand.asset.bulkOptIn()` instead + +Opt in to a list of assets on the Algorand blockchain. + +## Throws + +If there is an error during the opt-in process. + +## Example + +```ts +algokit.bulkOptIn({ account: account, assetIds: [12345, 67890] }, algod) +``` diff --git a/docs/code/index/functions/assetBulkOptOut.md b/docs/code/index/functions/assetBulkOptOut.md new file mode 100644 index 00000000..3ac93663 --- /dev/null +++ b/docs/code/index/functions/assetBulkOptOut.md @@ -0,0 +1,47 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / assetBulkOptOut + +# Function: ~~assetBulkOptOut()~~ + +> **assetBulkOptOut**(`optOut`, `algod`): `Promise`\<`Record`\<`number`, `string`\>\> + +Defined in: [src/asset.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L157) + +## Parameters + +### optOut + +[`AssetBulkOptInOutParams`](../../types/asset/interfaces/AssetBulkOptInOutParams.md) + +The bulk opt-out request. + +### algod + +`AlgodClient` + +An instance of the Algodv2 client used to interact with the Algorand blockchain. + +## Returns + +`Promise`\<`Record`\<`number`, `string`\>\> + +A record object containing asset IDs as keys and their corresponding transaction IDs as values. + +## Deprecated + +use `algorand.asset.bulkOptOut()` instead + +Opt out of multiple assets in Algorand blockchain. + +## Throws + +If there is an error during the opt-out process. + +## Example + +```ts +algokit.bulkOptOut({ account: account, assetIds: [12345, 67890] }, algod) +``` diff --git a/docs/code/index/functions/assetOptIn.md b/docs/code/index/functions/assetOptIn.md new file mode 100644 index 00000000..050b1531 --- /dev/null +++ b/docs/code/index/functions/assetOptIn.md @@ -0,0 +1,43 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / assetOptIn + +# Function: ~~assetOptIn()~~ + +> **assetOptIn**(`optIn`, `algod`): `Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +Defined in: [src/asset.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L67) + +## Parameters + +### optIn + +[`AssetOptInParams`](../../types/asset/interfaces/AssetOptInParams.md) + +The opt-in definition + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) + +## Deprecated + +use `algorand.send.assetOptIn()` / `algorand.createTransaction.assetOptIn()` instead + +Opt-in an account to an asset. + +## Example + +```typescript +await algokit.assetOptIn({ account, assetId }, algod) +``` diff --git a/docs/code/index/functions/assetOptOut.md b/docs/code/index/functions/assetOptOut.md new file mode 100644 index 00000000..9337ab42 --- /dev/null +++ b/docs/code/index/functions/assetOptOut.md @@ -0,0 +1,43 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / assetOptOut + +# Function: ~~assetOptOut()~~ + +> **assetOptOut**(`optOut`, `algod`): `Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +Defined in: [src/asset.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L98) + +## Parameters + +### optOut + +[`AssetOptOutParams`](../../types/asset/interfaces/AssetOptOutParams.md) + +The opt-in definition + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) + +## Deprecated + +use `algorand.send.assetOptOut()` / `algorand.createTransaction.assetOptOut()` instead + +Opt-out an account from an asset. + +## Example + +```typescript +await algokit.assetOptOut({ account, assetId, assetCreatorAddress }, algod) +``` diff --git a/docs/code/index/functions/callApp.md b/docs/code/index/functions/callApp.md new file mode 100644 index 00000000..fde49438 --- /dev/null +++ b/docs/code/index/functions/callApp.md @@ -0,0 +1,38 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / callApp + +# Function: ~~callApp()~~ + +> **callApp**(`call`, `algod`): `Promise`\<[`AppCallTransactionResult`](../../types/app/type-aliases/AppCallTransactionResult.md)\> + +Defined in: [src/app.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L187) + +## Parameters + +### call + +[`AppCallParams`](../../types/app/interfaces/AppCallParams.md) + +The call details. + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`AppCallTransactionResult`](../../types/app/type-aliases/AppCallTransactionResult.md)\> + +The result of the call + +## Deprecated + +Use `algorand.send.appUpdate()` / `algorand.createTransaction.appUpdate()` / `algorand.send.appUpdateMethodCall()` +/ `algorand.createTransaction.appUpdateMethodCall()` instead + +Issues a call to a given app. diff --git a/docs/code/index/functions/capTransactionFee.md b/docs/code/index/functions/capTransactionFee.md new file mode 100644 index 00000000..636841e8 --- /dev/null +++ b/docs/code/index/functions/capTransactionFee.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / capTransactionFee + +# Function: ~~capTransactionFee()~~ + +> **capTransactionFee**(`transaction`, `maxAcceptableFee`): `void` + +Defined in: [src/transaction/transaction.ts:1057](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1057) + +## Parameters + +### transaction + +The transaction to cap or suggested params object about to be used to create a transaction + +`Transaction` | `SuggestedParams` + +### maxAcceptableFee + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +The maximum acceptable fee to pay + +## Returns + +`void` + +## Deprecated + +Use `TransactionComposer` and the `maxFee` field in the transaction params instead. + +Limit the acceptable fee to a defined amount of µAlgo. +This also sets the transaction to be flatFee to ensure the transaction only succeeds at +the estimated rate. diff --git a/docs/code/index/functions/compileTeal.md b/docs/code/index/functions/compileTeal.md new file mode 100644 index 00000000..c99177b0 --- /dev/null +++ b/docs/code/index/functions/compileTeal.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / compileTeal + +# Function: ~~compileTeal()~~ + +> **compileTeal**(`tealCode`, `algod`): `Promise`\<[`CompiledTeal`](../../types/app/interfaces/CompiledTeal.md)\> + +Defined in: [src/app.ts:419](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L419) + +## Parameters + +### tealCode + +`string` + +The TEAL code + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`CompiledTeal`](../../types/app/interfaces/CompiledTeal.md)\> + +The information about the compiled file + +## Deprecated + +Use `algorand.app.compileTeal` instead. + +Compiles the given TEAL using algod and returns the result, including source map. diff --git a/docs/code/index/functions/controlFees.md b/docs/code/index/functions/controlFees.md new file mode 100644 index 00000000..49e2d93b --- /dev/null +++ b/docs/code/index/functions/controlFees.md @@ -0,0 +1,47 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / controlFees + +# Function: ~~controlFees()~~ + +> **controlFees**\<`T`\>(`transaction`, `feeControl`): `T` + +Defined in: [src/transaction/transaction.ts:1084](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1084) + +## Type Parameters + +### T + +`T` *extends* `Transaction` \| `SuggestedParams` + +## Parameters + +### transaction + +`T` + +The transaction or suggested params + +### feeControl + +The fee control parameters + +#### fee? + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +#### maxFee? + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +## Returns + +`T` + +## Deprecated + +Use `TransactionComposer` and the `maxFee` and `staticFee` fields in the transaction params instead. + +Allows for control of fees on a `Transaction` or `SuggestedParams` object diff --git a/docs/code/index/functions/createApp.md b/docs/code/index/functions/createApp.md new file mode 100644 index 00000000..61e91198 --- /dev/null +++ b/docs/code/index/functions/createApp.md @@ -0,0 +1,38 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / createApp + +# Function: ~~createApp()~~ + +> **createApp**(`create`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../../types/app/interfaces/AppCompilationResult.md)\> & [`AppCallTransactionResult`](../../types/app/type-aliases/AppCallTransactionResult.md) & [`AppReference`](../../types/app/interfaces/AppReference.md)\> + +Defined in: [src/app.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L44) + +## Parameters + +### create + +[`CreateAppParams`](../../types/app/interfaces/CreateAppParams.md) + +The parameters to create the app with + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<`Partial`\<[`AppCompilationResult`](../../types/app/interfaces/AppCompilationResult.md)\> & [`AppCallTransactionResult`](../../types/app/type-aliases/AppCallTransactionResult.md) & [`AppReference`](../../types/app/interfaces/AppReference.md)\> + +The details of the created app, or the transaction to create it if `skipSending` and the compilation result + +## Deprecated + +Use `algorand.send.appCreate()` / `algorand.createTransaction.appCreate()` / `algorand.send.appCreateMethodCall()` +/ `algorand.createTransaction.appCreateMethodCall()` instead + +Creates a smart contract app, returns the details of the created app. diff --git a/docs/code/index/functions/createAsset.md b/docs/code/index/functions/createAsset.md new file mode 100644 index 00000000..9109222b --- /dev/null +++ b/docs/code/index/functions/createAsset.md @@ -0,0 +1,43 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / createAsset + +# Function: ~~createAsset()~~ + +> **createAsset**(`create`, `algod`): `Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md) & `object`\> + +Defined in: [src/asset.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L23) + +## Parameters + +### create + +[`CreateAssetParams`](../../types/asset/interfaces/CreateAssetParams.md) + +The asset creation definition + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md) & `object`\> + +The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) + +## Deprecated + +use `algorand.send.assetCreate()` / `algorand.createTransaction.assetCreate()` instead + +Create an Algorand Standard Asset (ASA). + +## Example + +```typescript +await algokit.createAsset({ creator: account, total: 1, decimals: 0, name: 'My asset' }, algod) +``` diff --git a/docs/code/index/functions/decodeAppState.md b/docs/code/index/functions/decodeAppState.md new file mode 100644 index 00000000..e9df2952 --- /dev/null +++ b/docs/code/index/functions/decodeAppState.md @@ -0,0 +1,32 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / decodeAppState + +# Function: ~~decodeAppState()~~ + +> **decodeAppState**(`state`): [`AppState`](../../types/app/interfaces/AppState.md) + +Defined in: [src/app.ts:345](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L345) + +## Parameters + +### state + +`object`[] + +A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas` + +## Returns + +[`AppState`](../../types/app/interfaces/AppState.md) + +An object keyeed by the UTF-8 representation of the key with various parsings of the values + +## Deprecated + +Use `AppManager.decodeAppState` instead. + +Converts an array of global/local state values from the algod api to a more friendly +generic object keyed by the UTF-8 value of the key. diff --git a/docs/code/index/functions/deployApp.md b/docs/code/index/functions/deployApp.md new file mode 100644 index 00000000..546b68a4 --- /dev/null +++ b/docs/code/index/functions/deployApp.md @@ -0,0 +1,51 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / deployApp + +# Function: ~~deployApp()~~ + +> **deployApp**(`deployment`, `algod`, `indexer?`): `Promise`\<`Partial`\<[`AppCompilationResult`](../../types/app/interfaces/AppCompilationResult.md)\> & [`ConfirmedTransactionResults`](../../types/transaction/interfaces/ConfirmedTransactionResults.md) & [`AppMetadata`](../../types/app/interfaces/AppMetadata.md) & `object` \| [`ConfirmedTransactionResults`](../../types/transaction/interfaces/ConfirmedTransactionResults.md) & [`AppMetadata`](../../types/app/interfaces/AppMetadata.md) & `object` \| [`AppMetadata`](../../types/app/interfaces/AppMetadata.md) & `object`\> + +Defined in: [src/app-deploy.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L51) + +## Parameters + +### deployment + +[`AppDeploymentParams`](../../types/app/interfaces/AppDeploymentParams.md) + +The arguments to control the app deployment + +### algod + +`AlgodClient` + +An algod client + +### indexer? + +`IndexerClient` + +An indexer client, needed if `existingDeployments` not passed in + +## Returns + +`Promise`\<`Partial`\<[`AppCompilationResult`](../../types/app/interfaces/AppCompilationResult.md)\> & [`ConfirmedTransactionResults`](../../types/transaction/interfaces/ConfirmedTransactionResults.md) & [`AppMetadata`](../../types/app/interfaces/AppMetadata.md) & `object` \| [`ConfirmedTransactionResults`](../../types/transaction/interfaces/ConfirmedTransactionResults.md) & [`AppMetadata`](../../types/app/interfaces/AppMetadata.md) & `object` \| [`AppMetadata`](../../types/app/interfaces/AppMetadata.md) & `object`\> + +The app reference of the new/existing app + +## Deprecated + +Use `algorand.appDeployer.deploy` instead. + +Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions. + +To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md + +**Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`. + +**Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created. + +**Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created. diff --git a/docs/code/index/functions/encodeLease.md b/docs/code/index/functions/encodeLease.md new file mode 100644 index 00000000..c0b9d5c6 --- /dev/null +++ b/docs/code/index/functions/encodeLease.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / encodeLease + +# Function: encodeLease() + +> **encodeLease**(`lease?`): `undefined` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/transaction/transaction.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L74) + +Encodes a transaction lease into a 32-byte array ready to be included in an Algorand transaction. + +## Parameters + +### lease? + +The transaction lease as a string or binary array or null/undefined if there is no lease + +`string` | `Uint8Array`\<`ArrayBufferLike`\> + +## Returns + +`undefined` \| `Uint8Array`\<`ArrayBufferLike`\> + +the transaction lease ready for inclusion in a transaction or `undefined` if there is no lease + +## Throws + +if the length of the data is > 32 bytes or empty + +## Examples + +```ts +algokit.encodeLease('UNIQUE_ID') +``` + +```ts +algokit.encodeLease(new Uint8Array([1, 2, 3])) +``` diff --git a/docs/code/index/functions/encodeTransactionNote.md b/docs/code/index/functions/encodeTransactionNote.md new file mode 100644 index 00000000..d3704177 --- /dev/null +++ b/docs/code/index/functions/encodeTransactionNote.md @@ -0,0 +1,38 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / encodeTransactionNote + +# Function: ~~encodeTransactionNote()~~ + +> **encodeTransactionNote**(`note?`): `undefined` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/transaction/transaction.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L50) + +## Parameters + +### note? + +[`TransactionNote`](../../types/transaction/type-aliases/TransactionNote.md) + +The transaction note + +## Returns + +`undefined` \| `Uint8Array`\<`ArrayBufferLike`\> + +the transaction note ready for inclusion in a transaction + + Case on the value of `data` this either be: + * `null` | `undefined`: `undefined` + * `string`: The string value + * Uint8Array: passthrough + * Arc2TransactionNote object: ARC-0002 compatible transaction note + * Else: The object/value converted into a JSON string representation + +## Deprecated + +Convert your data to a `string` or `Uint8Array`, if using ARC-2 use `TransactionComposer.arc2Note`. + +Encodes a transaction note into a byte array ready to be included in an Algorand transaction. diff --git a/docs/code/index/functions/ensureFunded.md b/docs/code/index/functions/ensureFunded.md new file mode 100644 index 00000000..b41be79b --- /dev/null +++ b/docs/code/index/functions/ensureFunded.md @@ -0,0 +1,53 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / ensureFunded + +# Function: ~~ensureFunded()~~ + +> **ensureFunded**\<`T`\>(`funding`, `algod`, `kmd?`): `Promise`\<`undefined` \| [`EnsureFundedReturnType`](../../types/transfer/interfaces/EnsureFundedReturnType.md)\> + +Defined in: [src/transfer/transfer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L26) + +## Type Parameters + +### T + +`T` *extends* [`EnsureFundedParams`](../../types/transfer/interfaces/EnsureFundedParams.md) + +## Parameters + +### funding + +`T` + +The funding configuration of type `EnsureFundedParams`, including the account to fund, minimum spending balance, and optional parameters. If you set `useDispenserApi` to true, you must also set `ALGOKIT_DISPENSER_ACCESS_TOKEN` in your environment variables. + +### algod + +`AlgodClient` + +An instance of the Algodv2 client. + +### kmd? + +`KmdClient` + +An optional instance of the Kmd client. + +## Returns + +`Promise`\<`undefined` \| [`EnsureFundedReturnType`](../../types/transfer/interfaces/EnsureFundedReturnType.md)\> + +- `EnsureFundedReturnType` if funds were transferred. +- `undefined` if no funds were needed. + +## Deprecated + +Use `algorand.account.ensureFunded()` / `algorand.account.ensureFundedFromEnvironment()` +/ `algorand.account.ensureFundedFromTestNetDispenserApi()` instead + +Funds a given account using a funding source such that it has a certain amount of Algo free to spend (accounting for Algo locked in minimum balance requirement). + +https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr diff --git a/docs/code/index/functions/executePaginatedRequest.md b/docs/code/index/functions/executePaginatedRequest.md new file mode 100644 index 00000000..1725f521 --- /dev/null +++ b/docs/code/index/functions/executePaginatedRequest.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / executePaginatedRequest + +# Function: executePaginatedRequest() + +> **executePaginatedRequest**\<`TResult`, `TRequest`\>(`extractItems`, `buildRequest`): `Promise`\<`TResult`[]\> + +Defined in: [src/indexer-lookup.ts:145](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L145) + +## Type Parameters + +### TResult + +`TResult` + +### TRequest + +`TRequest` *extends* `object` + +## Parameters + +### extractItems + +(`response`) => `TResult`[] + +### buildRequest + +(`nextToken?`) => `TRequest` + +## Returns + +`Promise`\<`TResult`[]\> diff --git a/docs/code/index/functions/getABIMethodSignature.md b/docs/code/index/functions/getABIMethodSignature.md new file mode 100644 index 00000000..3459d3bc --- /dev/null +++ b/docs/code/index/functions/getABIMethodSignature.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getABIMethodSignature + +# Function: ~~getABIMethodSignature()~~ + +> **getABIMethodSignature**(`method`): `string` + +Defined in: [src/app.ts:430](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L430) + +## Parameters + +### method + +The method to return a signature for + +`ABIMethodParams` | `ABIMethod` + +## Returns + +`string` + +The encoded ABI method spec e.g. `method_name(uint64,string)string` + +## Deprecated + +Use `abiMethod.getSignature()` or `new ABIMethod(abiMethodParams).getSignature()` instead. + +Returns the encoded ABI spec for a given ABI Method diff --git a/docs/code/index/functions/getABIReturn.md b/docs/code/index/functions/getABIReturn.md new file mode 100644 index 00000000..9fc40994 --- /dev/null +++ b/docs/code/index/functions/getABIReturn.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getABIReturn + +# Function: ~~getABIReturn()~~ + +> **getABIReturn**(`args?`, `confirmation?`): `undefined` \| [`ABIReturn`](../../types/app/type-aliases/ABIReturn.md) + +Defined in: [src/app.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L235) + +## Parameters + +### args? + +[`AppCallArgs`](../../types/app/type-aliases/AppCallArgs.md) + +The arguments that were used for the call + +### confirmation? + +`PendingTransactionResponse` + +The transaction confirmation from algod + +## Returns + +`undefined` \| [`ABIReturn`](../../types/app/type-aliases/ABIReturn.md) + +The return value for the method call + +## Deprecated + +Use `AppManager.getABIReturn` instead. + +Returns any ABI return values for the given app call arguments and transaction confirmation. diff --git a/docs/code/index/functions/getABIReturnValue.md b/docs/code/index/functions/getABIReturnValue.md new file mode 100644 index 00000000..632dd113 --- /dev/null +++ b/docs/code/index/functions/getABIReturnValue.md @@ -0,0 +1,26 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getABIReturnValue + +# Function: getABIReturnValue() + +> **getABIReturnValue**(`result`): [`ABIReturn`](../../types/app/type-aliases/ABIReturn.md) + +Defined in: [src/transaction/transaction.ts:927](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L927) + +Takes an algosdk `ABIResult` and converts it to an `ABIReturn`. +Converts `bigint`'s for Uint's < 64 to `number` for easier use. + +## Parameters + +### result + +`ABIResult` + +The `ABIReturn` + +## Returns + +[`ABIReturn`](../../types/app/type-aliases/ABIReturn.md) diff --git a/docs/code/index/functions/getAccount.md b/docs/code/index/functions/getAccount.md new file mode 100644 index 00000000..fd1fcadc --- /dev/null +++ b/docs/code/index/functions/getAccount.md @@ -0,0 +1,238 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAccount + +# Function: ~~getAccount()~~ + +## Deprecated + +use `algorand.account.fromEnvironment()` instead +Returns an Algorand account with private key loaded by convention based on the given name identifier. + +Note: This function expects to run in a Node.js environment. + +## Convention: +* **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**, + never commit it into source control and ideally load it via a secret storage service rather than the file system. + If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts) +* **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you + +This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet). + +## Example + +If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: +```typescript +const account = await getAccount({config: getAccountConfigFromEnvironment('ACCOUNT')}, algod) +``` + +If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. + +## Param + +The details of the account to get, either the name identifier (string) or an object with: + * `config`: Account configuration. To get from environment use getAccountConfigFromEnvironment(accountName) OR + * `name`: string: The name identifier of the account (deprecated) + And optionally + * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account + +## Param + +An algod client + +## Param + +An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables + +## Call Signature + +> **getAccount**(`account`, `algod`, `kmdClient?`): `Promise`\<`Account` \| [`SigningAccount`](../../types/account/classes/SigningAccount.md)\> + +Defined in: [src/account/get-account.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account.ts#L41) + +### Parameters + +#### account + +The details of the account to get, either the name identifier (string) or an object with: + * `name`: The name identifier of the account + * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account + +`string` | \{ `fundWith?`: [`AlgoAmount`](../../types/amount/classes/AlgoAmount.md); `name`: `string`; \} + +#### algod + +`AlgodClient` + +An algod client + +#### kmdClient? + +`KmdClient` + +An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables + +### Returns + +`Promise`\<`Account` \| [`SigningAccount`](../../types/account/classes/SigningAccount.md)\> + +The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account) + +### Deprecated + +use `algorand.account.fromEnvironment()` instead +Returns an Algorand account with private key loaded by convention based on the given name identifier. + +Note: This function expects to run in a Node.js environment. + +## Convention: +* **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**, + never commit it into source control and ideally load it via a secret storage service rather than the file system. + If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts) +* **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you + +This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet). + +### Examples + +If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: +```typescript +const account = await getAccount({config: getAccountConfigFromEnvironment('ACCOUNT')}, algod) +``` + +If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. + +If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: +```typescript +const account = await getAccount('ACCOUNT', algod) +``` + +If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. + +### Param + +The details of the account to get, either the name identifier (string) or an object with: + * `config`: Account configuration. To get from environment use getAccountConfigFromEnvironment(accountName) OR + * `name`: string: The name identifier of the account (deprecated) + And optionally + * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account + +### Param + +An algod client + +### Param + +An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables + +### Deprecated + +use `algorand.account.fromEnvironment()` instead + +Returns an Algorand account with private key loaded by convention based on the given name identifier. + +Note: This function expects to run in a Node.js environment. + +## Convention: +* **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**, + never commit it into source control and ideally load it via a secret storage service rather than the file system. + If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts) +* **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you + +This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet). + +## Call Signature + +> **getAccount**(`account`, `algod`, `kmdClient?`): `Promise`\<`Account` \| [`SigningAccount`](../../types/account/classes/SigningAccount.md)\> + +Defined in: [src/account/get-account.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account.ts#L68) + +### Parameters + +#### account + +The details of the account to get, an object with: + * `config`: Account configuration. To get from environment use getAccountConfigFromEnvironment(accountName) + * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account + +##### config + +[`AccountConfig`](../../types/account/interfaces/AccountConfig.md) + +##### fundWith? + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +#### algod + +`AlgodClient` + +An algod client + +#### kmdClient? + +`KmdClient` + +An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables + +### Returns + +`Promise`\<`Account` \| [`SigningAccount`](../../types/account/classes/SigningAccount.md)\> + +The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account) + +### Deprecated + +use `algorand.account.fromEnvironment()` instead +Returns an Algorand account with private key loaded by convention based on the given name identifier. + +Note: This function expects to run in a Node.js environment. + +## Convention: +* **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**, + never commit it into source control and ideally load it via a secret storage service rather than the file system. + If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts) +* **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you + +This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet). + +### Examples + +If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: +```typescript +const account = await getAccount({config: getAccountConfigFromEnvironment('ACCOUNT')}, algod) +``` + +If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. + +If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: +```typescript +const account = await getAccount({config: getAccountConfigFromEnvironment('ACCOUNT')}, algod) +``` + +If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. + +### Param + +The details of the account to get, either the name identifier (string) or an object with: + * `config`: Account configuration. To get from environment use getAccountConfigFromEnvironment(accountName) OR + * `name`: string: The name identifier of the account (deprecated) + And optionally + * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account + +### Param + +An algod client + +### Param + +An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables + +### Deprecated + +use `algorand.account.fromEnvironment()` instead +Returns an Algorand account with private key loaded by convention based on the given name identifier. + +Note: This function expects to run in a Node.js environment. diff --git a/docs/code/index/functions/getAccountAddressAsString.md b/docs/code/index/functions/getAccountAddressAsString.md new file mode 100644 index 00000000..9a257c90 --- /dev/null +++ b/docs/code/index/functions/getAccountAddressAsString.md @@ -0,0 +1,29 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAccountAddressAsString + +# Function: ~~getAccountAddressAsString()~~ + +> **getAccountAddressAsString**(`addressEncodedInB64`): `string` + +Defined in: [src/account/account.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L128) + +## Parameters + +### addressEncodedInB64 + +`string` + +The base64 encoded version of the underlying byte array of the address public key + +## Returns + +`string` + +## Deprecated + +Use `algosdk.encodeAddress` instead. + +Returns the string address of an Algorand account from a base64 encoded version of the underlying byte array of the address public key diff --git a/docs/code/index/functions/getAccountAddressAsUint8Array.md b/docs/code/index/functions/getAccountAddressAsUint8Array.md new file mode 100644 index 00000000..a2a5027d --- /dev/null +++ b/docs/code/index/functions/getAccountAddressAsUint8Array.md @@ -0,0 +1,29 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAccountAddressAsUint8Array + +# Function: ~~getAccountAddressAsUint8Array()~~ + +> **getAccountAddressAsUint8Array**(`account`): `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/account/account.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L117) + +## Parameters + +### account + +Either an account (with private key loaded) or the string address of an account + +`string` | [`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +## Returns + +`Uint8Array`\<`ArrayBufferLike`\> + +## Deprecated + +Use `algosdk.decodeAddress` instead. + +Returns an account's address as a byte array diff --git a/docs/code/index/functions/getAccountAssetInformation.md b/docs/code/index/functions/getAccountAssetInformation.md new file mode 100644 index 00000000..2e8b7bbe --- /dev/null +++ b/docs/code/index/functions/getAccountAssetInformation.md @@ -0,0 +1,53 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAccountAssetInformation + +# Function: ~~getAccountAssetInformation()~~ + +> **getAccountAssetInformation**(`sender`, `assetId`, `algod`): `Promise`\<[`AccountAssetInformation`](../../types/account/type-aliases/AccountAssetInformation.md)\> + +Defined in: [src/account/account.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L201) + +## Parameters + +### sender + +The address of the sender/account to look up + +`string` | [`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +### assetId + +The ID of the asset to return a holding for + +`number` | `bigint` + +### algod + +`AlgodClient` + +The algod instance + +## Returns + +`Promise`\<[`AccountAssetInformation`](../../types/account/type-aliases/AccountAssetInformation.md)\> + +The account asset holding information + +## Deprecated + +Use `algorand.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead. + +Returns the given sender account's asset holding for a given asset. + +## Example + +```typescript +const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; +const assetId = 123345; +const accountInfo = await account.getAccountAssetInformation(address, assetId, algod); +``` + +[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation) diff --git a/docs/code/index/functions/getAccountConfigFromEnvironment.md b/docs/code/index/functions/getAccountConfigFromEnvironment.md new file mode 100644 index 00000000..4ca32b42 --- /dev/null +++ b/docs/code/index/functions/getAccountConfigFromEnvironment.md @@ -0,0 +1,36 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAccountConfigFromEnvironment + +# Function: ~~getAccountConfigFromEnvironment()~~ + +> **getAccountConfigFromEnvironment**(`accountName`): [`AccountConfig`](../../types/account/interfaces/AccountConfig.md) + +Defined in: [src/account/get-account-config-from-environment.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account-config-from-environment.ts#L13) + +## Parameters + +### accountName + +`string` + +account name + +## Returns + +[`AccountConfig`](../../types/account/interfaces/AccountConfig.md) + +## Deprecated + +Use algokit.mnemonicAccountFromEnvironment, which doesn't need this function +Returns the Account configuration from environment variables + +## Example + +```ts +environment variables +{accountName}_MNEMONIC +{accountName}_SENDER +``` diff --git a/docs/code/index/functions/getAccountInformation.md b/docs/code/index/functions/getAccountInformation.md new file mode 100644 index 00000000..fc281b80 --- /dev/null +++ b/docs/code/index/functions/getAccountInformation.md @@ -0,0 +1,46 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAccountInformation + +# Function: ~~getAccountInformation()~~ + +> **getAccountInformation**(`sender`, `algod`): `Promise`\<[`AccountInformation`](../type-aliases/AccountInformation.md)\> + +Defined in: [src/account/account.ts:156](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L156) + +## Parameters + +### sender + +The address of the sender/account to look up + +`string` | [`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +### algod + +`AlgodClient` + +The algod instance + +## Returns + +`Promise`\<[`AccountInformation`](../type-aliases/AccountInformation.md)\> + +The account information + +## Deprecated + +Use `algorand.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead. + +Returns the given sender account's current status, balance and spendable amounts. + +## Example + +```typescript +const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; +const accountInfo = await account.getInformation(address, algod); +``` + +[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountinformation) diff --git a/docs/code/index/functions/getAlgoClient.md b/docs/code/index/functions/getAlgoClient.md new file mode 100644 index 00000000..8ca7fceb --- /dev/null +++ b/docs/code/index/functions/getAlgoClient.md @@ -0,0 +1,53 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAlgoClient + +# Function: ~~getAlgoClient()~~ + +> **getAlgoClient**(`config?`): `AlgodClient` + +Defined in: [src/network-client.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L88) + +## Parameters + +### config? + +[`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +The config if you want to override the default (getting config from process.env) + +## Returns + +`AlgodClient` + +## Deprecated + +Use `ClientManager.getAlgodClient(config)` or `ClientManager.getAlgodClientFromEnvironment()` instead. + +Returns an algod SDK client that automatically retries transient failures on idempotent calls + +## Examples + +```typescript + // Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN + // Automatically detects if you are using PureStake to switch in the right header name for ALGOD_TOKEN + const algod = getAlgoClient() + await algod.healthCheck().do() + ``` + +```typescript + const algod = getAlgoClient(getAlgoNodeConfig('testnet', 'algod')) + await algod.healthCheck().do() +``` + +```typescript + const algod = getAlgoClient(getAlgoNodeConfig('mainnet', 'algod')) + await algod.healthCheck().do() +``` + +```typescript + const algod = getAlgoClient({server: 'http://localhost', port: '4001', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) + await algod.healthCheck().do() +``` diff --git a/docs/code/index/functions/getAlgoIndexerClient.md b/docs/code/index/functions/getAlgoIndexerClient.md new file mode 100644 index 00000000..9f58389d --- /dev/null +++ b/docs/code/index/functions/getAlgoIndexerClient.md @@ -0,0 +1,52 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAlgoIndexerClient + +# Function: ~~getAlgoIndexerClient()~~ + +> **getAlgoIndexerClient**(`config?`): `IndexerClient` + +Defined in: [src/network-client.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L121) + +## Parameters + +### config? + +[`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +The config if you want to override the default (getting config from process.env) + +## Returns + +`IndexerClient` + +## Deprecated + +Use `ClientManager.getIndexerClient(config, overrideIntDecoding)` or `ClientManager.getIndexerClientFromEnvironment(overrideIntDecoding)` instead. + +Returns an indexer SDK client that automatically retries transient failures on idempotent calls + +## Examples + +```typescript + // Uses process.env.INDEXER_SERVER, process.env.INDEXER_PORT and process.env.INDEXER_TOKEN + const indexer = getAlgoIndexerClient() + await indexer.makeHealthCheck().do() + ``` + +```typescript + const indexer = getAlgoIndexerClient(getAlgoNodeConfig('testnet', 'indexer')) + await indexer.makeHealthCheck().do() +``` + +```typescript + const indexer = getAlgoIndexerClient(getAlgoNodeConfig('mainnet', 'indexer')) + await indexer.makeHealthCheck().do() +``` + +```typescript + const indexer = getAlgoIndexerClient({server: 'http://localhost', port: '8980', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) + await indexer.makeHealthCheck().do() +``` diff --git a/docs/code/index/functions/getAlgoKmdClient.md b/docs/code/index/functions/getAlgoKmdClient.md new file mode 100644 index 00000000..7b8bad8d --- /dev/null +++ b/docs/code/index/functions/getAlgoKmdClient.md @@ -0,0 +1,42 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAlgoKmdClient + +# Function: ~~getAlgoKmdClient()~~ + +> **getAlgoKmdClient**(`config?`): `KmdClient` + +Defined in: [src/network-client.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L144) + +## Parameters + +### config? + +[`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +The config if you want to override the default (getting config from process.env) + +## Returns + +`KmdClient` + +## Deprecated + +Use `ClientManager.getKmdClient(config)` or `ClientManager.getKmdClientFromEnvironment()` instead. + +Returns a KMD SDK client that automatically retries transient failures on idempotent calls. + +KMD client allows you to export private keys, which is useful to get the default account in a LocalNet network. + +## Examples + +```typescript + // Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN + const kmd = getAlgoKmdClient() + ``` + +```typescript + const kmd = getAlgoKmdClient({server: 'http://localhost', port: '4002', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) +``` diff --git a/docs/code/index/functions/getAlgoNodeConfig.md b/docs/code/index/functions/getAlgoNodeConfig.md new file mode 100644 index 00000000..d78e5ae8 --- /dev/null +++ b/docs/code/index/functions/getAlgoNodeConfig.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAlgoNodeConfig + +# Function: ~~getAlgoNodeConfig()~~ + +> **getAlgoNodeConfig**(`network`, `config`): [`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/network-client.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L43) + +## Parameters + +### network + +Which network to connect to - TestNet or MainNet + +`"testnet"` | `"mainnet"` + +### config + +Which algod config to return - Algod or Indexer + +`"algod"` | `"indexer"` + +## Returns + +[`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +## Deprecated + +Use `ClientManager.getAlgoNodeConfig(network, config)` instead. + +Returns the Algorand configuration to point to the AlgoNode service diff --git a/docs/code/index/functions/getAlgodConfigFromEnvironment.md b/docs/code/index/functions/getAlgodConfigFromEnvironment.md new file mode 100644 index 00000000..c8b66964 --- /dev/null +++ b/docs/code/index/functions/getAlgodConfigFromEnvironment.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAlgodConfigFromEnvironment + +# Function: ~~getAlgodConfigFromEnvironment()~~ + +> **getAlgodConfigFromEnvironment**(): [`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/network-client.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L22) + +## Returns + +[`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +## Deprecated + +Use `ClientManager.getAlgodConfigFromEnvironment()` instead. + +Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment not algod-side) diff --git a/docs/code/index/functions/getAppArgsForABICall.md b/docs/code/index/functions/getAppArgsForABICall.md new file mode 100644 index 00000000..b7dc06bc --- /dev/null +++ b/docs/code/index/functions/getAppArgsForABICall.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppArgsForABICall + +# Function: ~~getAppArgsForABICall()~~ + +> **getAppArgsForABICall**(`args`, `from`): `Promise`\<\{ `appAccounts`: `undefined` \| `string`[]; `appForeignApps`: `undefined` \| `number`[]; `appForeignAssets`: `undefined` \| `number`[]; `boxes`: `undefined` \| `BoxReference`[]; `lease`: `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>; `method`: `ABIMethod`; `methodArgs`: (`string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| `TransactionWithSigner`)[]; `rekeyTo`: `undefined` \| `string`; `sender`: `string`; `signer`: `TransactionSigner`; \}\> + +Defined in: [src/app.ts:378](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L378) + +## Parameters + +### args + +[`ABIAppCallArgs`](../../types/app/type-aliases/ABIAppCallArgs.md) + +The ABI app call args + +### from + +[`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +The transaction signer + +## Returns + +`Promise`\<\{ `appAccounts`: `undefined` \| `string`[]; `appForeignApps`: `undefined` \| `number`[]; `appForeignAssets`: `undefined` \| `number`[]; `boxes`: `undefined` \| `BoxReference`[]; `lease`: `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>; `method`: `ABIMethod`; `methodArgs`: (`string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| `TransactionWithSigner`)[]; `rekeyTo`: `undefined` \| `string`; `sender`: `string`; `signer`: `TransactionSigner`; \}\> + +The parameters ready to pass into `addMethodCall` within AtomicTransactionComposer + +## Deprecated + +Use `TransactionComposer` methods to construct transactions instead. + +Returns the app args ready to load onto an ABI method call in `AtomicTransactionComposer` diff --git a/docs/code/index/functions/getAppArgsForTransaction.md b/docs/code/index/functions/getAppArgsForTransaction.md new file mode 100644 index 00000000..07162a29 --- /dev/null +++ b/docs/code/index/functions/getAppArgsForTransaction.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppArgsForTransaction + +# Function: ~~getAppArgsForTransaction()~~ + +> **getAppArgsForTransaction**(`args?`): `undefined` \| \{ `accounts`: `undefined` \| `string`[]; `appArgs`: `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>[]; `boxes`: `undefined` \| `BoxReference`[]; `foreignApps`: `undefined` \| `number`[]; `foreignAssets`: `undefined` \| `number`[]; `lease`: `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>; \} + +Defined in: [src/app.ts:356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L356) + +## Parameters + +### args? + +[`RawAppCallArgs`](../../types/app/interfaces/RawAppCallArgs.md) + +The app call args + +## Returns + +`undefined` \| \{ `accounts`: `undefined` \| `string`[]; `appArgs`: `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>[]; `boxes`: `undefined` \| `BoxReference`[]; `foreignApps`: `undefined` \| `number`[]; `foreignAssets`: `undefined` \| `number`[]; `lease`: `undefined` \| `Uint8Array`\<`ArrayBufferLike`\>; \} + +The args ready to load into a `Transaction` + +## Deprecated + +Use `TransactionComposer` methods to construct transactions instead. + +Returns the app args ready to load onto an app `Transaction` object diff --git a/docs/code/index/functions/getAppBoxNames.md b/docs/code/index/functions/getAppBoxNames.md new file mode 100644 index 00000000..ea479286 --- /dev/null +++ b/docs/code/index/functions/getAppBoxNames.md @@ -0,0 +1,36 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppBoxNames + +# Function: ~~getAppBoxNames()~~ + +> **getAppBoxNames**(`appId`, `algod`): `Promise`\<[`BoxName`](../../types/app/interfaces/BoxName.md)[]\> + +Defined in: [src/app.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L276) + +## Parameters + +### appId + +The ID of the app return box names for + +`number` | `bigint` + +### algod + +`AlgodClient` + +An algod client instance + +## Returns + +`Promise`\<[`BoxName`](../../types/app/interfaces/BoxName.md)[]\> + +The current box names + +## Deprecated + +Use `algorand.app.getBoxNames` instead. +Returns the names of the boxes for the given app. diff --git a/docs/code/index/functions/getAppBoxValue.md b/docs/code/index/functions/getAppBoxValue.md new file mode 100644 index 00000000..e2b58543 --- /dev/null +++ b/docs/code/index/functions/getAppBoxValue.md @@ -0,0 +1,42 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppBoxValue + +# Function: ~~getAppBoxValue()~~ + +> **getAppBoxValue**(`appId`, `boxName`, `algod`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +Defined in: [src/app.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L288) + +## Parameters + +### appId + +The ID of the app return box names for + +`number` | `bigint` + +### boxName + +The name of the box to return either as a string, binary array or `BoxName` + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BoxName`](../../types/app/interfaces/BoxName.md) + +### algod + +`AlgodClient` + +An algod client instance + +## Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +The current box value as a byte array + +## Deprecated + +Use `algorand.app.getBoxValue` instead. +Returns the value of the given box name for the given app. diff --git a/docs/code/index/functions/getAppBoxValueFromABIType.md b/docs/code/index/functions/getAppBoxValueFromABIType.md new file mode 100644 index 00000000..262fd62c --- /dev/null +++ b/docs/code/index/functions/getAppBoxValueFromABIType.md @@ -0,0 +1,36 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppBoxValueFromABIType + +# Function: ~~getAppBoxValueFromABIType()~~ + +> **getAppBoxValueFromABIType**(`request`, `algod`): `Promise`\<`ABIValue`\> + +Defined in: [src/app.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L314) + +## Parameters + +### request + +[`BoxValueRequestParams`](../../types/app/interfaces/BoxValueRequestParams.md) + +The parameters for the box value request + +### algod + +`AlgodClient` + +An algod client instance + +## Returns + +`Promise`\<`ABIValue`\> + +The current box value as an ABI value + +## Deprecated + +Use `algorand.app.getBoxValueFromABIType` instead. +Returns the value of the given box name for the given app decoded based on the given ABI type. diff --git a/docs/code/index/functions/getAppBoxValues.md b/docs/code/index/functions/getAppBoxValues.md new file mode 100644 index 00000000..b66c5264 --- /dev/null +++ b/docs/code/index/functions/getAppBoxValues.md @@ -0,0 +1,42 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppBoxValues + +# Function: ~~getAppBoxValues()~~ + +> **getAppBoxValues**(`appId`, `boxNames`, `algod`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>[]\> + +Defined in: [src/app.ts:300](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L300) + +## Parameters + +### appId + +`number` + +The ID of the app return box names for + +### boxNames + +(`string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`BoxName`](../../types/app/interfaces/BoxName.md))[] + +The names of the boxes to return either as a string, binary array or `BoxName` + +### algod + +`AlgodClient` + +An algod client instance + +## Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>[]\> + +The current box values as a byte array in the same order as the passed in box names + +## Deprecated + +Use `algorand.app.getBoxValues` instead. +Returns the value of the given box names for the given app. diff --git a/docs/code/index/functions/getAppBoxValuesFromABIType.md b/docs/code/index/functions/getAppBoxValuesFromABIType.md new file mode 100644 index 00000000..2a016d69 --- /dev/null +++ b/docs/code/index/functions/getAppBoxValuesFromABIType.md @@ -0,0 +1,36 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppBoxValuesFromABIType + +# Function: ~~getAppBoxValuesFromABIType()~~ + +> **getAppBoxValuesFromABIType**(`request`, `algod`): `Promise`\<`ABIValue`[]\> + +Defined in: [src/app.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L329) + +## Parameters + +### request + +[`BoxValuesRequestParams`](../../types/app/interfaces/BoxValuesRequestParams.md) + +The parameters for the box value request + +### algod + +`AlgodClient` + +An algod client instance + +## Returns + +`Promise`\<`ABIValue`[]\> + +The current box values as an ABI value in the same order as the passed in box names + +## Deprecated + +Use `algorand.app.getBoxValuesFromABIType` instead. +Returns the value of the given box names for the given app decoded based on the given ABI type. diff --git a/docs/code/index/functions/getAppById.md b/docs/code/index/functions/getAppById.md new file mode 100644 index 00000000..844245ba --- /dev/null +++ b/docs/code/index/functions/getAppById.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppById + +# Function: ~~getAppById()~~ + +> **getAppById**(`appId`, `algod`): `Promise`\<`Application`\> + +Defined in: [src/app.ts:406](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L406) + +## Parameters + +### appId + +The id of the app + +`number` | `bigint` + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<`Application`\> + +The data about the app + +## Deprecated + +Use `algorand.app.getById` instead. + +Gets the current data for the given app from algod. diff --git a/docs/code/index/functions/getAppClient.md b/docs/code/index/functions/getAppClient.md new file mode 100644 index 00000000..26231162 --- /dev/null +++ b/docs/code/index/functions/getAppClient.md @@ -0,0 +1,69 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppClient + +# Function: ~~getAppClient()~~ + +> **getAppClient**(`appDetails`, `algod`): [`ApplicationClient`](../../types/app-client/classes/ApplicationClient.md) + +Defined in: [src/app-client.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L40) + +## Parameters + +### appDetails + +[`AppSpecAppDetails`](../../types/app-client/type-aliases/AppSpecAppDetails.md) + +The details of the app + +### algod + +`AlgodClient` + +An algod instance + +## Returns + +[`ApplicationClient`](../../types/app-client/classes/ApplicationClient.md) + +The application client + +## Deprecated + +Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or +`algorand.client.getAppClientByCreatorAndName`. +If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, +which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. + +Create a new ApplicationClient instance + +## Examples + +```ts +Resolve by creator and name +const client = algokit.getAppClient( + { + resolveBy: 'creatorAndName', + app: {appSpec}, + sender: {account}, + creatorAddress: {creator}, + findExistingUsing: indexerClient, + }, + algodClient, + ) +``` + +```ts +Resolve by id: +const client = algokit.getAppClient( + { + resolveBy: 'id', + app: {appSpec}, + sender: {account}, + id: {id}, + }, + algodClient, +) +``` diff --git a/docs/code/index/functions/getAppClientByCreatorAndName.md b/docs/code/index/functions/getAppClientByCreatorAndName.md new file mode 100644 index 00000000..7f0b9699 --- /dev/null +++ b/docs/code/index/functions/getAppClientByCreatorAndName.md @@ -0,0 +1,53 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppClientByCreatorAndName + +# Function: ~~getAppClientByCreatorAndName()~~ + +> **getAppClientByCreatorAndName**(`appDetails`, `algod`): [`ApplicationClient`](../../types/app-client/classes/ApplicationClient.md) + +Defined in: [src/app-client.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L93) + +## Parameters + +### appDetails + +[`AppSpecAppDetailsByCreatorAndName`](../../types/app-client/type-aliases/AppSpecAppDetailsByCreatorAndName.md) + +The details of the app by creator and name + +### algod + +`AlgodClient` + +An algod instance + +## Returns + +[`ApplicationClient`](../../types/app-client/classes/ApplicationClient.md) + +The application client + +## Deprecated + +Use `AppClient` instead e.g. via `algorand.client.getAppClientByCreatorAndName`. +If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, +which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. + +Create a new ApplicationClient instance by creator and name + +## Example + +```ts +const client = algokit.getAppClientByCreatorAndName( + { + app: appSpec, + sender: account, + creatorAddress: account, + findExistingUsing: indexerClient, + }, + algodClient, + ) +``` diff --git a/docs/code/index/functions/getAppClientById.md b/docs/code/index/functions/getAppClientById.md new file mode 100644 index 00000000..cb0f1d03 --- /dev/null +++ b/docs/code/index/functions/getAppClientById.md @@ -0,0 +1,52 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppClientById + +# Function: ~~getAppClientById()~~ + +> **getAppClientById**(`appDetails`, `algod`): [`ApplicationClient`](../../types/app-client/classes/ApplicationClient.md) + +Defined in: [src/app-client.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L66) + +## Parameters + +### appDetails + +[`AppSpecAppDetailsById`](../../types/app-client/type-aliases/AppSpecAppDetailsById.md) + +The details of the app + +### algod + +`AlgodClient` + +An algod instance + +## Returns + +[`ApplicationClient`](../../types/app-client/classes/ApplicationClient.md) + +The application client + +## Deprecated + +Use `AppClient` instead e.g. via `algorand.client.getAppClientById`. +If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, +which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. + +Create a new ApplicationClient instance by id + +## Example + +```ts +const client = algokit.getAppClientById( + { + app: {appSpec}, + sender: {account}, + id: {id}, + }, + algodClient, + ) +``` diff --git a/docs/code/index/functions/getAppDeploymentTransactionNote.md b/docs/code/index/functions/getAppDeploymentTransactionNote.md new file mode 100644 index 00000000..4f9c1307 --- /dev/null +++ b/docs/code/index/functions/getAppDeploymentTransactionNote.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppDeploymentTransactionNote + +# Function: ~~getAppDeploymentTransactionNote()~~ + +> **getAppDeploymentTransactionNote**(`metadata`): [`Arc2TransactionNote`](../../types/transaction/type-aliases/Arc2TransactionNote.md) + +Defined in: [src/app-deploy.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L271) + +## Parameters + +### metadata + +[`AppDeployMetadata`](../../types/app/interfaces/AppDeployMetadata.md) + +The metadata of the deployment + +## Returns + +[`Arc2TransactionNote`](../../types/transaction/type-aliases/Arc2TransactionNote.md) + +The transaction note as a utf-8 string + +## Deprecated + +Use `{ dAppName: APP_DEPLOY_NOTE_DAPP, data: metadata, format: 'j' }` instead. + +Return the transaction note for an app deployment. diff --git a/docs/code/index/functions/getAppGlobalState.md b/docs/code/index/functions/getAppGlobalState.md new file mode 100644 index 00000000..2674bdde --- /dev/null +++ b/docs/code/index/functions/getAppGlobalState.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppGlobalState + +# Function: ~~getAppGlobalState()~~ + +> **getAppGlobalState**(`appId`, `algod`): `Promise`\<[`AppState`](../../types/app/interfaces/AppState.md)\> + +Defined in: [src/app.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L252) + +## Parameters + +### appId + +The ID of the app return global state for + +`number` | `bigint` + +### algod + +`AlgodClient` + +An algod client instance + +## Returns + +`Promise`\<[`AppState`](../../types/app/interfaces/AppState.md)\> + +The current global state + +## Deprecated + +Use `algorand.app.getGlobalState` instead. + +Returns the current global state values for the given app ID diff --git a/docs/code/index/functions/getAppLocalState.md b/docs/code/index/functions/getAppLocalState.md new file mode 100644 index 00000000..6d8d13f7 --- /dev/null +++ b/docs/code/index/functions/getAppLocalState.md @@ -0,0 +1,43 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppLocalState + +# Function: ~~getAppLocalState()~~ + +> **getAppLocalState**(`appId`, `account`, `algod`): `Promise`\<[`AppState`](../../types/app/interfaces/AppState.md)\> + +Defined in: [src/app.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L265) + +## Parameters + +### appId + +The ID of the app return global state for + +`number` | `bigint` + +### account + +Either the string address of an account or an account object for the account to get local state for the given app + +`string` | [`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +### algod + +`AlgodClient` + +An algod client instance + +## Returns + +`Promise`\<[`AppState`](../../types/app/interfaces/AppState.md)\> + +The current local state for the given (app, account) combination + +## Deprecated + +Use `algorand.app.getLocalState` instead. + +Returns the current global state values for the given app ID and account diff --git a/docs/code/index/functions/getAppOnCompleteAction.md b/docs/code/index/functions/getAppOnCompleteAction.md new file mode 100644 index 00000000..09679f45 --- /dev/null +++ b/docs/code/index/functions/getAppOnCompleteAction.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAppOnCompleteAction + +# Function: ~~getAppOnCompleteAction()~~ + +> **getAppOnCompleteAction**(`onCompletionAction?`): `OnApplicationComplete` + +Defined in: [src/app.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L154) + +## Parameters + +### onCompletionAction? + +The on completion action + +[`AppCallType`](../../types/app/type-aliases/AppCallType.md) | `OnApplicationComplete` + +## Returns + +`OnApplicationComplete` + +The `algosdk.OnApplicationComplete` + +## Deprecated + +Use `algosdk.OnApplicationComplete` directly instead. + +Returns a `algosdk.OnApplicationComplete` for the given onCompleteAction. + +If given `undefined` will return `OnApplicationComplete.NoOpOC`. + +If given an `AppCallType` will convert the string enum to the correct underlying `algosdk.OnApplicationComplete`. diff --git a/docs/code/index/functions/getAtomicTransactionComposerTransactions.md b/docs/code/index/functions/getAtomicTransactionComposerTransactions.md new file mode 100644 index 00000000..fafcb373 --- /dev/null +++ b/docs/code/index/functions/getAtomicTransactionComposerTransactions.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getAtomicTransactionComposerTransactions + +# Function: ~~getAtomicTransactionComposerTransactions()~~ + +> **getAtomicTransactionComposerTransactions**(`atc`): `TransactionWithSigner`[] + +Defined in: [src/transaction/transaction.ts:1133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1133) + +## Parameters + +### atc + +`AtomicTransactionComposer` + +The atomic transaction composer + +## Returns + +`TransactionWithSigner`[] + +The array of transactions with signers + +## Deprecated + +Use `atc.clone().buildGroup()` instead. + +Returns the array of transactions currently present in the given `AtomicTransactionComposer` diff --git a/docs/code/index/functions/getBoxReference.md b/docs/code/index/functions/getBoxReference.md new file mode 100644 index 00000000..e7671075 --- /dev/null +++ b/docs/code/index/functions/getBoxReference.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getBoxReference + +# Function: ~~getBoxReference()~~ + +> **getBoxReference**(`box`): `BoxReference` + +Defined in: [src/app.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L389) + +## Parameters + +### box + +The box to return a reference for + +[`BoxReference`](../../types/app/interfaces/BoxReference.md) | [`BoxIdentifier`](../../types/app/type-aliases/BoxIdentifier.md) | `BoxReference` + +## Returns + +`BoxReference` + +The box reference ready to pass into a `Transaction` + +## Deprecated + +Use `AppManager.getBoxReference()` instead. + +Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`. diff --git a/docs/code/index/functions/getConfigFromEnvOrDefaults.md b/docs/code/index/functions/getConfigFromEnvOrDefaults.md new file mode 100644 index 00000000..8d3196f9 --- /dev/null +++ b/docs/code/index/functions/getConfigFromEnvOrDefaults.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getConfigFromEnvOrDefaults + +# Function: ~~getConfigFromEnvOrDefaults()~~ + +> **getConfigFromEnvOrDefaults**(): [`AlgoConfig`](../../types/network-client/interfaces/AlgoConfig.md) + +Defined in: [src/network-client.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L13) + +## Returns + +[`AlgoConfig`](../../types/network-client/interfaces/AlgoConfig.md) + +## Deprecated + +Use `ClientManager.getConfigFromEnvironmentOrLocalNet()` instead. + +Retrieve configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment not algod-side) diff --git a/docs/code/index/functions/getCreatorAppsByName.md b/docs/code/index/functions/getCreatorAppsByName.md new file mode 100644 index 00000000..e21fa6cc --- /dev/null +++ b/docs/code/index/functions/getCreatorAppsByName.md @@ -0,0 +1,39 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getCreatorAppsByName + +# Function: ~~getCreatorAppsByName()~~ + +> **getCreatorAppsByName**(`creatorAccount`, `indexer`): `Promise`\<[`AppLookup`](../../types/app/interfaces/AppLookup.md)\> + +Defined in: [src/app-deploy.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L244) + +## Parameters + +### creatorAccount + +The account (with private key loaded) or string address of an account that is the creator of the apps you want to search for + +`string` | [`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +### indexer + +`IndexerClient` + +An indexer client + +## Returns + +`Promise`\<[`AppLookup`](../../types/app/interfaces/AppLookup.md)\> + +A name-based lookup of the app information (id, address) + +## Deprecated + +Use `algorand.appDeployer.getCreatorAppsByName` instead. + +Returns a lookup of name => app metadata (id, address, ...metadata) for all apps created by the given account that have an `AppDeployNote` in the transaction note of the creation transaction. + +**Note:** It's recommended this is only called once and then stored since it's a somewhat expensive operation (multiple indexer calls). diff --git a/docs/code/index/functions/getDefaultLocalNetConfig.md b/docs/code/index/functions/getDefaultLocalNetConfig.md new file mode 100644 index 00000000..97351b7e --- /dev/null +++ b/docs/code/index/functions/getDefaultLocalNetConfig.md @@ -0,0 +1,29 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getDefaultLocalNetConfig + +# Function: ~~getDefaultLocalNetConfig()~~ + +> **getDefaultLocalNetConfig**(`configOrPort`): [`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/network-client.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L54) + +## Parameters + +### configOrPort + +Which algod config to return - algod, kmd, or indexer OR a port number + +`number` | `"algod"` | `"indexer"` | `"kmd"` + +## Returns + +[`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +## Deprecated + +Use `ClientManager.getDefaultLocalNetConfig(configOrPort)` instead. + +Returns the Algorand configuration to point to the default LocalNet diff --git a/docs/code/index/functions/getDispenserAccount.md b/docs/code/index/functions/getDispenserAccount.md new file mode 100644 index 00000000..36315153 --- /dev/null +++ b/docs/code/index/functions/getDispenserAccount.md @@ -0,0 +1,38 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getDispenserAccount + +# Function: ~~getDispenserAccount()~~ + +> **getDispenserAccount**(`algod`, `kmd?`): `Promise`\<`Address` & [`TransactionSignerAccount`](../../types/account/interfaces/TransactionSignerAccount.md) & `object`\> + +Defined in: [src/account/get-dispenser-account.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-dispenser-account.ts#L19) + +## Parameters + +### algod + +`AlgodClient` + +An algod client + +### kmd? + +`KmdClient` + +A KMD client, if not specified then a default KMD client will be loaded from environment variables + +## Returns + +`Promise`\<`Address` & [`TransactionSignerAccount`](../../types/account/interfaces/TransactionSignerAccount.md) & `object`\> + +## Deprecated + +Use `algorand.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead + +Returns an account (with private key loaded) that can act as a dispenser + +If running on LocalNet then it will return the default dispenser account automatically, + otherwise it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC diff --git a/docs/code/index/functions/getIndexerConfigFromEnvironment.md b/docs/code/index/functions/getIndexerConfigFromEnvironment.md new file mode 100644 index 00000000..db9a60bb --- /dev/null +++ b/docs/code/index/functions/getIndexerConfigFromEnvironment.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getIndexerConfigFromEnvironment + +# Function: ~~getIndexerConfigFromEnvironment()~~ + +> **getIndexerConfigFromEnvironment**(): [`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/network-client.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L31) + +## Returns + +[`AlgoClientConfig`](../../types/network-client/interfaces/AlgoClientConfig.md) + +## Deprecated + +Use `ClientManager.getIndexerConfigFromEnvironment()` instead. + +Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment not algod-side) diff --git a/docs/code/index/functions/getKmdWalletAccount.md b/docs/code/index/functions/getKmdWalletAccount.md new file mode 100644 index 00000000..3d964223 --- /dev/null +++ b/docs/code/index/functions/getKmdWalletAccount.md @@ -0,0 +1,58 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getKmdWalletAccount + +# Function: ~~getKmdWalletAccount()~~ + +> **getKmdWalletAccount**(`walletAccount`, `algod`, `kmdClient?`): `Promise`\<`undefined` \| `Account`\> + +Defined in: [src/localnet/get-kmd-wallet-account.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-kmd-wallet-account.ts#L27) + +## Parameters + +### walletAccount + +The details of the wallet, with: + * `name`: The name of the wallet to retrieve an account from + * `predicate`: An optional filter to use to find the account (otherwise it will return a random account from the wallet) + +#### name + +`string` + +#### predicate? + +(`account`) => `boolean` + +### algod + +`AlgodClient` + +An algod client + +### kmdClient? + +`KmdClient` + +A KMD client, if not specified then a default KMD client will be loaded from environment variables + +## Returns + +`Promise`\<`undefined` \| `Account`\> + +## Deprecated + +use `algorand.account.kmd.getWalletAccount(name, predicate)` or `new KMDAccountManager(clientManager).getWalletAccount(name, predicate)` instead. + +Returns an Algorand account with private key loaded from the given KMD wallet (identified by name). + +## Example + +```typescript +const defaultDispenserAccount = await getKmdWalletAccount(algod, + 'unencrypted-default-wallet', + a => a.status !== 'Offline' && a.amount > 1_000_000_000 +) +``` diff --git a/docs/code/index/functions/getLocalNetDispenserAccount.md b/docs/code/index/functions/getLocalNetDispenserAccount.md new file mode 100644 index 00000000..76957b8a --- /dev/null +++ b/docs/code/index/functions/getLocalNetDispenserAccount.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getLocalNetDispenserAccount + +# Function: ~~getLocalNetDispenserAccount()~~ + +> **getLocalNetDispenserAccount**(`algod`, `kmd?`): `Promise`\<`Account`\> + +Defined in: [src/localnet/get-localnet-dispenser-account.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-localnet-dispenser-account.ts#L15) + +## Parameters + +### algod + +`AlgodClient` + +An algod client + +### kmd? + +`KmdClient` + +A KMD client, if not specified then a default KMD client will be loaded from environment variables + +## Returns + +`Promise`\<`Account`\> + +## Deprecated + +Use `algorand.account.kmd.getLocalNetDispenserAccount()` instead. + +Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts) diff --git a/docs/code/index/functions/getOrCreateKmdWalletAccount.md b/docs/code/index/functions/getOrCreateKmdWalletAccount.md new file mode 100644 index 00000000..b694ce8b --- /dev/null +++ b/docs/code/index/functions/getOrCreateKmdWalletAccount.md @@ -0,0 +1,57 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getOrCreateKmdWalletAccount + +# Function: ~~getOrCreateKmdWalletAccount()~~ + +> **getOrCreateKmdWalletAccount**(`walletAccount`, `algod`, `kmdClient?`): `Promise`\<`Account`\> + +Defined in: [src/localnet/get-or-create-kmd-wallet-account.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-or-create-kmd-wallet-account.ts#L28) + +## Parameters + +### walletAccount + +The wallet details with: + * `name`: The name of the wallet to retrieve / create + * `fundWith`: The number of Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account + +#### fundWith? + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +#### name + +`string` + +### algod + +`AlgodClient` + +An algod client + +### kmdClient? + +`KmdClient` + +A KMD client, if not specified then a default KMD client will be loaded from environment variables + +## Returns + +`Promise`\<`Account`\> + +An Algorand account with private key loaded - either one that already existed in the given KMD wallet, or a new one that is funded for you + +## Deprecated + +use `algorand.account.kmd.getOrCreateWalletAccount(name, fundWith)` or `new KMDAccountManager(clientManager).getOrCreateWalletAccount(name, fundWith)` instead. + +Gets an account with private key loaded from a KMD wallet of the given name, or alternatively creates one with funds in it via a KMD wallet of the given name. + +This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet). + +This significantly speeds up local dev time and improves experience since you can write code that *just works* first go without manual config in a fresh LocalNet. + +If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development! diff --git a/docs/code/index/functions/getSenderAddress.md b/docs/code/index/functions/getSenderAddress.md new file mode 100644 index 00000000..87ae71b4 --- /dev/null +++ b/docs/code/index/functions/getSenderAddress.md @@ -0,0 +1,32 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getSenderAddress + +# Function: ~~getSenderAddress()~~ + +> **getSenderAddress**(`sender`): `string` + +Defined in: [src/transaction/transaction.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L110) + +## Parameters + +### sender + +A transaction sender + +`string` | [`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +## Returns + +`string` + +The public address + +## Deprecated + +Use `algorand.client` to interact with accounts, and use `.addr` to get the address +and/or move from using `SendTransactionFrom` to `TransactionSignerAccount` and use `.addr` instead. + +Returns the public address of the given transaction sender. diff --git a/docs/code/index/functions/getTestNetDispenserApiClient.md b/docs/code/index/functions/getTestNetDispenserApiClient.md new file mode 100644 index 00000000..8dbfaa11 --- /dev/null +++ b/docs/code/index/functions/getTestNetDispenserApiClient.md @@ -0,0 +1,44 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getTestNetDispenserApiClient + +# Function: ~~getTestNetDispenserApiClient()~~ + +> **getTestNetDispenserApiClient**(`params`): [`TestNetDispenserApiClient`](../../types/dispenser-client/classes/TestNetDispenserApiClient.md) + +Defined in: [src/dispenser-client.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/dispenser-client.ts#L21) + +## Parameters + +### params + +An object containing parameters for the TestNetDispenserApiClient class. +Or null if you want the client to load the access token from the environment variable `ALGOKIT_DISPENSER_ACCESS_TOKEN`. + +`null` | [`TestNetDispenserApiClientParams`](../../types/dispenser-client/interfaces/TestNetDispenserApiClientParams.md) + +## Returns + +[`TestNetDispenserApiClient`](../../types/dispenser-client/classes/TestNetDispenserApiClient.md) + +An instance of the TestNetDispenserApiClient class. + +## Deprecated + +Use `clientManager.getTestNetDispenser` or `clientManager.getTestNetDispenserFromEnvironment` instead + +Create a new TestNetDispenserApiClient instance. +Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token. + +## Example + +```ts +const client = algokit.getTestNetDispenserApiClient( + { + authToken: 'your_auth_token', + requestTimeout: 15, + } +) +``` diff --git a/docs/code/index/functions/getTransactionParams.md b/docs/code/index/functions/getTransactionParams.md new file mode 100644 index 00000000..d4aa26d9 --- /dev/null +++ b/docs/code/index/functions/getTransactionParams.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getTransactionParams + +# Function: ~~getTransactionParams()~~ + +> **getTransactionParams**(`params`, `algod`): `Promise`\<`SuggestedParams`\> + +Defined in: [src/transaction/transaction.ts:1111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1111) + +## Parameters + +### params + +Optionally provide parameters to use + +`undefined` | `SuggestedParams` + +### algod + +`AlgodClient` + +Algod algod + +## Returns + +`Promise`\<`SuggestedParams`\> + +The suggested transaction parameters + +## Deprecated + +Use `suggestedParams ? { ...suggestedParams } : await algod.getTransactionParams().do()` instead + +Returns suggested transaction parameters from algod unless some are already provided. diff --git a/docs/code/index/functions/getTransactionWithSigner.md b/docs/code/index/functions/getTransactionWithSigner.md new file mode 100644 index 00000000..9b3ea558 --- /dev/null +++ b/docs/code/index/functions/getTransactionWithSigner.md @@ -0,0 +1,42 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getTransactionWithSigner + +# Function: ~~getTransactionWithSigner()~~ + +> **getTransactionWithSigner**(`transaction`, `defaultSender?`): `Promise`\<`TransactionWithSigner`\> + +Defined in: [src/transaction/transaction.ts:127](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L127) + +## Parameters + +### transaction + +One of: A TransactionWithSigner object (returned as is), a TransactionToSign object (signer is obtained from the +signer property), a Transaction object (signer is extracted from the defaultSender parameter), an async SendTransactionResult returned by +one of algokit utils' helpers (signer is obtained from the defaultSender parameter) + +`Transaction` | [`TransactionToSign`](../../types/transaction/interfaces/TransactionToSign.md) | `Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> | `TransactionWithSigner` + +### defaultSender? + +[`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +The default sender to be used to obtain a signer where the object provided to the transaction parameter does not +include a signer. + +## Returns + +`Promise`\<`TransactionWithSigner`\> + +A TransactionWithSigner object. + +## Deprecated + +Use `AlgorandClient` / `TransactionComposer` to construct transactions instead or +construct an `algosdk.TransactionWithSigner` manually instead. + +Given a transaction in a variety of supported formats, returns a TransactionWithSigner object ready to be passed to an +AtomicTransactionComposer's addTransaction method. diff --git a/docs/code/index/functions/isLocalNet.md b/docs/code/index/functions/isLocalNet.md new file mode 100644 index 00000000..9cabec58 --- /dev/null +++ b/docs/code/index/functions/isLocalNet.md @@ -0,0 +1,27 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / isLocalNet + +# Function: ~~isLocalNet()~~ + +> **isLocalNet**(`algod`): `Promise`\<`boolean`\> + +Defined in: [src/localnet/is-localnet.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/is-localnet.ts#L9) + +## Parameters + +### algod + +`AlgodClient` + +## Returns + +`Promise`\<`boolean`\> + +## Deprecated + +Use `await algorand.client.isLocalNet()` or `await new ClientManager({ algod }).isLocalNet()` instead. + +Returns true if the algod client is pointing to a LocalNet Algorand network diff --git a/docs/code/index/functions/isMainNet.md b/docs/code/index/functions/isMainNet.md new file mode 100644 index 00000000..336d9760 --- /dev/null +++ b/docs/code/index/functions/isMainNet.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / isMainNet + +# Function: ~~isMainNet()~~ + +> **isMainNet**(`algod`): `Promise`\<`boolean`\> + +Defined in: [src/network-client.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L154) + +## Parameters + +### algod + +`AlgodClient` + +## Returns + +`Promise`\<`boolean`\> + +## Deprecated + +Use `await algorand.client.isMainNet()` or `await new ClientManager({ algod }).isMainNet()` instead. diff --git a/docs/code/index/functions/isSchemaIsBroken.md b/docs/code/index/functions/isSchemaIsBroken.md new file mode 100644 index 00000000..7636312e --- /dev/null +++ b/docs/code/index/functions/isSchemaIsBroken.md @@ -0,0 +1,39 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / isSchemaIsBroken + +# Function: ~~isSchemaIsBroken()~~ + +> **isSchemaIsBroken**(`before`, `after`): `boolean` + +Defined in: [src/app-deploy.ts:229](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L229) + +## Parameters + +### before + +`ApplicationStateSchema` + +The existing schema + +### after + +`ApplicationStateSchema` + +The new schema + +## Returns + +`boolean` + +Whether or not there is a breaking change + +## Deprecated + +Use `before.numByteSlice < after.numByteSlice || before.numUint < after.numUint` instead. + +Returns true is there is a breaking change in the application state schema from before to after. + i.e. if the schema becomes larger, since applications can't ask for more schema after creation. + Otherwise, there is no error, the app just doesn't store data in the extra schema :( diff --git a/docs/code/index/functions/isTestNet.md b/docs/code/index/functions/isTestNet.md new file mode 100644 index 00000000..82bee576 --- /dev/null +++ b/docs/code/index/functions/isTestNet.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / isTestNet + +# Function: ~~isTestNet()~~ + +> **isTestNet**(`algod`): `Promise`\<`boolean`\> + +Defined in: [src/network-client.ts:149](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L149) + +## Parameters + +### algod + +`AlgodClient` + +## Returns + +`Promise`\<`boolean`\> + +## Deprecated + +Use `await algorand.client.isTestNet()` or `await new ClientManager({ algod }).isTestNet()` instead. diff --git a/docs/code/index/functions/lookupAccountByAddress.md b/docs/code/index/functions/lookupAccountByAddress.md new file mode 100644 index 00000000..56c8f223 --- /dev/null +++ b/docs/code/index/functions/lookupAccountByAddress.md @@ -0,0 +1,36 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / lookupAccountByAddress + +# Function: ~~lookupAccountByAddress()~~ + +> **lookupAccountByAddress**(`accountAddress`, `indexer`): `Promise`\<`AccountResponse`\> + +Defined in: [src/indexer-lookup.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L26) + +## Parameters + +### accountAddress + +The address of the account to look up + +`string` | `Address` + +### indexer + +`IndexerClient` + +An indexer client + +## Returns + +`Promise`\<`AccountResponse`\> + +The result of the look-up + +## Deprecated + +Use `indexer.lookupAccountByID(accountAddress).do()`. +Looks up an account by address using Indexer. diff --git a/docs/code/index/functions/lookupAccountCreatedApplicationByAddress.md b/docs/code/index/functions/lookupAccountCreatedApplicationByAddress.md new file mode 100644 index 00000000..01f71514 --- /dev/null +++ b/docs/code/index/functions/lookupAccountCreatedApplicationByAddress.md @@ -0,0 +1,45 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / lookupAccountCreatedApplicationByAddress + +# Function: lookupAccountCreatedApplicationByAddress() + +> **lookupAccountCreatedApplicationByAddress**(`indexer`, `address`, `getAll`, `paginationLimit?`): `Promise`\<`Application`[]\> + +Defined in: [src/indexer-lookup.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L38) + +Looks up applications that were created by the given address; will automatically paginate through all data. + +## Parameters + +### indexer + +`IndexerClient` + +An indexer instance + +### address + +The address of the creator to look up + +`string` | `Address` + +### getAll + +Whether or not to include deleted applications + +`undefined` | `boolean` + +### paginationLimit? + +`number` + +The number of records to return per paginated request, default 1000 + +## Returns + +`Promise`\<`Application`[]\> + +The list of application results diff --git a/docs/code/index/functions/lookupAssetHoldings.md b/docs/code/index/functions/lookupAssetHoldings.md new file mode 100644 index 00000000..a2121735 --- /dev/null +++ b/docs/code/index/functions/lookupAssetHoldings.md @@ -0,0 +1,45 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / lookupAssetHoldings + +# Function: lookupAssetHoldings() + +> **lookupAssetHoldings**(`indexer`, `assetId`, `options?`, `paginationLimit?`): `Promise`\<`MiniAssetHolding`[]\> + +Defined in: [src/indexer-lookup.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L72) + +Looks up asset holdings for the given asset; will automatically paginate through all data. + +## Parameters + +### indexer + +`IndexerClient` + +An indexer instance + +### assetId + +The ID of the asset to look up holdings for + +`number` | `bigint` + +### options? + +[`LookupAssetHoldingsOptions`](../../types/indexer/interfaces/LookupAssetHoldingsOptions.md) + +Optional options to control the lookup + +### paginationLimit? + +`number` + +The number of records to return per paginated request, default 1000 + +## Returns + +`Promise`\<`MiniAssetHolding`[]\> + +The list of application results diff --git a/docs/code/index/functions/lookupTransactionById.md b/docs/code/index/functions/lookupTransactionById.md new file mode 100644 index 00000000..772316ef --- /dev/null +++ b/docs/code/index/functions/lookupTransactionById.md @@ -0,0 +1,36 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / lookupTransactionById + +# Function: ~~lookupTransactionById()~~ + +> **lookupTransactionById**(`transactionId`, `indexer`): `Promise`\<`TransactionResponse`\> + +Defined in: [src/indexer-lookup.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L15) + +## Parameters + +### transactionId + +`string` + +The ID of the transaction to look up + +### indexer + +`IndexerClient` + +An indexer client + +## Returns + +`Promise`\<`TransactionResponse`\> + +The result of the look-up + +## Deprecated + +Use `indexer.lookupTransactionByID(transactionId).do()`. +Looks up a transaction by ID using Indexer. diff --git a/docs/code/index/functions/microAlgo.md b/docs/code/index/functions/microAlgo.md new file mode 100644 index 00000000..f0226b22 --- /dev/null +++ b/docs/code/index/functions/microAlgo.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / microAlgo + +# Function: microAlgo() + +> **microAlgo**(`microAlgos`): [`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +Defined in: [src/amount.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L82) + +Returns an amount of µAlgo using AlgoAmount + +## Parameters + +### microAlgos + +The amount of µAlgo + +`number` | `bigint` + +## Returns + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) diff --git a/docs/code/index/functions/microAlgos.md b/docs/code/index/functions/microAlgos.md new file mode 100644 index 00000000..dc1630eb --- /dev/null +++ b/docs/code/index/functions/microAlgos.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / microAlgos + +# Function: microAlgos() + +> **microAlgos**(`microAlgos`): [`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +Defined in: [src/amount.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L75) + +Returns an amount of µAlgo using AlgoAmount + +## Parameters + +### microAlgos + +The amount of µAlgo + +`number` | `bigint` + +## Returns + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) diff --git a/docs/code/index/functions/mnemonicAccount.md b/docs/code/index/functions/mnemonicAccount.md new file mode 100644 index 00000000..789f0cc4 --- /dev/null +++ b/docs/code/index/functions/mnemonicAccount.md @@ -0,0 +1,32 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / mnemonicAccount + +# Function: ~~mnemonicAccount()~~ + +> **mnemonicAccount**(`mnemonicSecret`): `Account` + +Defined in: [src/account/mnemonic-account.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/mnemonic-account.ts#L14) + +## Parameters + +### mnemonicSecret + +`string` + +The mnemonic secret representing the private key of an account; **Note: Be careful how the mnemonic is handled**, + never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system. + +## Returns + +`Account` + +## Deprecated + +Use `algorand.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead. + +Returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret. + +This is a wrapper around algosdk.mnemonicToSecretKey to provide a more friendly/obvious name. diff --git a/docs/code/index/functions/mnemonicAccountFromEnvironment.md b/docs/code/index/functions/mnemonicAccountFromEnvironment.md new file mode 100644 index 00000000..0203a003 --- /dev/null +++ b/docs/code/index/functions/mnemonicAccountFromEnvironment.md @@ -0,0 +1,65 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / mnemonicAccountFromEnvironment + +# Function: ~~mnemonicAccountFromEnvironment()~~ + +> **mnemonicAccountFromEnvironment**(`account`, `algod`, `kmdClient?`): `Promise`\<`Account` \| [`SigningAccount`](../../types/account/classes/SigningAccount.md)\> + +Defined in: [src/account/account.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L97) + +## Parameters + +### account + +The details of the account to get, either the name identifier (string) or an object with: + * `name`: string: The name identifier of the account + * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account + +`string` | \{ `fundWith?`: [`AlgoAmount`](../../types/amount/classes/AlgoAmount.md); `name`: `string`; \} + +### algod + +`AlgodClient` + +An algod client + +### kmdClient? + +`KmdClient` + +An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables + +## Returns + +`Promise`\<`Account` \| [`SigningAccount`](../../types/account/classes/SigningAccount.md)\> + +The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account) + +## Deprecated + +Use `algorand.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead. + +Returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier. + +Note: This function expects to run in a Node.js environment. + +## Convention: +* **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**, + never commit it into source control and ideally load it via a secret storage service rather than the file system. + If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts) +* **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you + +This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet). + +## Example + +If you have a mnemonic secret loaded into `process.env.MY_ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: +```typescript +const account = await mnemonicAccountFromEnvironment('MY_ACCOUNT', algod) +``` + +If that code runs against LocalNet then a wallet called `MY_ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. +If not running against LocalNet then it will use proces.env.MY_ACCOUNT_MNEMONIC as the private key and (if present) process.env.MY_ACCOUNT_SENDER as the sender address. diff --git a/docs/code/index/functions/multisigAccount.md b/docs/code/index/functions/multisigAccount.md new file mode 100644 index 00000000..45c2430e --- /dev/null +++ b/docs/code/index/functions/multisigAccount.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / multisigAccount + +# Function: ~~multisigAccount()~~ + +> **multisigAccount**(`multisigParams`, `signingAccounts`): [`MultisigAccount`](../../types/account/classes/MultisigAccount.md) + +Defined in: [src/account/account.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L24) + +## Parameters + +### multisigParams + +`MultisigMetadata` + +The parameters that define the multisig account + +### signingAccounts + +(`Account` \| [`SigningAccount`](../../types/account/classes/SigningAccount.md))[] + +The signers that are currently present + +## Returns + +[`MultisigAccount`](../../types/account/classes/MultisigAccount.md) + +A multisig account wrapper + +## Deprecated + +Use `algorand.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead. + +Returns an account wrapper that supports partial or full multisig signing. diff --git a/docs/code/index/functions/performAtomicTransactionComposerSimulate.md b/docs/code/index/functions/performAtomicTransactionComposerSimulate.md new file mode 100644 index 00000000..b97fd3e3 --- /dev/null +++ b/docs/code/index/functions/performAtomicTransactionComposerSimulate.md @@ -0,0 +1,38 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / performAtomicTransactionComposerSimulate + +# Function: performAtomicTransactionComposerSimulate() + +> **performAtomicTransactionComposerSimulate**(`atc`, `algod`, `options?`): `Promise`\<`SimulateResponse`\> + +Defined in: [src/transaction/perform-atomic-transaction-composer-simulate.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/perform-atomic-transaction-composer-simulate.ts#L14) + +Performs a simulation of the transactions loaded into the given AtomicTransactionComposer. +Uses empty transaction signers for all transactions. + +## Parameters + +### atc + +`AtomicTransactionComposer` + +The AtomicTransactionComposer with transaction(s) loaded. + +### algod + +`AlgodClient` + +An Algod client to perform the simulation. + +### options? + +`Omit`\<\{ `allowEmptySignatures?`: `boolean`; `allowMoreLogging?`: `boolean`; `allowUnnamedResources?`: `boolean`; `execTraceConfig?`: `SimulateTraceConfig`; `extraOpcodeBudget?`: `number` \| `bigint`; `fixSigners?`: `boolean`; `round?`: `number` \| `bigint`; `txnGroups`: `SimulateRequestTransactionGroup`[]; \}, `"txnGroups"`\> + +## Returns + +`Promise`\<`SimulateResponse`\> + +The simulation result, which includes various details about how the transactions would be processed. diff --git a/docs/code/index/functions/performTemplateSubstitution.md b/docs/code/index/functions/performTemplateSubstitution.md new file mode 100644 index 00000000..97f7aa57 --- /dev/null +++ b/docs/code/index/functions/performTemplateSubstitution.md @@ -0,0 +1,39 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / performTemplateSubstitution + +# Function: ~~performTemplateSubstitution()~~ + +> **performTemplateSubstitution**(`tealCode`, `templateParams?`): `string` + +Defined in: [src/app-deploy.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L309) + +## Parameters + +### tealCode + +`string` + +The TEAL logic to compile + +### templateParams? + +[`TealTemplateParams`](../../types/app/interfaces/TealTemplateParams.md) + +Any parameters to replace in the .teal file before compiling + +## Returns + +`string` + +The TEAL code with replacements + +## Deprecated + +Use `AppManager.replaceTealTemplateParams` instead + +Performs template substitution of a teal file. + +Looks for `TMPL_{parameter}` for template replacements. diff --git a/docs/code/index/functions/performTemplateSubstitutionAndCompile.md b/docs/code/index/functions/performTemplateSubstitutionAndCompile.md new file mode 100644 index 00000000..60b51e15 --- /dev/null +++ b/docs/code/index/functions/performTemplateSubstitutionAndCompile.md @@ -0,0 +1,51 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / performTemplateSubstitutionAndCompile + +# Function: ~~performTemplateSubstitutionAndCompile()~~ + +> **performTemplateSubstitutionAndCompile**(`tealCode`, `algod`, `templateParams?`, `deploymentMetadata?`): `Promise`\<[`CompiledTeal`](../../types/app/interfaces/CompiledTeal.md)\> + +Defined in: [src/app-deploy.ts:326](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L326) + +## Parameters + +### tealCode + +`string` + +The TEAL logic to compile + +### algod + +`AlgodClient` + +An algod client + +### templateParams? + +[`TealTemplateParams`](../../types/app/interfaces/TealTemplateParams.md) + +Any parameters to replace in the .teal file before compiling + +### deploymentMetadata? + +[`AppDeployMetadata`](../../types/app/interfaces/AppDeployMetadata.md) + +The deployment metadata the app will be deployed with + +## Returns + +`Promise`\<[`CompiledTeal`](../../types/app/interfaces/CompiledTeal.md)\> + +The information about the compiled code + +## Deprecated + +Use `algorand.appManager.compileTealTemplate` instead. + +Performs template substitution of a teal file and compiles it, returning the compiled result. + +Looks for `TMPL_{parameter}` for template replacements. diff --git a/docs/code/index/functions/persistSourceMaps.md b/docs/code/index/functions/persistSourceMaps.md new file mode 100644 index 00000000..20dcb048 --- /dev/null +++ b/docs/code/index/functions/persistSourceMaps.md @@ -0,0 +1,29 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / persistSourceMaps + +# Function: ~~persistSourceMaps()~~ + +> **persistSourceMaps**(`_params`): `Promise`\<`void`\> + +Defined in: [src/debugging/debugging.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/debugging/debugging.ts#L8) + +## Parameters + +### \_params + +`unknown` + +## Returns + +`Promise`\<`void`\> + +A promise that resolves when the source maps have been persisted. + +## Deprecated + +Use latest version of `AlgoKit AVM Debugger` VSCode extension instead. It will automatically manage your sourcemaps. + +This function persists the source maps for the given sources. diff --git a/docs/code/index/functions/populateAppCallResources.md b/docs/code/index/functions/populateAppCallResources.md new file mode 100644 index 00000000..a85df553 --- /dev/null +++ b/docs/code/index/functions/populateAppCallResources.md @@ -0,0 +1,34 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / populateAppCallResources + +# Function: populateAppCallResources() + +> **populateAppCallResources**(`atc`, `algod`): `Promise`\<`AtomicTransactionComposer`\> + +Defined in: [src/transaction/transaction.ts:382](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L382) + +Take an existing Atomic Transaction Composer and return a new one with the required +app call resources populated into it + +## Parameters + +### atc + +`AtomicTransactionComposer` + +The ATC containing the txn group + +### algod + +`AlgodClient` + +The algod client to use for the simulation + +## Returns + +`Promise`\<`AtomicTransactionComposer`\> + +A new ATC with the resources populated into the transactions diff --git a/docs/code/index/functions/prepareGroupForSending.md b/docs/code/index/functions/prepareGroupForSending.md new file mode 100644 index 00000000..ece64fc6 --- /dev/null +++ b/docs/code/index/functions/prepareGroupForSending.md @@ -0,0 +1,47 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / prepareGroupForSending + +# Function: prepareGroupForSending() + +> **prepareGroupForSending**(`atc`, `algod`, `sendParams`, `additionalAtcContext?`): `Promise`\<`AtomicTransactionComposer`\> + +Defined in: [src/transaction/transaction.ts:401](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L401) + +Take an existing Atomic Transaction Composer and return a new one with changes applied to the transactions +based on the supplied sendParams to prepare it for sending. +Please note, that before calling `.execute()` on the returned ATC, you must call `.buildGroup()`. + +## Parameters + +### atc + +`AtomicTransactionComposer` + +The ATC containing the txn group + +### algod + +`AlgodClient` + +The algod client to use for the simulation + +### sendParams + +[`SendParams`](../../types/transaction/interfaces/SendParams.md) + +The send params for the transaction group + +### additionalAtcContext? + +[`AdditionalAtomicTransactionComposerContext`](../../types/transaction/interfaces/AdditionalAtomicTransactionComposerContext.md) + +Additional ATC context used to determine how best to change the transactions in the group + +## Returns + +`Promise`\<`AtomicTransactionComposer`\> + +A new ATC with the changes applied diff --git a/docs/code/index/functions/randomAccount.md b/docs/code/index/functions/randomAccount.md new file mode 100644 index 00000000..a5eba8b4 --- /dev/null +++ b/docs/code/index/functions/randomAccount.md @@ -0,0 +1,23 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / randomAccount + +# Function: ~~randomAccount()~~ + +> **randomAccount**(): `Account` + +Defined in: [src/account/account.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L60) + +## Returns + +`Account` + +## Deprecated + +Use `algorand.account.random()` or `algosdk.generateAccount()` instead. + +Returns a new, random Algorand account with secret key loaded. + +This is a wrapper around algosdk.generateAccount to provide a more friendly/obvious name. diff --git a/docs/code/index/functions/rekeyAccount.md b/docs/code/index/functions/rekeyAccount.md new file mode 100644 index 00000000..ead81658 --- /dev/null +++ b/docs/code/index/functions/rekeyAccount.md @@ -0,0 +1,45 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / rekeyAccount + +# Function: ~~rekeyAccount()~~ + +> **rekeyAccount**(`rekey`, `algod`): `Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +Defined in: [src/transfer/transfer.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L125) + +## Parameters + +### rekey + +[`AlgoRekeyParams`](../../types/transfer/interfaces/AlgoRekeyParams.md) + +The rekey definition + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) + +## Deprecated + +Use `algorand.account.rekeyAccount()` instead + +Rekey an account to a new address. + +**Note:** Please be careful with this function and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +## Example + +```typescript +await algokit.rekeyAccount({ from, rekeyTo }, algod) +``` diff --git a/docs/code/index/functions/rekeyedAccount.md b/docs/code/index/functions/rekeyedAccount.md new file mode 100644 index 00000000..57bf0416 --- /dev/null +++ b/docs/code/index/functions/rekeyedAccount.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / rekeyedAccount + +# Function: ~~rekeyedAccount()~~ + +> **rekeyedAccount**(`signer`, `sender`): [`SigningAccount`](../../types/account/classes/SigningAccount.md) + +Defined in: [src/account/account.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L36) + +## Parameters + +### signer + +`Account` + +The account, with private key loaded, that is signing + +### sender + +`string` + +The address of the rekeyed account that will act as a sender + +## Returns + +[`SigningAccount`](../../types/account/classes/SigningAccount.md) + +The SigningAccount wrapper + +## Deprecated + +Use `algorand.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead. + +Returns an account wrapper that supports a rekeyed account. diff --git a/docs/code/index/functions/replaceDeployTimeControlParams.md b/docs/code/index/functions/replaceDeployTimeControlParams.md new file mode 100644 index 00000000..be00a397 --- /dev/null +++ b/docs/code/index/functions/replaceDeployTimeControlParams.md @@ -0,0 +1,49 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / replaceDeployTimeControlParams + +# Function: ~~replaceDeployTimeControlParams()~~ + +> **replaceDeployTimeControlParams**(`tealCode`, `params`): `string` + +Defined in: [src/app-deploy.ts:294](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L294) + +## Parameters + +### tealCode + +`string` + +The TEAL code to substitute + +### params + +The deploy-time deployment control parameter value to replace + +#### deletable? + +`boolean` + +#### updatable? + +`boolean` + +## Returns + +`string` + +The replaced TEAL code + +## Deprecated + +Use `AppManager.replaceTealTemplateDeployTimeControlParams` instead + +Replaces deploy-time deployment control parameters within the given teal code. + +* `TMPL_UPDATABLE` for updatability / immutability control +* `TMPL_DELETABLE` for deletability / permanence control + +Note: If these values are not undefined, but the corresponding `TMPL_*` value + isn't in the teal code it will throw an exception. diff --git a/docs/code/index/functions/searchTransactions.md b/docs/code/index/functions/searchTransactions.md new file mode 100644 index 00000000..0ecd45fb --- /dev/null +++ b/docs/code/index/functions/searchTransactions.md @@ -0,0 +1,39 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / searchTransactions + +# Function: searchTransactions() + +> **searchTransactions**(`indexer`, `searchCriteria`, `paginationLimit?`): `Promise`\<`TransactionsResponse`\> + +Defined in: [src/indexer-lookup.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L111) + +Allows transactions to be searched for the given criteria. + +## Parameters + +### indexer + +`IndexerClient` + +An indexer client + +### searchCriteria + +(`s`) => `SearchForTransactions` + +The criteria to search for + +### paginationLimit? + +`number` + +The number of records to return per paginated request, default 1000 + +## Returns + +`Promise`\<`TransactionsResponse`\> + +The search results diff --git a/docs/code/index/functions/sendAtomicTransactionComposer.md b/docs/code/index/functions/sendAtomicTransactionComposer.md new file mode 100644 index 00000000..20dc1f53 --- /dev/null +++ b/docs/code/index/functions/sendAtomicTransactionComposer.md @@ -0,0 +1,33 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / sendAtomicTransactionComposer + +# Function: sendAtomicTransactionComposer() + +> **sendAtomicTransactionComposer**(`atcSend`, `algod`): `Promise`\<[`SendAtomicTransactionComposerResults`](../../types/transaction/interfaces/SendAtomicTransactionComposerResults.md)\> + +Defined in: [src/transaction/transaction.ts:776](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L776) + +Signs and sends transactions that have been collected by an `AtomicTransactionComposer`. + +## Parameters + +### atcSend + +[`AtomicTransactionComposerToSend`](../../types/transaction/interfaces/AtomicTransactionComposerToSend.md) + +The parameters controlling the send, including `atc` The `AtomicTransactionComposer` and params to control send behaviour + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`SendAtomicTransactionComposerResults`](../../types/transaction/interfaces/SendAtomicTransactionComposerResults.md)\> + +An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`) diff --git a/docs/code/index/functions/sendGroupOfTransactions.md b/docs/code/index/functions/sendGroupOfTransactions.md new file mode 100644 index 00000000..040d08bf --- /dev/null +++ b/docs/code/index/functions/sendGroupOfTransactions.md @@ -0,0 +1,39 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / sendGroupOfTransactions + +# Function: ~~sendGroupOfTransactions()~~ + +> **sendGroupOfTransactions**(`groupSend`, `algod`): `Promise`\<`Omit`\<[`SendAtomicTransactionComposerResults`](../../types/transaction/interfaces/SendAtomicTransactionComposerResults.md), `"returns"`\>\> + +Defined in: [src/transaction/transaction.ts:956](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L956) + +## Parameters + +### groupSend + +[`TransactionGroupToSend`](../../types/transaction/interfaces/TransactionGroupToSend.md) + +The group details to send, with: + * `transactions`: The array of transactions to send along with their signing account + * `sendParams`: The parameters to dictate how the group is sent + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<`Omit`\<[`SendAtomicTransactionComposerResults`](../../types/transaction/interfaces/SendAtomicTransactionComposerResults.md), `"returns"`\>\> + +An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`) + +## Deprecated + +Use `TransactionComposer` (`algorand.newGroup()`) or `AtomicTransactionComposer` to construct and send group transactions instead. + +Signs and sends a group of [up to 16](https://dev.algorand.co/concepts/transactions/atomic-txn-groups/#create-transactions) transactions to the chain diff --git a/docs/code/index/functions/sendTransaction.md b/docs/code/index/functions/sendTransaction.md new file mode 100644 index 00000000..5b0ba236 --- /dev/null +++ b/docs/code/index/functions/sendTransaction.md @@ -0,0 +1,50 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / sendTransaction + +# Function: ~~sendTransaction()~~ + +> **sendTransaction**(`send`, `algod`): `Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +Defined in: [src/transaction/transaction.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L209) + +## Parameters + +### send + +The details for the transaction to prepare/send, including: + * `transaction`: The unsigned transaction + * `from`: The account to sign the transaction with: either an account with private key loaded or a logic signature account + * `config`: The sending configuration for this transaction + +#### from + +[`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +#### sendParams? + +[`SendTransactionParams`](../../types/transaction/interfaces/SendTransactionParams.md) + +#### transaction + +`Transaction` + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +An object with transaction (`transaction`) and (if `skipWaiting` is `false` or `undefined`) confirmation (`confirmation`) + +## Deprecated + +Use `AlgorandClient` / `TransactionComposer` to send transactions. + +Prepares a transaction for sending and then (if instructed) signs and sends the given transaction to the chain. diff --git a/docs/code/index/functions/signTransaction.md b/docs/code/index/functions/signTransaction.md new file mode 100644 index 00000000..434f26c2 --- /dev/null +++ b/docs/code/index/functions/signTransaction.md @@ -0,0 +1,39 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / signTransaction + +# Function: ~~signTransaction()~~ + +> **signTransaction**(`transaction`, `signer`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +Defined in: [src/transaction/transaction.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L186) + +## Parameters + +### transaction + +`Transaction` + +The transaction to sign + +### signer + +[`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +The signer to sign + +## Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +The signed transaction as a `Uint8Array` + +## Deprecated + +Use `AlgorandClient` / `TransactionComposer` to sign transactions +or use the relevant underlying `account.signTxn` / `algosdk.signLogicSigTransactionObject` +/ `multiSigAccount.sign` / `TransactionSigner` methods directly. + +Signs a single transaction by the given signer. diff --git a/docs/code/index/functions/stripTealComments.md b/docs/code/index/functions/stripTealComments.md new file mode 100644 index 00000000..4f520585 --- /dev/null +++ b/docs/code/index/functions/stripTealComments.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / stripTealComments + +# Function: ~~stripTealComments()~~ + +> **stripTealComments**(`tealCode`): `string` + +Defined in: [src/app-deploy.ts:351](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L351) + +## Parameters + +### tealCode + +`string` + +The TEAL logic to compile + +## Returns + +`string` + +The TEAL without comments + +## Deprecated + +Use `AppManager.stripTealComments` instead. + +Remove comments from TEAL Code diff --git a/docs/code/index/functions/transactionFees.md b/docs/code/index/functions/transactionFees.md new file mode 100644 index 00000000..ea0c8cc0 --- /dev/null +++ b/docs/code/index/functions/transactionFees.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / transactionFees + +# Function: transactionFees() + +> **transactionFees**(`numberOfTransactions`): [`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +Defined in: [src/amount.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L89) + +Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount + +## Parameters + +### numberOfTransactions + +`number` + +The of standard transaction fees to return the amount of Algo + +## Returns + +[`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) diff --git a/docs/code/index/functions/transactionSignerAccount.md b/docs/code/index/functions/transactionSignerAccount.md new file mode 100644 index 00000000..eeeb68d4 --- /dev/null +++ b/docs/code/index/functions/transactionSignerAccount.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / transactionSignerAccount + +# Function: ~~transactionSignerAccount()~~ + +> **transactionSignerAccount**(`signer`, `sender`): [`TransactionSignerAccount`](../../types/account/interfaces/TransactionSignerAccount.md) + +Defined in: [src/account/account.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L48) + +## Parameters + +### signer + +`TransactionSigner` + +The transaction signer + +### sender + +`string` + +The address of sender account + +## Returns + +[`TransactionSignerAccount`](../../types/account/interfaces/TransactionSignerAccount.md) + +The SigningAccount wrapper + +## Deprecated + +Use `algorand.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead. + +Returns an account wrapper that supports a transaction signer with associated sender address. diff --git a/docs/code/index/functions/transferAlgos.md b/docs/code/index/functions/transferAlgos.md new file mode 100644 index 00000000..0a464d0d --- /dev/null +++ b/docs/code/index/functions/transferAlgos.md @@ -0,0 +1,43 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / transferAlgos + +# Function: ~~transferAlgos()~~ + +> **transferAlgos**(`transfer`, `algod`): `Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +Defined in: [src/transfer/transfer-algos.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer-algos.ts#L22) + +## Parameters + +### transfer + +[`AlgoTransferParams`](../../types/transfer/interfaces/AlgoTransferParams.md) + +The transfer definition + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) + +## Deprecated + +Use `algorand.send.payment()` / `algorand.createTransaction.payment()` instead + +Transfer Algo between two accounts. + +## Example + +```typescript +await algokit.transferAlgos({ from, to, amount: algokit.algo(1) }, algod) +``` diff --git a/docs/code/index/functions/transferAsset.md b/docs/code/index/functions/transferAsset.md new file mode 100644 index 00000000..826a14b9 --- /dev/null +++ b/docs/code/index/functions/transferAsset.md @@ -0,0 +1,43 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / transferAsset + +# Function: ~~transferAsset()~~ + +> **transferAsset**(`transfer`, `algod`): `Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +Defined in: [src/transfer/transfer.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L90) + +## Parameters + +### transfer + +[`TransferAssetParams`](../../types/transfer/interfaces/TransferAssetParams.md) + +The transfer definition + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<[`SendTransactionResult`](../../types/transaction/interfaces/SendTransactionResult.md)\> + +The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) + +## Deprecated + +Use `algorand.send.assetTransfer()` / `algorand.createTransaction.assetTransfer()` instead + +Transfer asset between two accounts. + +## Example + +```typescript +await algokit.transferAsset({ from, to, assetId, amount }, algod) +``` diff --git a/docs/code/index/functions/updateApp.md b/docs/code/index/functions/updateApp.md new file mode 100644 index 00000000..47fc7ab7 --- /dev/null +++ b/docs/code/index/functions/updateApp.md @@ -0,0 +1,38 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / updateApp + +# Function: ~~updateApp()~~ + +> **updateApp**(`update`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../../types/app/interfaces/AppCompilationResult.md)\> & [`AppCallTransactionResult`](../../types/app/type-aliases/AppCallTransactionResult.md)\> + +Defined in: [src/app.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L104) + +## Parameters + +### update + +[`UpdateAppParams`](../../types/app/interfaces/UpdateAppParams.md) + +The parameters to update the app with + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<`Partial`\<[`AppCompilationResult`](../../types/app/interfaces/AppCompilationResult.md)\> & [`AppCallTransactionResult`](../../types/app/type-aliases/AppCallTransactionResult.md)\> + +The transaction send result and the compilation result + +## Deprecated + +Use `algorand.send.appUpdate()` / `algorand.createTransaction.appUpdate()` / `algorand.send.appUpdateMethodCall()` +/ `algorand.createTransaction.appUpdateMethodCall()` instead + +Updates a smart contract app. diff --git a/docs/code/index/functions/waitForConfirmation.md b/docs/code/index/functions/waitForConfirmation.md new file mode 100644 index 00000000..4142b463 --- /dev/null +++ b/docs/code/index/functions/waitForConfirmation.md @@ -0,0 +1,44 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / waitForConfirmation + +# Function: waitForConfirmation() + +> **waitForConfirmation**(`transactionId`, `maxRoundsToWait`, `algod`): `Promise`\<`PendingTransactionResponse`\> + +Defined in: [src/transaction/transaction.ts:1000](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1000) + +Wait until the transaction is confirmed or rejected, or until `timeout` +number of rounds have passed. + +## Parameters + +### transactionId + +`string` + +The transaction ID to wait for + +### maxRoundsToWait + +Maximum number of rounds to wait + +`number` | `bigint` + +### algod + +`AlgodClient` + +An algod client + +## Returns + +`Promise`\<`PendingTransactionResponse`\> + +Pending transaction information + +## Throws + +Throws an error if the transaction is not confirmed or rejected in the next `timeout` rounds diff --git a/docs/code/index/namespaces/indexer/README.md b/docs/code/index/namespaces/indexer/README.md new file mode 100644 index 00000000..f0adadef --- /dev/null +++ b/docs/code/index/namespaces/indexer/README.md @@ -0,0 +1,49 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [index](../../README.md) / indexer + +# indexer + +## References + +### executePaginatedRequest + +Re-exports [executePaginatedRequest](../../functions/executePaginatedRequest.md) + +*** + +### lookupAccountByAddress + +Re-exports [lookupAccountByAddress](../../functions/lookupAccountByAddress.md) + +*** + +### lookupAccountCreatedApplicationByAddress + +Re-exports [lookupAccountCreatedApplicationByAddress](../../functions/lookupAccountCreatedApplicationByAddress.md) + +*** + +### lookupAssetHoldings + +Re-exports [lookupAssetHoldings](../../functions/lookupAssetHoldings.md) + +*** + +### lookupTransactionById + +Re-exports [lookupTransactionById](../../functions/lookupTransactionById.md) + +*** + +### SearchForTransactions + +Re-exports [SearchForTransactions](../../type-aliases/SearchForTransactions.md) + +*** + +### searchTransactions + +Re-exports [searchTransactions](../../functions/searchTransactions.md) diff --git a/docs/code/index/type-aliases/AccountInformation.md b/docs/code/index/type-aliases/AccountInformation.md new file mode 100644 index 00000000..cc33d7a1 --- /dev/null +++ b/docs/code/index/type-aliases/AccountInformation.md @@ -0,0 +1,23 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / AccountInformation + +# Type Alias: ~~AccountInformation~~ + +> **AccountInformation** = `Omit`\<[`NumberConverter`](NumberConverter.md)\<`AccountInformationModel`\>, `"getEncodingSchema"` \| `"toEncodingData"` \| `"authAddr"`\> & `object` + +Defined in: [src/account/account.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L135) + +## Type declaration + +### ~~authAddr?~~ + +> `optional` **authAddr**: `string` + +(spend) the address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the RekeyTo field. + +## Deprecated + +Account information at a given round. diff --git a/docs/code/index/type-aliases/NumberConverter.md b/docs/code/index/type-aliases/NumberConverter.md new file mode 100644 index 00000000..30ae1aee --- /dev/null +++ b/docs/code/index/type-aliases/NumberConverter.md @@ -0,0 +1,17 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / NumberConverter + +# Type Alias: NumberConverter\ + +> **NumberConverter**\<`T`\> = \{ \[key in keyof T\]: ToNumberIfExtends\ \} + +Defined in: [src/account/account.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L132) + +## Type Parameters + +### T + +`T` *extends* `AccountInformationModel` diff --git a/docs/code/index/type-aliases/SearchForTransactions.md b/docs/code/index/type-aliases/SearchForTransactions.md new file mode 100644 index 00000000..860d2e62 --- /dev/null +++ b/docs/code/index/type-aliases/SearchForTransactions.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / SearchForTransactions + +# Type Alias: SearchForTransactions + +> **SearchForTransactions** = `ReturnType`\<`Indexer`\[`"searchForTransactions"`\]\> + +Defined in: [src/indexer-lookup.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L4) diff --git a/docs/code/index/variables/ALGORAND_MIN_TX_FEE.md b/docs/code/index/variables/ALGORAND_MIN_TX_FEE.md new file mode 100644 index 00000000..0db667b0 --- /dev/null +++ b/docs/code/index/variables/ALGORAND_MIN_TX_FEE.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / ALGORAND\_MIN\_TX\_FEE + +# Variable: ALGORAND\_MIN\_TX\_FEE + +> `const` **ALGORAND\_MIN\_TX\_FEE**: [`AlgoAmount`](../../types/amount/classes/AlgoAmount.md) + +Defined in: [src/amount.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L93) diff --git a/docs/code/index/variables/Config.md b/docs/code/index/variables/Config.md new file mode 100644 index 00000000..734a5e8d --- /dev/null +++ b/docs/code/index/variables/Config.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / Config + +# Variable: Config + +> `const` **Config**: [`UpdatableConfig`](../../types/config/classes/UpdatableConfig.md) + +Defined in: [src/config.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/config.ts#L4) + +The AlgoKit config. To update it use the configure method. diff --git a/docs/code/index/variables/MAX_APP_CALL_ACCOUNT_REFERENCES.md b/docs/code/index/variables/MAX_APP_CALL_ACCOUNT_REFERENCES.md new file mode 100644 index 00000000..ac5ce120 --- /dev/null +++ b/docs/code/index/variables/MAX_APP_CALL_ACCOUNT_REFERENCES.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / MAX\_APP\_CALL\_ACCOUNT\_REFERENCES + +# Variable: MAX\_APP\_CALL\_ACCOUNT\_REFERENCES + +> `const` **MAX\_APP\_CALL\_ACCOUNT\_REFERENCES**: `4` = `4` + +Defined in: [src/transaction/transaction.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L33) diff --git a/docs/code/index/variables/MAX_APP_CALL_FOREIGN_REFERENCES.md b/docs/code/index/variables/MAX_APP_CALL_FOREIGN_REFERENCES.md new file mode 100644 index 00000000..fc8dcd3b --- /dev/null +++ b/docs/code/index/variables/MAX_APP_CALL_FOREIGN_REFERENCES.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / MAX\_APP\_CALL\_FOREIGN\_REFERENCES + +# Variable: MAX\_APP\_CALL\_FOREIGN\_REFERENCES + +> `const` **MAX\_APP\_CALL\_FOREIGN\_REFERENCES**: `8` = `8` + +Defined in: [src/transaction/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L32) diff --git a/docs/code/index/variables/MAX_TRANSACTION_GROUP_SIZE.md b/docs/code/index/variables/MAX_TRANSACTION_GROUP_SIZE.md new file mode 100644 index 00000000..4b2f516a --- /dev/null +++ b/docs/code/index/variables/MAX_TRANSACTION_GROUP_SIZE.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / MAX\_TRANSACTION\_GROUP\_SIZE + +# Variable: MAX\_TRANSACTION\_GROUP\_SIZE + +> `const` **MAX\_TRANSACTION\_GROUP\_SIZE**: `16` = `16` + +Defined in: [src/transaction/transaction.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L31) diff --git a/docs/code/index/variables/getSenderTransactionSigner.md b/docs/code/index/variables/getSenderTransactionSigner.md new file mode 100644 index 00000000..56d1a4c0 --- /dev/null +++ b/docs/code/index/variables/getSenderTransactionSigner.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [index](../README.md) / getSenderTransactionSigner + +# Variable: ~~getSenderTransactionSigner()~~ + +> `const` **getSenderTransactionSigner**: (`val`) => `TransactionSigner` + +Defined in: [src/transaction/transaction.ts:168](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L168) + +## Parameters + +### val + +[`SendTransactionFrom`](../../types/transaction/type-aliases/SendTransactionFrom.md) + +## Returns + +`TransactionSigner` + +A transaction signer + +## Deprecated + +Use `TransactionSignerAccount` instead of `SendTransactionFrom` or use +`algosdk.makeBasicAccountTransactionSigner` / `algosdk.makeLogicSigAccountTransactionSigner`. + +Returns a `TransactionSigner` for the given transaction sender. +This function has memoization, so will return the same transaction signer for a given sender. diff --git a/docs/code/interfaces/types_account.AccountConfig.md b/docs/code/interfaces/types_account.AccountConfig.md deleted file mode 100644 index 37b3eb45..00000000 --- a/docs/code/interfaces/types_account.AccountConfig.md +++ /dev/null @@ -1,69 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/account](../modules/types_account.md) / AccountConfig - -# Interface: AccountConfig - -[types/account](../modules/types_account.md).AccountConfig - -**`Deprecated`** - -The methods that use this can be achieved using `AccountManager` instead. -Config for an account config - -## Table of contents - -### Properties - -- [accountMnemonic](types_account.AccountConfig.md#accountmnemonic) -- [accountName](types_account.AccountConfig.md#accountname) -- [senderAddress](types_account.AccountConfig.md#senderaddress) -- [senderMnemonic](types_account.AccountConfig.md#sendermnemonic) - -## Properties - -### accountMnemonic - -• **accountMnemonic**: `string` - -Mnemonic for an account - -#### Defined in - -[src/types/account.ts:294](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L294) - -___ - -### accountName - -• **accountName**: `string` - -Account name used to retrieve config - -#### Defined in - -[src/types/account.ts:298](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L298) - -___ - -### senderAddress - -• `Optional` **senderAddress**: `string` - -Address of a rekeyed account - -#### Defined in - -[src/types/account.ts:296](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L296) - -___ - -### senderMnemonic - -• `Optional` **senderMnemonic**: `string` - -**`Deprecated`** - -Renamed to senderAddress in 2.3.1 - -#### Defined in - -[src/types/account.ts:301](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L301) diff --git a/docs/code/interfaces/types_account.TransactionSignerAccount.md b/docs/code/interfaces/types_account.TransactionSignerAccount.md deleted file mode 100644 index 0717c1e6..00000000 --- a/docs/code/interfaces/types_account.TransactionSignerAccount.md +++ /dev/null @@ -1,34 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/account](../modules/types_account.md) / TransactionSignerAccount - -# Interface: TransactionSignerAccount - -[types/account](../modules/types_account.md).TransactionSignerAccount - -A wrapper around `TransactionSigner` that also has the sender address. - -## Table of contents - -### Properties - -- [addr](types_account.TransactionSignerAccount.md#addr) -- [signer](types_account.TransactionSignerAccount.md#signer) - -## Properties - -### addr - -• **addr**: `Readonly`\<`Address`\> - -#### Defined in - -[src/types/account.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L124) - -___ - -### signer - -• **signer**: `TransactionSigner` - -#### Defined in - -[src/types/account.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L125) diff --git a/docs/code/interfaces/types_account_manager.EnsureFundedResult.md b/docs/code/interfaces/types_account_manager.EnsureFundedResult.md deleted file mode 100644 index 05a89850..00000000 --- a/docs/code/interfaces/types_account_manager.EnsureFundedResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/account-manager](../modules/types_account_manager.md) / EnsureFundedResult - -# Interface: EnsureFundedResult - -[types/account-manager](../modules/types_account_manager.md).EnsureFundedResult - -Result from performing an ensureFunded call. - -## Table of contents - -### Properties - -- [amountFunded](types_account_manager.EnsureFundedResult.md#amountfunded) -- [transactionId](types_account_manager.EnsureFundedResult.md#transactionid) - -## Properties - -### amountFunded - -• **amountFunded**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The amount that was sent to the account. - -#### Defined in - -[src/types/account-manager.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L22) - -___ - -### transactionId - -• **transactionId**: `string` - -The transaction ID of the transaction that funded the account. - -#### Defined in - -[src/types/account-manager.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L20) diff --git a/docs/code/interfaces/types_app.AppCallParams.md b/docs/code/interfaces/types_app.AppCallParams.md deleted file mode 100644 index bc51f40e..00000000 --- a/docs/code/interfaces/types_app.AppCallParams.md +++ /dev/null @@ -1,233 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppCallParams - -# Interface: AppCallParams - -[types/app](../modules/types_app.md).AppCallParams - -Parameters representing a call to an app. - -## Hierarchy - -- [`SendTransactionParams`](types_transaction.SendTransactionParams.md) - - ↳ **`AppCallParams`** - -## Table of contents - -### Properties - -- [appId](types_app.AppCallParams.md#appid) -- [args](types_app.AppCallParams.md#args) -- [atc](types_app.AppCallParams.md#atc) -- [callType](types_app.AppCallParams.md#calltype) -- [fee](types_app.AppCallParams.md#fee) -- [from](types_app.AppCallParams.md#from) -- [maxFee](types_app.AppCallParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_app.AppCallParams.md#maxroundstowaitforconfirmation) -- [note](types_app.AppCallParams.md#note) -- [populateAppCallResources](types_app.AppCallParams.md#populateappcallresources) -- [skipSending](types_app.AppCallParams.md#skipsending) -- [skipWaiting](types_app.AppCallParams.md#skipwaiting) -- [suppressLog](types_app.AppCallParams.md#suppresslog) -- [transactionParams](types_app.AppCallParams.md#transactionparams) - -## Properties - -### appId - -• **appId**: `number` \| `bigint` - -The id of the app to call - -#### Defined in - -[src/types/app.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L185) - -___ - -### args - -• `Optional` **args**: [`AppCallArgs`](../modules/types_app.md#appcallargs) - -The arguments passed in to the app call - -#### Defined in - -[src/types/app.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L195) - -___ - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[atc](types_transaction.SendTransactionParams.md#atc) - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### callType - -• **callType**: ``"no_op"`` \| ``"opt_in"`` \| ``"close_out"`` \| ``"clear_state"`` \| ``"delete_application"`` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `ClearStateOC` \| `DeleteApplicationOC` - -The type of call, everything except create (see `createApp`) and update (see `updateApp`) - -#### Defined in - -[src/types/app.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L187) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee) - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### from - -• **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account to make the call from - -#### Defined in - -[src/types/app.ts:189](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L189) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxFee](types_transaction.SendTransactionParams.md#maxfee) - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Defined in - -[src/types/app.ts:193](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L193) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[populateAppCallResources](types_transaction.SendTransactionParams.md#populateappcallresources) - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipSending](types_transaction.SendTransactionParams.md#skipsending) - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipWaiting](types_transaction.SendTransactionParams.md#skipwaiting) - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[suppressLog](types_transaction.SendTransactionParams.md#suppresslog) - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Defined in - -[src/types/app.ts:191](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L191) diff --git a/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md b/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md deleted file mode 100644 index b975c0db..00000000 --- a/docs/code/interfaces/types_app.AppCallTransactionResultOfType.md +++ /dev/null @@ -1,108 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppCallTransactionResultOfType - -# Interface: AppCallTransactionResultOfType\ - -[types/app](../modules/types_app.md).AppCallTransactionResultOfType - -The result of preparing and/or sending multiple transactions - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Hierarchy - -- [`SendTransactionResults`](types_transaction.SendTransactionResults.md) - -- [`SendTransactionResult`](types_transaction.SendTransactionResult.md) - - ↳ **`AppCallTransactionResultOfType`** - -## Table of contents - -### Properties - -- [confirmation](types_app.AppCallTransactionResultOfType.md#confirmation) -- [confirmations](types_app.AppCallTransactionResultOfType.md#confirmations) -- [return](types_app.AppCallTransactionResultOfType.md#return) -- [transaction](types_app.AppCallTransactionResultOfType.md#transaction) -- [transactions](types_app.AppCallTransactionResultOfType.md#transactions) - -## Properties - -### confirmation - -• `Optional` **confirmation**: `PendingTransactionResponse` - -The response if the transaction was sent and waited for - -#### Inherited from - -[SendTransactionResult](types_transaction.SendTransactionResult.md).[confirmation](types_transaction.SendTransactionResult.md#confirmation) - -#### Defined in - -[src/types/transaction.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L57) - -___ - -### confirmations - -• `Optional` **confirmations**: `PendingTransactionResponse`[] - -The responses if the transactions were sent and waited for, -the index of the confirmation will match the index of the underlying transaction - -#### Inherited from - -[SendTransactionResults](types_transaction.SendTransactionResults.md).[confirmations](types_transaction.SendTransactionResults.md#confirmations) - -#### Defined in - -[src/types/transaction.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L67) - -___ - -### return - -• `Optional` **return**: `T` - -If an ABI method was called the processed return value - -#### Defined in - -[src/types/app.ts:228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L228) - -___ - -### transaction - -• **transaction**: `Transaction` - -The transaction - -#### Inherited from - -[SendTransactionResult](types_transaction.SendTransactionResult.md).[transaction](types_transaction.SendTransactionResult.md#transaction) - -#### Defined in - -[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) - -___ - -### transactions - -• **transactions**: `Transaction`[] - -The transactions that have been prepared and/or sent - -#### Inherited from - -[SendTransactionResults](types_transaction.SendTransactionResults.md).[transactions](types_transaction.SendTransactionResults.md#transactions) - -#### Defined in - -[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) diff --git a/docs/code/interfaces/types_app.AppCompilationResult.md b/docs/code/interfaces/types_app.AppCompilationResult.md deleted file mode 100644 index 8d22ba97..00000000 --- a/docs/code/interfaces/types_app.AppCompilationResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppCompilationResult - -# Interface: AppCompilationResult - -[types/app](../modules/types_app.md).AppCompilationResult - -The result of compiling the approval and clear state TEAL programs for an app - -## Table of contents - -### Properties - -- [compiledApproval](types_app.AppCompilationResult.md#compiledapproval) -- [compiledClear](types_app.AppCompilationResult.md#compiledclear) - -## Properties - -### compiledApproval - -• **compiledApproval**: [`CompiledTeal`](types_app.CompiledTeal.md) - -The result of compiling the approval program - -#### Defined in - -[src/types/app.ts:335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L335) - -___ - -### compiledClear - -• **compiledClear**: [`CompiledTeal`](types_app.CompiledTeal.md) - -The result of compiling the clear state program - -#### Defined in - -[src/types/app.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L337) diff --git a/docs/code/interfaces/types_app.AppDeployMetadata.md b/docs/code/interfaces/types_app.AppDeployMetadata.md deleted file mode 100644 index 97f2a0b0..00000000 --- a/docs/code/interfaces/types_app.AppDeployMetadata.md +++ /dev/null @@ -1,72 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppDeployMetadata - -# Interface: AppDeployMetadata - -[types/app](../modules/types_app.md).AppDeployMetadata - -The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with `APP_DEPLOY_NOTE_PREFIX`. - -## Hierarchy - -- **`AppDeployMetadata`** - - ↳ [`AppMetadata`](types_app_deployer.AppMetadata.md) - - ↳ [`AppMetadata`](types_app.AppMetadata.md) - -## Table of contents - -### Properties - -- [deletable](types_app.AppDeployMetadata.md#deletable) -- [name](types_app.AppDeployMetadata.md#name) -- [updatable](types_app.AppDeployMetadata.md#updatable) -- [version](types_app.AppDeployMetadata.md#version) - -## Properties - -### deletable - -• `Optional` **deletable**: `boolean` - -Whether or not the app is deletable / permanent / unspecified - -#### Defined in - -[src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) - -___ - -### name - -• **name**: `string` - -The unique name identifier of the app within the creator account - -#### Defined in - -[src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249) - -___ - -### updatable - -• `Optional` **updatable**: `boolean` - -Whether or not the app is updatable / immutable / unspecified - -#### Defined in - -[src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255) - -___ - -### version - -• **version**: `string` - -The version of app that is / will be deployed - -#### Defined in - -[src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251) diff --git a/docs/code/interfaces/types_app.AppDeploymentParams.md b/docs/code/interfaces/types_app.AppDeploymentParams.md deleted file mode 100644 index 1ca9f699..00000000 --- a/docs/code/interfaces/types_app.AppDeploymentParams.md +++ /dev/null @@ -1,305 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppDeploymentParams - -# Interface: AppDeploymentParams - -[types/app](../modules/types_app.md).AppDeploymentParams - -The parameters to deploy an app - -## Hierarchy - -- `Omit`\<[`CreateAppParams`](types_app.CreateAppParams.md), ``"onCompleteAction"`` \| ``"args"`` \| ``"note"`` \| ``"skipSending"`` \| ``"skipWaiting"`` \| ``"atc"``\> - - ↳ **`AppDeploymentParams`** - -## Table of contents - -### Properties - -- [approvalProgram](types_app.AppDeploymentParams.md#approvalprogram) -- [clearStateProgram](types_app.AppDeploymentParams.md#clearstateprogram) -- [createArgs](types_app.AppDeploymentParams.md#createargs) -- [createOnCompleteAction](types_app.AppDeploymentParams.md#createoncompleteaction) -- [deleteArgs](types_app.AppDeploymentParams.md#deleteargs) -- [deployTimeParams](types_app.AppDeploymentParams.md#deploytimeparams) -- [existingDeployments](types_app.AppDeploymentParams.md#existingdeployments) -- [fee](types_app.AppDeploymentParams.md#fee) -- [from](types_app.AppDeploymentParams.md#from) -- [maxFee](types_app.AppDeploymentParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_app.AppDeploymentParams.md#maxroundstowaitforconfirmation) -- [metadata](types_app.AppDeploymentParams.md#metadata) -- [onSchemaBreak](types_app.AppDeploymentParams.md#onschemabreak) -- [onUpdate](types_app.AppDeploymentParams.md#onupdate) -- [populateAppCallResources](types_app.AppDeploymentParams.md#populateappcallresources) -- [schema](types_app.AppDeploymentParams.md#schema) -- [suppressLog](types_app.AppDeploymentParams.md#suppresslog) -- [transactionParams](types_app.AppDeploymentParams.md#transactionparams) -- [updateArgs](types_app.AppDeploymentParams.md#updateargs) - -## Properties - -### approvalProgram - -• **approvalProgram**: `string` \| `Uint8Array` - -The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) - -#### Inherited from - -Omit.approvalProgram - -#### Defined in - -[src/types/app.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L135) - -___ - -### clearStateProgram - -• **clearStateProgram**: `string` \| `Uint8Array` - -The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) - -#### Inherited from - -Omit.clearStateProgram - -#### Defined in - -[src/types/app.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L137) - -___ - -### createArgs - -• `Optional` **createArgs**: [`AppCallArgs`](../modules/types_app.md#appcallargs) - -Any args to pass to any create transaction that is issued as part of deployment - -#### Defined in - -[src/types/app.ts:323](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L323) - -___ - -### createOnCompleteAction - -• `Optional` **createOnCompleteAction**: ``"no_op"`` \| ``"opt_in"`` \| ``"close_out"`` \| ``"update_application"`` \| ``"delete_application"`` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` - -Override the on-completion action for the create call; defaults to NoOp - -#### Defined in - -[src/types/app.ts:325](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L325) - -___ - -### deleteArgs - -• `Optional` **deleteArgs**: [`AppCallArgs`](../modules/types_app.md#appcallargs) - -Any args to pass to any delete transaction that is issued as part of deployment - -#### Defined in - -[src/types/app.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L329) - -___ - -### deployTimeParams - -• `Optional` **deployTimeParams**: [`TealTemplateParams`](types_app.TealTemplateParams.md) - -Any deploy-time parameters to replace in the TEAL code - -#### Defined in - -[src/types/app.ts:315](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L315) - -___ - -### existingDeployments - -• `Optional` **existingDeployments**: [`AppLookup`](types_app.AppLookup.md) - -Optional cached value of the existing apps for the given creator - -#### Defined in - -[src/types/app.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L321) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -Omit.fee - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### from - -• **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account (with private key loaded) that will send the transaction - -#### Inherited from - -Omit.from - -#### Defined in - -[src/types/app.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L133) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -Omit.maxFee - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -Omit.maxRoundsToWaitForConfirmation - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### metadata - -• **metadata**: [`AppDeployMetadata`](types_app.AppDeployMetadata.md) - -The deployment metadata - -#### Defined in - -[src/types/app.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L313) - -___ - -### onSchemaBreak - -• `Optional` **onSchemaBreak**: [`OnSchemaBreak`](../enums/types_app.OnSchemaBreak.md) \| ``"replace"`` \| ``"fail"`` \| ``"append"`` - -What action to perform if a schema break is detected - -#### Defined in - -[src/types/app.ts:317](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L317) - -___ - -### onUpdate - -• `Optional` **onUpdate**: ``"replace"`` \| ``"fail"`` \| ``"append"`` \| [`OnUpdate`](../enums/types_app.OnUpdate.md) \| ``"update"`` - -What action to perform if a TEAL update is detected - -#### Defined in - -[src/types/app.ts:319](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L319) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -Omit.populateAppCallResources - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### schema - -• **schema**: [`AppStorageSchema`](types_app.AppStorageSchema.md) - -The storage schema to request for the created app - -#### Inherited from - -Omit.schema - -#### Defined in - -[src/types/app.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L152) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -Omit.suppressLog - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Inherited from - -Omit.transactionParams - -#### Defined in - -[src/types/app.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L139) - -___ - -### updateArgs - -• `Optional` **updateArgs**: [`AppCallArgs`](../modules/types_app.md#appcallargs) - -Any args to pass to any update transaction that is issued as part of deployment - -#### Defined in - -[src/types/app.ts:327](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L327) diff --git a/docs/code/interfaces/types_app.AppLookup.md b/docs/code/interfaces/types_app.AppLookup.md deleted file mode 100644 index cdfe0176..00000000 --- a/docs/code/interfaces/types_app.AppLookup.md +++ /dev/null @@ -1,34 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppLookup - -# Interface: AppLookup - -[types/app](../modules/types_app.md).AppLookup - -A lookup of name -> Algorand app for a creator - -## Table of contents - -### Properties - -- [apps](types_app.AppLookup.md#apps) -- [creator](types_app.AppLookup.md#creator) - -## Properties - -### apps - -• **apps**: `Readonly`\<\{ `[name: string]`: [`AppMetadata`](types_app.AppMetadata.md); }\> - -#### Defined in - -[src/types/app.ts:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L273) - -___ - -### creator - -• **creator**: `string` - -#### Defined in - -[src/types/app.ts:272](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L272) diff --git a/docs/code/interfaces/types_app.AppMetadata.md b/docs/code/interfaces/types_app.AppMetadata.md deleted file mode 100644 index 104f4f04..00000000 --- a/docs/code/interfaces/types_app.AppMetadata.md +++ /dev/null @@ -1,174 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppMetadata - -# Interface: AppMetadata - -[types/app](../modules/types_app.md).AppMetadata - -The metadata that can be collected about a deployed app - -## Hierarchy - -- [`AppReference`](types_app.AppReference.md) - -- [`AppDeployMetadata`](types_app.AppDeployMetadata.md) - - ↳ **`AppMetadata`** - -## Table of contents - -### Properties - -- [appAddress](types_app.AppMetadata.md#appaddress) -- [appId](types_app.AppMetadata.md#appid) -- [createdMetadata](types_app.AppMetadata.md#createdmetadata) -- [createdRound](types_app.AppMetadata.md#createdround) -- [deletable](types_app.AppMetadata.md#deletable) -- [deleted](types_app.AppMetadata.md#deleted) -- [name](types_app.AppMetadata.md#name) -- [updatable](types_app.AppMetadata.md#updatable) -- [updatedRound](types_app.AppMetadata.md#updatedround) -- [version](types_app.AppMetadata.md#version) - -## Properties - -### appAddress - -• **appAddress**: `string` - -The Algorand address of the account associated with the app - -#### Inherited from - -[AppReference](types_app.AppReference.md).[appAddress](types_app.AppReference.md#appaddress) - -#### Defined in - -[src/types/app.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L43) - -___ - -### appId - -• **appId**: `number` \| `bigint` - -The id of the app - -#### Inherited from - -[AppReference](types_app.AppReference.md).[appId](types_app.AppReference.md#appid) - -#### Defined in - -[src/types/app.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L41) - -___ - -### createdMetadata - -• **createdMetadata**: [`AppDeployMetadata`](types_app.AppDeployMetadata.md) - -The metadata when the app was created - -#### Defined in - -[src/types/app.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L265) - -___ - -### createdRound - -• **createdRound**: `number` - -The round the app was created - -#### Defined in - -[src/types/app.ts:261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L261) - -___ - -### deletable - -• `Optional` **deletable**: `boolean` - -Whether or not the app is deletable / permanent / unspecified - -#### Inherited from - -[AppDeployMetadata](types_app.AppDeployMetadata.md).[deletable](types_app.AppDeployMetadata.md#deletable) - -#### Defined in - -[src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) - -___ - -### deleted - -• **deleted**: `boolean` - -Whether or not the app is deleted - -#### Defined in - -[src/types/app.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L267) - -___ - -### name - -• **name**: `string` - -The unique name identifier of the app within the creator account - -#### Inherited from - -[AppDeployMetadata](types_app.AppDeployMetadata.md).[name](types_app.AppDeployMetadata.md#name) - -#### Defined in - -[src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249) - -___ - -### updatable - -• `Optional` **updatable**: `boolean` - -Whether or not the app is updatable / immutable / unspecified - -#### Inherited from - -[AppDeployMetadata](types_app.AppDeployMetadata.md).[updatable](types_app.AppDeployMetadata.md#updatable) - -#### Defined in - -[src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255) - -___ - -### updatedRound - -• **updatedRound**: `number` - -The last round that the app was updated - -#### Defined in - -[src/types/app.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L263) - -___ - -### version - -• **version**: `string` - -The version of app that is / will be deployed - -#### Inherited from - -[AppDeployMetadata](types_app.AppDeployMetadata.md).[version](types_app.AppDeployMetadata.md#version) - -#### Defined in - -[src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251) diff --git a/docs/code/interfaces/types_app.AppReference.md b/docs/code/interfaces/types_app.AppReference.md deleted file mode 100644 index 90633cd7..00000000 --- a/docs/code/interfaces/types_app.AppReference.md +++ /dev/null @@ -1,44 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppReference - -# Interface: AppReference - -[types/app](../modules/types_app.md).AppReference - -Information about an Algorand app - -## Hierarchy - -- **`AppReference`** - - ↳ [`AppMetadata`](types_app.AppMetadata.md) - -## Table of contents - -### Properties - -- [appAddress](types_app.AppReference.md#appaddress) -- [appId](types_app.AppReference.md#appid) - -## Properties - -### appAddress - -• **appAddress**: `string` - -The Algorand address of the account associated with the app - -#### Defined in - -[src/types/app.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L43) - -___ - -### appId - -• **appId**: `number` \| `bigint` - -The id of the app - -#### Defined in - -[src/types/app.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L41) diff --git a/docs/code/interfaces/types_app.AppState.md b/docs/code/interfaces/types_app.AppState.md deleted file mode 100644 index f92066be..00000000 --- a/docs/code/interfaces/types_app.AppState.md +++ /dev/null @@ -1,11 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppState - -# Interface: AppState - -[types/app](../modules/types_app.md).AppState - -Object holding app state values - -## Indexable - -▪ [key: `string`]: \{ `keyBase64`: `string` ; `keyRaw`: `Uint8Array` ; `value`: `bigint` } \| \{ `keyBase64`: `string` ; `keyRaw`: `Uint8Array` ; `value`: `string` ; `valueBase64`: `string` ; `valueRaw`: `Uint8Array` } diff --git a/docs/code/interfaces/types_app.AppStorageSchema.md b/docs/code/interfaces/types_app.AppStorageSchema.md deleted file mode 100644 index 1280c927..00000000 --- a/docs/code/interfaces/types_app.AppStorageSchema.md +++ /dev/null @@ -1,77 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / AppStorageSchema - -# Interface: AppStorageSchema - -[types/app](../modules/types_app.md).AppStorageSchema - -Parameters representing the storage schema of an app. - -## Table of contents - -### Properties - -- [extraPages](types_app.AppStorageSchema.md#extrapages) -- [globalByteSlices](types_app.AppStorageSchema.md#globalbyteslices) -- [globalInts](types_app.AppStorageSchema.md#globalints) -- [localByteSlices](types_app.AppStorageSchema.md#localbyteslices) -- [localInts](types_app.AppStorageSchema.md#localints) - -## Properties - -### extraPages - -• `Optional` **extraPages**: `number` - -Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size - -#### Defined in - -[src/types/app.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L209) - -___ - -### globalByteSlices - -• **globalByteSlices**: `number` - -Restricts number of byte slices in global state - -#### Defined in - -[src/types/app.ts:207](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L207) - -___ - -### globalInts - -• **globalInts**: `number` - -Restricts number of ints in global state - -#### Defined in - -[src/types/app.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L205) - -___ - -### localByteSlices - -• **localByteSlices**: `number` - -Restricts number of byte slices in per-user local state - -#### Defined in - -[src/types/app.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L203) - -___ - -### localInts - -• **localInts**: `number` - -Restricts number of ints in per-user local state - -#### Defined in - -[src/types/app.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L201) diff --git a/docs/code/interfaces/types_app.BoxName.md b/docs/code/interfaces/types_app.BoxName.md deleted file mode 100644 index 16dc8fda..00000000 --- a/docs/code/interfaces/types_app.BoxName.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / BoxName - -# Interface: BoxName - -[types/app](../modules/types_app.md).BoxName - -The name of a box storage box - -## Table of contents - -### Properties - -- [name](types_app.BoxName.md#name) -- [nameBase64](types_app.BoxName.md#namebase64) -- [nameRaw](types_app.BoxName.md#nameraw) - -## Properties - -### name - -• **name**: `string` - -Name in UTF-8 - -#### Defined in - -[src/types/app.ts:387](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L387) - -___ - -### nameBase64 - -• **nameBase64**: `string` - -Name in Base64 - -#### Defined in - -[src/types/app.ts:391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L391) - -___ - -### nameRaw - -• **nameRaw**: `Uint8Array` - -Name in binary bytes - -#### Defined in - -[src/types/app.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L389) diff --git a/docs/code/interfaces/types_app.BoxReference.md b/docs/code/interfaces/types_app.BoxReference.md deleted file mode 100644 index af39545f..00000000 --- a/docs/code/interfaces/types_app.BoxReference.md +++ /dev/null @@ -1,42 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / BoxReference - -# Interface: BoxReference - -[types/app](../modules/types_app.md).BoxReference - -**`Deprecated`** - -Use `types/app-manager/BoxReference` instead. - -A grouping of the app ID and name of the box in an Uint8Array - -## Table of contents - -### Properties - -- [appId](types_app.BoxReference.md#appid) -- [name](types_app.BoxReference.md#name) - -## Properties - -### appId - -• **appId**: `number` \| `bigint` - -A unique application id - -#### Defined in - -[src/types/app.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L55) - -___ - -### name - -• **name**: [`BoxIdentifier`](../modules/types_app.md#boxidentifier) - -Name of box to reference - -#### Defined in - -[src/types/app.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L59) diff --git a/docs/code/interfaces/types_app.BoxValueRequestParams.md b/docs/code/interfaces/types_app.BoxValueRequestParams.md deleted file mode 100644 index c9e6b693..00000000 --- a/docs/code/interfaces/types_app.BoxValueRequestParams.md +++ /dev/null @@ -1,54 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / BoxValueRequestParams - -# Interface: BoxValueRequestParams - -[types/app](../modules/types_app.md).BoxValueRequestParams - -**`Deprecated`** - -Use `types/app-manager/BoxValueRequestParams` instead. -Parameters to get and decode a box value as an ABI type. - -## Table of contents - -### Properties - -- [appId](types_app.BoxValueRequestParams.md#appid) -- [boxName](types_app.BoxValueRequestParams.md#boxname) -- [type](types_app.BoxValueRequestParams.md#type) - -## Properties - -### appId - -• **appId**: `number` \| `bigint` - -The ID of the app return box names for - -#### Defined in - -[src/types/app.ts:400](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L400) - -___ - -### boxName - -• **boxName**: `string` \| `Uint8Array` \| [`BoxName`](types_app.BoxName.md) - -The name of the box to return either as a string, binary array or `BoxName` - -#### Defined in - -[src/types/app.ts:402](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L402) - -___ - -### type - -• **type**: `ABIType` - -The ABI type to decode the value using - -#### Defined in - -[src/types/app.ts:404](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L404) diff --git a/docs/code/interfaces/types_app.BoxValuesRequestParams.md b/docs/code/interfaces/types_app.BoxValuesRequestParams.md deleted file mode 100644 index df0fbfe6..00000000 --- a/docs/code/interfaces/types_app.BoxValuesRequestParams.md +++ /dev/null @@ -1,54 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / BoxValuesRequestParams - -# Interface: BoxValuesRequestParams - -[types/app](../modules/types_app.md).BoxValuesRequestParams - -**`Deprecated`** - -Use `types/app-manager/BoxValuesRequestParams` instead. -Parameters to get and decode a box value as an ABI type. - -## Table of contents - -### Properties - -- [appId](types_app.BoxValuesRequestParams.md#appid) -- [boxNames](types_app.BoxValuesRequestParams.md#boxnames) -- [type](types_app.BoxValuesRequestParams.md#type) - -## Properties - -### appId - -• **appId**: `number` - -The ID of the app return box names for - -#### Defined in - -[src/types/app.ts:413](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L413) - -___ - -### boxNames - -• **boxNames**: (`string` \| `Uint8Array` \| [`BoxName`](types_app.BoxName.md))[] - -The names of the boxes to return either as a string, binary array or BoxName` - -#### Defined in - -[src/types/app.ts:415](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L415) - -___ - -### type - -• **type**: `ABIType` - -The ABI type to decode the value using - -#### Defined in - -[src/types/app.ts:417](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L417) diff --git a/docs/code/interfaces/types_app.CompiledTeal.md b/docs/code/interfaces/types_app.CompiledTeal.md deleted file mode 100644 index 99e3c525..00000000 --- a/docs/code/interfaces/types_app.CompiledTeal.md +++ /dev/null @@ -1,77 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / CompiledTeal - -# Interface: CompiledTeal - -[types/app](../modules/types_app.md).CompiledTeal - -Information about a compiled teal program - -## Table of contents - -### Properties - -- [compiled](types_app.CompiledTeal.md#compiled) -- [compiledBase64ToBytes](types_app.CompiledTeal.md#compiledbase64tobytes) -- [compiledHash](types_app.CompiledTeal.md#compiledhash) -- [sourceMap](types_app.CompiledTeal.md#sourcemap) -- [teal](types_app.CompiledTeal.md#teal) - -## Properties - -### compiled - -• **compiled**: `string` - -The compiled code - -#### Defined in - -[src/types/app.ts:217](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L217) - -___ - -### compiledBase64ToBytes - -• **compiledBase64ToBytes**: `Uint8Array` - -The base64 encoded code as a byte array - -#### Defined in - -[src/types/app.ts:221](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L221) - -___ - -### compiledHash - -• **compiledHash**: `string` - -The hash returned by the compiler - -#### Defined in - -[src/types/app.ts:219](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L219) - -___ - -### sourceMap - -• **sourceMap**: `ProgramSourceMap` - -Source map from the compilation - -#### Defined in - -[src/types/app.ts:223](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L223) - -___ - -### teal - -• **teal**: `string` - -Original TEAL code - -#### Defined in - -[src/types/app.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L215) diff --git a/docs/code/interfaces/types_app.CoreAppCallArgs.md b/docs/code/interfaces/types_app.CoreAppCallArgs.md deleted file mode 100644 index acbf17a8..00000000 --- a/docs/code/interfaces/types_app.CoreAppCallArgs.md +++ /dev/null @@ -1,98 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / CoreAppCallArgs - -# Interface: CoreAppCallArgs - -[types/app](../modules/types_app.md).CoreAppCallArgs - -Common app call arguments for ABI and non-ABI (raw) calls - -## Hierarchy - -- **`CoreAppCallArgs`** - - ↳ [`RawAppCallArgs`](types_app.RawAppCallArgs.md) - -## Table of contents - -### Properties - -- [accounts](types_app.CoreAppCallArgs.md#accounts) -- [apps](types_app.CoreAppCallArgs.md#apps) -- [assets](types_app.CoreAppCallArgs.md#assets) -- [boxes](types_app.CoreAppCallArgs.md#boxes) -- [lease](types_app.CoreAppCallArgs.md#lease) -- [rekeyTo](types_app.CoreAppCallArgs.md#rekeyto) - -## Properties - -### accounts - -• `Optional` **accounts**: (`string` \| `Address`)[] - -The address of any accounts to load in - -#### Defined in - -[src/types/app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L79) - -___ - -### apps - -• `Optional` **apps**: `number`[] - -IDs of any apps to load into the foreignApps array - -#### Defined in - -[src/types/app.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L81) - -___ - -### assets - -• `Optional` **assets**: `number`[] - -IDs of any assets to load into the foreignAssets array - -#### Defined in - -[src/types/app.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L83) - -___ - -### boxes - -• `Optional` **boxes**: ([`BoxReference`](types_app.BoxReference.md) \| [`BoxIdentifier`](../modules/types_app.md#boxidentifier) \| `BoxReference`)[] - -Any box references to load - -#### Defined in - -[src/types/app.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L77) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -The optional lease for the transaction - -#### Defined in - -[src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction. - -**Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first. - -#### Defined in - -[src/types/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L88) diff --git a/docs/code/interfaces/types_app.CreateAppParams.md b/docs/code/interfaces/types_app.CreateAppParams.md deleted file mode 100644 index 94c796a3..00000000 --- a/docs/code/interfaces/types_app.CreateAppParams.md +++ /dev/null @@ -1,287 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / CreateAppParams - -# Interface: CreateAppParams - -[types/app](../modules/types_app.md).CreateAppParams - -**`Deprecated`** - -Use `TransactionComposer` to construct create app transactions instead. - -Parameters that are passed in when creating an app. - -## Hierarchy - -- `CreateOrUpdateAppParams` - - ↳ **`CreateAppParams`** - -## Table of contents - -### Properties - -- [approvalProgram](types_app.CreateAppParams.md#approvalprogram) -- [args](types_app.CreateAppParams.md#args) -- [atc](types_app.CreateAppParams.md#atc) -- [clearStateProgram](types_app.CreateAppParams.md#clearstateprogram) -- [fee](types_app.CreateAppParams.md#fee) -- [from](types_app.CreateAppParams.md#from) -- [maxFee](types_app.CreateAppParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_app.CreateAppParams.md#maxroundstowaitforconfirmation) -- [note](types_app.CreateAppParams.md#note) -- [onCompleteAction](types_app.CreateAppParams.md#oncompleteaction) -- [populateAppCallResources](types_app.CreateAppParams.md#populateappcallresources) -- [schema](types_app.CreateAppParams.md#schema) -- [skipSending](types_app.CreateAppParams.md#skipsending) -- [skipWaiting](types_app.CreateAppParams.md#skipwaiting) -- [suppressLog](types_app.CreateAppParams.md#suppresslog) -- [transactionParams](types_app.CreateAppParams.md#transactionparams) - -## Properties - -### approvalProgram - -• **approvalProgram**: `string` \| `Uint8Array` - -The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) - -#### Inherited from - -CreateOrUpdateAppParams.approvalProgram - -#### Defined in - -[src/types/app.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L135) - -___ - -### args - -• `Optional` **args**: [`AppCallArgs`](../modules/types_app.md#appcallargs) - -The arguments passed in to the app call - -#### Inherited from - -CreateOrUpdateAppParams.args - -#### Defined in - -[src/types/app.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L143) - -___ - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -CreateOrUpdateAppParams.atc - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### clearStateProgram - -• **clearStateProgram**: `string` \| `Uint8Array` - -The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) - -#### Inherited from - -CreateOrUpdateAppParams.clearStateProgram - -#### Defined in - -[src/types/app.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L137) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -CreateOrUpdateAppParams.fee - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### from - -• **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account (with private key loaded) that will send the transaction - -#### Inherited from - -CreateOrUpdateAppParams.from - -#### Defined in - -[src/types/app.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L133) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -CreateOrUpdateAppParams.maxFee - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Inherited from - -CreateOrUpdateAppParams.note - -#### Defined in - -[src/types/app.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L141) - -___ - -### onCompleteAction - -• `Optional` **onCompleteAction**: ``"no_op"`` \| ``"opt_in"`` \| ``"close_out"`` \| ``"update_application"`` \| ``"delete_application"`` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` - -Override the on-completion action for the create call; defaults to NoOp - -#### Defined in - -[src/types/app.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L154) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -CreateOrUpdateAppParams.populateAppCallResources - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### schema - -• **schema**: [`AppStorageSchema`](types_app.AppStorageSchema.md) - -The storage schema to request for the created app - -#### Defined in - -[src/types/app.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L152) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -CreateOrUpdateAppParams.skipSending - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -CreateOrUpdateAppParams.skipWaiting - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -CreateOrUpdateAppParams.suppressLog - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Inherited from - -CreateOrUpdateAppParams.transactionParams - -#### Defined in - -[src/types/app.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L139) diff --git a/docs/code/interfaces/types_app.RawAppCallArgs.md b/docs/code/interfaces/types_app.RawAppCallArgs.md deleted file mode 100644 index 76aeb382..00000000 --- a/docs/code/interfaces/types_app.RawAppCallArgs.md +++ /dev/null @@ -1,148 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / RawAppCallArgs - -# Interface: RawAppCallArgs - -[types/app](../modules/types_app.md).RawAppCallArgs - -App call args with non-ABI (raw) values (minus some processing like encoding strings as binary) - -## Hierarchy - -- [`CoreAppCallArgs`](types_app.CoreAppCallArgs.md) - - ↳ **`RawAppCallArgs`** - -## Table of contents - -### Properties - -- [accounts](types_app.RawAppCallArgs.md#accounts) -- [appArgs](types_app.RawAppCallArgs.md#appargs) -- [apps](types_app.RawAppCallArgs.md#apps) -- [assets](types_app.RawAppCallArgs.md#assets) -- [boxes](types_app.RawAppCallArgs.md#boxes) -- [lease](types_app.RawAppCallArgs.md#lease) -- [method](types_app.RawAppCallArgs.md#method) -- [rekeyTo](types_app.RawAppCallArgs.md#rekeyto) - -## Properties - -### accounts - -• `Optional` **accounts**: (`string` \| `Address`)[] - -The address of any accounts to load in - -#### Inherited from - -[CoreAppCallArgs](types_app.CoreAppCallArgs.md).[accounts](types_app.CoreAppCallArgs.md#accounts) - -#### Defined in - -[src/types/app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L79) - -___ - -### appArgs - -• `Optional` **appArgs**: (`string` \| `Uint8Array`)[] - -Any application arguments to pass through - -#### Defined in - -[src/types/app.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L96) - -___ - -### apps - -• `Optional` **apps**: `number`[] - -IDs of any apps to load into the foreignApps array - -#### Inherited from - -[CoreAppCallArgs](types_app.CoreAppCallArgs.md).[apps](types_app.CoreAppCallArgs.md#apps) - -#### Defined in - -[src/types/app.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L81) - -___ - -### assets - -• `Optional` **assets**: `number`[] - -IDs of any assets to load into the foreignAssets array - -#### Inherited from - -[CoreAppCallArgs](types_app.CoreAppCallArgs.md).[assets](types_app.CoreAppCallArgs.md#assets) - -#### Defined in - -[src/types/app.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L83) - -___ - -### boxes - -• `Optional` **boxes**: ([`BoxReference`](types_app.BoxReference.md) \| [`BoxIdentifier`](../modules/types_app.md#boxidentifier) \| `BoxReference`)[] - -Any box references to load - -#### Inherited from - -[CoreAppCallArgs](types_app.CoreAppCallArgs.md).[boxes](types_app.CoreAppCallArgs.md#boxes) - -#### Defined in - -[src/types/app.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L77) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -The optional lease for the transaction - -#### Inherited from - -[CoreAppCallArgs](types_app.CoreAppCallArgs.md).[lease](types_app.CoreAppCallArgs.md#lease) - -#### Defined in - -[src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75) - -___ - -### method - -• `Optional` **method**: `undefined` - -Property to aid intellisense - -#### Defined in - -[src/types/app.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L98) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction. - -**Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first. - -#### Inherited from - -[CoreAppCallArgs](types_app.CoreAppCallArgs.md).[rekeyTo](types_app.CoreAppCallArgs.md#rekeyto) - -#### Defined in - -[src/types/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L88) diff --git a/docs/code/interfaces/types_app.TealTemplateParams.md b/docs/code/interfaces/types_app.TealTemplateParams.md deleted file mode 100644 index ad36e436..00000000 --- a/docs/code/interfaces/types_app.TealTemplateParams.md +++ /dev/null @@ -1,13 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / TealTemplateParams - -# Interface: TealTemplateParams - -[types/app](../modules/types_app.md).TealTemplateParams - -Dictionary of deploy-time parameters to replace in a teal template. - -Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`. - -## Indexable - -▪ [key: `string`]: `string` \| `bigint` \| `number` \| `Uint8Array` diff --git a/docs/code/interfaces/types_app.UpdateAppParams.md b/docs/code/interfaces/types_app.UpdateAppParams.md deleted file mode 100644 index 0249bd35..00000000 --- a/docs/code/interfaces/types_app.UpdateAppParams.md +++ /dev/null @@ -1,274 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app](../modules/types_app.md) / UpdateAppParams - -# Interface: UpdateAppParams - -[types/app](../modules/types_app.md).UpdateAppParams - -**`Deprecated`** - -Use `TransactionComposer` to construct update app transactions instead. - -Parameters that are passed in when updating an app. - -## Hierarchy - -- `CreateOrUpdateAppParams` - - ↳ **`UpdateAppParams`** - -## Table of contents - -### Properties - -- [appId](types_app.UpdateAppParams.md#appid) -- [approvalProgram](types_app.UpdateAppParams.md#approvalprogram) -- [args](types_app.UpdateAppParams.md#args) -- [atc](types_app.UpdateAppParams.md#atc) -- [clearStateProgram](types_app.UpdateAppParams.md#clearstateprogram) -- [fee](types_app.UpdateAppParams.md#fee) -- [from](types_app.UpdateAppParams.md#from) -- [maxFee](types_app.UpdateAppParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_app.UpdateAppParams.md#maxroundstowaitforconfirmation) -- [note](types_app.UpdateAppParams.md#note) -- [populateAppCallResources](types_app.UpdateAppParams.md#populateappcallresources) -- [skipSending](types_app.UpdateAppParams.md#skipsending) -- [skipWaiting](types_app.UpdateAppParams.md#skipwaiting) -- [suppressLog](types_app.UpdateAppParams.md#suppresslog) -- [transactionParams](types_app.UpdateAppParams.md#transactionparams) - -## Properties - -### appId - -• **appId**: `number` \| `bigint` - -The id of the app to update - -#### Defined in - -[src/types/app.ts:163](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L163) - -___ - -### approvalProgram - -• **approvalProgram**: `string` \| `Uint8Array` - -The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) - -#### Inherited from - -CreateOrUpdateAppParams.approvalProgram - -#### Defined in - -[src/types/app.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L135) - -___ - -### args - -• `Optional` **args**: [`AppCallArgs`](../modules/types_app.md#appcallargs) - -The arguments passed in to the app call - -#### Inherited from - -CreateOrUpdateAppParams.args - -#### Defined in - -[src/types/app.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L143) - -___ - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -CreateOrUpdateAppParams.atc - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### clearStateProgram - -• **clearStateProgram**: `string` \| `Uint8Array` - -The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) - -#### Inherited from - -CreateOrUpdateAppParams.clearStateProgram - -#### Defined in - -[src/types/app.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L137) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -CreateOrUpdateAppParams.fee - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### from - -• **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account (with private key loaded) that will send the transaction - -#### Inherited from - -CreateOrUpdateAppParams.from - -#### Defined in - -[src/types/app.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L133) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -CreateOrUpdateAppParams.maxFee - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Inherited from - -CreateOrUpdateAppParams.note - -#### Defined in - -[src/types/app.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L141) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -CreateOrUpdateAppParams.populateAppCallResources - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -CreateOrUpdateAppParams.skipSending - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -CreateOrUpdateAppParams.skipWaiting - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -CreateOrUpdateAppParams.suppressLog - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Inherited from - -CreateOrUpdateAppParams.transactionParams - -#### Defined in - -[src/types/app.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L139) diff --git a/docs/code/interfaces/types_app_arc56.Arc56Contract.md b/docs/code/interfaces/types_app_arc56.Arc56Contract.md deleted file mode 100644 index 2b4b064f..00000000 --- a/docs/code/interfaces/types_app_arc56.Arc56Contract.md +++ /dev/null @@ -1,284 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-arc56](../modules/types_app_arc56.md) / Arc56Contract - -# Interface: Arc56Contract - -[types/app-arc56](../modules/types_app_arc56.md).Arc56Contract - -Describes the entire contract. This interface is an extension of the interface described in ARC-4 - -## Table of contents - -### Properties - -- [arcs](types_app_arc56.Arc56Contract.md#arcs) -- [bareActions](types_app_arc56.Arc56Contract.md#bareactions) -- [byteCode](types_app_arc56.Arc56Contract.md#bytecode) -- [compilerInfo](types_app_arc56.Arc56Contract.md#compilerinfo) -- [desc](types_app_arc56.Arc56Contract.md#desc) -- [events](types_app_arc56.Arc56Contract.md#events) -- [methods](types_app_arc56.Arc56Contract.md#methods) -- [name](types_app_arc56.Arc56Contract.md#name) -- [networks](types_app_arc56.Arc56Contract.md#networks) -- [scratchVariables](types_app_arc56.Arc56Contract.md#scratchvariables) -- [source](types_app_arc56.Arc56Contract.md#source) -- [sourceInfo](types_app_arc56.Arc56Contract.md#sourceinfo) -- [state](types_app_arc56.Arc56Contract.md#state) -- [structs](types_app_arc56.Arc56Contract.md#structs) -- [templateVariables](types_app_arc56.Arc56Contract.md#templatevariables) - -## Properties - -### arcs - -• **arcs**: `number`[] - -The ARCs used and/or supported by this contract. All contracts implicitly support ARC4 and ARC56 - -#### Defined in - -[src/types/app-arc56.ts:233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L233) - -___ - -### bareActions - -• **bareActions**: `Object` - -Supported bare actions for the contract. An action is a combination of call/create and an OnComplete - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | (``"NoOp"`` \| ``"OptIn"`` \| ``"DeleteApplication"`` \| ``"CloseOut"`` \| ``"ClearState"`` \| ``"UpdateApplication"``)[] | OnCompletes this method allows when appID !== 0 | -| `create` | (``"NoOp"`` \| ``"OptIn"`` \| ``"DeleteApplication"``)[] | OnCompletes this method allows when appID === 0 | - -#### Defined in - -[src/types/app-arc56.ts:281](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L281) - -___ - -### byteCode - -• `Optional` **byteCode**: `Object` - -The compiled bytecode for the application. MUST be omitted if included as part of ARC23 - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `approval` | `string` | The approval program | -| `clear` | `string` | The clear program | - -#### Defined in - -[src/types/app-arc56.ts:302](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L302) - -___ - -### compilerInfo - -• `Optional` **compilerInfo**: `Object` - -Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `compiler` | ``"algod"`` \| ``"puya"`` | The name of the compiler | -| `compilerVersion` | \{ `commitHash?`: `string` ; `major`: `number` ; `minor`: `number` ; `patch`: `number` } | Compiler version information | -| `compilerVersion.commitHash?` | `string` | - | -| `compilerVersion.major` | `number` | - | -| `compilerVersion.minor` | `number` | - | -| `compilerVersion.patch` | `number` | - | - -#### Defined in - -[src/types/app-arc56.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L309) - -___ - -### desc - -• `Optional` **desc**: `string` - -Optional, user-friendly description for the interface - -#### Defined in - -[src/types/app-arc56.ts:237](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L237) - -___ - -### events - -• `Optional` **events**: [`Event`](types_app_arc56.Event.md)[] - -ARC-28 events that MAY be emitted by this contract - -#### Defined in - -[src/types/app-arc56.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L321) - -___ - -### methods - -• **methods**: [`Method`](types_app_arc56.Method.md)[] - -All of the methods that the contract implements - -#### Defined in - -[src/types/app-arc56.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L254) - -___ - -### name - -• **name**: `string` - -A user-friendly name for the contract - -#### Defined in - -[src/types/app-arc56.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L235) - -___ - -### networks - -• `Optional` **networks**: `Object` - -Optional object listing the contract instances across different networks. -The key is the base64 genesis hash of the network, and the value contains -information about the deployed contract in the network indicated by the -key. A key containing the human-readable name of the network MAY be -included, but the corresponding genesis hash key MUST also be defined - -#### Index signature - -▪ [network: `string`]: \{ `appID`: `number` } - -#### Defined in - -[src/types/app-arc56.ts:245](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L245) - -___ - -### scratchVariables - -• `Optional` **scratchVariables**: `Object` - -The scratch variables used during runtime - -#### Index signature - -▪ [name: `string`]: \{ `slot`: `number` ; `type`: [`ABIType`](../modules/types_app_arc56.md#abitype) \| [`AVMType`](../modules/types_app_arc56.md#avmtype) \| [`StructName`](../modules/types_app_arc56.md#structname) } - -#### Defined in - -[src/types/app-arc56.ts:332](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L332) - -___ - -### source - -• `Optional` **source**: `Object` - -The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `approval` | `string` | The approval program | -| `clear` | `string` | The clear program | - -#### Defined in - -[src/types/app-arc56.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L295) - -___ - -### sourceInfo - -• `Optional` **sourceInfo**: `Object` - -Information about the TEAL programs - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `approval` | [`ProgramSourceInfo`](types_app_arc56.ProgramSourceInfo.md) | Approval program information | -| `clear` | [`ProgramSourceInfo`](types_app_arc56.ProgramSourceInfo.md) | Clear program information | - -#### Defined in - -[src/types/app-arc56.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L288) - -___ - -### state - -• **state**: `Object` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `keys` | \{ `box`: \{ `[name: string]`: [`StorageKey`](types_app_arc56.StorageKey.md); } ; `global`: \{ `[name: string]`: [`StorageKey`](types_app_arc56.StorageKey.md); } ; `local`: \{ `[name: string]`: [`StorageKey`](types_app_arc56.StorageKey.md); } } | Mapping of human-readable names to StorageKey objects | -| `keys.box` | \{ `[name: string]`: [`StorageKey`](types_app_arc56.StorageKey.md); } | - | -| `keys.global` | \{ `[name: string]`: [`StorageKey`](types_app_arc56.StorageKey.md); } | - | -| `keys.local` | \{ `[name: string]`: [`StorageKey`](types_app_arc56.StorageKey.md); } | - | -| `maps` | \{ `box`: \{ `[name: string]`: [`StorageMap`](types_app_arc56.StorageMap.md); } ; `global`: \{ `[name: string]`: [`StorageMap`](types_app_arc56.StorageMap.md); } ; `local`: \{ `[name: string]`: [`StorageMap`](types_app_arc56.StorageMap.md); } } | Mapping of human-readable names to StorageMap objects | -| `maps.box` | \{ `[name: string]`: [`StorageMap`](types_app_arc56.StorageMap.md); } | - | -| `maps.global` | \{ `[name: string]`: [`StorageMap`](types_app_arc56.StorageMap.md); } | - | -| `maps.local` | \{ `[name: string]`: [`StorageMap`](types_app_arc56.StorageMap.md); } | - | -| `schema` | \{ `global`: \{ `bytes`: `number` ; `ints`: `number` } ; `local`: \{ `bytes`: `number` ; `ints`: `number` } } | Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application | -| `schema.global` | \{ `bytes`: `number` ; `ints`: `number` } | - | -| `schema.global.bytes` | `number` | - | -| `schema.global.ints` | `number` | - | -| `schema.local` | \{ `bytes`: `number` ; `ints`: `number` } | - | -| `schema.local.bytes` | `number` | - | -| `schema.local.ints` | `number` | - | - -#### Defined in - -[src/types/app-arc56.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L255) - -___ - -### structs - -• **structs**: `Object` - -Named structs used by the application. Each struct field appears in the same order as ABI encoding. - -#### Index signature - -▪ [structName: [`StructName`](../modules/types_app_arc56.md#structname)]: [`StructField`](types_app_arc56.StructField.md)[] - -#### Defined in - -[src/types/app-arc56.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L252) - -___ - -### templateVariables - -• `Optional` **templateVariables**: `Object` - -A mapping of template variable names as they appear in the TEAL (not including TMPL_ prefix) to their respective types and values (if applicable) - -#### Index signature - -▪ [name: `string`]: \{ `type`: [`ABIType`](../modules/types_app_arc56.md#abitype) \| [`AVMType`](../modules/types_app_arc56.md#avmtype) \| [`StructName`](../modules/types_app_arc56.md#structname) ; `value?`: `string` } - -#### Defined in - -[src/types/app-arc56.ts:323](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L323) diff --git a/docs/code/interfaces/types_app_arc56.Event.md b/docs/code/interfaces/types_app_arc56.Event.md deleted file mode 100644 index e99ba735..00000000 --- a/docs/code/interfaces/types_app_arc56.Event.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-arc56](../modules/types_app_arc56.md) / Event - -# Interface: Event - -[types/app-arc56](../modules/types_app_arc56.md).Event - -ARC-28 event - -## Table of contents - -### Properties - -- [args](types_app_arc56.Event.md#args) -- [desc](types_app_arc56.Event.md#desc) -- [name](types_app_arc56.Event.md#name) - -## Properties - -### args - -• **args**: \{ `desc?`: `string` ; `name?`: `string` ; `struct?`: `string` ; `type`: `string` }[] - -The arguments of the event, in order - -#### Defined in - -[src/types/app-arc56.ts:423](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L423) - -___ - -### desc - -• `Optional` **desc**: `string` - -Optional, user-friendly description for the event - -#### Defined in - -[src/types/app-arc56.ts:421](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L421) - -___ - -### name - -• **name**: `string` - -The name of the event - -#### Defined in - -[src/types/app-arc56.ts:419](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L419) diff --git a/docs/code/interfaces/types_app_arc56.Method.md b/docs/code/interfaces/types_app_arc56.Method.md deleted file mode 100644 index 3dbe6245..00000000 --- a/docs/code/interfaces/types_app_arc56.Method.md +++ /dev/null @@ -1,145 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-arc56](../modules/types_app_arc56.md) / Method - -# Interface: Method - -[types/app-arc56](../modules/types_app_arc56.md).Method - -Describes a method in the contract. This interface is an extension of the interface described in ARC-4 - -## Table of contents - -### Properties - -- [actions](types_app_arc56.Method.md#actions) -- [args](types_app_arc56.Method.md#args) -- [desc](types_app_arc56.Method.md#desc) -- [events](types_app_arc56.Method.md#events) -- [name](types_app_arc56.Method.md#name) -- [readonly](types_app_arc56.Method.md#readonly) -- [recommendations](types_app_arc56.Method.md#recommendations) -- [returns](types_app_arc56.Method.md#returns) - -## Properties - -### actions - -• **actions**: `Object` - -an action is a combination of call/create and an OnComplete - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | (``"NoOp"`` \| ``"OptIn"`` \| ``"DeleteApplication"`` \| ``"CloseOut"`` \| ``"ClearState"`` \| ``"UpdateApplication"``)[] | OnCompletes this method allows when appID !== 0 | -| `create` | (``"NoOp"`` \| ``"OptIn"`` \| ``"DeleteApplication"``)[] | OnCompletes this method allows when appID === 0 | - -#### Defined in - -[src/types/app-arc56.ts:382](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L382) - -___ - -### args - -• **args**: \{ `defaultValue?`: \{ `data`: `string` ; `source`: ``"method"`` \| ``"box"`` \| ``"global"`` \| ``"local"`` \| ``"literal"`` ; `type?`: `string` } ; `desc?`: `string` ; `name?`: `string` ; `struct?`: `string` ; `type`: `string` }[] - -The arguments of the method, in order - -#### Defined in - -[src/types/app-arc56.ts:347](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L347) - -___ - -### desc - -• `Optional` **desc**: `string` - -Optional, user-friendly description for the method - -#### Defined in - -[src/types/app-arc56.ts:345](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L345) - -___ - -### events - -• `Optional` **events**: [`Event`](types_app_arc56.Event.md)[] - -ARC-28 events that MAY be emitted by this method - -#### Defined in - -[src/types/app-arc56.ts:391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L391) - -___ - -### name - -• **name**: `string` - -The name of the method - -#### Defined in - -[src/types/app-arc56.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L343) - -___ - -### readonly - -• `Optional` **readonly**: `boolean` - -If this method does not write anything to the ledger (ARC-22) - -#### Defined in - -[src/types/app-arc56.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L389) - -___ - -### recommendations - -• `Optional` **recommendations**: `Object` - -Information that clients can use when calling the method - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `accounts?` | `string`[] | Recommended foreign accounts | -| `apps?` | `number`[] | Recommended foreign apps | -| `assets?` | `number`[] | Recommended foreign assets | -| `boxes?` | \{ `app?`: `number` ; `key`: `string` ; `readBytes`: `number` ; `writeBytes`: `number` } | Recommended box references to include | -| `boxes.app?` | `number` | The app ID for the box | -| `boxes.key` | `string` | The base64 encoded box key | -| `boxes.readBytes` | `number` | The number of bytes being read from the box | -| `boxes.writeBytes` | `number` | The number of bytes being written to the box | -| `innerTransactionCount?` | `number` | The number of inner transactions the caller should cover the fees for | - -#### Defined in - -[src/types/app-arc56.ts:393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L393) - -___ - -### returns - -• **returns**: `Object` - -Information about the method's return value - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `desc?` | `string` | Optional, user-friendly description for the return value | -| `struct?` | `string` | If the type is a struct, the name of the struct | -| `type` | `string` | The type of the return value, or "void" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct. | - -#### Defined in - -[src/types/app-arc56.ts:373](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L373) diff --git a/docs/code/interfaces/types_app_arc56.ProgramSourceInfo.md b/docs/code/interfaces/types_app_arc56.ProgramSourceInfo.md deleted file mode 100644 index d7a3497e..00000000 --- a/docs/code/interfaces/types_app_arc56.ProgramSourceInfo.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-arc56](../modules/types_app_arc56.md) / ProgramSourceInfo - -# Interface: ProgramSourceInfo - -[types/app-arc56](../modules/types_app_arc56.md).ProgramSourceInfo - -## Table of contents - -### Properties - -- [pcOffsetMethod](types_app_arc56.ProgramSourceInfo.md#pcoffsetmethod) -- [sourceInfo](types_app_arc56.ProgramSourceInfo.md#sourceinfo) - -## Properties - -### pcOffsetMethod - -• **pcOffsetMethod**: ``"none"`` \| ``"cblocks"`` - -How the program counter offset is calculated -- none: The pc values in sourceInfo are not offset -- cblocks: The pc values in sourceInfo are offset by the PC of the first op following the last cblock at the top of the program - -#### Defined in - -[src/types/app-arc56.ts:504](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L504) - -___ - -### sourceInfo - -• **sourceInfo**: `SourceInfo`[] - -The source information for the program - -#### Defined in - -[src/types/app-arc56.ts:499](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L499) diff --git a/docs/code/interfaces/types_app_arc56.StorageKey.md b/docs/code/interfaces/types_app_arc56.StorageKey.md deleted file mode 100644 index 29872e9d..00000000 --- a/docs/code/interfaces/types_app_arc56.StorageKey.md +++ /dev/null @@ -1,64 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-arc56](../modules/types_app_arc56.md) / StorageKey - -# Interface: StorageKey - -[types/app-arc56](../modules/types_app_arc56.md).StorageKey - -Describes a single key in app storage - -## Table of contents - -### Properties - -- [desc](types_app_arc56.StorageKey.md#desc) -- [key](types_app_arc56.StorageKey.md#key) -- [keyType](types_app_arc56.StorageKey.md#keytype) -- [valueType](types_app_arc56.StorageKey.md#valuetype) - -## Properties - -### desc - -• `Optional` **desc**: `string` - -Description of what this storage key holds - -#### Defined in - -[src/types/app-arc56.ts:464](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L464) - -___ - -### key - -• **key**: `string` - -The bytes of the key encoded as base64 - -#### Defined in - -[src/types/app-arc56.ts:471](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L471) - -___ - -### keyType - -• **keyType**: `string` - -The type of the key - -#### Defined in - -[src/types/app-arc56.ts:466](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L466) - -___ - -### valueType - -• **valueType**: `string` - -The type of the value - -#### Defined in - -[src/types/app-arc56.ts:469](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L469) diff --git a/docs/code/interfaces/types_app_arc56.StorageMap.md b/docs/code/interfaces/types_app_arc56.StorageMap.md deleted file mode 100644 index d31ba7c7..00000000 --- a/docs/code/interfaces/types_app_arc56.StorageMap.md +++ /dev/null @@ -1,64 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-arc56](../modules/types_app_arc56.md) / StorageMap - -# Interface: StorageMap - -[types/app-arc56](../modules/types_app_arc56.md).StorageMap - -Describes a mapping of key-value pairs in storage - -## Table of contents - -### Properties - -- [desc](types_app_arc56.StorageMap.md#desc) -- [keyType](types_app_arc56.StorageMap.md#keytype) -- [prefix](types_app_arc56.StorageMap.md#prefix) -- [valueType](types_app_arc56.StorageMap.md#valuetype) - -## Properties - -### desc - -• `Optional` **desc**: `string` - -Description of what the key-value pairs in this mapping hold - -#### Defined in - -[src/types/app-arc56.ts:477](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L477) - -___ - -### keyType - -• **keyType**: `string` - -The type of the keys in the map - -#### Defined in - -[src/types/app-arc56.ts:479](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L479) - -___ - -### prefix - -• `Optional` **prefix**: `string` - -The base64-encoded prefix of the map keys - -#### Defined in - -[src/types/app-arc56.ts:483](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L483) - -___ - -### valueType - -• **valueType**: `string` - -The type of the values in the map - -#### Defined in - -[src/types/app-arc56.ts:481](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L481) diff --git a/docs/code/interfaces/types_app_arc56.StructField.md b/docs/code/interfaces/types_app_arc56.StructField.md deleted file mode 100644 index aa8f9f85..00000000 --- a/docs/code/interfaces/types_app_arc56.StructField.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-arc56](../modules/types_app_arc56.md) / StructField - -# Interface: StructField - -[types/app-arc56](../modules/types_app_arc56.md).StructField - -Information about a single field in a struct - -## Table of contents - -### Properties - -- [name](types_app_arc56.StructField.md#name) -- [type](types_app_arc56.StructField.md#type) - -## Properties - -### name - -• **name**: `string` - -The name of the struct field - -#### Defined in - -[src/types/app-arc56.ts:456](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L456) - -___ - -### type - -• **type**: `string` \| [`StructField`](types_app_arc56.StructField.md)[] - -The type of the struct field's value - -#### Defined in - -[src/types/app-arc56.ts:458](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L458) diff --git a/docs/code/interfaces/types_app_client.AppClientCallABIArgs.md b/docs/code/interfaces/types_app_client.AppClientCallABIArgs.md deleted file mode 100644 index 52674a3e..00000000 --- a/docs/code/interfaces/types_app_client.AppClientCallABIArgs.md +++ /dev/null @@ -1,150 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClientCallABIArgs - -# Interface: AppClientCallABIArgs - -[types/app-client](../modules/types_app_client.md).AppClientCallABIArgs - -## Hierarchy - -- `Omit`\<[`ABIAppCallArgs`](../modules/types_app.md#abiappcallargs), ``"method"``\> - - ↳ **`AppClientCallABIArgs`** - -## Table of contents - -### Properties - -- [accounts](types_app_client.AppClientCallABIArgs.md#accounts) -- [apps](types_app_client.AppClientCallABIArgs.md#apps) -- [assets](types_app_client.AppClientCallABIArgs.md#assets) -- [boxes](types_app_client.AppClientCallABIArgs.md#boxes) -- [lease](types_app_client.AppClientCallABIArgs.md#lease) -- [method](types_app_client.AppClientCallABIArgs.md#method) -- [methodArgs](types_app_client.AppClientCallABIArgs.md#methodargs) -- [rekeyTo](types_app_client.AppClientCallABIArgs.md#rekeyto) - -## Properties - -### accounts - -• `Optional` **accounts**: (`string` \| `Address`)[] - -The address of any accounts to load in - -#### Inherited from - -Omit.accounts - -#### Defined in - -[src/types/app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L79) - -___ - -### apps - -• `Optional` **apps**: `number`[] - -IDs of any apps to load into the foreignApps array - -#### Inherited from - -Omit.apps - -#### Defined in - -[src/types/app.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L81) - -___ - -### assets - -• `Optional` **assets**: `number`[] - -IDs of any assets to load into the foreignAssets array - -#### Inherited from - -Omit.assets - -#### Defined in - -[src/types/app.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L83) - -___ - -### boxes - -• `Optional` **boxes**: ([`BoxReference`](types_app.BoxReference.md) \| [`BoxIdentifier`](../modules/types_app.md#boxidentifier) \| `BoxReference`)[] - -Any box references to load - -#### Inherited from - -Omit.boxes - -#### Defined in - -[src/types/app.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L77) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -The optional lease for the transaction - -#### Inherited from - -Omit.lease - -#### Defined in - -[src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75) - -___ - -### method - -• **method**: `string` - -If calling an ABI method then either the name of the method, or the ABI signature - -#### Defined in - -[src/types/app-client.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L201) - -___ - -### methodArgs - -• **methodArgs**: [`ABIAppCallArg`](../modules/types_app.md#abiappcallarg)[] - -The ABI method args to pass in - -#### Inherited from - -Omit.methodArgs - -#### Defined in - -[src/types/app.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L117) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction. - -**Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first. - -#### Inherited from - -Omit.rekeyTo - -#### Defined in - -[src/types/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L88) diff --git a/docs/code/interfaces/types_app_client.AppClientCallCoreParams.md b/docs/code/interfaces/types_app_client.AppClientCallCoreParams.md deleted file mode 100644 index af6e40d9..00000000 --- a/docs/code/interfaces/types_app_client.AppClientCallCoreParams.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClientCallCoreParams - -# Interface: AppClientCallCoreParams - -[types/app-client](../modules/types_app_client.md).AppClientCallCoreParams - -Common (core) parameters to construct a ApplicationClient contract call - -## Table of contents - -### Properties - -- [note](types_app_client.AppClientCallCoreParams.md#note) -- [sendParams](types_app_client.AppClientCallCoreParams.md#sendparams) -- [sender](types_app_client.AppClientCallCoreParams.md#sender) - -## Properties - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The transaction note for the smart contract call - -#### Defined in - -[src/types/app-client.ts:212](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L212) - -___ - -### sendParams - -• `Optional` **sendParams**: [`SendTransactionParams`](types_transaction.SendTransactionParams.md) - -Parameters to control transaction sending - -#### Defined in - -[src/types/app-client.ts:214](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L214) - -___ - -### sender - -• `Optional` **sender**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The optional sender to send the transaction from, will use the application client's default sender by default if specified - -#### Defined in - -[src/types/app-client.ts:210](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L210) diff --git a/docs/code/interfaces/types_app_client.AppClientCompilationParams.md b/docs/code/interfaces/types_app_client.AppClientCompilationParams.md deleted file mode 100644 index d5053214..00000000 --- a/docs/code/interfaces/types_app_client.AppClientCompilationParams.md +++ /dev/null @@ -1,49 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClientCompilationParams - -# Interface: AppClientCompilationParams - -[types/app-client](../modules/types_app_client.md).AppClientCompilationParams - -## Table of contents - -### Properties - -- [deletable](types_app_client.AppClientCompilationParams.md#deletable) -- [deployTimeParams](types_app_client.AppClientCompilationParams.md#deploytimeparams) -- [updatable](types_app_client.AppClientCompilationParams.md#updatable) - -## Properties - -### deletable - -• `Optional` **deletable**: `boolean` - -Whether or not the contract should have deploy-time permanence control set, undefined = ignore - -#### Defined in - -[src/types/app-client.ts:229](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L229) - -___ - -### deployTimeParams - -• `Optional` **deployTimeParams**: [`TealTemplateParams`](types_app.TealTemplateParams.md) - -Any deploy-time parameters to replace in the TEAL code - -#### Defined in - -[src/types/app-client.ts:225](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L225) - -___ - -### updatable - -• `Optional` **updatable**: `boolean` - -Whether or not the contract should have deploy-time immutability control set, undefined = ignore - -#### Defined in - -[src/types/app-client.ts:227](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L227) diff --git a/docs/code/interfaces/types_app_client.AppClientCompilationResult.md b/docs/code/interfaces/types_app_client.AppClientCompilationResult.md deleted file mode 100644 index 28adc068..00000000 --- a/docs/code/interfaces/types_app_client.AppClientCompilationResult.md +++ /dev/null @@ -1,80 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClientCompilationResult - -# Interface: AppClientCompilationResult - -[types/app-client](../modules/types_app_client.md).AppClientCompilationResult - -The result of asking an `AppClient` to compile a program. - -Always contains the compiled bytecode, and may contain the result of compiling TEAL (including sourcemap) if it was available. - -## Hierarchy - -- `Partial`\<[`AppCompilationResult`](types_app.AppCompilationResult.md)\> - - ↳ **`AppClientCompilationResult`** - -## Table of contents - -### Properties - -- [approvalProgram](types_app_client.AppClientCompilationResult.md#approvalprogram) -- [clearStateProgram](types_app_client.AppClientCompilationResult.md#clearstateprogram) -- [compiledApproval](types_app_client.AppClientCompilationResult.md#compiledapproval) -- [compiledClear](types_app_client.AppClientCompilationResult.md#compiledclear) - -## Properties - -### approvalProgram - -• **approvalProgram**: `Uint8Array` - -The compiled bytecode of the approval program, ready to deploy to algod - -#### Defined in - -[src/types/app-client.ts:282](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L282) - -___ - -### clearStateProgram - -• **clearStateProgram**: `Uint8Array` - -The compiled bytecode of the clear state program, ready to deploy to algod - -#### Defined in - -[src/types/app-client.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L284) - -___ - -### compiledApproval - -• `Optional` **compiledApproval**: [`CompiledTeal`](types_app.CompiledTeal.md) - -The result of compiling the approval program - -#### Inherited from - -Partial.compiledApproval - -#### Defined in - -[src/types/app.ts:335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L335) - -___ - -### compiledClear - -• `Optional` **compiledClear**: [`CompiledTeal`](types_app.CompiledTeal.md) - -The result of compiling the clear state program - -#### Inherited from - -Partial.compiledClear - -#### Defined in - -[src/types/app.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L337) diff --git a/docs/code/interfaces/types_app_client.AppClientDeployCallInterfaceParams.md b/docs/code/interfaces/types_app_client.AppClientDeployCallInterfaceParams.md deleted file mode 100644 index bcb02b30..00000000 --- a/docs/code/interfaces/types_app_client.AppClientDeployCallInterfaceParams.md +++ /dev/null @@ -1,83 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClientDeployCallInterfaceParams - -# Interface: AppClientDeployCallInterfaceParams - -[types/app-client](../modules/types_app_client.md).AppClientDeployCallInterfaceParams - -Call interface parameters to pass into ApplicationClient.deploy - -## Hierarchy - -- **`AppClientDeployCallInterfaceParams`** - - ↳ [`AppClientDeployParams`](types_app_client.AppClientDeployParams.md) - -## Table of contents - -### Properties - -- [createArgs](types_app_client.AppClientDeployCallInterfaceParams.md#createargs) -- [createOnCompleteAction](types_app_client.AppClientDeployCallInterfaceParams.md#createoncompleteaction) -- [deleteArgs](types_app_client.AppClientDeployCallInterfaceParams.md#deleteargs) -- [deployTimeParams](types_app_client.AppClientDeployCallInterfaceParams.md#deploytimeparams) -- [updateArgs](types_app_client.AppClientDeployCallInterfaceParams.md#updateargs) - -## Properties - -### createArgs - -• `Optional` **createArgs**: [`AppClientCallArgs`](../modules/types_app_client.md#appclientcallargs) - -Any args to pass to any create transaction that is issued as part of deployment - -#### Defined in - -[src/types/app-client.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L182) - -___ - -### createOnCompleteAction - -• `Optional` **createOnCompleteAction**: ``"no_op"`` \| ``"opt_in"`` \| ``"close_out"`` \| ``"update_application"`` \| ``"delete_application"`` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` - -Override the on-completion action for the create call; defaults to NoOp - -#### Defined in - -[src/types/app-client.ts:184](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L184) - -___ - -### deleteArgs - -• `Optional` **deleteArgs**: [`AppClientCallArgs`](../modules/types_app_client.md#appclientcallargs) - -Any args to pass to any delete transaction that is issued as part of deployment - -#### Defined in - -[src/types/app-client.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L188) - -___ - -### deployTimeParams - -• `Optional` **deployTimeParams**: [`TealTemplateParams`](types_app.TealTemplateParams.md) - -Any deploy-time parameters to replace in the TEAL code - -#### Defined in - -[src/types/app-client.ts:180](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L180) - -___ - -### updateArgs - -• `Optional` **updateArgs**: [`AppClientCallArgs`](../modules/types_app_client.md#appclientcallargs) - -Any args to pass to any update transaction that is issued as part of deployment - -#### Defined in - -[src/types/app-client.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L186) diff --git a/docs/code/interfaces/types_app_client.AppClientDeployCoreParams.md b/docs/code/interfaces/types_app_client.AppClientDeployCoreParams.md deleted file mode 100644 index 7d5b63bf..00000000 --- a/docs/code/interfaces/types_app_client.AppClientDeployCoreParams.md +++ /dev/null @@ -1,111 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClientDeployCoreParams - -# Interface: AppClientDeployCoreParams - -[types/app-client](../modules/types_app_client.md).AppClientDeployCoreParams - -Core parameters to pass into ApplicationClient.deploy - -## Hierarchy - -- **`AppClientDeployCoreParams`** - - ↳ [`AppClientDeployParams`](types_app_client.AppClientDeployParams.md) - -## Table of contents - -### Properties - -- [allowDelete](types_app_client.AppClientDeployCoreParams.md#allowdelete) -- [allowUpdate](types_app_client.AppClientDeployCoreParams.md#allowupdate) -- [onSchemaBreak](types_app_client.AppClientDeployCoreParams.md#onschemabreak) -- [onUpdate](types_app_client.AppClientDeployCoreParams.md#onupdate) -- [sendParams](types_app_client.AppClientDeployCoreParams.md#sendparams) -- [sender](types_app_client.AppClientDeployCoreParams.md#sender) -- [version](types_app_client.AppClientDeployCoreParams.md#version) - -## Properties - -### allowDelete - -• `Optional` **allowDelete**: `boolean` - -Whether or not to allow deletes in the contract using the deploy-time deletability control if present in your contract. -If this is not specified then it will automatically be determined based on the AppSpec definition - -#### Defined in - -[src/types/app-client.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L170) - -___ - -### allowUpdate - -• `Optional` **allowUpdate**: `boolean` - -Whether or not to allow updates in the contract using the deploy-time updatability control if present in your contract. -If this is not specified then it will automatically be determined based on the AppSpec definition - -#### Defined in - -[src/types/app-client.ts:166](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L166) - -___ - -### onSchemaBreak - -• `Optional` **onSchemaBreak**: [`OnSchemaBreak`](../enums/types_app.OnSchemaBreak.md) \| ``"replace"`` \| ``"fail"`` \| ``"append"`` - -What action to perform if a schema break is detected - -#### Defined in - -[src/types/app-client.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L172) - -___ - -### onUpdate - -• `Optional` **onUpdate**: ``"replace"`` \| ``"fail"`` \| ``"append"`` \| [`OnUpdate`](../enums/types_app.OnUpdate.md) \| ``"update"`` - -What action to perform if a TEAL update is detected - -#### Defined in - -[src/types/app-client.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L174) - -___ - -### sendParams - -• `Optional` **sendParams**: `Omit`\<[`SendTransactionParams`](types_transaction.SendTransactionParams.md), ``"skipSending"`` \| ``"skipWaiting"``\> - -Parameters to control transaction sending - -#### Defined in - -[src/types/app-client.ts:162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L162) - -___ - -### sender - -• `Optional` **sender**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The optional sender to send the transaction from, will use the application client's default sender by default if specified - -#### Defined in - -[src/types/app-client.ts:160](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L160) - -___ - -### version - -• `Optional` **version**: `string` - -The version of the contract, uses "1.0" by default - -#### Defined in - -[src/types/app-client.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L158) diff --git a/docs/code/interfaces/types_app_client.AppClientDeployParams.md b/docs/code/interfaces/types_app_client.AppClientDeployParams.md deleted file mode 100644 index f0742673..00000000 --- a/docs/code/interfaces/types_app_client.AppClientDeployParams.md +++ /dev/null @@ -1,239 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClientDeployParams - -# Interface: AppClientDeployParams - -[types/app-client](../modules/types_app_client.md).AppClientDeployParams - -Parameters to pass into ApplicationClient.deploy - -## Hierarchy - -- [`AppClientDeployCoreParams`](types_app_client.AppClientDeployCoreParams.md) - -- [`AppClientDeployCallInterfaceParams`](types_app_client.AppClientDeployCallInterfaceParams.md) - - ↳ **`AppClientDeployParams`** - -## Table of contents - -### Properties - -- [allowDelete](types_app_client.AppClientDeployParams.md#allowdelete) -- [allowUpdate](types_app_client.AppClientDeployParams.md#allowupdate) -- [createArgs](types_app_client.AppClientDeployParams.md#createargs) -- [createOnCompleteAction](types_app_client.AppClientDeployParams.md#createoncompleteaction) -- [deleteArgs](types_app_client.AppClientDeployParams.md#deleteargs) -- [deployTimeParams](types_app_client.AppClientDeployParams.md#deploytimeparams) -- [onSchemaBreak](types_app_client.AppClientDeployParams.md#onschemabreak) -- [onUpdate](types_app_client.AppClientDeployParams.md#onupdate) -- [schema](types_app_client.AppClientDeployParams.md#schema) -- [sendParams](types_app_client.AppClientDeployParams.md#sendparams) -- [sender](types_app_client.AppClientDeployParams.md#sender) -- [updateArgs](types_app_client.AppClientDeployParams.md#updateargs) -- [version](types_app_client.AppClientDeployParams.md#version) - -## Properties - -### allowDelete - -• `Optional` **allowDelete**: `boolean` - -Whether or not to allow deletes in the contract using the deploy-time deletability control if present in your contract. -If this is not specified then it will automatically be determined based on the AppSpec definition - -#### Inherited from - -[AppClientDeployCoreParams](types_app_client.AppClientDeployCoreParams.md).[allowDelete](types_app_client.AppClientDeployCoreParams.md#allowdelete) - -#### Defined in - -[src/types/app-client.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L170) - -___ - -### allowUpdate - -• `Optional` **allowUpdate**: `boolean` - -Whether or not to allow updates in the contract using the deploy-time updatability control if present in your contract. -If this is not specified then it will automatically be determined based on the AppSpec definition - -#### Inherited from - -[AppClientDeployCoreParams](types_app_client.AppClientDeployCoreParams.md).[allowUpdate](types_app_client.AppClientDeployCoreParams.md#allowupdate) - -#### Defined in - -[src/types/app-client.ts:166](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L166) - -___ - -### createArgs - -• `Optional` **createArgs**: [`AppClientCallArgs`](../modules/types_app_client.md#appclientcallargs) - -Any args to pass to any create transaction that is issued as part of deployment - -#### Inherited from - -[AppClientDeployCallInterfaceParams](types_app_client.AppClientDeployCallInterfaceParams.md).[createArgs](types_app_client.AppClientDeployCallInterfaceParams.md#createargs) - -#### Defined in - -[src/types/app-client.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L182) - -___ - -### createOnCompleteAction - -• `Optional` **createOnCompleteAction**: ``"no_op"`` \| ``"opt_in"`` \| ``"close_out"`` \| ``"update_application"`` \| ``"delete_application"`` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` - -Override the on-completion action for the create call; defaults to NoOp - -#### Inherited from - -[AppClientDeployCallInterfaceParams](types_app_client.AppClientDeployCallInterfaceParams.md).[createOnCompleteAction](types_app_client.AppClientDeployCallInterfaceParams.md#createoncompleteaction) - -#### Defined in - -[src/types/app-client.ts:184](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L184) - -___ - -### deleteArgs - -• `Optional` **deleteArgs**: [`AppClientCallArgs`](../modules/types_app_client.md#appclientcallargs) - -Any args to pass to any delete transaction that is issued as part of deployment - -#### Inherited from - -[AppClientDeployCallInterfaceParams](types_app_client.AppClientDeployCallInterfaceParams.md).[deleteArgs](types_app_client.AppClientDeployCallInterfaceParams.md#deleteargs) - -#### Defined in - -[src/types/app-client.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L188) - -___ - -### deployTimeParams - -• `Optional` **deployTimeParams**: [`TealTemplateParams`](types_app.TealTemplateParams.md) - -Any deploy-time parameters to replace in the TEAL code - -#### Inherited from - -[AppClientDeployCallInterfaceParams](types_app_client.AppClientDeployCallInterfaceParams.md).[deployTimeParams](types_app_client.AppClientDeployCallInterfaceParams.md#deploytimeparams) - -#### Defined in - -[src/types/app-client.ts:180](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L180) - -___ - -### onSchemaBreak - -• `Optional` **onSchemaBreak**: [`OnSchemaBreak`](../enums/types_app.OnSchemaBreak.md) \| ``"replace"`` \| ``"fail"`` \| ``"append"`` - -What action to perform if a schema break is detected - -#### Inherited from - -[AppClientDeployCoreParams](types_app_client.AppClientDeployCoreParams.md).[onSchemaBreak](types_app_client.AppClientDeployCoreParams.md#onschemabreak) - -#### Defined in - -[src/types/app-client.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L172) - -___ - -### onUpdate - -• `Optional` **onUpdate**: ``"replace"`` \| ``"fail"`` \| ``"append"`` \| [`OnUpdate`](../enums/types_app.OnUpdate.md) \| ``"update"`` - -What action to perform if a TEAL update is detected - -#### Inherited from - -[AppClientDeployCoreParams](types_app_client.AppClientDeployCoreParams.md).[onUpdate](types_app_client.AppClientDeployCoreParams.md#onupdate) - -#### Defined in - -[src/types/app-client.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L174) - -___ - -### schema - -• `Optional` **schema**: `Partial`\<[`AppStorageSchema`](types_app.AppStorageSchema.md)\> - -Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used. - -#### Defined in - -[src/types/app-client.ts:194](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L194) - -___ - -### sendParams - -• `Optional` **sendParams**: `Omit`\<[`SendTransactionParams`](types_transaction.SendTransactionParams.md), ``"skipSending"`` \| ``"skipWaiting"``\> - -Parameters to control transaction sending - -#### Inherited from - -[AppClientDeployCoreParams](types_app_client.AppClientDeployCoreParams.md).[sendParams](types_app_client.AppClientDeployCoreParams.md#sendparams) - -#### Defined in - -[src/types/app-client.ts:162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L162) - -___ - -### sender - -• `Optional` **sender**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The optional sender to send the transaction from, will use the application client's default sender by default if specified - -#### Inherited from - -[AppClientDeployCoreParams](types_app_client.AppClientDeployCoreParams.md).[sender](types_app_client.AppClientDeployCoreParams.md#sender) - -#### Defined in - -[src/types/app-client.ts:160](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L160) - -___ - -### updateArgs - -• `Optional` **updateArgs**: [`AppClientCallArgs`](../modules/types_app_client.md#appclientcallargs) - -Any args to pass to any update transaction that is issued as part of deployment - -#### Inherited from - -[AppClientDeployCallInterfaceParams](types_app_client.AppClientDeployCallInterfaceParams.md).[updateArgs](types_app_client.AppClientDeployCallInterfaceParams.md#updateargs) - -#### Defined in - -[src/types/app-client.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L186) - -___ - -### version - -• `Optional` **version**: `string` - -The version of the contract, uses "1.0" by default - -#### Inherited from - -[AppClientDeployCoreParams](types_app_client.AppClientDeployCoreParams.md).[version](types_app_client.AppClientDeployCoreParams.md#version) - -#### Defined in - -[src/types/app-client.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L158) diff --git a/docs/code/interfaces/types_app_client.AppClientParams.md b/docs/code/interfaces/types_app_client.AppClientParams.md deleted file mode 100644 index cbd623fd..00000000 --- a/docs/code/interfaces/types_app_client.AppClientParams.md +++ /dev/null @@ -1,120 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppClientParams - -# Interface: AppClientParams - -[types/app-client](../modules/types_app_client.md).AppClientParams - -Parameters to create an app client - -## Table of contents - -### Properties - -- [algorand](types_app_client.AppClientParams.md#algorand) -- [appId](types_app_client.AppClientParams.md#appid) -- [appName](types_app_client.AppClientParams.md#appname) -- [appSpec](types_app_client.AppClientParams.md#appspec) -- [approvalSourceMap](types_app_client.AppClientParams.md#approvalsourcemap) -- [clearSourceMap](types_app_client.AppClientParams.md#clearsourcemap) -- [defaultSender](types_app_client.AppClientParams.md#defaultsender) -- [defaultSigner](types_app_client.AppClientParams.md#defaultsigner) - -## Properties - -### algorand - -• **algorand**: [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md) - -An `AlgorandClient` instance - -#### Defined in - -[src/types/app-client.ts:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L328) - -___ - -### appId - -• **appId**: `bigint` - -The ID of the app instance this client should make calls against. - -#### Defined in - -[src/types/app-client.ts:318](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L318) - -___ - -### appName - -• `Optional` **appName**: `string` - -Optional override for the app name; used for on-chain metadata and lookups. -Defaults to the ARC-32/ARC-56 app spec name - -#### Defined in - -[src/types/app-client.ts:334](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L334) - -___ - -### appSpec - -• **appSpec**: `string` \| [`Arc56Contract`](types_app_arc56.Arc56Contract.md) \| [`AppSpec`](types_app_spec.AppSpec.md) - -The ARC-56 or ARC-32 application spec as either: - * Parsed JSON ARC-56 `Contract` - * Parsed JSON ARC-32 `AppSpec` - * Raw JSON string (in either ARC-56 or ARC-32 format) - -#### Defined in - -[src/types/app-client.ts:325](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L325) - -___ - -### approvalSourceMap - -• `Optional` **approvalSourceMap**: `ProgramSourceMap` - -Optional source map for the approval program - -#### Defined in - -[src/types/app-client.ts:340](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L340) - -___ - -### clearSourceMap - -• `Optional` **clearSourceMap**: `ProgramSourceMap` - -Optional source map for the clear state program - -#### Defined in - -[src/types/app-client.ts:342](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L342) - -___ - -### defaultSender - -• `Optional` **defaultSender**: `string` \| `Address` - -Optional address to use for the account to use as the default sender for calls. - -#### Defined in - -[src/types/app-client.ts:336](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L336) - -___ - -### defaultSigner - -• `Optional` **defaultSigner**: `TransactionSigner` - -Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). - -#### Defined in - -[src/types/app-client.ts:338](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L338) diff --git a/docs/code/interfaces/types_app_client.AppSourceMaps.md b/docs/code/interfaces/types_app_client.AppSourceMaps.md deleted file mode 100644 index 4d84967d..00000000 --- a/docs/code/interfaces/types_app_client.AppSourceMaps.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / AppSourceMaps - -# Interface: AppSourceMaps - -[types/app-client](../modules/types_app_client.md).AppSourceMaps - -Source maps for an Algorand app - -## Table of contents - -### Properties - -- [approvalSourceMap](types_app_client.AppSourceMaps.md#approvalsourcemap) -- [clearSourceMap](types_app_client.AppSourceMaps.md#clearsourcemap) - -## Properties - -### approvalSourceMap - -• **approvalSourceMap**: [`SourceMapExport`](types_app_client.SourceMapExport.md) - -The source map of the approval program - -#### Defined in - -[src/types/app-client.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L263) - -___ - -### clearSourceMap - -• **clearSourceMap**: [`SourceMapExport`](types_app_client.SourceMapExport.md) - -The source map of the clear program - -#### Defined in - -[src/types/app-client.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L265) diff --git a/docs/code/interfaces/types_app_client.FundAppAccountParams.md b/docs/code/interfaces/types_app_client.FundAppAccountParams.md deleted file mode 100644 index 17c027bf..00000000 --- a/docs/code/interfaces/types_app_client.FundAppAccountParams.md +++ /dev/null @@ -1,62 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / FundAppAccountParams - -# Interface: FundAppAccountParams - -[types/app-client](../modules/types_app_client.md).FundAppAccountParams - -Parameters for funding an app account - -## Table of contents - -### Properties - -- [amount](types_app_client.FundAppAccountParams.md#amount) -- [note](types_app_client.FundAppAccountParams.md#note) -- [sendParams](types_app_client.FundAppAccountParams.md#sendparams) -- [sender](types_app_client.FundAppAccountParams.md#sender) - -## Properties - -### amount - -• **amount**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -#### Defined in - -[src/types/app-client.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L251) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The transaction note for the smart contract call - -#### Defined in - -[src/types/app-client.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L255) - -___ - -### sendParams - -• `Optional` **sendParams**: [`SendTransactionParams`](types_transaction.SendTransactionParams.md) - -Parameters to control transaction sending - -#### Defined in - -[src/types/app-client.ts:257](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L257) - -___ - -### sender - -• `Optional` **sender**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The optional sender to send the transaction from, will use the application client's default sender by default if specified - -#### Defined in - -[src/types/app-client.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L253) diff --git a/docs/code/interfaces/types_app_client.ResolveAppById.md b/docs/code/interfaces/types_app_client.ResolveAppById.md deleted file mode 100644 index 113d2eeb..00000000 --- a/docs/code/interfaces/types_app_client.ResolveAppById.md +++ /dev/null @@ -1,65 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / ResolveAppById - -# Interface: ResolveAppById - -[types/app-client](../modules/types_app_client.md).ResolveAppById - -Configuration to resolve app by ID - -## Hierarchy - -- [`ResolveAppByIdBase`](types_app_client.ResolveAppByIdBase.md) - - ↳ **`ResolveAppById`** - -## Table of contents - -### Properties - -- [id](types_app_client.ResolveAppById.md#id) -- [name](types_app_client.ResolveAppById.md#name) -- [resolveBy](types_app_client.ResolveAppById.md#resolveby) - -## Properties - -### id - -• **id**: `number` \| `bigint` - -The id of an existing app to call using this client, or 0 if the app hasn't been created yet - -#### Inherited from - -[ResolveAppByIdBase](types_app_client.ResolveAppByIdBase.md).[id](types_app_client.ResolveAppByIdBase.md#id) - -#### Defined in - -[src/types/app-client.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L112) - -___ - -### name - -• `Optional` **name**: `string` - -The optional name to use to mark the app when deploying `ApplicationClient.deploy` (default: uses the name in the ABI contract) - -#### Inherited from - -[ResolveAppByIdBase](types_app_client.ResolveAppByIdBase.md).[name](types_app_client.ResolveAppByIdBase.md#name) - -#### Defined in - -[src/types/app-client.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L114) - -___ - -### resolveBy - -• **resolveBy**: ``"id"`` - -How the app ID is resolved, either by `'id'` or `'creatorAndName'`; must be `'creatorAndName'` if you want to use `deploy` - -#### Defined in - -[src/types/app-client.ts:119](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L119) diff --git a/docs/code/interfaces/types_app_client.ResolveAppByIdBase.md b/docs/code/interfaces/types_app_client.ResolveAppByIdBase.md deleted file mode 100644 index c9571d3f..00000000 --- a/docs/code/interfaces/types_app_client.ResolveAppByIdBase.md +++ /dev/null @@ -1,44 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / ResolveAppByIdBase - -# Interface: ResolveAppByIdBase - -[types/app-client](../modules/types_app_client.md).ResolveAppByIdBase - -Configuration to resolve app by ID - -## Hierarchy - -- **`ResolveAppByIdBase`** - - ↳ [`ResolveAppById`](types_app_client.ResolveAppById.md) - -## Table of contents - -### Properties - -- [id](types_app_client.ResolveAppByIdBase.md#id) -- [name](types_app_client.ResolveAppByIdBase.md#name) - -## Properties - -### id - -• **id**: `number` \| `bigint` - -The id of an existing app to call using this client, or 0 if the app hasn't been created yet - -#### Defined in - -[src/types/app-client.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L112) - -___ - -### name - -• `Optional` **name**: `string` - -The optional name to use to mark the app when deploying `ApplicationClient.deploy` (default: uses the name in the ABI contract) - -#### Defined in - -[src/types/app-client.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L114) diff --git a/docs/code/interfaces/types_app_client.SourceMapExport.md b/docs/code/interfaces/types_app_client.SourceMapExport.md deleted file mode 100644 index 07b40a63..00000000 --- a/docs/code/interfaces/types_app_client.SourceMapExport.md +++ /dev/null @@ -1,54 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-client](../modules/types_app_client.md) / SourceMapExport - -# Interface: SourceMapExport - -[types/app-client](../modules/types_app_client.md).SourceMapExport - -## Table of contents - -### Properties - -- [mappings](types_app_client.SourceMapExport.md#mappings) -- [names](types_app_client.SourceMapExport.md#names) -- [sources](types_app_client.SourceMapExport.md#sources) -- [version](types_app_client.SourceMapExport.md#version) - -## Properties - -### mappings - -• **mappings**: `string` - -#### Defined in - -[src/types/app-client.ts:272](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L272) - -___ - -### names - -• **names**: `string`[] - -#### Defined in - -[src/types/app-client.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L271) - -___ - -### sources - -• **sources**: `string`[] - -#### Defined in - -[src/types/app-client.ts:270](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L270) - -___ - -### version - -• **version**: `number` - -#### Defined in - -[src/types/app-client.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L269) diff --git a/docs/code/interfaces/types_app_deployer.AppLookup.md b/docs/code/interfaces/types_app_deployer.AppLookup.md deleted file mode 100644 index cf79c2c0..00000000 --- a/docs/code/interfaces/types_app_deployer.AppLookup.md +++ /dev/null @@ -1,42 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-deployer](../modules/types_app_deployer.md) / AppLookup - -# Interface: AppLookup - -[types/app-deployer](../modules/types_app_deployer.md).AppLookup - -A lookup of name -> Algorand app for a creator - -## Table of contents - -### Properties - -- [apps](types_app_deployer.AppLookup.md#apps) -- [creator](types_app_deployer.AppLookup.md#creator) - -## Properties - -### apps - -• **apps**: `Object` - -A hash map of app name to app metadata - -#### Index signature - -▪ [name: `string`]: [`AppMetadata`](types_app_deployer.AppMetadata.md) - -#### Defined in - -[src/types/app-deployer.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L94) - -___ - -### creator - -• **creator**: `Readonly`\<`Address`\> - -The address of the creator associated with this lookup - -#### Defined in - -[src/types/app-deployer.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L92) diff --git a/docs/code/interfaces/types_app_deployer.AppMetadata.md b/docs/code/interfaces/types_app_deployer.AppMetadata.md deleted file mode 100644 index d4db46d7..00000000 --- a/docs/code/interfaces/types_app_deployer.AppMetadata.md +++ /dev/null @@ -1,164 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-deployer](../modules/types_app_deployer.md) / AppMetadata - -# Interface: AppMetadata - -[types/app-deployer](../modules/types_app_deployer.md).AppMetadata - -The metadata that can be collected about a deployed app - -## Hierarchy - -- [`AppDeployMetadata`](types_app.AppDeployMetadata.md) - - ↳ **`AppMetadata`** - -## Table of contents - -### Properties - -- [appAddress](types_app_deployer.AppMetadata.md#appaddress) -- [appId](types_app_deployer.AppMetadata.md#appid) -- [createdMetadata](types_app_deployer.AppMetadata.md#createdmetadata) -- [createdRound](types_app_deployer.AppMetadata.md#createdround) -- [deletable](types_app_deployer.AppMetadata.md#deletable) -- [deleted](types_app_deployer.AppMetadata.md#deleted) -- [name](types_app_deployer.AppMetadata.md#name) -- [updatable](types_app_deployer.AppMetadata.md#updatable) -- [updatedRound](types_app_deployer.AppMetadata.md#updatedround) -- [version](types_app_deployer.AppMetadata.md#version) - -## Properties - -### appAddress - -• **appAddress**: `Address` - -The Algorand address of the account associated with the app - -#### Defined in - -[src/types/app-deployer.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L78) - -___ - -### appId - -• **appId**: `bigint` - -The id of the app - -#### Defined in - -[src/types/app-deployer.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L76) - -___ - -### createdMetadata - -• **createdMetadata**: [`AppDeployMetadata`](types_app.AppDeployMetadata.md) - -The metadata when the app was created - -#### Defined in - -[src/types/app-deployer.ts:84](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L84) - -___ - -### createdRound - -• **createdRound**: `bigint` - -The round the app was created - -#### Defined in - -[src/types/app-deployer.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L80) - -___ - -### deletable - -• `Optional` **deletable**: `boolean` - -Whether or not the app is deletable / permanent / unspecified - -#### Inherited from - -[AppDeployMetadata](types_app.AppDeployMetadata.md).[deletable](types_app.AppDeployMetadata.md#deletable) - -#### Defined in - -[src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) - -___ - -### deleted - -• **deleted**: `boolean` - -Whether or not the app is deleted - -#### Defined in - -[src/types/app-deployer.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L86) - -___ - -### name - -• **name**: `string` - -The unique name identifier of the app within the creator account - -#### Inherited from - -[AppDeployMetadata](types_app.AppDeployMetadata.md).[name](types_app.AppDeployMetadata.md#name) - -#### Defined in - -[src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249) - -___ - -### updatable - -• `Optional` **updatable**: `boolean` - -Whether or not the app is updatable / immutable / unspecified - -#### Inherited from - -[AppDeployMetadata](types_app.AppDeployMetadata.md).[updatable](types_app.AppDeployMetadata.md#updatable) - -#### Defined in - -[src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255) - -___ - -### updatedRound - -• **updatedRound**: `bigint` - -The last round that the app was updated - -#### Defined in - -[src/types/app-deployer.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L82) - -___ - -### version - -• **version**: `string` - -The version of app that is / will be deployed - -#### Inherited from - -[AppDeployMetadata](types_app.AppDeployMetadata.md).[version](types_app.AppDeployMetadata.md#version) - -#### Defined in - -[src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251) diff --git a/docs/code/interfaces/types_app_factory.AppFactoryParams.md b/docs/code/interfaces/types_app_factory.AppFactoryParams.md deleted file mode 100644 index a46d4d91..00000000 --- a/docs/code/interfaces/types_app_factory.AppFactoryParams.md +++ /dev/null @@ -1,145 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-factory](../modules/types_app_factory.md) / AppFactoryParams - -# Interface: AppFactoryParams - -[types/app-factory](../modules/types_app_factory.md).AppFactoryParams - -Parameters to create an app client - -## Table of contents - -### Properties - -- [algorand](types_app_factory.AppFactoryParams.md#algorand) -- [appName](types_app_factory.AppFactoryParams.md#appname) -- [appSpec](types_app_factory.AppFactoryParams.md#appspec) -- [defaultSender](types_app_factory.AppFactoryParams.md#defaultsender) -- [defaultSigner](types_app_factory.AppFactoryParams.md#defaultsigner) -- [deletable](types_app_factory.AppFactoryParams.md#deletable) -- [deployTimeParams](types_app_factory.AppFactoryParams.md#deploytimeparams) -- [updatable](types_app_factory.AppFactoryParams.md#updatable) -- [version](types_app_factory.AppFactoryParams.md#version) - -## Properties - -### algorand - -• **algorand**: [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md) - -`AlgorandClient` instance - -#### Defined in - -[src/types/app-factory.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L56) - -___ - -### appName - -• `Optional` **appName**: `string` - -Optional override for the app name; used for on-chain metadata and lookups. -Defaults to the ARC-32/ARC-56 app spec name. - -#### Defined in - -[src/types/app-factory.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L62) - -___ - -### appSpec - -• **appSpec**: `string` \| [`Arc56Contract`](types_app_arc56.Arc56Contract.md) \| [`AppSpec`](types_app_spec.AppSpec.md) - -The ARC-56 or ARC-32 application spec as either: - * Parsed JSON ARC-56 `Contract` - * Parsed JSON ARC-32 `AppSpec` - * Raw JSON string (in either ARC-56 or ARC-32 format) - -#### Defined in - -[src/types/app-factory.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L53) - -___ - -### defaultSender - -• `Optional` **defaultSender**: `string` \| `Address` - -Optional address to use for the account to use as the default sender for calls. - -#### Defined in - -[src/types/app-factory.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L65) - -___ - -### defaultSigner - -• `Optional` **defaultSigner**: `TransactionSigner` - -Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). - -#### Defined in - -[src/types/app-factory.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L68) - -___ - -### deletable - -• `Optional` **deletable**: `boolean` - -Whether or not the contract should have deploy-time permanence control set, undefined = ignore. -If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. - -Useful if you want to vend multiple contracts from the same factory without specifying this value -for each call. - -#### Defined in - -[src/types/app-factory.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L89) - -___ - -### deployTimeParams - -• `Optional` **deployTimeParams**: [`TealTemplateParams`](types_app.TealTemplateParams.md) - -Optional deploy-time TEAL template replacement parameters. -If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. - -Useful if you want to vend multiple contracts from the same factory without specifying this value -for each call. - -#### Defined in - -[src/types/app-factory.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L98) - -___ - -### updatable - -• `Optional` **updatable**: `boolean` - -Whether or not the contract should have deploy-time immutability control set, undefined = ignore. -If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. - -Useful if you want to vend multiple contracts from the same factory without specifying this value -for each call. - -#### Defined in - -[src/types/app-factory.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L80) - -___ - -### version - -• `Optional` **version**: `string` - -The version of app that is / will be deployed; defaults to 1.0 - -#### Defined in - -[src/types/app-factory.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L71) diff --git a/docs/code/interfaces/types_app_manager.AppInformation.md b/docs/code/interfaces/types_app_manager.AppInformation.md deleted file mode 100644 index 68de898e..00000000 --- a/docs/code/interfaces/types_app_manager.AppInformation.md +++ /dev/null @@ -1,156 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-manager](../modules/types_app_manager.md) / AppInformation - -# Interface: AppInformation - -[types/app-manager](../modules/types_app_manager.md).AppInformation - -Information about an app. - -## Table of contents - -### Properties - -- [appAddress](types_app_manager.AppInformation.md#appaddress) -- [appId](types_app_manager.AppInformation.md#appid) -- [approvalProgram](types_app_manager.AppInformation.md#approvalprogram) -- [clearStateProgram](types_app_manager.AppInformation.md#clearstateprogram) -- [creator](types_app_manager.AppInformation.md#creator) -- [extraProgramPages](types_app_manager.AppInformation.md#extraprogrampages) -- [globalByteSlices](types_app_manager.AppInformation.md#globalbyteslices) -- [globalInts](types_app_manager.AppInformation.md#globalints) -- [globalState](types_app_manager.AppInformation.md#globalstate) -- [localByteSlices](types_app_manager.AppInformation.md#localbyteslices) -- [localInts](types_app_manager.AppInformation.md#localints) - -## Properties - -### appAddress - -• **appAddress**: `Address` - -The escrow address that the app operates with. - -#### Defined in - -[src/types/app-manager.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L20) - -___ - -### appId - -• **appId**: `bigint` - -The ID of the app. - -#### Defined in - -[src/types/app-manager.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L18) - -___ - -### approvalProgram - -• **approvalProgram**: `Uint8Array` - -Approval program. - -#### Defined in - -[src/types/app-manager.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L24) - -___ - -### clearStateProgram - -• **clearStateProgram**: `Uint8Array` - -Clear state program. - -#### Defined in - -[src/types/app-manager.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L28) - -___ - -### creator - -• **creator**: `Address` - -The address that created this application. This is the address where the -parameters and global state for this application can be found. - -#### Defined in - -[src/types/app-manager.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L33) - -___ - -### extraProgramPages - -• `Optional` **extraProgramPages**: `number` - -Any extra pages that are needed for the smart contract. - -#### Defined in - -[src/types/app-manager.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L47) - -___ - -### globalByteSlices - -• **globalByteSlices**: `number` - -The number of allocated byte slices in global state. - -#### Defined in - -[src/types/app-manager.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L45) - -___ - -### globalInts - -• **globalInts**: `number` - -The number of allocated ints in global state. - -#### Defined in - -[src/types/app-manager.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L43) - -___ - -### globalState - -• **globalState**: [`AppState`](types_app.AppState.md) - -Current global state values. - -#### Defined in - -[src/types/app-manager.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L37) - -___ - -### localByteSlices - -• **localByteSlices**: `number` - -The number of allocated byte slices in per-user local state. - -#### Defined in - -[src/types/app-manager.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L41) - -___ - -### localInts - -• **localInts**: `number` - -The number of allocated ints in per-user local state. - -#### Defined in - -[src/types/app-manager.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L39) diff --git a/docs/code/interfaces/types_app_manager.BoxReference.md b/docs/code/interfaces/types_app_manager.BoxReference.md deleted file mode 100644 index d9e83a41..00000000 --- a/docs/code/interfaces/types_app_manager.BoxReference.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-manager](../modules/types_app_manager.md) / BoxReference - -# Interface: BoxReference - -[types/app-manager](../modules/types_app_manager.md).BoxReference - -A grouping of the app ID and name identifier to reference an app box. - -## Table of contents - -### Properties - -- [appId](types_app_manager.BoxReference.md#appid) -- [name](types_app_manager.BoxReference.md#name) - -## Properties - -### appId - -• **appId**: `bigint` - -A unique application id - -#### Defined in - -[src/types/app-manager.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L66) - -___ - -### name - -• **name**: [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) - -Identifier for a box name - -#### Defined in - -[src/types/app-manager.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L70) diff --git a/docs/code/interfaces/types_app_manager.BoxValueRequestParams.md b/docs/code/interfaces/types_app_manager.BoxValueRequestParams.md deleted file mode 100644 index c9ef2c00..00000000 --- a/docs/code/interfaces/types_app_manager.BoxValueRequestParams.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-manager](../modules/types_app_manager.md) / BoxValueRequestParams - -# Interface: BoxValueRequestParams - -[types/app-manager](../modules/types_app_manager.md).BoxValueRequestParams - -Parameters to get and decode a box value as an ABI type. - -## Table of contents - -### Properties - -- [appId](types_app_manager.BoxValueRequestParams.md#appid) -- [boxName](types_app_manager.BoxValueRequestParams.md#boxname) -- [type](types_app_manager.BoxValueRequestParams.md#type) - -## Properties - -### appId - -• **appId**: `bigint` - -The ID of the app return box names for - -#### Defined in - -[src/types/app-manager.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L78) - -___ - -### boxName - -• **boxName**: [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier) - -The name of the box to return either as a string, binary array or `BoxName` - -#### Defined in - -[src/types/app-manager.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L80) - -___ - -### type - -• **type**: `ABIType` - -The ABI type to decode the value using - -#### Defined in - -[src/types/app-manager.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L82) diff --git a/docs/code/interfaces/types_app_manager.BoxValuesRequestParams.md b/docs/code/interfaces/types_app_manager.BoxValuesRequestParams.md deleted file mode 100644 index 7e20dc0d..00000000 --- a/docs/code/interfaces/types_app_manager.BoxValuesRequestParams.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-manager](../modules/types_app_manager.md) / BoxValuesRequestParams - -# Interface: BoxValuesRequestParams - -[types/app-manager](../modules/types_app_manager.md).BoxValuesRequestParams - -Parameters to get and decode a box value as an ABI type. - -## Table of contents - -### Properties - -- [appId](types_app_manager.BoxValuesRequestParams.md#appid) -- [boxNames](types_app_manager.BoxValuesRequestParams.md#boxnames) -- [type](types_app_manager.BoxValuesRequestParams.md#type) - -## Properties - -### appId - -• **appId**: `bigint` - -The ID of the app return box names for - -#### Defined in - -[src/types/app-manager.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L90) - -___ - -### boxNames - -• **boxNames**: [`BoxIdentifier`](../modules/types_app_manager.md#boxidentifier)[] - -The names of the boxes to return either as a string, binary array or BoxName` - -#### Defined in - -[src/types/app-manager.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L92) - -___ - -### type - -• **type**: `ABIType` - -The ABI type to decode the value using - -#### Defined in - -[src/types/app-manager.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L94) diff --git a/docs/code/interfaces/types_app_spec.AppSources.md b/docs/code/interfaces/types_app_spec.AppSources.md deleted file mode 100644 index 208369e1..00000000 --- a/docs/code/interfaces/types_app_spec.AppSources.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / AppSources - -# Interface: AppSources - -[types/app-spec](../modules/types_app_spec.md).AppSources - -The TEAL source of a contract - -## Table of contents - -### Properties - -- [approval](types_app_spec.AppSources.md#approval) -- [clear](types_app_spec.AppSources.md#clear) - -## Properties - -### approval - -• **approval**: `string` - -The TEAL source of the approval program - -#### Defined in - -[src/types/app-spec.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L172) - -___ - -### clear - -• **clear**: `string` - -The TEAL source of the clear program - -#### Defined in - -[src/types/app-spec.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L174) diff --git a/docs/code/interfaces/types_app_spec.AppSpec.md b/docs/code/interfaces/types_app_spec.AppSpec.md deleted file mode 100644 index 0f30aa9a..00000000 --- a/docs/code/interfaces/types_app_spec.AppSpec.md +++ /dev/null @@ -1,90 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / AppSpec - -# Interface: AppSpec - -[types/app-spec](../modules/types_app_spec.md).AppSpec - -An ARC-0032 Application Specification see https://github.com/algorandfoundation/ARCs/pull/150 - -## Table of contents - -### Properties - -- [bare\_call\_config](types_app_spec.AppSpec.md#bare_call_config) -- [contract](types_app_spec.AppSpec.md#contract) -- [hints](types_app_spec.AppSpec.md#hints) -- [schema](types_app_spec.AppSpec.md#schema) -- [source](types_app_spec.AppSpec.md#source) -- [state](types_app_spec.AppSpec.md#state) - -## Properties - -### bare\_call\_config - -• **bare\_call\_config**: [`CallConfig`](types_app_spec.CallConfig.md) - -The config of all BARE calls (i.e. non ABI calls with no args) - -#### Defined in - -[src/types/app-spec.ts:163](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L163) - -___ - -### contract - -• **contract**: `ABIContractParams` - -The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md - -#### Defined in - -[src/types/app-spec.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L157) - -___ - -### hints - -• **hints**: [`HintSpec`](../modules/types_app_spec.md#hintspec) - -Method call hints - -#### Defined in - -[src/types/app-spec.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L153) - -___ - -### schema - -• **schema**: [`SchemaSpec`](types_app_spec.SchemaSpec.md) - -The values that make up the local and global state - -#### Defined in - -[src/types/app-spec.ts:159](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L159) - -___ - -### source - -• **source**: [`AppSources`](types_app_spec.AppSources.md) - -The TEAL source - -#### Defined in - -[src/types/app-spec.ts:155](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L155) - -___ - -### state - -• **state**: [`StateSchemaSpec`](types_app_spec.StateSchemaSpec.md) - -The rolled-up schema allocation values for local and global state - -#### Defined in - -[src/types/app-spec.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L161) diff --git a/docs/code/interfaces/types_app_spec.CallConfig.md b/docs/code/interfaces/types_app_spec.CallConfig.md deleted file mode 100644 index 605dff07..00000000 --- a/docs/code/interfaces/types_app_spec.CallConfig.md +++ /dev/null @@ -1,77 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / CallConfig - -# Interface: CallConfig - -[types/app-spec](../modules/types_app_spec.md).CallConfig - -Call configuration for a method - -## Table of contents - -### Properties - -- [close\_out](types_app_spec.CallConfig.md#close_out) -- [delete\_application](types_app_spec.CallConfig.md#delete_application) -- [no\_op](types_app_spec.CallConfig.md#no_op) -- [opt\_in](types_app_spec.CallConfig.md#opt_in) -- [update\_application](types_app_spec.CallConfig.md#update_application) - -## Properties - -### close\_out - -• `Optional` **close\_out**: [`CallConfigValue`](../modules/types_app_spec.md#callconfigvalue) - -Close out call config - -#### Defined in - -[src/types/app-spec.ts:192](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L192) - -___ - -### delete\_application - -• `Optional` **delete\_application**: [`CallConfigValue`](../modules/types_app_spec.md#callconfigvalue) - -Delete call config - -#### Defined in - -[src/types/app-spec.ts:196](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L196) - -___ - -### no\_op - -• `Optional` **no\_op**: [`CallConfigValue`](../modules/types_app_spec.md#callconfigvalue) - -NoOp call config - -#### Defined in - -[src/types/app-spec.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L188) - -___ - -### opt\_in - -• `Optional` **opt\_in**: [`CallConfigValue`](../modules/types_app_spec.md#callconfigvalue) - -Opt-in call config - -#### Defined in - -[src/types/app-spec.ts:190](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L190) - -___ - -### update\_application - -• `Optional` **update\_application**: [`CallConfigValue`](../modules/types_app_spec.md#callconfigvalue) - -Update call config - -#### Defined in - -[src/types/app-spec.ts:194](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L194) diff --git a/docs/code/interfaces/types_app_spec.DeclaredSchemaValueSpec.md b/docs/code/interfaces/types_app_spec.DeclaredSchemaValueSpec.md deleted file mode 100644 index 1e6445e8..00000000 --- a/docs/code/interfaces/types_app_spec.DeclaredSchemaValueSpec.md +++ /dev/null @@ -1,64 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / DeclaredSchemaValueSpec - -# Interface: DeclaredSchemaValueSpec - -[types/app-spec](../modules/types_app_spec.md).DeclaredSchemaValueSpec - -Declared schema value specification - -## Table of contents - -### Properties - -- [descr](types_app_spec.DeclaredSchemaValueSpec.md#descr) -- [key](types_app_spec.DeclaredSchemaValueSpec.md#key) -- [static](types_app_spec.DeclaredSchemaValueSpec.md#static) -- [type](types_app_spec.DeclaredSchemaValueSpec.md#type) - -## Properties - -### descr - -• `Optional` **descr**: `string` - -A description of the variable - -#### Defined in - -[src/types/app-spec.ts:277](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L277) - -___ - -### key - -• **key**: `string` - -The name of the key - -#### Defined in - -[src/types/app-spec.ts:275](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L275) - -___ - -### static - -• `Optional` **static**: `boolean` - -Whether or not the value is set statically (at create time only) or dynamically - -#### Defined in - -[src/types/app-spec.ts:279](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L279) - -___ - -### type - -• **type**: [`AVMType`](../modules/types_app_spec.md#avmtype) - -The type of value - -#### Defined in - -[src/types/app-spec.ts:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L273) diff --git a/docs/code/interfaces/types_app_spec.Hint.md b/docs/code/interfaces/types_app_spec.Hint.md deleted file mode 100644 index c1f97577..00000000 --- a/docs/code/interfaces/types_app_spec.Hint.md +++ /dev/null @@ -1,58 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / Hint - -# Interface: Hint - -[types/app-spec](../modules/types_app_spec.md).Hint - -Hint information for a given method call to allow client generation - -## Table of contents - -### Properties - -- [call\_config](types_app_spec.Hint.md#call_config) -- [default\_arguments](types_app_spec.Hint.md#default_arguments) -- [read\_only](types_app_spec.Hint.md#read_only) -- [structs](types_app_spec.Hint.md#structs) - -## Properties - -### call\_config - -• **call\_config**: [`CallConfig`](types_app_spec.CallConfig.md) - -#### Defined in - -[src/types/app-spec.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L205) - -___ - -### default\_arguments - -• `Optional` **default\_arguments**: `Record`\<`string`, [`DefaultArgument`](../modules/types_app_spec.md#defaultargument)\> - -#### Defined in - -[src/types/app-spec.ts:204](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L204) - -___ - -### read\_only - -• `Optional` **read\_only**: `boolean` - -#### Defined in - -[src/types/app-spec.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L203) - -___ - -### structs - -• `Optional` **structs**: `Record`\<`string`, [`Struct`](types_app_spec.Struct.md)\> - -Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type - -#### Defined in - -[src/types/app-spec.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L202) diff --git a/docs/code/interfaces/types_app_spec.ReservedSchemaValueSpec.md b/docs/code/interfaces/types_app_spec.ReservedSchemaValueSpec.md deleted file mode 100644 index f72ff94b..00000000 --- a/docs/code/interfaces/types_app_spec.ReservedSchemaValueSpec.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / ReservedSchemaValueSpec - -# Interface: ReservedSchemaValueSpec - -[types/app-spec](../modules/types_app_spec.md).ReservedSchemaValueSpec - -Reserved schema value specification - -## Table of contents - -### Properties - -- [descr](types_app_spec.ReservedSchemaValueSpec.md#descr) -- [max\_keys](types_app_spec.ReservedSchemaValueSpec.md#max_keys) -- [type](types_app_spec.ReservedSchemaValueSpec.md#type) - -## Properties - -### descr - -• **descr**: `string` - -The description of the reserved storage space - -#### Defined in - -[src/types/app-spec.ts:287](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L287) - -___ - -### max\_keys - -• **max\_keys**: `number` - -The maximum number of slots to reserve - -#### Defined in - -[src/types/app-spec.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L289) - -___ - -### type - -• **type**: [`AVMType`](../modules/types_app_spec.md#avmtype) - -The type of value - -#### Defined in - -[src/types/app-spec.ts:285](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L285) diff --git a/docs/code/interfaces/types_app_spec.Schema.md b/docs/code/interfaces/types_app_spec.Schema.md deleted file mode 100644 index 82076d8a..00000000 --- a/docs/code/interfaces/types_app_spec.Schema.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / Schema - -# Interface: Schema - -[types/app-spec](../modules/types_app_spec.md).Schema - -The storage schema definition - -## Table of contents - -### Properties - -- [declared](types_app_spec.Schema.md#declared) -- [reserved](types_app_spec.Schema.md#reserved) - -## Properties - -### declared - -• **declared**: `Record`\<`string`, [`DeclaredSchemaValueSpec`](types_app_spec.DeclaredSchemaValueSpec.md)\> - -Declared storage schema - -#### Defined in - -[src/types/app-spec.ts:303](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L303) - -___ - -### reserved - -• **reserved**: `Record`\<`string`, [`ReservedSchemaValueSpec`](types_app_spec.ReservedSchemaValueSpec.md)\> - -Reserved storage schema - -#### Defined in - -[src/types/app-spec.ts:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L305) diff --git a/docs/code/interfaces/types_app_spec.SchemaSpec.md b/docs/code/interfaces/types_app_spec.SchemaSpec.md deleted file mode 100644 index 0467410f..00000000 --- a/docs/code/interfaces/types_app_spec.SchemaSpec.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / SchemaSpec - -# Interface: SchemaSpec - -[types/app-spec](../modules/types_app_spec.md).SchemaSpec - -The schema for global and local storage - -## Table of contents - -### Properties - -- [global](types_app_spec.SchemaSpec.md#global) -- [local](types_app_spec.SchemaSpec.md#local) - -## Properties - -### global - -• **global**: [`Schema`](types_app_spec.Schema.md) - -The global storage schema - -#### Defined in - -[src/types/app-spec.ts:297](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L297) - -___ - -### local - -• **local**: [`Schema`](types_app_spec.Schema.md) - -The local storage schema - -#### Defined in - -[src/types/app-spec.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L295) diff --git a/docs/code/interfaces/types_app_spec.StateSchemaSpec.md b/docs/code/interfaces/types_app_spec.StateSchemaSpec.md deleted file mode 100644 index 6d0206d6..00000000 --- a/docs/code/interfaces/types_app_spec.StateSchemaSpec.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / StateSchemaSpec - -# Interface: StateSchemaSpec - -[types/app-spec](../modules/types_app_spec.md).StateSchemaSpec - -The rolled-up schema allocation specification for local and global state - -## Table of contents - -### Properties - -- [global](types_app_spec.StateSchemaSpec.md#global) -- [local](types_app_spec.StateSchemaSpec.md#local) - -## Properties - -### global - -• **global**: [`StateSchema`](../modules/types_app_spec.md#stateschema) - -Global storage spec - -#### Defined in - -[src/types/app-spec.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L311) - -___ - -### local - -• **local**: [`StateSchema`](../modules/types_app_spec.md#stateschema) - -Local storage spec - -#### Defined in - -[src/types/app-spec.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L313) diff --git a/docs/code/interfaces/types_app_spec.Struct.md b/docs/code/interfaces/types_app_spec.Struct.md deleted file mode 100644 index e608c1d2..00000000 --- a/docs/code/interfaces/types_app_spec.Struct.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/app-spec](../modules/types_app_spec.md) / Struct - -# Interface: Struct - -[types/app-spec](../modules/types_app_spec.md).Struct - -A user-defined struct/tuple type - -## Table of contents - -### Properties - -- [elements](types_app_spec.Struct.md#elements) -- [name](types_app_spec.Struct.md#name) - -## Properties - -### elements - -• **elements**: [`StructElement`](../modules/types_app_spec.md#structelement)[] - -The elements (in order) that make up the struct/tuple - -#### Defined in - -[src/types/app-spec.ts:222](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L222) - -___ - -### name - -• **name**: `string` - -The name of the type - -#### Defined in - -[src/types/app-spec.ts:220](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L220) diff --git a/docs/code/interfaces/types_asset.AssetBulkOptInOutParams.md b/docs/code/interfaces/types_asset.AssetBulkOptInOutParams.md deleted file mode 100644 index cb99c97a..00000000 --- a/docs/code/interfaces/types_asset.AssetBulkOptInOutParams.md +++ /dev/null @@ -1,105 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/asset](../modules/types_asset.md) / AssetBulkOptInOutParams - -# Interface: AssetBulkOptInOutParams - -[types/asset](../modules/types_asset.md).AssetBulkOptInOutParams - -**`Deprecated`** - -Parameters for `assetBulkOptIn` / `assetBulkOptOut` call. - -## Table of contents - -### Properties - -- [account](types_asset.AssetBulkOptInOutParams.md#account) -- [assetIds](types_asset.AssetBulkOptInOutParams.md#assetids) -- [maxFee](types_asset.AssetBulkOptInOutParams.md#maxfee) -- [note](types_asset.AssetBulkOptInOutParams.md#note) -- [suppressLog](types_asset.AssetBulkOptInOutParams.md#suppresslog) -- [transactionParams](types_asset.AssetBulkOptInOutParams.md#transactionparams) -- [validateBalances](types_asset.AssetBulkOptInOutParams.md#validatebalances) - -## Properties - -### account - -• **account**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account to opt in/out for - -#### Defined in - -[src/types/asset.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L94) - -___ - -### assetIds - -• **assetIds**: `number`[] - -The IDs of the assets to opt in for / out of - -#### Defined in - -[src/types/asset.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L96) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay per transaction (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Defined in - -[src/types/asset.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L104) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Defined in - -[src/types/asset.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L102) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Defined in - -[src/types/asset.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L106) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Defined in - -[src/types/asset.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L100) - -___ - -### validateBalances - -• `Optional` **validateBalances**: `boolean` - -Whether or not to validate the opt-in/out is valid before issuing transactions; default = true - -#### Defined in - -[src/types/asset.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L98) diff --git a/docs/code/interfaces/types_asset.AssetOptInParams.md b/docs/code/interfaces/types_asset.AssetOptInParams.md deleted file mode 100644 index d5e72f8d..00000000 --- a/docs/code/interfaces/types_asset.AssetOptInParams.md +++ /dev/null @@ -1,224 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/asset](../modules/types_asset.md) / AssetOptInParams - -# Interface: AssetOptInParams - -[types/asset](../modules/types_asset.md).AssetOptInParams - -**`Deprecated`** - -Parameters for `assetOptIn` call. - -## Hierarchy - -- [`SendTransactionParams`](types_transaction.SendTransactionParams.md) - - ↳ **`AssetOptInParams`** - - ↳↳ [`AssetOptOutParams`](types_asset.AssetOptOutParams.md) - -## Table of contents - -### Properties - -- [account](types_asset.AssetOptInParams.md#account) -- [assetId](types_asset.AssetOptInParams.md#assetid) -- [atc](types_asset.AssetOptInParams.md#atc) -- [fee](types_asset.AssetOptInParams.md#fee) -- [lease](types_asset.AssetOptInParams.md#lease) -- [maxFee](types_asset.AssetOptInParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_asset.AssetOptInParams.md#maxroundstowaitforconfirmation) -- [note](types_asset.AssetOptInParams.md#note) -- [populateAppCallResources](types_asset.AssetOptInParams.md#populateappcallresources) -- [skipSending](types_asset.AssetOptInParams.md#skipsending) -- [skipWaiting](types_asset.AssetOptInParams.md#skipwaiting) -- [suppressLog](types_asset.AssetOptInParams.md#suppresslog) -- [transactionParams](types_asset.AssetOptInParams.md#transactionparams) - -## Properties - -### account - -• **account**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account to opt in/out for - -#### Defined in - -[src/types/asset.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L72) - -___ - -### assetId - -• **assetId**: `number` - -The ID of the assets to opt in for / out of - -#### Defined in - -[src/types/asset.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L74) - -___ - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[atc](types_transaction.SendTransactionParams.md#atc) - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee) - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply - -#### Defined in - -[src/types/asset.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L80) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxFee](types_transaction.SendTransactionParams.md#maxfee) - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Defined in - -[src/types/asset.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L78) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[populateAppCallResources](types_transaction.SendTransactionParams.md#populateappcallresources) - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipSending](types_transaction.SendTransactionParams.md#skipsending) - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipWaiting](types_transaction.SendTransactionParams.md#skipwaiting) - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[suppressLog](types_transaction.SendTransactionParams.md#suppresslog) - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Defined in - -[src/types/asset.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L76) diff --git a/docs/code/interfaces/types_asset.AssetOptOutParams.md b/docs/code/interfaces/types_asset.AssetOptOutParams.md deleted file mode 100644 index 99de450b..00000000 --- a/docs/code/interfaces/types_asset.AssetOptOutParams.md +++ /dev/null @@ -1,268 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/asset](../modules/types_asset.md) / AssetOptOutParams - -# Interface: AssetOptOutParams - -[types/asset](../modules/types_asset.md).AssetOptOutParams - -**`Deprecated`** - -Parameters for `assetOptOut` call. - -## Hierarchy - -- [`AssetOptInParams`](types_asset.AssetOptInParams.md) - - ↳ **`AssetOptOutParams`** - -## Table of contents - -### Properties - -- [account](types_asset.AssetOptOutParams.md#account) -- [assetCreatorAddress](types_asset.AssetOptOutParams.md#assetcreatoraddress) -- [assetId](types_asset.AssetOptOutParams.md#assetid) -- [atc](types_asset.AssetOptOutParams.md#atc) -- [ensureZeroBalance](types_asset.AssetOptOutParams.md#ensurezerobalance) -- [fee](types_asset.AssetOptOutParams.md#fee) -- [lease](types_asset.AssetOptOutParams.md#lease) -- [maxFee](types_asset.AssetOptOutParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_asset.AssetOptOutParams.md#maxroundstowaitforconfirmation) -- [note](types_asset.AssetOptOutParams.md#note) -- [populateAppCallResources](types_asset.AssetOptOutParams.md#populateappcallresources) -- [skipSending](types_asset.AssetOptOutParams.md#skipsending) -- [skipWaiting](types_asset.AssetOptOutParams.md#skipwaiting) -- [suppressLog](types_asset.AssetOptOutParams.md#suppresslog) -- [transactionParams](types_asset.AssetOptOutParams.md#transactionparams) - -## Properties - -### account - -• **account**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account to opt in/out for - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[account](types_asset.AssetOptInParams.md#account) - -#### Defined in - -[src/types/asset.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L72) - -___ - -### assetCreatorAddress - -• `Optional` **assetCreatorAddress**: `string` - -The address of the creator account for the asset; if unspecified then it looks it up using algod - -#### Defined in - -[src/types/asset.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L86) - -___ - -### assetId - -• **assetId**: `number` - -The ID of the assets to opt in for / out of - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[assetId](types_asset.AssetOptInParams.md#assetid) - -#### Defined in - -[src/types/asset.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L74) - -___ - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[atc](types_asset.AssetOptInParams.md#atc) - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### ensureZeroBalance - -• `Optional` **ensureZeroBalance**: `boolean` - -Whether or not to validate the account has a zero-balance before issuing the opt-out; default = true - -#### Defined in - -[src/types/asset.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L88) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[fee](types_asset.AssetOptInParams.md#fee) - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[lease](types_asset.AssetOptInParams.md#lease) - -#### Defined in - -[src/types/asset.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L80) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[maxFee](types_asset.AssetOptInParams.md#maxfee) - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[maxRoundsToWaitForConfirmation](types_asset.AssetOptInParams.md#maxroundstowaitforconfirmation) - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[note](types_asset.AssetOptInParams.md#note) - -#### Defined in - -[src/types/asset.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L78) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[populateAppCallResources](types_asset.AssetOptInParams.md#populateappcallresources) - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[skipSending](types_asset.AssetOptInParams.md#skipsending) - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[skipWaiting](types_asset.AssetOptInParams.md#skipwaiting) - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[suppressLog](types_asset.AssetOptInParams.md#suppresslog) - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Inherited from - -[AssetOptInParams](types_asset.AssetOptInParams.md).[transactionParams](types_asset.AssetOptInParams.md#transactionparams) - -#### Defined in - -[src/types/asset.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L76) diff --git a/docs/code/interfaces/types_asset.CreateAssetParams.md b/docs/code/interfaces/types_asset.CreateAssetParams.md deleted file mode 100644 index 22dd2136..00000000 --- a/docs/code/interfaces/types_asset.CreateAssetParams.md +++ /dev/null @@ -1,369 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/asset](../modules/types_asset.md) / CreateAssetParams - -# Interface: CreateAssetParams - -[types/asset](../modules/types_asset.md).CreateAssetParams - -**`Deprecated`** - -Parameters for `createAsset` call. - -## Hierarchy - -- [`SendTransactionParams`](types_transaction.SendTransactionParams.md) - - ↳ **`CreateAssetParams`** - -## Table of contents - -### Properties - -- [atc](types_asset.CreateAssetParams.md#atc) -- [clawbackAccount](types_asset.CreateAssetParams.md#clawbackaccount) -- [creator](types_asset.CreateAssetParams.md#creator) -- [decimals](types_asset.CreateAssetParams.md#decimals) -- [fee](types_asset.CreateAssetParams.md#fee) -- [freezeAccount](types_asset.CreateAssetParams.md#freezeaccount) -- [frozenByDefault](types_asset.CreateAssetParams.md#frozenbydefault) -- [lease](types_asset.CreateAssetParams.md#lease) -- [manager](types_asset.CreateAssetParams.md#manager) -- [maxFee](types_asset.CreateAssetParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_asset.CreateAssetParams.md#maxroundstowaitforconfirmation) -- [metadataHash](types_asset.CreateAssetParams.md#metadatahash) -- [name](types_asset.CreateAssetParams.md#name) -- [note](types_asset.CreateAssetParams.md#note) -- [populateAppCallResources](types_asset.CreateAssetParams.md#populateappcallresources) -- [reserveAccount](types_asset.CreateAssetParams.md#reserveaccount) -- [skipSending](types_asset.CreateAssetParams.md#skipsending) -- [skipWaiting](types_asset.CreateAssetParams.md#skipwaiting) -- [suppressLog](types_asset.CreateAssetParams.md#suppresslog) -- [total](types_asset.CreateAssetParams.md#total) -- [transactionParams](types_asset.CreateAssetParams.md#transactionparams) -- [unit](types_asset.CreateAssetParams.md#unit) -- [url](types_asset.CreateAssetParams.md#url) - -## Properties - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[atc](types_transaction.SendTransactionParams.md#atc) - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### clawbackAccount - -• `Optional` **clawbackAccount**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The optional account that can clawback holdings of this asset. If empty, clawback is not permitted. -If not set at asset creation or subsequently set to empty by the manager the field is permanently empty. - -#### Defined in - -[src/types/asset.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L57) - -___ - -### creator - -• **creator**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account to create the asset. - -This account automatically is opted in to the asset and holds all units after creation. - -#### Defined in - -[src/types/asset.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L11) - -___ - -### decimals - -• **decimals**: `number` - -The number of digits to use after the decimal point when displaying the asset. -If 0, the asset is not divisible. -If 1, the base unit of the asset is in tenths. -If 2, the base unit of the asset is in hundredths. -If 3, the base unit of the asset is in thousandths, and so on up to 19 decimal places. -This field can only be specified upon asset creation. - -#### Defined in - -[src/types/asset.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L26) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee) - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### freezeAccount - -• `Optional` **freezeAccount**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The optional account that can be used to freeze holdings of this asset. If empty, freezing is not permitted. -If not set at asset creation or subsequently set to empty by the manager the field is permanently empty. - -#### Defined in - -[src/types/asset.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L53) - -___ - -### frozenByDefault - -• `Optional` **frozenByDefault**: `boolean` - -Whether to freeze holdings for this asset by default. If `true` then for anyone apart from the creator to hold the asset it needs to be unfrozen per account using `freeze`. Defaults to `false`. - -#### Defined in - -[src/types/asset.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L59) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply - -#### Defined in - -[src/types/asset.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L66) - -___ - -### manager - -• `Optional` **manager**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The optional account that can manage the configuration of the asset and destroy it. -If not set at asset creation or subsequently set to empty by the manager the asset becomes immutable. - -#### Defined in - -[src/types/asset.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L43) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxFee](types_transaction.SendTransactionParams.md#maxfee) - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### metadataHash - -• `Optional` **metadataHash**: `string` \| `Uint8Array` - -This field is intended to be a 32-byte hash of some metadata that is relevant to your asset and/or asset holders. -The format of this metadata is up to the application. This field can only be specified upon asset creation. - -#### Defined in - -[src/types/asset.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L39) - -___ - -### name - -• `Optional` **name**: `string` - -The optional name of the asset. Max size if 32 bytes. This field can only be specified upon asset creation. - -#### Defined in - -[src/types/asset.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L29) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Defined in - -[src/types/asset.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L64) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[populateAppCallResources](types_transaction.SendTransactionParams.md#populateappcallresources) - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### reserveAccount - -• `Optional` **reserveAccount**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The optional account that holds the reserve (non-minted) units of the asset. This address has no specific authority in the protocol itself and is informational. -Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md) rely on this field to hold meaningful data. -It is used in the case where you want to signal to holders of your asset that the non-minted units of the asset reside in an account that is different from the default creator account. -If not set at asset creation or subsequently set to empty by the manager the field is permanently empty. - -#### Defined in - -[src/types/asset.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L49) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipSending](types_transaction.SendTransactionParams.md#skipsending) - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipWaiting](types_transaction.SendTransactionParams.md#skipwaiting) - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[suppressLog](types_transaction.SendTransactionParams.md#suppresslog) - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### total - -• **total**: `number` \| `bigint` - -The total number of base (decimal) units of the asset to create. -If decimal is, say, 2, then for every 100 `total` there would be 1 whole unit. -This field can only be specified upon asset creation. - -#### Defined in - -[src/types/asset.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L17) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Defined in - -[src/types/asset.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L62) - -___ - -### unit - -• `Optional` **unit**: `string` - -The optional name of the unit of this asset. Max size is 8 bytes. This field can only be specified upon asset creation. - -#### Defined in - -[src/types/asset.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L31) - -___ - -### url - -• `Optional` **url**: `string` - -Specifies an optional URL where more information about the asset can be retrieved. Max size is 96 bytes. -This field can only be specified upon asset creation. - -#### Defined in - -[src/types/asset.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L35) diff --git a/docs/code/interfaces/types_asset_manager.AssetInformation.md b/docs/code/interfaces/types_asset_manager.AssetInformation.md deleted file mode 100644 index 206d187e..00000000 --- a/docs/code/interfaces/types_asset_manager.AssetInformation.md +++ /dev/null @@ -1,272 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/asset-manager](../modules/types_asset_manager.md) / AssetInformation - -# Interface: AssetInformation - -[types/asset-manager](../modules/types_asset_manager.md).AssetInformation - -Information about an asset. - -## Table of contents - -### Properties - -- [assetId](types_asset_manager.AssetInformation.md#assetid) -- [assetName](types_asset_manager.AssetInformation.md#assetname) -- [assetNameAsBytes](types_asset_manager.AssetInformation.md#assetnameasbytes) -- [clawback](types_asset_manager.AssetInformation.md#clawback) -- [creator](types_asset_manager.AssetInformation.md#creator) -- [decimals](types_asset_manager.AssetInformation.md#decimals) -- [defaultFrozen](types_asset_manager.AssetInformation.md#defaultfrozen) -- [freeze](types_asset_manager.AssetInformation.md#freeze) -- [manager](types_asset_manager.AssetInformation.md#manager) -- [metadataHash](types_asset_manager.AssetInformation.md#metadatahash) -- [reserve](types_asset_manager.AssetInformation.md#reserve) -- [total](types_asset_manager.AssetInformation.md#total) -- [unitName](types_asset_manager.AssetInformation.md#unitname) -- [unitNameAsBytes](types_asset_manager.AssetInformation.md#unitnameasbytes) -- [url](types_asset_manager.AssetInformation.md#url) -- [urlAsBytes](types_asset_manager.AssetInformation.md#urlasbytes) - -## Properties - -### assetId - -• **assetId**: `bigint` - -The ID of the asset. - -#### Defined in - -[src/types/asset-manager.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L19) - -___ - -### assetName - -• `Optional` **assetName**: `string` - -The optional name of the asset. - -Max size is 32 bytes. - -#### Defined in - -[src/types/asset-manager.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L110) - -___ - -### assetNameAsBytes - -• `Optional` **assetNameAsBytes**: `Uint8Array` - -The optional name of the asset. - -Max size is 32 bytes. - -#### Defined in - -[src/types/asset-manager.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L116) - -___ - -### clawback - -• `Optional` **clawback**: `string` - -The address of the optional account that can clawback holdings of this asset from any account. - -The clawback account has the ability to **unconditionally take assets from any account**. - -If empty, clawback is not permitted. - -If not set the field is permanently empty. - -#### Defined in - -[src/types/asset-manager.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L92) - -___ - -### creator - -• **creator**: `string` - -The address of the account that created the asset. - -This is the address where the parameters for this asset can be found, -and also the address where unwanted asset units can be sent when -closing out an asset position and opting-out of the asset. - -#### Defined in - -[src/types/asset-manager.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L27) - -___ - -### decimals - -• **decimals**: `number` - -The amount of decimal places the asset was created with. - -* If 0, the asset is not divisible; -* If 1, the base unit of the asset is in tenths; -* If 2, the base unit of the asset is in hundredths; -* If 3, the base unit of the asset is in thousandths; -* and so on up to 19 decimal places. - -#### Defined in - -[src/types/asset-manager.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L43) - -___ - -### defaultFrozen - -• `Optional` **defaultFrozen**: `boolean` - -Whether the asset was frozen by default for all accounts. - -If `true` then for anyone apart from the creator to hold the -asset it needs to be unfrozen per account using an asset freeze -transaction from the `freeze` account. - -#### Defined in - -[src/types/asset-manager.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L51) - -___ - -### freeze - -• `Optional` **freeze**: `string` - -The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account. - -If empty, freezing is not permitted. - -If not set the field is permanently empty. - -#### Defined in - -[src/types/asset-manager.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L81) - -___ - -### manager - -• `Optional` **manager**: `string` - -The address of the optional account that can manage the configuration of the asset and destroy it. - -If not set the asset is permanently immutable. - -#### Defined in - -[src/types/asset-manager.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L57) - -___ - -### metadataHash - -• `Optional` **metadataHash**: `Uint8Array` - -32-byte hash of some metadata that is relevant to the asset and/or asset holders. - -The format of this metadata is up to the application. - -#### Defined in - -[src/types/asset-manager.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L134) - -___ - -### reserve - -• `Optional` **reserve**: `string` - -The address of the optional account that holds the reserve (uncirculated supply) units of the asset. - -This address has no specific authority in the protocol itself and is informational only. - -Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md) -rely on this field to hold meaningful data. - -It can be used in the case where you want to signal to holders of your asset that the uncirculated units -of the asset reside in an account that is different from the default creator account. - -If not set the field is permanently empty. - -#### Defined in - -[src/types/asset-manager.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L72) - -___ - -### total - -• **total**: `bigint` - -The total amount of the smallest divisible (decimal) units that were created of the asset. - -For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit. - -#### Defined in - -[src/types/asset-manager.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L33) - -___ - -### unitName - -• `Optional` **unitName**: `string` - -The optional name of the unit of this asset (e.g. ticker name). - -Max size is 8 bytes. - -#### Defined in - -[src/types/asset-manager.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L98) - -___ - -### unitNameAsBytes - -• `Optional` **unitNameAsBytes**: `Uint8Array` - -The optional name of the unit of this asset (e.g. ticker name). - -Max size is 8 bytes. - -#### Defined in - -[src/types/asset-manager.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L104) - -___ - -### url - -• `Optional` **url**: `string` - -Optional URL where more information about the asset can be retrieved (e.g. metadata). - -Max size is 96 bytes. - -#### Defined in - -[src/types/asset-manager.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L122) - -___ - -### urlAsBytes - -• `Optional` **urlAsBytes**: `Uint8Array` - -Optional URL where more information about the asset can be retrieved (e.g. metadata). - -Max size is 96 bytes. - -#### Defined in - -[src/types/asset-manager.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L128) diff --git a/docs/code/interfaces/types_asset_manager.BulkAssetOptInOutResult.md b/docs/code/interfaces/types_asset_manager.BulkAssetOptInOutResult.md deleted file mode 100644 index 1297e837..00000000 --- a/docs/code/interfaces/types_asset_manager.BulkAssetOptInOutResult.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/asset-manager](../modules/types_asset_manager.md) / BulkAssetOptInOutResult - -# Interface: BulkAssetOptInOutResult - -[types/asset-manager](../modules/types_asset_manager.md).BulkAssetOptInOutResult - -Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. - -## Table of contents - -### Properties - -- [assetId](types_asset_manager.BulkAssetOptInOutResult.md#assetid) -- [transactionId](types_asset_manager.BulkAssetOptInOutResult.md#transactionid) - -## Properties - -### assetId - -• **assetId**: `bigint` - -The ID of the asset opted into / out of - -#### Defined in - -[src/types/asset-manager.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L11) - -___ - -### transactionId - -• **transactionId**: `string` - -The transaction ID of the resulting opt in / out - -#### Defined in - -[src/types/asset-manager.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L13) diff --git a/docs/code/interfaces/types_client_manager.AlgoSdkClients.md b/docs/code/interfaces/types_client_manager.AlgoSdkClients.md deleted file mode 100644 index db391b10..00000000 --- a/docs/code/interfaces/types_client_manager.AlgoSdkClients.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/client-manager](../modules/types_client_manager.md) / AlgoSdkClients - -# Interface: AlgoSdkClients - -[types/client-manager](../modules/types_client_manager.md).AlgoSdkClients - -Clients from algosdk that interact with the official Algorand APIs - -## Table of contents - -### Properties - -- [algod](types_client_manager.AlgoSdkClients.md#algod) -- [indexer](types_client_manager.AlgoSdkClients.md#indexer) -- [kmd](types_client_manager.AlgoSdkClients.md#kmd) - -## Properties - -### algod - -• **algod**: `AlgodClient` - -Algod client, see https://dev.algorand.co/reference/rest-apis/algod/ - -#### Defined in - -[src/types/client-manager.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L16) - -___ - -### indexer - -• `Optional` **indexer**: `IndexerClient` - -Optional indexer client, see https://dev.algorand.co/reference/rest-apis/indexer - -#### Defined in - -[src/types/client-manager.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L18) - -___ - -### kmd - -• `Optional` **kmd**: `KmdClient` - -Optional KMD client, see https://dev.algorand.co/reference/rest-apis/kmd/ - -#### Defined in - -[src/types/client-manager.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L20) diff --git a/docs/code/interfaces/types_client_manager.TypedAppClient.md b/docs/code/interfaces/types_client_manager.TypedAppClient.md deleted file mode 100644 index c9de94b2..00000000 --- a/docs/code/interfaces/types_client_manager.TypedAppClient.md +++ /dev/null @@ -1,84 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/client-manager](../modules/types_client_manager.md) / TypedAppClient - -# Interface: TypedAppClient\ - -[types/client-manager](../modules/types_client_manager.md).TypedAppClient - -Interface to identify a typed client that can be used to interact with an application. - -## Type parameters - -| Name | -| :------ | -| `TClient` | - -## Table of contents - -### Constructors - -- [constructor](types_client_manager.TypedAppClient.md#constructor) - -### Methods - -- [fromCreatorAndName](types_client_manager.TypedAppClient.md#fromcreatorandname) -- [fromNetwork](types_client_manager.TypedAppClient.md#fromnetwork) - -## Constructors - -### constructor - -• **new TypedAppClient**(`params`): `TClient` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Omit`\<[`AppClientParams`](types_app_client.AppClientParams.md), ``"appSpec"``\> | - -#### Returns - -`TClient` - -#### Defined in - -[src/types/client-manager.ts:694](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L694) - -## Methods - -### fromCreatorAndName - -▸ **fromCreatorAndName**(`params`): `Promise`\<`TClient`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Omit`\<\{ `algorand`: [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md) ; `appLookupCache?`: [`AppLookup`](types_app_deployer.AppLookup.md) ; `appName?`: `string` ; `appSpec`: `string` \| [`Arc56Contract`](types_app_arc56.Arc56Contract.md) \| [`AppSpec`](types_app_spec.AppSpec.md) ; `approvalSourceMap?`: `ProgramSourceMap` ; `clearSourceMap?`: `ProgramSourceMap` ; `creatorAddress`: `string` \| `Address` ; `defaultSender?`: `string` \| `Address` ; `defaultSigner?`: `TransactionSigner` ; `ignoreCache?`: `boolean` }, ``"appSpec"``\> | - -#### Returns - -`Promise`\<`TClient`\> - -#### Defined in - -[src/types/client-manager.ts:696](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L696) - -___ - -### fromNetwork - -▸ **fromNetwork**(`params`): `Promise`\<`TClient`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Omit`\<[`AppClientParams`](types_app_client.AppClientParams.md), ``"appId"`` \| ``"appSpec"``\> | - -#### Returns - -`Promise`\<`TClient`\> - -#### Defined in - -[src/types/client-manager.ts:695](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L695) diff --git a/docs/code/interfaces/types_client_manager.TypedAppFactory.md b/docs/code/interfaces/types_client_manager.TypedAppFactory.md deleted file mode 100644 index b55adc9d..00000000 --- a/docs/code/interfaces/types_client_manager.TypedAppFactory.md +++ /dev/null @@ -1,39 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/client-manager](../modules/types_client_manager.md) / TypedAppFactory - -# Interface: TypedAppFactory\ - -[types/client-manager](../modules/types_client_manager.md).TypedAppFactory - -Interface to identify a typed factory that can be used to create and deploy an application. - -## Type parameters - -| Name | -| :------ | -| `TClient` | - -## Table of contents - -### Constructors - -- [constructor](types_client_manager.TypedAppFactory.md#constructor) - -## Constructors - -### constructor - -• **new TypedAppFactory**(`params`): `TClient` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Omit`\<[`AppFactoryParams`](types_app_factory.AppFactoryParams.md), ``"appSpec"``\> | - -#### Returns - -`TClient` - -#### Defined in - -[src/types/client-manager.ts:703](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L703) diff --git a/docs/code/interfaces/types_composer.BuiltTransactions.md b/docs/code/interfaces/types_composer.BuiltTransactions.md deleted file mode 100644 index 8b563213..00000000 --- a/docs/code/interfaces/types_composer.BuiltTransactions.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/composer](../modules/types_composer.md) / BuiltTransactions - -# Interface: BuiltTransactions - -[types/composer](../modules/types_composer.md).BuiltTransactions - -Set of transactions built by `TransactionComposer`. - -## Table of contents - -### Properties - -- [methodCalls](types_composer.BuiltTransactions.md#methodcalls) -- [signers](types_composer.BuiltTransactions.md#signers) -- [transactions](types_composer.BuiltTransactions.md#transactions) - -## Properties - -### methodCalls - -• **methodCalls**: `Map`\<`number`, `ABIMethod`\> - -Any `ABIMethod` objects associated with any of the transactions in a map keyed by transaction index. - -#### Defined in - -[src/types/composer.ts:516](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L516) - -___ - -### signers - -• **signers**: `Map`\<`number`, `TransactionSigner`\> - -Any `TransactionSigner` objects associated with any of the transactions in a map keyed by transaction index. - -#### Defined in - -[src/types/composer.ts:518](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L518) - -___ - -### transactions - -• **transactions**: `Transaction`[] - -The built transactions - -#### Defined in - -[src/types/composer.ts:514](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L514) diff --git a/docs/code/interfaces/types_config.Config.md b/docs/code/interfaces/types_config.Config.md deleted file mode 100644 index 65e6b63d..00000000 --- a/docs/code/interfaces/types_config.Config.md +++ /dev/null @@ -1,115 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/config](../modules/types_config.md) / Config - -# Interface: Config - -[types/config](../modules/types_config.md).Config - -The AlgoKit configuration type - -## Table of contents - -### Properties - -- [debug](types_config.Config.md#debug) -- [events](types_config.Config.md#events) -- [logger](types_config.Config.md#logger) -- [maxSearchDepth](types_config.Config.md#maxsearchdepth) -- [populateAppCallResources](types_config.Config.md#populateappcallresources) -- [projectRoot](types_config.Config.md#projectroot) -- [traceAll](types_config.Config.md#traceall) -- [traceBufferSizeMb](types_config.Config.md#tracebuffersizemb) - -## Properties - -### debug - -• **debug**: `boolean` - -Whether or not debug mode is enabled - -#### Defined in - -[src/types/config.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L9) - -___ - -### events - -• **events**: [`AsyncEventEmitter`](../classes/types_async_event_emitter.AsyncEventEmitter.md) - -#### Defined in - -[src/types/config.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L24) - -___ - -### logger - -• **logger**: [`Logger`](../modules/types_logging.md#logger) - -Logger - -#### Defined in - -[src/types/config.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L7) - -___ - -### maxSearchDepth - -• **maxSearchDepth**: `number` - -The maximum depth to search for a specific file - -#### Defined in - -[src/types/config.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L17) - -___ - -### populateAppCallResources - -• **populateAppCallResources**: `boolean` - -Whether to enable populateAppCallResources in sendParams by default. -Default value is false. - -#### Defined in - -[src/types/config.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L22) - -___ - -### projectRoot - -• **projectRoot**: ``null`` \| `string` - -The path to the project root directory - -#### Defined in - -[src/types/config.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L11) - -___ - -### traceAll - -• **traceAll**: `boolean` - -Indicates whether to trace all operations - -#### Defined in - -[src/types/config.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L13) - -___ - -### traceBufferSizeMb - -• **traceBufferSizeMb**: `number` - -The size of the trace buffer in megabytes - -#### Defined in - -[src/types/config.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L15) diff --git a/docs/code/interfaces/types_debugging.AVMTracesEventData.md b/docs/code/interfaces/types_debugging.AVMTracesEventData.md deleted file mode 100644 index 5fcf9053..00000000 --- a/docs/code/interfaces/types_debugging.AVMTracesEventData.md +++ /dev/null @@ -1,25 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/debugging](../modules/types_debugging.md) / AVMTracesEventData - -# Interface: AVMTracesEventData - -[types/debugging](../modules/types_debugging.md).AVMTracesEventData - -Represents the data for AVM traces debug events emitted whenever a transaction is simulated in debug mode - -## Table of contents - -### Properties - -- [simulateResponse](types_debugging.AVMTracesEventData.md#simulateresponse) - -## Properties - -### simulateResponse - -• **simulateResponse**: `SimulateResponse` - -The simulation response from Algod - -#### Defined in - -[src/types/debugging.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L48) diff --git a/docs/code/interfaces/types_debugging.TealSourceDebugEventData.md b/docs/code/interfaces/types_debugging.TealSourceDebugEventData.md deleted file mode 100644 index 5c03be57..00000000 --- a/docs/code/interfaces/types_debugging.TealSourceDebugEventData.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/debugging](../modules/types_debugging.md) / TealSourceDebugEventData - -# Interface: TealSourceDebugEventData - -[types/debugging](../modules/types_debugging.md).TealSourceDebugEventData - -Represents the data for a single TEAL source - -## Table of contents - -### Properties - -- [appName](types_debugging.TealSourceDebugEventData.md#appname) -- [compiledTeal](types_debugging.TealSourceDebugEventData.md#compiledteal) -- [fileName](types_debugging.TealSourceDebugEventData.md#filename) - -## Properties - -### appName - -• **appName**: `string` - -The name of the application - -#### Defined in - -[src/types/debugging.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L28) - -___ - -### compiledTeal - -• **compiledTeal**: [`CompiledTeal`](types_app.CompiledTeal.md) - -The compiled TEAL code - -#### Defined in - -[src/types/debugging.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L32) - -___ - -### fileName - -• **fileName**: `string` - -The name of the file - -#### Defined in - -[src/types/debugging.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L30) diff --git a/docs/code/interfaces/types_debugging.TealSourcesDebugEventData.md b/docs/code/interfaces/types_debugging.TealSourcesDebugEventData.md deleted file mode 100644 index 7281d441..00000000 --- a/docs/code/interfaces/types_debugging.TealSourcesDebugEventData.md +++ /dev/null @@ -1,25 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/debugging](../modules/types_debugging.md) / TealSourcesDebugEventData - -# Interface: TealSourcesDebugEventData - -[types/debugging](../modules/types_debugging.md).TealSourcesDebugEventData - -Represents the data for multiple TEAL sources debug events emitted whenever an app is compiled as part of a deploy in debug mode - -## Table of contents - -### Properties - -- [sources](types_debugging.TealSourcesDebugEventData.md#sources) - -## Properties - -### sources - -• **sources**: [`TealSourceDebugEventData`](types_debugging.TealSourceDebugEventData.md)[] - -An array of TEAL source debug event data - -#### Defined in - -[src/types/debugging.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L40) diff --git a/docs/code/interfaces/types_dispenser_client.DispenserFundResponse.md b/docs/code/interfaces/types_dispenser_client.DispenserFundResponse.md deleted file mode 100644 index 9893d106..00000000 --- a/docs/code/interfaces/types_dispenser_client.DispenserFundResponse.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/dispenser-client](../modules/types_dispenser_client.md) / DispenserFundResponse - -# Interface: DispenserFundResponse - -[types/dispenser-client](../modules/types_dispenser_client.md).DispenserFundResponse - -The TestNet Dispenser API response when funding. - -## Table of contents - -### Properties - -- [amount](types_dispenser_client.DispenserFundResponse.md#amount) -- [txId](types_dispenser_client.DispenserFundResponse.md#txid) - -## Properties - -### amount - -• **amount**: `number` - -The number of µAlgo that was funded. - -#### Defined in - -[src/types/dispenser-client.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L29) - -___ - -### txId - -• **txId**: `string` - -The ID of the transaction that was issued to fund the account. - -#### Defined in - -[src/types/dispenser-client.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L27) diff --git a/docs/code/interfaces/types_dispenser_client.DispenserLimitResponse.md b/docs/code/interfaces/types_dispenser_client.DispenserLimitResponse.md deleted file mode 100644 index f9140ad0..00000000 --- a/docs/code/interfaces/types_dispenser_client.DispenserLimitResponse.md +++ /dev/null @@ -1,25 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/dispenser-client](../modules/types_dispenser_client.md) / DispenserLimitResponse - -# Interface: DispenserLimitResponse - -[types/dispenser-client](../modules/types_dispenser_client.md).DispenserLimitResponse - -The TestNet Dispenser API response when getting the current limit. - -## Table of contents - -### Properties - -- [amount](types_dispenser_client.DispenserLimitResponse.md#amount) - -## Properties - -### amount - -• **amount**: `number` - -The limit, in µAlgo, that you can currently fund. - -#### Defined in - -[src/types/dispenser-client.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L35) diff --git a/docs/code/interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md b/docs/code/interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md deleted file mode 100644 index a880daed..00000000 --- a/docs/code/interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/dispenser-client](../modules/types_dispenser_client.md) / TestNetDispenserApiClientParams - -# Interface: TestNetDispenserApiClientParams - -[types/dispenser-client](../modules/types_dispenser_client.md).TestNetDispenserApiClientParams - -The parameters to construct a TestNet Dispenser API client. - -## Table of contents - -### Properties - -- [authToken](types_dispenser_client.TestNetDispenserApiClientParams.md#authtoken) -- [requestTimeout](types_dispenser_client.TestNetDispenserApiClientParams.md#requesttimeout) - -## Properties - -### authToken - -• **authToken**: `string` - -The API auth token - -#### Defined in - -[src/types/dispenser-client.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L41) - -___ - -### requestTimeout - -• `Optional` **requestTimeout**: `number` - -The request timeout in seconds - -#### Defined in - -[src/types/dispenser-client.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L43) diff --git a/docs/code/interfaces/types_indexer.LookupAssetHoldingsOptions.md b/docs/code/interfaces/types_indexer.LookupAssetHoldingsOptions.md deleted file mode 100644 index 04ab9c5b..00000000 --- a/docs/code/interfaces/types_indexer.LookupAssetHoldingsOptions.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/indexer](../modules/types_indexer.md) / LookupAssetHoldingsOptions - -# Interface: LookupAssetHoldingsOptions - -[types/indexer](../modules/types_indexer.md).LookupAssetHoldingsOptions - -Options when looking up an asset's account holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-idbalances - -## Table of contents - -### Properties - -- [currencyGreaterThan](types_indexer.LookupAssetHoldingsOptions.md#currencygreaterthan) -- [currencyLessThan](types_indexer.LookupAssetHoldingsOptions.md#currencylessthan) -- [includeAll](types_indexer.LookupAssetHoldingsOptions.md#includeall) - -## Properties - -### currencyGreaterThan - -• `Optional` **currencyGreaterThan**: `number` \| `bigint` - -Results should have a decimal units amount greater than this value. - -#### Defined in - -[src/types/indexer.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L27) - -___ - -### currencyLessThan - -• `Optional` **currencyLessThan**: `number` \| `bigint` - -Results should have a decimal units amount less than this value. - -#### Defined in - -[src/types/indexer.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L25) - -___ - -### includeAll - -• `Optional` **includeAll**: `boolean` - -Include all items including closed accounts and opted-out asset holdings. - -#### Defined in - -[src/types/indexer.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L29) diff --git a/docs/code/interfaces/types_logic_error.LogicErrorDetails.md b/docs/code/interfaces/types_logic_error.LogicErrorDetails.md deleted file mode 100644 index bb4dcc8f..00000000 --- a/docs/code/interfaces/types_logic_error.LogicErrorDetails.md +++ /dev/null @@ -1,77 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/logic-error](../modules/types_logic_error.md) / LogicErrorDetails - -# Interface: LogicErrorDetails - -[types/logic-error](../modules/types_logic_error.md).LogicErrorDetails - -Details about a smart contract logic error - -## Table of contents - -### Properties - -- [desc](types_logic_error.LogicErrorDetails.md#desc) -- [msg](types_logic_error.LogicErrorDetails.md#msg) -- [pc](types_logic_error.LogicErrorDetails.md#pc) -- [traces](types_logic_error.LogicErrorDetails.md#traces) -- [txId](types_logic_error.LogicErrorDetails.md#txid) - -## Properties - -### desc - -• **desc**: `string` - -The full error description - -#### Defined in - -[src/types/logic-error.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L14) - -___ - -### msg - -• **msg**: `string` - -The error message - -#### Defined in - -[src/types/logic-error.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L12) - -___ - -### pc - -• **pc**: `number` - -The program counter where the error was - -#### Defined in - -[src/types/logic-error.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L10) - -___ - -### traces - -• **traces**: `Record`\<`string`, `unknown`\>[] - -Any trace information included in the error - -#### Defined in - -[src/types/logic-error.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L16) - -___ - -### txId - -• **txId**: `string` - -The ID of the transaction with the logic error - -#### Defined in - -[src/types/logic-error.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L8) diff --git a/docs/code/interfaces/types_network_client.AlgoClientConfig.md b/docs/code/interfaces/types_network_client.AlgoClientConfig.md deleted file mode 100644 index 1ec77353..00000000 --- a/docs/code/interfaces/types_network_client.AlgoClientConfig.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/network-client](../modules/types_network_client.md) / AlgoClientConfig - -# Interface: AlgoClientConfig - -[types/network-client](../modules/types_network_client.md).AlgoClientConfig - -Config for an Algorand SDK client. - -## Table of contents - -### Properties - -- [port](types_network_client.AlgoClientConfig.md#port) -- [server](types_network_client.AlgoClientConfig.md#server) -- [token](types_network_client.AlgoClientConfig.md#token) - -## Properties - -### port - -• `Optional` **port**: `string` \| `number` - -The port to use e.g. 4001, 443, etc. - -#### Defined in - -[src/types/network-client.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L8) - -___ - -### server - -• **server**: `string` - -Base URL of the server e.g. http://localhost, https://testnet-api.algonode.cloud/, etc. - -#### Defined in - -[src/types/network-client.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L6) - -___ - -### token - -• `Optional` **token**: `string` \| `TokenHeader` - -The token to use for API authentication (or undefined if none needed) - can be a string, or an object with the header key => value - -#### Defined in - -[src/types/network-client.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L10) diff --git a/docs/code/interfaces/types_network_client.AlgoConfig.md b/docs/code/interfaces/types_network_client.AlgoConfig.md deleted file mode 100644 index a136607f..00000000 --- a/docs/code/interfaces/types_network_client.AlgoConfig.md +++ /dev/null @@ -1,51 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/network-client](../modules/types_network_client.md) / AlgoConfig - -# Interface: AlgoConfig - -[types/network-client](../modules/types_network_client.md).AlgoConfig - -Configuration for algod, indexer and kmd clients. - -## Table of contents - -### Properties - -- [algodConfig](types_network_client.AlgoConfig.md#algodconfig) -- [indexerConfig](types_network_client.AlgoConfig.md#indexerconfig) -- [kmdConfig](types_network_client.AlgoConfig.md#kmdconfig) - -## Properties - -### algodConfig - -• **algodConfig**: [`AlgoClientConfig`](types_network_client.AlgoClientConfig.md) - -Algod client configuration - -#### Defined in - -[src/types/network-client.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L16) - -___ - -### indexerConfig - -• `Optional` **indexerConfig**: [`AlgoClientConfig`](types_network_client.AlgoClientConfig.md) - -Indexer client configuration - -#### Defined in - -[src/types/network-client.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L18) - -___ - -### kmdConfig - -• `Optional` **kmdConfig**: [`AlgoClientConfig`](types_network_client.AlgoClientConfig.md) - -Kmd configuration - -#### Defined in - -[src/types/network-client.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L20) diff --git a/docs/code/interfaces/types_network_client.NetworkDetails.md b/docs/code/interfaces/types_network_client.NetworkDetails.md deleted file mode 100644 index 7c03383f..00000000 --- a/docs/code/interfaces/types_network_client.NetworkDetails.md +++ /dev/null @@ -1,77 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/network-client](../modules/types_network_client.md) / NetworkDetails - -# Interface: NetworkDetails - -[types/network-client](../modules/types_network_client.md).NetworkDetails - -Details of the current network. - -## Table of contents - -### Properties - -- [genesisHash](types_network_client.NetworkDetails.md#genesishash) -- [genesisId](types_network_client.NetworkDetails.md#genesisid) -- [isLocalNet](types_network_client.NetworkDetails.md#islocalnet) -- [isMainNet](types_network_client.NetworkDetails.md#ismainnet) -- [isTestNet](types_network_client.NetworkDetails.md#istestnet) - -## Properties - -### genesisHash - -• **genesisHash**: `string` - -The base64 genesis hash of the current network. - -#### Defined in - -[src/types/network-client.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L34) - -___ - -### genesisId - -• **genesisId**: `string` - -The genesis ID of the current network. - -#### Defined in - -[src/types/network-client.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L32) - -___ - -### isLocalNet - -• **isLocalNet**: `boolean` - -Whether or not the network is LocalNet. - -#### Defined in - -[src/types/network-client.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L30) - -___ - -### isMainNet - -• **isMainNet**: `boolean` - -Whether or not the network is MainNet. - -#### Defined in - -[src/types/network-client.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L28) - -___ - -### isTestNet - -• **isTestNet**: `boolean` - -Whether or not the network is TestNet. - -#### Defined in - -[src/types/network-client.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L26) diff --git a/docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md b/docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md deleted file mode 100644 index 59c1303b..00000000 --- a/docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md +++ /dev/null @@ -1,72 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/testing](../modules/types_testing.md) / AlgoKitLogCaptureFixture - -# Interface: AlgoKitLogCaptureFixture - -[types/testing](../modules/types_testing.md).AlgoKitLogCaptureFixture - -## Table of contents - -### Properties - -- [afterEach](types_testing.AlgoKitLogCaptureFixture.md#aftereach) -- [beforeEach](types_testing.AlgoKitLogCaptureFixture.md#beforeeach) - -### Accessors - -- [testLogger](types_testing.AlgoKitLogCaptureFixture.md#testlogger) - -## Properties - -### afterEach - -• **afterEach**: () => `void` - -Testing framework agnostic handler method to run after each test to reset the logger. - -#### Type declaration - -▸ (): `void` - -##### Returns - -`void` - -#### Defined in - -[src/types/testing.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L158) - -___ - -### beforeEach - -• **beforeEach**: () => `void` - -Testing framework agnostic handler method to run before each test to prepare the `testLogger` for that test. - -#### Type declaration - -▸ (): `void` - -##### Returns - -`void` - -#### Defined in - -[src/types/testing.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L154) - -## Accessors - -### testLogger - -• `get` **testLogger**(): [`TestLogger`](../classes/testing.TestLogger.md) - -The test logger instance for the current test - -#### Returns - -[`TestLogger`](../classes/testing.TestLogger.md) - -#### Defined in - -[src/types/testing.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L150) diff --git a/docs/code/interfaces/types_testing.AlgorandFixtureConfig.md b/docs/code/interfaces/types_testing.AlgorandFixtureConfig.md deleted file mode 100644 index a020dcdc..00000000 --- a/docs/code/interfaces/types_testing.AlgorandFixtureConfig.md +++ /dev/null @@ -1,149 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/testing](../modules/types_testing.md) / AlgorandFixtureConfig - -# Interface: AlgorandFixtureConfig - -[types/testing](../modules/types_testing.md).AlgorandFixtureConfig - -Configuration for creating an Algorand testing fixture. - -## Hierarchy - -- `Partial`\<[`AlgoConfig`](types_network_client.AlgoConfig.md)\> - - ↳ **`AlgorandFixtureConfig`** - -## Table of contents - -### Properties - -- [accountGetter](types_testing.AlgorandFixtureConfig.md#accountgetter) -- [algod](types_testing.AlgorandFixtureConfig.md#algod) -- [algodConfig](types_testing.AlgorandFixtureConfig.md#algodconfig) -- [indexer](types_testing.AlgorandFixtureConfig.md#indexer) -- [indexerConfig](types_testing.AlgorandFixtureConfig.md#indexerconfig) -- [kmd](types_testing.AlgorandFixtureConfig.md#kmd) -- [kmdConfig](types_testing.AlgorandFixtureConfig.md#kmdconfig) -- [testAccountFunding](types_testing.AlgorandFixtureConfig.md#testaccountfunding) - -## Properties - -### accountGetter - -• `Optional` **accountGetter**: (`algod`: `AlgodClient`, `kmd?`: `KmdClient`) => `Promise`\<`default`\> - -Optional override for how to get an account; this allows you to retrieve accounts from a known or cached list of accounts. - -#### Type declaration - -▸ (`algod`, `kmd?`): `Promise`\<`default`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `algod` | `AlgodClient` | -| `kmd?` | `KmdClient` | - -##### Returns - -`Promise`\<`default`\> - -#### Defined in - -[src/types/testing.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L62) - -___ - -### algod - -• `Optional` **algod**: `AlgodClient` - -An optional algod client, if not specified then it will create one against `algodConfig` (if present) then environment variables defined network (if present) or default LocalNet. - -#### Defined in - -[src/types/testing.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L54) - -___ - -### algodConfig - -• `Optional` **algodConfig**: [`AlgoClientConfig`](types_network_client.AlgoClientConfig.md) - -Algod client configuration - -#### Inherited from - -Partial.algodConfig - -#### Defined in - -[src/types/network-client.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L16) - -___ - -### indexer - -• `Optional` **indexer**: `IndexerClient` - -An optional indexer client, if not specified then it will create one against `indexerConfig` (if present) then environment variables defined network (if present) or default LocalNet. - -#### Defined in - -[src/types/testing.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L56) - -___ - -### indexerConfig - -• `Optional` **indexerConfig**: [`AlgoClientConfig`](types_network_client.AlgoClientConfig.md) - -Indexer client configuration - -#### Inherited from - -Partial.indexerConfig - -#### Defined in - -[src/types/network-client.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L18) - -___ - -### kmd - -• `Optional` **kmd**: `KmdClient` - -An optional kmd client, if not specified then it will create one against `kmdConfig` (if present) then environment variables defined network (if present) or default LocalNet. - -#### Defined in - -[src/types/testing.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L58) - -___ - -### kmdConfig - -• `Optional` **kmdConfig**: [`AlgoClientConfig`](types_network_client.AlgoClientConfig.md) - -Kmd configuration - -#### Inherited from - -Partial.kmdConfig - -#### Defined in - -[src/types/network-client.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L20) - -___ - -### testAccountFunding - -• `Optional` **testAccountFunding**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The amount of funds to allocate to the default testing account, if not specified then it will get 10 ALGO. - -#### Defined in - -[src/types/testing.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L60) diff --git a/docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md b/docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md deleted file mode 100644 index a2cf89a7..00000000 --- a/docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md +++ /dev/null @@ -1,165 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/testing](../modules/types_testing.md) / AlgorandTestAutomationContext - -# Interface: AlgorandTestAutomationContext - -[types/testing](../modules/types_testing.md).AlgorandTestAutomationContext - -Test automation context. - -## Table of contents - -### Properties - -- [algod](types_testing.AlgorandTestAutomationContext.md#algod) -- [algorand](types_testing.AlgorandTestAutomationContext.md#algorand) -- [generateAccount](types_testing.AlgorandTestAutomationContext.md#generateaccount) -- [indexer](types_testing.AlgorandTestAutomationContext.md#indexer) -- [kmd](types_testing.AlgorandTestAutomationContext.md#kmd) -- [testAccount](types_testing.AlgorandTestAutomationContext.md#testaccount) -- [transactionLogger](types_testing.AlgorandTestAutomationContext.md#transactionlogger) -- [waitForIndexer](types_testing.AlgorandTestAutomationContext.md#waitforindexer) -- [waitForIndexerTransaction](types_testing.AlgorandTestAutomationContext.md#waitforindexertransaction) - -## Properties - -### algod - -• **algod**: `AlgodClient` - -Algod client instance that will log transactions in `transactionLogger` - -#### Defined in - -[src/types/testing.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L22) - -___ - -### algorand - -• **algorand**: [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md) - -An AlgorandClient instance loaded with the current context, including testAccount and any generated accounts loaded as signers - -#### Defined in - -[src/types/testing.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L20) - -___ - -### generateAccount - -• **generateAccount**: (`params`: [`GetTestAccountParams`](types_testing.GetTestAccountParams.md)) => `Promise`\<`Address` & `default` & [`TransactionSignerAccount`](types_account.TransactionSignerAccount.md)\> - -Generate and fund an additional ephemerally created account - -#### Type declaration - -▸ (`params`): `Promise`\<`Address` & `default` & [`TransactionSignerAccount`](types_account.TransactionSignerAccount.md)\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | [`GetTestAccountParams`](types_testing.GetTestAccountParams.md) | - -##### Returns - -`Promise`\<`Address` & `default` & [`TransactionSignerAccount`](types_account.TransactionSignerAccount.md)\> - -#### Defined in - -[src/types/testing.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L32) - -___ - -### indexer - -• **indexer**: `IndexerClient` - -Indexer client instance - -#### Defined in - -[src/types/testing.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L24) - -___ - -### kmd - -• **kmd**: `KmdClient` - -KMD client instance - -#### Defined in - -[src/types/testing.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L26) - -___ - -### testAccount - -• **testAccount**: `Address` & [`TransactionSignerAccount`](types_account.TransactionSignerAccount.md) & `default` - -Default, funded test account that is ephemerally created - -#### Defined in - -[src/types/testing.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L30) - -___ - -### transactionLogger - -• **transactionLogger**: [`TransactionLogger`](../classes/testing.TransactionLogger.md) - -Transaction logger that will log transaction IDs for all transactions issued by `algod` - -#### Defined in - -[src/types/testing.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L28) - -___ - -### waitForIndexer - -• **waitForIndexer**: () => `Promise`\<`void`\> - -Wait for the indexer to catch up with all transactions logged by `transactionLogger` - -#### Type declaration - -▸ (): `Promise`\<`void`\> - -##### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/types/testing.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L34) - -___ - -### waitForIndexerTransaction - -• **waitForIndexerTransaction**: (`transactionId`: `string`) => `Promise`\<`TransactionResponse`\> - -Wait for the indexer to catch up with the given transaction ID - -#### Type declaration - -▸ (`transactionId`): `Promise`\<`TransactionResponse`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `transactionId` | `string` | - -##### Returns - -`Promise`\<`TransactionResponse`\> - -#### Defined in - -[src/types/testing.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L36) diff --git a/docs/code/interfaces/types_testing.GetTestAccountParams.md b/docs/code/interfaces/types_testing.GetTestAccountParams.md deleted file mode 100644 index cfdc00c8..00000000 --- a/docs/code/interfaces/types_testing.GetTestAccountParams.md +++ /dev/null @@ -1,65 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/testing](../modules/types_testing.md) / GetTestAccountParams - -# Interface: GetTestAccountParams - -[types/testing](../modules/types_testing.md).GetTestAccountParams - -Parameters for the `getTestAccount` function. - -## Table of contents - -### Properties - -- [accountGetter](types_testing.GetTestAccountParams.md#accountgetter) -- [initialFunds](types_testing.GetTestAccountParams.md#initialfunds) -- [suppressLog](types_testing.GetTestAccountParams.md#suppresslog) - -## Properties - -### accountGetter - -• `Optional` **accountGetter**: (`algorand`: [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md)) => `Promise`\<`default`\> - -Optional override for how to get a test account; this allows you to retrieve accounts from a known or cached list of accounts. - -#### Type declaration - -▸ (`algorand`): `Promise`\<`default`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `algorand` | [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md) | - -##### Returns - -`Promise`\<`default`\> - -#### Defined in - -[src/types/testing.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L48) - -___ - -### initialFunds - -• **initialFunds**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -Initial funds to ensure the account has - -#### Defined in - -[src/types/testing.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L44) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress the log (which includes a mnemonic) or not (default: do not suppress the log) - -#### Defined in - -[src/types/testing.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L46) diff --git a/docs/code/interfaces/types_testing.LogSnapshotConfig.md b/docs/code/interfaces/types_testing.LogSnapshotConfig.md deleted file mode 100644 index 1b02fc57..00000000 --- a/docs/code/interfaces/types_testing.LogSnapshotConfig.md +++ /dev/null @@ -1,80 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/testing](../modules/types_testing.md) / LogSnapshotConfig - -# Interface: LogSnapshotConfig - -[types/testing](../modules/types_testing.md).LogSnapshotConfig - -Configuration for preparing 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. - -## Table of contents - -### Properties - -- [accounts](types_testing.LogSnapshotConfig.md#accounts) -- [apps](types_testing.LogSnapshotConfig.md#apps) -- [filterPredicate](types_testing.LogSnapshotConfig.md#filterpredicate) -- [transactions](types_testing.LogSnapshotConfig.md#transactions) - -## Properties - -### accounts - -• `Optional` **accounts**: (`string` \| [`MultisigAccount`](../classes/types_account.MultisigAccount.md) \| `default` \| [`SigningAccount`](../classes/types_account.SigningAccount.md) \| `Address` \| [`TransactionSignerAccount`](types_account.TransactionSignerAccount.md) \| `LogicSigAccount`)[] - -Any accounts/addresses to replace the address for predictably - -#### Defined in - -[src/types/testing.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L141) - -___ - -### apps - -• `Optional` **apps**: (`string` \| `number` \| `bigint`)[] - -Any app IDs to replace predictably - -#### Defined in - -[src/types/testing.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L143) - -___ - -### filterPredicate - -• `Optional` **filterPredicate**: (`log`: `string`) => `boolean` - -Optional filter predicate to filter out logs - -#### Type declaration - -▸ (`log`): `boolean` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `log` | `string` | - -##### Returns - -`boolean` - -#### Defined in - -[src/types/testing.ts:145](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L145) - -___ - -### transactions - -• `Optional` **transactions**: (`string` \| `Transaction`)[] - -Any transaction IDs or transactions to replace the ID for predictably - -#### Defined in - -[src/types/testing.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L139) diff --git a/docs/code/interfaces/types_transaction.AdditionalAtomicTransactionComposerContext.md b/docs/code/interfaces/types_transaction.AdditionalAtomicTransactionComposerContext.md deleted file mode 100644 index d0f20124..00000000 --- a/docs/code/interfaces/types_transaction.AdditionalAtomicTransactionComposerContext.md +++ /dev/null @@ -1,36 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / AdditionalAtomicTransactionComposerContext - -# Interface: AdditionalAtomicTransactionComposerContext - -[types/transaction](../modules/types_transaction.md).AdditionalAtomicTransactionComposerContext - -Additional context about the `AtomicTransactionComposer`. - -## Table of contents - -### Properties - -- [maxFees](types_transaction.AdditionalAtomicTransactionComposerContext.md#maxfees) -- [suggestedParams](types_transaction.AdditionalAtomicTransactionComposerContext.md#suggestedparams) - -## Properties - -### maxFees - -• **maxFees**: `Map`\<`number`, [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)\> - -A map of transaction index in the `AtomicTransactionComposer` to the max fee that can be calculated for a transaction in the group - -#### Defined in - -[src/types/transaction.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L148) - -___ - -### suggestedParams - -• **suggestedParams**: `Pick`\<`SuggestedParams`, ``"fee"`` \| ``"minFee"``\> - -#### Defined in - -[src/types/transaction.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L151) diff --git a/docs/code/interfaces/types_transaction.AtomicTransactionComposerToSend.md b/docs/code/interfaces/types_transaction.AtomicTransactionComposerToSend.md deleted file mode 100644 index 85d472a8..00000000 --- a/docs/code/interfaces/types_transaction.AtomicTransactionComposerToSend.md +++ /dev/null @@ -1,129 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / AtomicTransactionComposerToSend - -# Interface: AtomicTransactionComposerToSend - -[types/transaction](../modules/types_transaction.md).AtomicTransactionComposerToSend - -An `AtomicTransactionComposer` with transactions to send. - -## Hierarchy - -- [`SendParams`](types_transaction.SendParams.md) - - ↳ **`AtomicTransactionComposerToSend`** - -## Table of contents - -### Properties - -- [additionalAtcContext](types_transaction.AtomicTransactionComposerToSend.md#additionalatccontext) -- [atc](types_transaction.AtomicTransactionComposerToSend.md#atc) -- [coverAppCallInnerTransactionFees](types_transaction.AtomicTransactionComposerToSend.md#coverappcallinnertransactionfees) -- [maxRoundsToWaitForConfirmation](types_transaction.AtomicTransactionComposerToSend.md#maxroundstowaitforconfirmation) -- [populateAppCallResources](types_transaction.AtomicTransactionComposerToSend.md#populateappcallresources) -- [sendParams](types_transaction.AtomicTransactionComposerToSend.md#sendparams) -- [suppressLog](types_transaction.AtomicTransactionComposerToSend.md#suppresslog) - -## Properties - -### additionalAtcContext - -• `Optional` **additionalAtcContext**: [`AdditionalAtomicTransactionComposerContext`](types_transaction.AdditionalAtomicTransactionComposerContext.md) - -Additional `AtomicTransactionComposer` context used when building the transaction group that is sent. -This additional context is used and must be supplied when coverAppCallInnerTransactionFees is set to true. - -#### Defined in - -[src/types/transaction.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L167) - -___ - -### atc - -• **atc**: `AtomicTransactionComposer` - -The `AtomicTransactionComposer` with transactions loaded to send - -#### Defined in - -[src/types/transaction.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L157) - -___ - -### coverAppCallInnerTransactionFees - -• `Optional` **coverAppCallInnerTransactionFees**: `boolean` - -Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee - -#### Inherited from - -[SendParams](types_transaction.SendParams.md).[coverAppCallInnerTransactionFees](types_transaction.SendParams.md#coverappcallinnertransactionfees) - -#### Defined in - -[src/types/transaction.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L142) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The number of rounds to wait for confirmation. By default until the latest lastValid has past. - -#### Inherited from - -[SendParams](types_transaction.SendParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendParams.md#maxroundstowaitforconfirmation) - -#### Defined in - -[src/types/transaction.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L136) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. - -#### Inherited from - -[SendParams](types_transaction.SendParams.md).[populateAppCallResources](types_transaction.SendParams.md#populateappcallresources) - -#### Defined in - -[src/types/transaction.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L140) - -___ - -### sendParams - -• `Optional` **sendParams**: `Omit`\<[`SendTransactionParams`](types_transaction.SendTransactionParams.md), ``"fee"`` \| ``"maxFee"`` \| ``"skipSending"`` \| ``"atc"``\> - -**`Deprecated`** - -- set the parameters at the top level instead -Any parameters to control the semantics of the send to the network - -#### Defined in - -[src/types/transaction.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L161) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress. - -#### Inherited from - -[SendParams](types_transaction.SendParams.md).[suppressLog](types_transaction.SendParams.md#suppresslog) - -#### Defined in - -[src/types/transaction.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L138) diff --git a/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md b/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md deleted file mode 100644 index 259c670a..00000000 --- a/docs/code/interfaces/types_transaction.ConfirmedTransactionResult.md +++ /dev/null @@ -1,52 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / ConfirmedTransactionResult - -# Interface: ConfirmedTransactionResult - -[types/transaction](../modules/types_transaction.md).ConfirmedTransactionResult - -The result of sending and confirming a transaction - -## Hierarchy - -- [`SendTransactionResult`](types_transaction.SendTransactionResult.md) - - ↳ **`ConfirmedTransactionResult`** - -## Table of contents - -### Properties - -- [confirmation](types_transaction.ConfirmedTransactionResult.md#confirmation) -- [transaction](types_transaction.ConfirmedTransactionResult.md#transaction) - -## Properties - -### confirmation - -• **confirmation**: `PendingTransactionResponse` - -The response from sending and waiting for the transaction - -#### Overrides - -[SendTransactionResult](types_transaction.SendTransactionResult.md).[confirmation](types_transaction.SendTransactionResult.md#confirmation) - -#### Defined in - -[src/types/transaction.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L87) - -___ - -### transaction - -• **transaction**: `Transaction` - -The transaction - -#### Inherited from - -[SendTransactionResult](types_transaction.SendTransactionResult.md).[transaction](types_transaction.SendTransactionResult.md#transaction) - -#### Defined in - -[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) diff --git a/docs/code/interfaces/types_transaction.ConfirmedTransactionResults.md b/docs/code/interfaces/types_transaction.ConfirmedTransactionResults.md deleted file mode 100644 index cc46e3ce..00000000 --- a/docs/code/interfaces/types_transaction.ConfirmedTransactionResults.md +++ /dev/null @@ -1,88 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / ConfirmedTransactionResults - -# Interface: ConfirmedTransactionResults - -[types/transaction](../modules/types_transaction.md).ConfirmedTransactionResults - -The result of sending and confirming one or more transactions, but where there is a primary transaction of interest - -## Hierarchy - -- [`SendTransactionResult`](types_transaction.SendTransactionResult.md) - -- [`SendTransactionResults`](types_transaction.SendTransactionResults.md) - - ↳ **`ConfirmedTransactionResults`** - -## Table of contents - -### Properties - -- [confirmation](types_transaction.ConfirmedTransactionResults.md#confirmation) -- [confirmations](types_transaction.ConfirmedTransactionResults.md#confirmations) -- [transaction](types_transaction.ConfirmedTransactionResults.md#transaction) -- [transactions](types_transaction.ConfirmedTransactionResults.md#transactions) - -## Properties - -### confirmation - -• **confirmation**: `PendingTransactionResponse` - -The response from sending and waiting for the primary transaction - -#### Overrides - -[SendTransactionResult](types_transaction.SendTransactionResult.md).[confirmation](types_transaction.SendTransactionResult.md#confirmation) - -#### Defined in - -[src/types/transaction.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L93) - -___ - -### confirmations - -• **confirmations**: `PendingTransactionResponse`[] - -The response from sending and waiting for the transactions - -#### Overrides - -[SendTransactionResults](types_transaction.SendTransactionResults.md).[confirmations](types_transaction.SendTransactionResults.md#confirmations) - -#### Defined in - -[src/types/transaction.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L95) - -___ - -### transaction - -• **transaction**: `Transaction` - -The transaction - -#### Inherited from - -[SendTransactionResult](types_transaction.SendTransactionResult.md).[transaction](types_transaction.SendTransactionResult.md#transaction) - -#### Defined in - -[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) - -___ - -### transactions - -• **transactions**: `Transaction`[] - -The transactions that have been prepared and/or sent - -#### Inherited from - -[SendTransactionResults](types_transaction.SendTransactionResults.md).[transactions](types_transaction.SendTransactionResults.md#transactions) - -#### Defined in - -[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) diff --git a/docs/code/interfaces/types_transaction.SendAtomicTransactionComposerResults.md b/docs/code/interfaces/types_transaction.SendAtomicTransactionComposerResults.md deleted file mode 100644 index a6a0afe9..00000000 --- a/docs/code/interfaces/types_transaction.SendAtomicTransactionComposerResults.md +++ /dev/null @@ -1,92 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / SendAtomicTransactionComposerResults - -# Interface: SendAtomicTransactionComposerResults - -[types/transaction](../modules/types_transaction.md).SendAtomicTransactionComposerResults - -The result of preparing and/or sending multiple transactions using an `AtomicTransactionComposer` - -## Hierarchy - -- [`SendTransactionResults`](types_transaction.SendTransactionResults.md) - - ↳ **`SendAtomicTransactionComposerResults`** - -## Table of contents - -### Properties - -- [confirmations](types_transaction.SendAtomicTransactionComposerResults.md#confirmations) -- [groupId](types_transaction.SendAtomicTransactionComposerResults.md#groupid) -- [returns](types_transaction.SendAtomicTransactionComposerResults.md#returns) -- [transactions](types_transaction.SendAtomicTransactionComposerResults.md#transactions) -- [txIds](types_transaction.SendAtomicTransactionComposerResults.md#txids) - -## Properties - -### confirmations - -• **confirmations**: `PendingTransactionResponse`[] - -The responses if the transactions were sent and waited for, -the index of the confirmation will match the index of the underlying transaction - -#### Overrides - -[SendTransactionResults](types_transaction.SendTransactionResults.md).[confirmations](types_transaction.SendTransactionResults.md#confirmations) - -#### Defined in - -[src/types/transaction.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L81) - -___ - -### groupId - -• **groupId**: `string` - -base64 encoded representation of the group ID of the atomic group - -#### Defined in - -[src/types/transaction.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L73) - -___ - -### returns - -• `Optional` **returns**: [`ABIReturn`](../modules/types_app.md#abireturn)[] - -If ABI method(s) were called the processed return values - -#### Defined in - -[src/types/transaction.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L77) - -___ - -### transactions - -• **transactions**: `Transaction`[] - -The transactions that have been prepared and/or sent - -#### Inherited from - -[SendTransactionResults](types_transaction.SendTransactionResults.md).[transactions](types_transaction.SendTransactionResults.md#transactions) - -#### Defined in - -[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) - -___ - -### txIds - -• **txIds**: `string`[] - -The transaction IDs that have been prepared and/or sent - -#### Defined in - -[src/types/transaction.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L75) diff --git a/docs/code/interfaces/types_transaction.SendParams.md b/docs/code/interfaces/types_transaction.SendParams.md deleted file mode 100644 index 3ed53aec..00000000 --- a/docs/code/interfaces/types_transaction.SendParams.md +++ /dev/null @@ -1,70 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / SendParams - -# Interface: SendParams - -[types/transaction](../modules/types_transaction.md).SendParams - -Parameters to configure transaction sending. - -## Hierarchy - -- **`SendParams`** - - ↳ [`AtomicTransactionComposerToSend`](types_transaction.AtomicTransactionComposerToSend.md) - -## Table of contents - -### Properties - -- [coverAppCallInnerTransactionFees](types_transaction.SendParams.md#coverappcallinnertransactionfees) -- [maxRoundsToWaitForConfirmation](types_transaction.SendParams.md#maxroundstowaitforconfirmation) -- [populateAppCallResources](types_transaction.SendParams.md#populateappcallresources) -- [suppressLog](types_transaction.SendParams.md#suppresslog) - -## Properties - -### coverAppCallInnerTransactionFees - -• `Optional` **coverAppCallInnerTransactionFees**: `boolean` - -Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee - -#### Defined in - -[src/types/transaction.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L142) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The number of rounds to wait for confirmation. By default until the latest lastValid has past. - -#### Defined in - -[src/types/transaction.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L136) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. - -#### Defined in - -[src/types/transaction.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L140) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress. - -#### Defined in - -[src/types/transaction.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L138) diff --git a/docs/code/interfaces/types_transaction.SendTransactionParams.md b/docs/code/interfaces/types_transaction.SendTransactionParams.md deleted file mode 100644 index c3666e63..00000000 --- a/docs/code/interfaces/types_transaction.SendTransactionParams.md +++ /dev/null @@ -1,135 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / SendTransactionParams - -# Interface: SendTransactionParams - -[types/transaction](../modules/types_transaction.md).SendTransactionParams - -The sending configuration for a transaction - -## Hierarchy - -- **`SendTransactionParams`** - - ↳ [`AppCallParams`](types_app.AppCallParams.md) - - ↳ [`CreateAssetParams`](types_asset.CreateAssetParams.md) - - ↳ [`AssetOptInParams`](types_asset.AssetOptInParams.md) - - ↳ [`AlgoTransferParams`](types_transfer.AlgoTransferParams.md) - - ↳ [`AlgoRekeyParams`](types_transfer.AlgoRekeyParams.md) - - ↳ [`EnsureFundedParams`](types_transfer.EnsureFundedParams.md) - - ↳ [`TransferAssetParams`](types_transfer.TransferAssetParams.md) - -## Table of contents - -### Properties - -- [atc](types_transaction.SendTransactionParams.md#atc) -- [fee](types_transaction.SendTransactionParams.md#fee) -- [maxFee](types_transaction.SendTransactionParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) -- [populateAppCallResources](types_transaction.SendTransactionParams.md#populateappcallresources) -- [skipSending](types_transaction.SendTransactionParams.md#skipsending) -- [skipWaiting](types_transaction.SendTransactionParams.md#skipwaiting) -- [suppressLog](types_transaction.SendTransactionParams.md#suppresslog) - -## Properties - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) diff --git a/docs/code/interfaces/types_transaction.SendTransactionResult.md b/docs/code/interfaces/types_transaction.SendTransactionResult.md deleted file mode 100644 index 58470c14..00000000 --- a/docs/code/interfaces/types_transaction.SendTransactionResult.md +++ /dev/null @@ -1,48 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / SendTransactionResult - -# Interface: SendTransactionResult - -[types/transaction](../modules/types_transaction.md).SendTransactionResult - -The result of sending a transaction - -## Hierarchy - -- **`SendTransactionResult`** - - ↳ [`AppCallTransactionResultOfType`](types_app.AppCallTransactionResultOfType.md) - - ↳ [`ConfirmedTransactionResult`](types_transaction.ConfirmedTransactionResult.md) - - ↳ [`ConfirmedTransactionResults`](types_transaction.ConfirmedTransactionResults.md) - -## Table of contents - -### Properties - -- [confirmation](types_transaction.SendTransactionResult.md#confirmation) -- [transaction](types_transaction.SendTransactionResult.md#transaction) - -## Properties - -### confirmation - -• `Optional` **confirmation**: `PendingTransactionResponse` - -The response if the transaction was sent and waited for - -#### Defined in - -[src/types/transaction.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L57) - -___ - -### transaction - -• **transaction**: `Transaction` - -The transaction - -#### Defined in - -[src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) diff --git a/docs/code/interfaces/types_transaction.SendTransactionResults.md b/docs/code/interfaces/types_transaction.SendTransactionResults.md deleted file mode 100644 index 12e5e9b4..00000000 --- a/docs/code/interfaces/types_transaction.SendTransactionResults.md +++ /dev/null @@ -1,49 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / SendTransactionResults - -# Interface: SendTransactionResults - -[types/transaction](../modules/types_transaction.md).SendTransactionResults - -The result of preparing and/or sending multiple transactions - -## Hierarchy - -- **`SendTransactionResults`** - - ↳ [`AppCallTransactionResultOfType`](types_app.AppCallTransactionResultOfType.md) - - ↳ [`SendAtomicTransactionComposerResults`](types_transaction.SendAtomicTransactionComposerResults.md) - - ↳ [`ConfirmedTransactionResults`](types_transaction.ConfirmedTransactionResults.md) - -## Table of contents - -### Properties - -- [confirmations](types_transaction.SendTransactionResults.md#confirmations) -- [transactions](types_transaction.SendTransactionResults.md#transactions) - -## Properties - -### confirmations - -• `Optional` **confirmations**: `PendingTransactionResponse`[] - -The responses if the transactions were sent and waited for, -the index of the confirmation will match the index of the underlying transaction - -#### Defined in - -[src/types/transaction.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L67) - -___ - -### transactions - -• **transactions**: `Transaction`[] - -The transactions that have been prepared and/or sent - -#### Defined in - -[src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) diff --git a/docs/code/interfaces/types_transaction.TransactionGroupToSend.md b/docs/code/interfaces/types_transaction.TransactionGroupToSend.md deleted file mode 100644 index 10dc5e5e..00000000 --- a/docs/code/interfaces/types_transaction.TransactionGroupToSend.md +++ /dev/null @@ -1,54 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / TransactionGroupToSend - -# Interface: TransactionGroupToSend - -[types/transaction](../modules/types_transaction.md).TransactionGroupToSend - -A group of transactions to send together as an atomic group -https://dev.algorand.co/concepts/transactions/atomic-txn-groups/ - -## Table of contents - -### Properties - -- [sendParams](types_transaction.TransactionGroupToSend.md#sendparams) -- [signer](types_transaction.TransactionGroupToSend.md#signer) -- [transactions](types_transaction.TransactionGroupToSend.md#transactions) - -## Properties - -### sendParams - -• `Optional` **sendParams**: `Omit`\<[`SendTransactionParams`](types_transaction.SendTransactionParams.md), ``"fee"`` \| ``"maxFee"`` \| ``"skipSending"`` \| ``"atc"``\> - -Any parameters to control the semantics of the send to the network - -#### Defined in - -[src/types/transaction.ts:123](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L123) - -___ - -### signer - -• `Optional` **signer**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -Optional signer to pass in, required if at least one transaction provided is just the transaction, ignored otherwise - -#### Defined in - -[src/types/transaction.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L130) - -___ - -### transactions - -• **transactions**: (`Transaction` \| [`TransactionToSign`](types_transaction.TransactionToSign.md) \| `Promise`\<[`SendTransactionResult`](types_transaction.SendTransactionResult.md)\>)[] - -The list of transactions to send, which can either be a raw transaction (in which case `signer` is required), - the async result of an AlgoKit utils method that returns a `SendTransactionResult` (saves unwrapping the promise, be sure to pass `skipSending: true`, `signer` is also required) - or the transaction with its signer (`signer` is ignored) - -#### Defined in - -[src/types/transaction.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L128) diff --git a/docs/code/interfaces/types_transaction.TransactionToSign.md b/docs/code/interfaces/types_transaction.TransactionToSign.md deleted file mode 100644 index 70ad95ed..00000000 --- a/docs/code/interfaces/types_transaction.TransactionToSign.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transaction](../modules/types_transaction.md) / TransactionToSign - -# Interface: TransactionToSign - -[types/transaction](../modules/types_transaction.md).TransactionToSign - -Defines an unsigned transaction that will appear in a group of transactions along with its signing information - -## Table of contents - -### Properties - -- [signer](types_transaction.TransactionToSign.md#signer) -- [transaction](types_transaction.TransactionToSign.md#transaction) - -## Properties - -### signer - -• **signer**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account to use to sign the transaction, either an account (with private key loaded) or a logic signature account - -#### Defined in - -[src/types/transaction.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L115) - -___ - -### transaction - -• **transaction**: `Transaction` - -The unsigned transaction to sign and send - -#### Defined in - -[src/types/transaction.ts:113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L113) diff --git a/docs/code/interfaces/types_transfer.AlgoRekeyParams.md b/docs/code/interfaces/types_transfer.AlgoRekeyParams.md deleted file mode 100644 index 1c208997..00000000 --- a/docs/code/interfaces/types_transfer.AlgoRekeyParams.md +++ /dev/null @@ -1,222 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transfer](../modules/types_transfer.md) / AlgoRekeyParams - -# Interface: AlgoRekeyParams - -[types/transfer](../modules/types_transfer.md).AlgoRekeyParams - -**`Deprecated`** - -Parameters for `rekeyAccount` call. - -## Hierarchy - -- [`SendTransactionParams`](types_transaction.SendTransactionParams.md) - - ↳ **`AlgoRekeyParams`** - -## Table of contents - -### Properties - -- [atc](types_transfer.AlgoRekeyParams.md#atc) -- [fee](types_transfer.AlgoRekeyParams.md#fee) -- [from](types_transfer.AlgoRekeyParams.md#from) -- [lease](types_transfer.AlgoRekeyParams.md#lease) -- [maxFee](types_transfer.AlgoRekeyParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_transfer.AlgoRekeyParams.md#maxroundstowaitforconfirmation) -- [note](types_transfer.AlgoRekeyParams.md#note) -- [populateAppCallResources](types_transfer.AlgoRekeyParams.md#populateappcallresources) -- [rekeyTo](types_transfer.AlgoRekeyParams.md#rekeyto) -- [skipSending](types_transfer.AlgoRekeyParams.md#skipsending) -- [skipWaiting](types_transfer.AlgoRekeyParams.md#skipwaiting) -- [suppressLog](types_transfer.AlgoRekeyParams.md#suppresslog) -- [transactionParams](types_transfer.AlgoRekeyParams.md#transactionparams) - -## Properties - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[atc](types_transaction.SendTransactionParams.md#atc) - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee) - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### from - -• **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account that will be rekeyed - -#### Defined in - -[src/types/transfer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L26) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply - -#### Defined in - -[src/types/transfer.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L34) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxFee](types_transaction.SendTransactionParams.md#maxfee) - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Defined in - -[src/types/transfer.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L32) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[populateAppCallResources](types_transaction.SendTransactionParams.md#populateappcallresources) - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### rekeyTo - -• **rekeyTo**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account / account address that will have the private key that is authorised to transact on behalf of the from account from now on - -#### Defined in - -[src/types/transfer.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L28) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipSending](types_transaction.SendTransactionParams.md#skipsending) - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipWaiting](types_transaction.SendTransactionParams.md#skipwaiting) - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[suppressLog](types_transaction.SendTransactionParams.md#suppresslog) - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Defined in - -[src/types/transfer.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L30) diff --git a/docs/code/interfaces/types_transfer.AlgoTransferParams.md b/docs/code/interfaces/types_transfer.AlgoTransferParams.md deleted file mode 100644 index efdb0af3..00000000 --- a/docs/code/interfaces/types_transfer.AlgoTransferParams.md +++ /dev/null @@ -1,235 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transfer](../modules/types_transfer.md) / AlgoTransferParams - -# Interface: AlgoTransferParams - -[types/transfer](../modules/types_transfer.md).AlgoTransferParams - -**`Deprecated`** - -Parameters for `transferAlgos` call. - -## Hierarchy - -- [`SendTransactionParams`](types_transaction.SendTransactionParams.md) - - ↳ **`AlgoTransferParams`** - -## Table of contents - -### Properties - -- [amount](types_transfer.AlgoTransferParams.md#amount) -- [atc](types_transfer.AlgoTransferParams.md#atc) -- [fee](types_transfer.AlgoTransferParams.md#fee) -- [from](types_transfer.AlgoTransferParams.md#from) -- [lease](types_transfer.AlgoTransferParams.md#lease) -- [maxFee](types_transfer.AlgoTransferParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_transfer.AlgoTransferParams.md#maxroundstowaitforconfirmation) -- [note](types_transfer.AlgoTransferParams.md#note) -- [populateAppCallResources](types_transfer.AlgoTransferParams.md#populateappcallresources) -- [skipSending](types_transfer.AlgoTransferParams.md#skipsending) -- [skipWaiting](types_transfer.AlgoTransferParams.md#skipwaiting) -- [suppressLog](types_transfer.AlgoTransferParams.md#suppresslog) -- [to](types_transfer.AlgoTransferParams.md#to) -- [transactionParams](types_transfer.AlgoTransferParams.md#transactionparams) - -## Properties - -### amount - -• **amount**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The amount to send - -#### Defined in - -[src/types/transfer.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L14) - -___ - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[atc](types_transaction.SendTransactionParams.md#atc) - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee) - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### from - -• **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account that will send the Algo - -#### Defined in - -[src/types/transfer.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L10) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply - -#### Defined in - -[src/types/transfer.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L20) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxFee](types_transaction.SendTransactionParams.md#maxfee) - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Defined in - -[src/types/transfer.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L18) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[populateAppCallResources](types_transaction.SendTransactionParams.md#populateappcallresources) - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipSending](types_transaction.SendTransactionParams.md#skipsending) - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipWaiting](types_transaction.SendTransactionParams.md#skipwaiting) - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[suppressLog](types_transaction.SendTransactionParams.md#suppresslog) - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### to - -• **to**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account / account address that will receive the Algo - -#### Defined in - -[src/types/transfer.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L12) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Defined in - -[src/types/transfer.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L16) diff --git a/docs/code/interfaces/types_transfer.EnsureFundedParams.md b/docs/code/interfaces/types_transfer.EnsureFundedParams.md deleted file mode 100644 index 31b82e06..00000000 --- a/docs/code/interfaces/types_transfer.EnsureFundedParams.md +++ /dev/null @@ -1,248 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transfer](../modules/types_transfer.md) / EnsureFundedParams - -# Interface: EnsureFundedParams - -[types/transfer](../modules/types_transfer.md).EnsureFundedParams - -**`Deprecated`** - -Parameters for `ensureFunded` call. - -## Hierarchy - -- [`SendTransactionParams`](types_transaction.SendTransactionParams.md) - - ↳ **`EnsureFundedParams`** - -## Table of contents - -### Properties - -- [accountToFund](types_transfer.EnsureFundedParams.md#accounttofund) -- [atc](types_transfer.EnsureFundedParams.md#atc) -- [fee](types_transfer.EnsureFundedParams.md#fee) -- [fundingSource](types_transfer.EnsureFundedParams.md#fundingsource) -- [lease](types_transfer.EnsureFundedParams.md#lease) -- [maxFee](types_transfer.EnsureFundedParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_transfer.EnsureFundedParams.md#maxroundstowaitforconfirmation) -- [minFundingIncrement](types_transfer.EnsureFundedParams.md#minfundingincrement) -- [minSpendingBalance](types_transfer.EnsureFundedParams.md#minspendingbalance) -- [note](types_transfer.EnsureFundedParams.md#note) -- [populateAppCallResources](types_transfer.EnsureFundedParams.md#populateappcallresources) -- [skipSending](types_transfer.EnsureFundedParams.md#skipsending) -- [skipWaiting](types_transfer.EnsureFundedParams.md#skipwaiting) -- [suppressLog](types_transfer.EnsureFundedParams.md#suppresslog) -- [transactionParams](types_transfer.EnsureFundedParams.md#transactionparams) - -## Properties - -### accountToFund - -• **accountToFund**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account to fund - -#### Defined in - -[src/types/transfer.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L40) - -___ - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[atc](types_transaction.SendTransactionParams.md#atc) - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee) - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### fundingSource - -• `Optional` **fundingSource**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) \| [`TestNetDispenserApiClient`](../classes/types_dispenser_client.TestNetDispenserApiClient.md) - -The account to use as a funding source, will default to using the dispenser account returned by `algokit.getDispenserAccount` - -#### Defined in - -[src/types/transfer.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L42) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply - -#### Defined in - -[src/types/transfer.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L52) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxFee](types_transaction.SendTransactionParams.md#maxfee) - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### minFundingIncrement - -• `Optional` **minFundingIncrement**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -When issuing a funding amount, the minimum amount to transfer (avoids many small transfers if this gets called often on an active account) - -#### Defined in - -[src/types/transfer.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L46) - -___ - -### minSpendingBalance - -• **minSpendingBalance**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) - -#### Defined in - -[src/types/transfer.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L44) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note, default: "Funding account to meet minimum requirement" - -#### Defined in - -[src/types/transfer.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L50) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[populateAppCallResources](types_transaction.SendTransactionParams.md#populateappcallresources) - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipSending](types_transaction.SendTransactionParams.md#skipsending) - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipWaiting](types_transaction.SendTransactionParams.md#skipwaiting) - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[suppressLog](types_transaction.SendTransactionParams.md#suppresslog) - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Defined in - -[src/types/transfer.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L48) diff --git a/docs/code/interfaces/types_transfer.EnsureFundedReturnType.md b/docs/code/interfaces/types_transfer.EnsureFundedReturnType.md deleted file mode 100644 index f60f3258..00000000 --- a/docs/code/interfaces/types_transfer.EnsureFundedReturnType.md +++ /dev/null @@ -1,38 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transfer](../modules/types_transfer.md) / EnsureFundedReturnType - -# Interface: EnsureFundedReturnType - -[types/transfer](../modules/types_transfer.md).EnsureFundedReturnType - -**`Deprecated`** - -## Table of contents - -### Properties - -- [amount](types_transfer.EnsureFundedReturnType.md#amount) -- [transactionId](types_transfer.EnsureFundedReturnType.md#transactionid) - -## Properties - -### amount - -• **amount**: `number` - -The response if the transaction was sent and waited for - -#### Defined in - -[src/types/transfer.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L80) - -___ - -### transactionId - -• **transactionId**: `string` - -The transaction - -#### Defined in - -[src/types/transfer.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L78) diff --git a/docs/code/interfaces/types_transfer.TransferAssetParams.md b/docs/code/interfaces/types_transfer.TransferAssetParams.md deleted file mode 100644 index f88a55c8..00000000 --- a/docs/code/interfaces/types_transfer.TransferAssetParams.md +++ /dev/null @@ -1,261 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/transfer](../modules/types_transfer.md) / TransferAssetParams - -# Interface: TransferAssetParams - -[types/transfer](../modules/types_transfer.md).TransferAssetParams - -**`Deprecated`** - -Parameters for `transferAsset` call. - -## Hierarchy - -- [`SendTransactionParams`](types_transaction.SendTransactionParams.md) - - ↳ **`TransferAssetParams`** - -## Table of contents - -### Properties - -- [amount](types_transfer.TransferAssetParams.md#amount) -- [assetId](types_transfer.TransferAssetParams.md#assetid) -- [atc](types_transfer.TransferAssetParams.md#atc) -- [clawbackFrom](types_transfer.TransferAssetParams.md#clawbackfrom) -- [fee](types_transfer.TransferAssetParams.md#fee) -- [from](types_transfer.TransferAssetParams.md#from) -- [lease](types_transfer.TransferAssetParams.md#lease) -- [maxFee](types_transfer.TransferAssetParams.md#maxfee) -- [maxRoundsToWaitForConfirmation](types_transfer.TransferAssetParams.md#maxroundstowaitforconfirmation) -- [note](types_transfer.TransferAssetParams.md#note) -- [populateAppCallResources](types_transfer.TransferAssetParams.md#populateappcallresources) -- [skipSending](types_transfer.TransferAssetParams.md#skipsending) -- [skipWaiting](types_transfer.TransferAssetParams.md#skipwaiting) -- [suppressLog](types_transfer.TransferAssetParams.md#suppresslog) -- [to](types_transfer.TransferAssetParams.md#to) -- [transactionParams](types_transfer.TransferAssetParams.md#transactionparams) - -## Properties - -### amount - -• **amount**: `number` \| `bigint` - -The amount to send as the smallest divisible unit value - -#### Defined in - -[src/types/transfer.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L64) - -___ - -### assetId - -• **assetId**: `number` - -The asset id that will be transfered - -#### Defined in - -[src/types/transfer.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L62) - -___ - -### atc - -• `Optional` **atc**: `AtomicTransactionComposer` - -An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[atc](types_transaction.SendTransactionParams.md#atc) - -#### Defined in - -[src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) - -___ - -### clawbackFrom - -• `Optional` **clawbackFrom**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -An address of a target account from which to perform a clawback operation. Please note, in such cases senderAccount must be equal to clawback field on ASA metadata. - -#### Defined in - -[src/types/transfer.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L68) - -___ - -### fee - -• `Optional` **fee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The flat fee you want to pay, useful for covering extra fees in a transaction group or app call - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[fee](types_transaction.SendTransactionParams.md#fee) - -#### Defined in - -[src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) - -___ - -### from - -• **from**: [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account that will send the asset - -#### Defined in - -[src/types/transfer.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L58) - -___ - -### lease - -• `Optional` **lease**: `string` \| `Uint8Array` - -An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply - -#### Defined in - -[src/types/transfer.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L72) - -___ - -### maxFee - -• `Optional` **maxFee**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxFee](types_transaction.SendTransactionParams.md#maxfee) - -#### Defined in - -[src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) - -___ - -### maxRoundsToWaitForConfirmation - -• `Optional` **maxRoundsToWaitForConfirmation**: `number` - -The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[maxRoundsToWaitForConfirmation](types_transaction.SendTransactionParams.md#maxroundstowaitforconfirmation) - -#### Defined in - -[src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) - -___ - -### note - -• `Optional` **note**: [`TransactionNote`](../modules/types_transaction.md#transactionnote) - -The (optional) transaction note - -#### Defined in - -[src/types/transfer.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L70) - -___ - -### populateAppCallResources - -• `Optional` **populateAppCallResources**: `boolean` - -Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[populateAppCallResources](types_transaction.SendTransactionParams.md#populateappcallresources) - -#### Defined in - -[src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) - -___ - -### skipSending - -• `Optional` **skipSending**: `boolean` - -Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) -and instead just return the raw transaction, e.g. so you can add it to a group of transactions - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipSending](types_transaction.SendTransactionParams.md#skipsending) - -#### Defined in - -[src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) - -___ - -### skipWaiting - -• `Optional` **skipWaiting**: `boolean` - -Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[skipWaiting](types_transaction.SendTransactionParams.md#skipwaiting) - -#### Defined in - -[src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) - -___ - -### suppressLog - -• `Optional` **suppressLog**: `boolean` - -Whether to suppress log messages from transaction send, default: do not suppress - -#### Inherited from - -[SendTransactionParams](types_transaction.SendTransactionParams.md).[suppressLog](types_transaction.SendTransactionParams.md#suppresslog) - -#### Defined in - -[src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) - -___ - -### to - -• **to**: `string` \| [`SendTransactionFrom`](../modules/types_transaction.md#sendtransactionfrom) - -The account / account address that will receive the asset - -#### Defined in - -[src/types/transfer.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L60) - -___ - -### transactionParams - -• `Optional` **transactionParams**: `SuggestedParams` - -Optional transaction parameters - -#### Defined in - -[src/types/transfer.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L66) diff --git a/docs/code/modules/index.indexer.md b/docs/code/modules/index.indexer.md deleted file mode 100644 index 83971316..00000000 --- a/docs/code/modules/index.indexer.md +++ /dev/null @@ -1,194 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / [index](index.md) / indexer - -# Namespace: indexer - -[index](index.md).indexer - -## Table of contents - -### Type Aliases - -- [SearchForTransactions](index.indexer.md#searchfortransactions) - -### Functions - -- [executePaginatedRequest](index.indexer.md#executepaginatedrequest) -- [lookupAccountByAddress](index.indexer.md#lookupaccountbyaddress) -- [lookupAccountCreatedApplicationByAddress](index.indexer.md#lookupaccountcreatedapplicationbyaddress) -- [lookupAssetHoldings](index.indexer.md#lookupassetholdings) -- [lookupTransactionById](index.indexer.md#lookuptransactionbyid) -- [searchTransactions](index.indexer.md#searchtransactions) - -## Type Aliases - -### SearchForTransactions - -Ƭ **SearchForTransactions**: `ReturnType`\<`Indexer`[``"searchForTransactions"``]\> - -#### Defined in - -[src/indexer-lookup.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L4) - -## Functions - -### executePaginatedRequest - -▸ **executePaginatedRequest**\<`TResult`, `TRequest`\>(`extractItems`, `buildRequest`): `Promise`\<`TResult`[]\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TResult` | `TResult` | -| `TRequest` | extends `Object` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `extractItems` | (`response`: `any`) => `TResult`[] | -| `buildRequest` | (`nextToken?`: `string`) => `TRequest` | - -#### Returns - -`Promise`\<`TResult`[]\> - -#### Defined in - -[src/indexer-lookup.ts:145](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L145) - -___ - -### lookupAccountByAddress - -▸ **lookupAccountByAddress**(`accountAddress`, `indexer`): `Promise`\<`AccountResponse`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `accountAddress` | `string` \| `Address` | The address of the account to look up | -| `indexer` | `IndexerClient` | An indexer client | - -#### Returns - -`Promise`\<`AccountResponse`\> - -The result of the look-up - -**`Deprecated`** - -Use `indexer.lookupAccountByID(accountAddress).do()`. -Looks up an account by address using Indexer. - -#### Defined in - -[src/indexer-lookup.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L26) - -___ - -### lookupAccountCreatedApplicationByAddress - -▸ **lookupAccountCreatedApplicationByAddress**(`indexer`, `address`, `getAll?`, `paginationLimit?`): `Promise`\<`algosdk.indexerModels.Application`[]\> - -Looks up applications that were created by the given address; will automatically paginate through all data. - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `indexer` | `IndexerClient` | `undefined` | An indexer instance | -| `address` | `string` \| `Address` | `undefined` | The address of the creator to look up | -| `getAll` | `undefined` \| `boolean` | `undefined` | Whether or not to include deleted applications | -| `paginationLimit?` | `number` | `undefined` | The number of records to return per paginated request, default 1000 | - -#### Returns - -`Promise`\<`algosdk.indexerModels.Application`[]\> - -The list of application results - -#### Defined in - -[src/indexer-lookup.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L38) - -___ - -### lookupAssetHoldings - -▸ **lookupAssetHoldings**(`indexer`, `assetId`, `options?`, `paginationLimit?`): `Promise`\<`algosdk.indexerModels.MiniAssetHolding`[]\> - -Looks up asset holdings for the given asset; will automatically paginate through all data. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `indexer` | `IndexerClient` | An indexer instance | -| `assetId` | `number` \| `bigint` | The ID of the asset to look up holdings for | -| `options?` | [`LookupAssetHoldingsOptions`](../interfaces/types_indexer.LookupAssetHoldingsOptions.md) | Optional options to control the lookup | -| `paginationLimit?` | `number` | The number of records to return per paginated request, default 1000 | - -#### Returns - -`Promise`\<`algosdk.indexerModels.MiniAssetHolding`[]\> - -The list of application results - -#### Defined in - -[src/indexer-lookup.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L72) - -___ - -### lookupTransactionById - -▸ **lookupTransactionById**(`transactionId`, `indexer`): `Promise`\<`TransactionResponse`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transactionId` | `string` | The ID of the transaction to look up | -| `indexer` | `IndexerClient` | An indexer client | - -#### Returns - -`Promise`\<`TransactionResponse`\> - -The result of the look-up - -**`Deprecated`** - -Use `indexer.lookupTransactionByID(transactionId).do()`. -Looks up a transaction by ID using Indexer. - -#### Defined in - -[src/indexer-lookup.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L15) - -___ - -### searchTransactions - -▸ **searchTransactions**(`indexer`, `searchCriteria`, `paginationLimit?`): `Promise`\<`algosdk.indexerModels.TransactionsResponse`\> - -Allows transactions to be searched for the given criteria. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `indexer` | `IndexerClient` | An indexer client | -| `searchCriteria` | (`s`: `default`) => `default` | The criteria to search for | -| `paginationLimit?` | `number` | The number of records to return per paginated request, default 1000 | - -#### Returns - -`Promise`\<`algosdk.indexerModels.TransactionsResponse`\> - -The search results - -#### Defined in - -[src/indexer-lookup.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/indexer-lookup.ts#L111) diff --git a/docs/code/modules/index.md b/docs/code/modules/index.md deleted file mode 100644 index 6c4d9556..00000000 --- a/docs/code/modules/index.md +++ /dev/null @@ -1,3245 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / index - -# Module: index - -## Table of contents - -### References - -- [ALGOKIT\_DIR](index.md#algokit_dir) -- [AVMTracesEventData](index.md#avmtraceseventdata) -- [AlgorandClient](index.md#algorandclient) -- [DEFAULT\_MAX\_SEARCH\_DEPTH](index.md#default_max_search_depth) -- [EventDataMap](index.md#eventdatamap) -- [EventType](index.md#eventtype) -- [SOURCES\_DIR](index.md#sources_dir) -- [SearchForTransactions](index.md#searchfortransactions) -- [TEAL\_FILE\_EXT](index.md#teal_file_ext) -- [TEAL\_SOURCEMAP\_EXT](index.md#teal_sourcemap_ext) -- [TealSourceDebugEventData](index.md#tealsourcedebugeventdata) -- [TealSourcesDebugEventData](index.md#tealsourcesdebugeventdata) -- [executePaginatedRequest](index.md#executepaginatedrequest) -- [lookupAccountByAddress](index.md#lookupaccountbyaddress) -- [lookupAccountCreatedApplicationByAddress](index.md#lookupaccountcreatedapplicationbyaddress) -- [lookupAssetHoldings](index.md#lookupassetholdings) -- [lookupTransactionById](index.md#lookuptransactionbyid) -- [searchTransactions](index.md#searchtransactions) - -### Namespaces - -- [indexer](index.indexer.md) - -### Type Aliases - -- [AccountInformation](index.md#accountinformation) -- [NumberConverter](index.md#numberconverter) - -### Variables - -- [ALGORAND\_MIN\_TX\_FEE](index.md#algorand_min_tx_fee) -- [Config](index.md#config) -- [MAX\_APP\_CALL\_ACCOUNT\_REFERENCES](index.md#max_app_call_account_references) -- [MAX\_APP\_CALL\_FOREIGN\_REFERENCES](index.md#max_app_call_foreign_references) -- [MAX\_TRANSACTION\_GROUP\_SIZE](index.md#max_transaction_group_size) - -### Functions - -- [algo](index.md#algo) -- [algos](index.md#algos) -- [assetBulkOptIn](index.md#assetbulkoptin) -- [assetBulkOptOut](index.md#assetbulkoptout) -- [assetOptIn](index.md#assetoptin) -- [assetOptOut](index.md#assetoptout) -- [callApp](index.md#callapp) -- [capTransactionFee](index.md#captransactionfee) -- [compileTeal](index.md#compileteal) -- [controlFees](index.md#controlfees) -- [createApp](index.md#createapp) -- [createAsset](index.md#createasset) -- [decodeAppState](index.md#decodeappstate) -- [deployApp](index.md#deployapp) -- [encodeLease](index.md#encodelease) -- [encodeTransactionNote](index.md#encodetransactionnote) -- [ensureFunded](index.md#ensurefunded) -- [getABIMethodSignature](index.md#getabimethodsignature) -- [getABIReturn](index.md#getabireturn) -- [getABIReturnValue](index.md#getabireturnvalue) -- [getAccount](index.md#getaccount) -- [getAccountAddressAsString](index.md#getaccountaddressasstring) -- [getAccountAddressAsUint8Array](index.md#getaccountaddressasuint8array) -- [getAccountAssetInformation](index.md#getaccountassetinformation) -- [getAccountConfigFromEnvironment](index.md#getaccountconfigfromenvironment) -- [getAccountInformation](index.md#getaccountinformation) -- [getAlgoClient](index.md#getalgoclient) -- [getAlgoIndexerClient](index.md#getalgoindexerclient) -- [getAlgoKmdClient](index.md#getalgokmdclient) -- [getAlgoNodeConfig](index.md#getalgonodeconfig) -- [getAlgodConfigFromEnvironment](index.md#getalgodconfigfromenvironment) -- [getAppArgsForABICall](index.md#getappargsforabicall) -- [getAppArgsForTransaction](index.md#getappargsfortransaction) -- [getAppBoxNames](index.md#getappboxnames) -- [getAppBoxValue](index.md#getappboxvalue) -- [getAppBoxValueFromABIType](index.md#getappboxvaluefromabitype) -- [getAppBoxValues](index.md#getappboxvalues) -- [getAppBoxValuesFromABIType](index.md#getappboxvaluesfromabitype) -- [getAppById](index.md#getappbyid) -- [getAppClient](index.md#getappclient) -- [getAppClientByCreatorAndName](index.md#getappclientbycreatorandname) -- [getAppClientById](index.md#getappclientbyid) -- [getAppDeploymentTransactionNote](index.md#getappdeploymenttransactionnote) -- [getAppGlobalState](index.md#getappglobalstate) -- [getAppLocalState](index.md#getapplocalstate) -- [getAppOnCompleteAction](index.md#getapponcompleteaction) -- [getAtomicTransactionComposerTransactions](index.md#getatomictransactioncomposertransactions) -- [getBoxReference](index.md#getboxreference) -- [getConfigFromEnvOrDefaults](index.md#getconfigfromenvordefaults) -- [getCreatorAppsByName](index.md#getcreatorappsbyname) -- [getDefaultLocalNetConfig](index.md#getdefaultlocalnetconfig) -- [getDispenserAccount](index.md#getdispenseraccount) -- [getIndexerConfigFromEnvironment](index.md#getindexerconfigfromenvironment) -- [getKmdWalletAccount](index.md#getkmdwalletaccount) -- [getLocalNetDispenserAccount](index.md#getlocalnetdispenseraccount) -- [getOrCreateKmdWalletAccount](index.md#getorcreatekmdwalletaccount) -- [getSenderAddress](index.md#getsenderaddress) -- [getSenderTransactionSigner](index.md#getsendertransactionsigner) -- [getTestNetDispenserApiClient](index.md#gettestnetdispenserapiclient) -- [getTransactionParams](index.md#gettransactionparams) -- [getTransactionWithSigner](index.md#gettransactionwithsigner) -- [isLocalNet](index.md#islocalnet) -- [isMainNet](index.md#ismainnet) -- [isSchemaIsBroken](index.md#isschemaisbroken) -- [isTestNet](index.md#istestnet) -- [microAlgo](index.md#microalgo) -- [microAlgos](index.md#microalgos) -- [mnemonicAccount](index.md#mnemonicaccount) -- [mnemonicAccountFromEnvironment](index.md#mnemonicaccountfromenvironment) -- [multisigAccount](index.md#multisigaccount) -- [performAtomicTransactionComposerSimulate](index.md#performatomictransactioncomposersimulate) -- [performTemplateSubstitution](index.md#performtemplatesubstitution) -- [performTemplateSubstitutionAndCompile](index.md#performtemplatesubstitutionandcompile) -- [persistSourceMaps](index.md#persistsourcemaps) -- [populateAppCallResources](index.md#populateappcallresources) -- [prepareGroupForSending](index.md#preparegroupforsending) -- [randomAccount](index.md#randomaccount) -- [rekeyAccount](index.md#rekeyaccount) -- [rekeyedAccount](index.md#rekeyedaccount) -- [replaceDeployTimeControlParams](index.md#replacedeploytimecontrolparams) -- [sendAtomicTransactionComposer](index.md#sendatomictransactioncomposer) -- [sendGroupOfTransactions](index.md#sendgroupoftransactions) -- [sendTransaction](index.md#sendtransaction) -- [signTransaction](index.md#signtransaction) -- [stripTealComments](index.md#striptealcomments) -- [transactionFees](index.md#transactionfees) -- [transactionSignerAccount](index.md#transactionsigneraccount) -- [transferAlgos](index.md#transferalgos) -- [transferAsset](index.md#transferasset) -- [updateApp](index.md#updateapp) -- [waitForConfirmation](index.md#waitforconfirmation) - -## References - -### ALGOKIT\_DIR - -Re-exports [ALGOKIT_DIR](types_debugging.md#algokit_dir) - -___ - -### AVMTracesEventData - -Re-exports [AVMTracesEventData](../interfaces/types_debugging.AVMTracesEventData.md) - -___ - -### AlgorandClient - -Re-exports [AlgorandClient](../classes/types_algorand_client.AlgorandClient.md) - -___ - -### DEFAULT\_MAX\_SEARCH\_DEPTH - -Re-exports [DEFAULT_MAX_SEARCH_DEPTH](types_debugging.md#default_max_search_depth) - -___ - -### EventDataMap - -Re-exports [EventDataMap](types_lifecycle_events.md#eventdatamap) - -___ - -### EventType - -Re-exports [EventType](../enums/types_lifecycle_events.EventType.md) - -___ - -### SOURCES\_DIR - -Re-exports [SOURCES_DIR](types_debugging.md#sources_dir) - -___ - -### SearchForTransactions - -Re-exports [SearchForTransactions](index.indexer.md#searchfortransactions) - -___ - -### TEAL\_FILE\_EXT - -Re-exports [TEAL_FILE_EXT](types_debugging.md#teal_file_ext) - -___ - -### TEAL\_SOURCEMAP\_EXT - -Re-exports [TEAL_SOURCEMAP_EXT](types_debugging.md#teal_sourcemap_ext) - -___ - -### TealSourceDebugEventData - -Re-exports [TealSourceDebugEventData](../interfaces/types_debugging.TealSourceDebugEventData.md) - -___ - -### TealSourcesDebugEventData - -Re-exports [TealSourcesDebugEventData](../interfaces/types_debugging.TealSourcesDebugEventData.md) - -___ - -### executePaginatedRequest - -Re-exports [executePaginatedRequest](index.indexer.md#executepaginatedrequest) - -___ - -### lookupAccountByAddress - -Re-exports [lookupAccountByAddress](index.indexer.md#lookupaccountbyaddress) - -___ - -### lookupAccountCreatedApplicationByAddress - -Re-exports [lookupAccountCreatedApplicationByAddress](index.indexer.md#lookupaccountcreatedapplicationbyaddress) - -___ - -### lookupAssetHoldings - -Re-exports [lookupAssetHoldings](index.indexer.md#lookupassetholdings) - -___ - -### lookupTransactionById - -Re-exports [lookupTransactionById](index.indexer.md#lookuptransactionbyid) - -___ - -### searchTransactions - -Re-exports [searchTransactions](index.indexer.md#searchtransactions) - -## Type Aliases - -### AccountInformation - -Ƭ **AccountInformation**: `Omit`\<[`NumberConverter`](index.md#numberconverter)\<`AccountInformationModel`\>, ``"getEncodingSchema"`` \| ``"toEncodingData"`` \| ``"authAddr"``\> & \{ `authAddr?`: `string` } - -**`Deprecated`** - -Account information at a given round. - -#### Defined in - -[src/account/account.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L135) - -___ - -### NumberConverter - -Ƭ **NumberConverter**\<`T`\>: \{ [key in keyof T]: ToNumberIfExtends\ } - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `AccountInformationModel` | - -#### Defined in - -[src/account/account.ts:132](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L132) - -## Variables - -### ALGORAND\_MIN\_TX\_FEE - -• `Const` **ALGORAND\_MIN\_TX\_FEE**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -#### Defined in - -[src/amount.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L93) - -___ - -### Config - -• `Const` **Config**: [`UpdatableConfig`](../classes/types_config.UpdatableConfig.md) - -The AlgoKit config. To update it use the configure method. - -#### Defined in - -[src/config.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/config.ts#L4) - -___ - -### MAX\_APP\_CALL\_ACCOUNT\_REFERENCES - -• `Const` **MAX\_APP\_CALL\_ACCOUNT\_REFERENCES**: ``4`` - -#### Defined in - -[src/transaction/transaction.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L33) - -___ - -### MAX\_APP\_CALL\_FOREIGN\_REFERENCES - -• `Const` **MAX\_APP\_CALL\_FOREIGN\_REFERENCES**: ``8`` - -#### Defined in - -[src/transaction/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L32) - -___ - -### MAX\_TRANSACTION\_GROUP\_SIZE - -• `Const` **MAX\_TRANSACTION\_GROUP\_SIZE**: ``16`` - -#### Defined in - -[src/transaction/transaction.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L31) - -## Functions - -### algo - -▸ **algo**(`algos`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -Returns an amount of Algo using AlgoAmount - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `algos` | `number` \| `bigint` | The amount of Algo | - -#### Returns - -[`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -#### Defined in - -[src/amount.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L68) - -___ - -### algos - -▸ **algos**(`algos`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -Returns an amount of Algo using AlgoAmount - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `algos` | `number` \| `bigint` | The amount of Algo | - -#### Returns - -[`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -#### Defined in - -[src/amount.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L61) - -___ - -### assetBulkOptIn - -▸ **assetBulkOptIn**(`optIn`, `algod`): `Promise`\<`Record`\<`number`, `string`\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `optIn` | [`AssetBulkOptInOutParams`](../interfaces/types_asset.AssetBulkOptInOutParams.md) | The bulk opt-in request. | -| `algod` | `AlgodClient` | An instance of the Algodv2 class from the `algosdk` library. | - -#### Returns - -`Promise`\<`Record`\<`number`, `string`\>\> - -A record object where the keys are the asset IDs and the values are the corresponding transaction IDs for successful opt-ins. - -**`Deprecated`** - -use `algorand.asset.bulkOptIn()` instead - -Opt in to a list of assets on the Algorand blockchain. - -**`Throws`** - -If there is an error during the opt-in process. - -**`Example`** - -```ts -algokit.bulkOptIn({ account: account, assetIds: [12345, 67890] }, algod) -``` - -#### Defined in - -[src/asset.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L130) - -___ - -### assetBulkOptOut - -▸ **assetBulkOptOut**(`optOut`, `algod`): `Promise`\<`Record`\<`number`, `string`\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `optOut` | [`AssetBulkOptInOutParams`](../interfaces/types_asset.AssetBulkOptInOutParams.md) | The bulk opt-out request. | -| `algod` | `AlgodClient` | An instance of the Algodv2 client used to interact with the Algorand blockchain. | - -#### Returns - -`Promise`\<`Record`\<`number`, `string`\>\> - -A record object containing asset IDs as keys and their corresponding transaction IDs as values. - -**`Deprecated`** - -use `algorand.asset.bulkOptOut()` instead - -Opt out of multiple assets in Algorand blockchain. - -**`Throws`** - -If there is an error during the opt-out process. - -**`Example`** - -```ts -algokit.bulkOptOut({ account: account, assetIds: [12345, 67890] }, algod) -``` - -#### Defined in - -[src/asset.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L157) - -___ - -### assetOptIn - -▸ **assetOptIn**(`optIn`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `optIn` | [`AssetOptInParams`](../interfaces/types_asset.AssetOptInParams.md) | The opt-in definition | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) - -**`Deprecated`** - -use `algorand.send.assetOptIn()` / `algorand.createTransaction.assetOptIn()` instead - -Opt-in an account to an asset. - -**`Example`** - -```typescript -await algokit.assetOptIn({ account, assetId }, algod) -``` - -#### Defined in - -[src/asset.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L67) - -___ - -### assetOptOut - -▸ **assetOptOut**(`optOut`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `optOut` | [`AssetOptOutParams`](../interfaces/types_asset.AssetOptOutParams.md) | The opt-in definition | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) - -**`Deprecated`** - -use `algorand.send.assetOptOut()` / `algorand.createTransaction.assetOptOut()` instead - -Opt-out an account from an asset. - -**`Example`** - -```typescript -await algokit.assetOptOut({ account, assetId, assetCreatorAddress }, algod) -``` - -#### Defined in - -[src/asset.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L98) - -___ - -### callApp - -▸ **callApp**(`call`, `algod`): `Promise`\<[`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `call` | [`AppCallParams`](../interfaces/types_app.AppCallParams.md) | The call details. | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\> - -The result of the call - -**`Deprecated`** - -Use `algorand.send.appUpdate()` / `algorand.createTransaction.appUpdate()` / `algorand.send.appUpdateMethodCall()` -/ `algorand.createTransaction.appUpdateMethodCall()` instead - -Issues a call to a given app. - -#### Defined in - -[src/app.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L187) - -___ - -### capTransactionFee - -▸ **capTransactionFee**(`transaction`, `maxAcceptableFee`): `void` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transaction` | `Transaction` \| `SuggestedParams` | The transaction to cap or suggested params object about to be used to create a transaction | -| `maxAcceptableFee` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | The maximum acceptable fee to pay | - -#### Returns - -`void` - -**`Deprecated`** - -Use `TransactionComposer` and the `maxFee` field in the transaction params instead. - -Limit the acceptable fee to a defined amount of µAlgo. -This also sets the transaction to be flatFee to ensure the transaction only succeeds at -the estimated rate. - -#### Defined in - -[src/transaction/transaction.ts:1057](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1057) - -___ - -### compileTeal - -▸ **compileTeal**(`tealCode`, `algod`): `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealCode` | `string` | The TEAL code | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> - -The information about the compiled file - -**`Deprecated`** - -Use `algorand.app.compileTeal` instead. - -Compiles the given TEAL using algod and returns the result, including source map. - -#### Defined in - -[src/app.ts:419](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L419) - -___ - -### controlFees - -▸ **controlFees**\<`T`\>(`transaction`, `feeControl`): `T` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `Transaction` \| `SuggestedParams` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transaction` | `T` | The transaction or suggested params | -| `feeControl` | `Object` | The fee control parameters | -| `feeControl.fee?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | - | -| `feeControl.maxFee?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | - | - -#### Returns - -`T` - -**`Deprecated`** - -Use `TransactionComposer` and the `maxFee` and `staticFee` fields in the transaction params instead. - -Allows for control of fees on a `Transaction` or `SuggestedParams` object - -#### Defined in - -[src/transaction/transaction.ts:1084](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1084) - -___ - -### createApp - -▸ **createApp**(`create`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult) & [`AppReference`](../interfaces/types_app.AppReference.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `create` | [`CreateAppParams`](../interfaces/types_app.CreateAppParams.md) | The parameters to create the app with | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult) & [`AppReference`](../interfaces/types_app.AppReference.md)\> - -The details of the created app, or the transaction to create it if `skipSending` and the compilation result - -**`Deprecated`** - -Use `algorand.send.appCreate()` / `algorand.createTransaction.appCreate()` / `algorand.send.appCreateMethodCall()` -/ `algorand.createTransaction.appCreateMethodCall()` instead - -Creates a smart contract app, returns the details of the created app. - -#### Defined in - -[src/app.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L44) - -___ - -### createAsset - -▸ **createAsset**(`create`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md) & \{ `confirmation?`: \{ `assetIndex`: `number` \| `bigint` } }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `create` | [`CreateAssetParams`](../interfaces/types_asset.CreateAssetParams.md) | The asset creation definition | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md) & \{ `confirmation?`: \{ `assetIndex`: `number` \| `bigint` } }\> - -The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) - -**`Deprecated`** - -use `algorand.send.assetCreate()` / `algorand.createTransaction.assetCreate()` instead - -Create an Algorand Standard Asset (ASA). - -**`Example`** - -```typescript -await algokit.createAsset({ creator: account, total: 1, decimals: 0, name: 'My asset' }, algod) -``` - -#### Defined in - -[src/asset.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/asset.ts#L23) - -___ - -### decodeAppState - -▸ **decodeAppState**(`state`): [`AppState`](../interfaces/types_app.AppState.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `state` | \{ `key`: `string` ; `value`: `TealValue` \| `EvalDelta` }[] | A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas` | - -#### Returns - -[`AppState`](../interfaces/types_app.AppState.md) - -An object keyeed by the UTF-8 representation of the key with various parsings of the values - -**`Deprecated`** - -Use `AppManager.decodeAppState` instead. - -Converts an array of global/local state values from the algod api to a more friendly -generic object keyed by the UTF-8 value of the key. - -#### Defined in - -[src/app.ts:345](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L345) - -___ - -### deployApp - -▸ **deployApp**(`deployment`, `algod`, `indexer?`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResults`](../interfaces/types_transaction.ConfirmedTransactionResults.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"create"`` \| ``"update"`` ; `return?`: [`ABIReturn`](types_app.md#abireturn) } \| [`ConfirmedTransactionResults`](../interfaces/types_transaction.ConfirmedTransactionResults.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `deleteReturn?`: [`ABIReturn`](types_app.md#abireturn) ; `operationPerformed`: ``"replace"`` ; `return?`: [`ABIReturn`](types_app.md#abireturn) } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"nothing"`` }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `deployment` | [`AppDeploymentParams`](../interfaces/types_app.AppDeploymentParams.md) | The arguments to control the app deployment | -| `algod` | `AlgodClient` | An algod client | -| `indexer?` | `IndexerClient` | An indexer client, needed if `existingDeployments` not passed in | - -#### Returns - -`Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`ConfirmedTransactionResults`](../interfaces/types_transaction.ConfirmedTransactionResults.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"create"`` \| ``"update"`` ; `return?`: [`ABIReturn`](types_app.md#abireturn) } \| [`ConfirmedTransactionResults`](../interfaces/types_transaction.ConfirmedTransactionResults.md) & [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `deleteReturn?`: [`ABIReturn`](types_app.md#abireturn) ; `operationPerformed`: ``"replace"`` ; `return?`: [`ABIReturn`](types_app.md#abireturn) } \| [`AppMetadata`](../interfaces/types_app.AppMetadata.md) & \{ `operationPerformed`: ``"nothing"`` }\> - -The app reference of the new/existing app - -**`Deprecated`** - -Use `algorand.appDeployer.deploy` instead. - -Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions. - -To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md - -**Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`. - -**Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created. - -**Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created. - -#### Defined in - -[src/app-deploy.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L51) - -___ - -### encodeLease - -▸ **encodeLease**(`lease?`): `Uint8Array` \| `undefined` - -Encodes a transaction lease into a 32-byte array ready to be included in an Algorand transaction. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `lease?` | `string` \| `Uint8Array` | The transaction lease as a string or binary array or null/undefined if there is no lease | - -#### Returns - -`Uint8Array` \| `undefined` - -the transaction lease ready for inclusion in a transaction or `undefined` if there is no lease - -**`Throws`** - -if the length of the data is > 32 bytes or empty - -**`Example`** - -```ts -algokit.encodeLease('UNIQUE_ID') -``` - -**`Example`** - -```ts -algokit.encodeLease(new Uint8Array([1, 2, 3])) -``` - -#### Defined in - -[src/transaction/transaction.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L74) - -___ - -### encodeTransactionNote - -▸ **encodeTransactionNote**(`note?`): `Uint8Array` \| `undefined` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `note?` | [`TransactionNote`](types_transaction.md#transactionnote) | The transaction note | - -#### Returns - -`Uint8Array` \| `undefined` - -the transaction note ready for inclusion in a transaction - - Case on the value of `data` this either be: - * `null` | `undefined`: `undefined` - * `string`: The string value - * Uint8Array: passthrough - * Arc2TransactionNote object: ARC-0002 compatible transaction note - * Else: The object/value converted into a JSON string representation - -**`Deprecated`** - -Convert your data to a `string` or `Uint8Array`, if using ARC-2 use `TransactionComposer.arc2Note`. - -Encodes a transaction note into a byte array ready to be included in an Algorand transaction. - -#### Defined in - -[src/transaction/transaction.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L50) - -___ - -### ensureFunded - -▸ **ensureFunded**\<`T`\>(`funding`, `algod`, `kmd?`): `Promise`\<[`EnsureFundedReturnType`](../interfaces/types_transfer.EnsureFundedReturnType.md) \| `undefined`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`EnsureFundedParams`](../interfaces/types_transfer.EnsureFundedParams.md) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `funding` | `T` | The funding configuration of type `EnsureFundedParams`, including the account to fund, minimum spending balance, and optional parameters. If you set `useDispenserApi` to true, you must also set `ALGOKIT_DISPENSER_ACCESS_TOKEN` in your environment variables. | -| `algod` | `AlgodClient` | An instance of the Algodv2 client. | -| `kmd?` | `KmdClient` | An optional instance of the Kmd client. | - -#### Returns - -`Promise`\<[`EnsureFundedReturnType`](../interfaces/types_transfer.EnsureFundedReturnType.md) \| `undefined`\> - -- `EnsureFundedReturnType` if funds were transferred. -- `undefined` if no funds were needed. - -**`Deprecated`** - -Use `algorand.account.ensureFunded()` / `algorand.account.ensureFundedFromEnvironment()` -/ `algorand.account.ensureFundedFromTestNetDispenserApi()` instead - -Funds a given account using a funding source such that it has a certain amount of Algo free to spend (accounting for Algo locked in minimum balance requirement). - -https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr - -#### Defined in - -[src/transfer/transfer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L26) - -___ - -### getABIMethodSignature - -▸ **getABIMethodSignature**(`method`): `string` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `method` | `ABIMethodParams` \| `ABIMethod` | The method to return a signature for | - -#### Returns - -`string` - -The encoded ABI method spec e.g. `method_name(uint64,string)string` - -**`Deprecated`** - -Use `abiMethod.getSignature()` or `new ABIMethod(abiMethodParams).getSignature()` instead. - -Returns the encoded ABI spec for a given ABI Method - -#### Defined in - -[src/app.ts:430](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L430) - -___ - -### getABIReturn - -▸ **getABIReturn**(`args?`, `confirmation?`): [`ABIReturn`](types_app.md#abireturn) \| `undefined` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `args?` | [`AppCallArgs`](types_app.md#appcallargs) | The arguments that were used for the call | -| `confirmation?` | `PendingTransactionResponse` | The transaction confirmation from algod | - -#### Returns - -[`ABIReturn`](types_app.md#abireturn) \| `undefined` - -The return value for the method call - -**`Deprecated`** - -Use `AppManager.getABIReturn` instead. - -Returns any ABI return values for the given app call arguments and transaction confirmation. - -#### Defined in - -[src/app.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L235) - -___ - -### getABIReturnValue - -▸ **getABIReturnValue**(`result`): [`ABIReturn`](types_app.md#abireturn) - -Takes an algosdk `ABIResult` and converts it to an `ABIReturn`. -Converts `bigint`'s for Uint's < 64 to `number` for easier use. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `result` | `ABIResult` | The `ABIReturn` | - -#### Returns - -[`ABIReturn`](types_app.md#abireturn) - -#### Defined in - -[src/transaction/transaction.ts:927](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L927) - -___ - -### getAccount - -▸ **getAccount**(`account`, `algod`, `kmdClient?`): `Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | `string` \| \{ `fundWith?`: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) ; `name`: `string` } | The details of the account to get, either the name identifier (string) or an object with: * `name`: The name identifier of the account * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account | -| `algod` | `AlgodClient` | An algod client | -| `kmdClient?` | `KmdClient` | An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables | - -#### Returns - -`Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\> - -The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account) - -**`Deprecated`** - -use `algorand.account.fromEnvironment()` instead - -Returns an Algorand account with private key loaded by convention based on the given name identifier. - -Note: This function expects to run in a Node.js environment. - -## Convention: -* **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**, - never commit it into source control and ideally load it via a secret storage service rather than the file system. - If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts) -* **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you - -This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet). - -**`Example`** - -If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: -```typescript -const account = await getAccount('ACCOUNT', algod) -``` - -If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. - -#### Defined in - -[src/account/get-account.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account.ts#L41) - -▸ **getAccount**(`account`, `algod`, `kmdClient?`): `Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | `Object` | The details of the account to get, an object with: * `config`: Account configuration. To get from environment use getAccountConfigFromEnvironment(accountName) * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account | -| `account.config` | [`AccountConfig`](../interfaces/types_account.AccountConfig.md) | - | -| `account.fundWith?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | - | -| `algod` | `AlgodClient` | An algod client | -| `kmdClient?` | `KmdClient` | An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables | - -#### Returns - -`Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\> - -The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account) - -**`Deprecated`** - -use `algorand.account.fromEnvironment()` instead -Returns an Algorand account with private key loaded by convention based on the given name identifier. - -Note: This function expects to run in a Node.js environment. - -**`Example`** - -If you have a mnemonic secret loaded into `process.env.ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: -```typescript -const account = await getAccount({config: getAccountConfigFromEnvironment('ACCOUNT')}, algod) -``` - -If that code runs against LocalNet then a wallet called `ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. - -#### Defined in - -[src/account/get-account.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account.ts#L68) - -___ - -### getAccountAddressAsString - -▸ **getAccountAddressAsString**(`addressEncodedInB64`): `string` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `addressEncodedInB64` | `string` | The base64 encoded version of the underlying byte array of the address public key | - -#### Returns - -`string` - -**`Deprecated`** - -Use `algosdk.encodeAddress` instead. - -Returns the string address of an Algorand account from a base64 encoded version of the underlying byte array of the address public key - -#### Defined in - -[src/account/account.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L128) - -___ - -### getAccountAddressAsUint8Array - -▸ **getAccountAddressAsUint8Array**(`account`): `Uint8Array` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | Either an account (with private key loaded) or the string address of an account | - -#### Returns - -`Uint8Array` - -**`Deprecated`** - -Use `algosdk.decodeAddress` instead. - -Returns an account's address as a byte array - -#### Defined in - -[src/account/account.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L117) - -___ - -### getAccountAssetInformation - -▸ **getAccountAssetInformation**(`sender`, `assetId`, `algod`): `Promise`\<[`AccountAssetInformation`](types_account.md#accountassetinformation)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The address of the sender/account to look up | -| `assetId` | `number` \| `bigint` | The ID of the asset to return a holding for | -| `algod` | `AlgodClient` | The algod instance | - -#### Returns - -`Promise`\<[`AccountAssetInformation`](types_account.md#accountassetinformation)\> - -The account asset holding information - -**`Deprecated`** - -Use `algorand.asset.getAccountInformation(sender, assetId)` or `new AssetManager(...).getAccountInformation(sender, assetId)` instead. - -Returns the given sender account's asset holding for a given asset. - -**`Example`** - -```typescript -const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; -const assetId = 123345; -const accountInfo = await account.getAccountAssetInformation(address, assetId, algod); -``` - -[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation) - -#### Defined in - -[src/account/account.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L201) - -___ - -### getAccountConfigFromEnvironment - -▸ **getAccountConfigFromEnvironment**(`accountName`): [`AccountConfig`](../interfaces/types_account.AccountConfig.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `accountName` | `string` | account name | - -#### Returns - -[`AccountConfig`](../interfaces/types_account.AccountConfig.md) - -**`Deprecated`** - -Use algokit.mnemonicAccountFromEnvironment, which doesn't need this function -Returns the Account configuration from environment variables - -**`Example`** - -```ts -environment variables -{accountName}_MNEMONIC -{accountName}_SENDER -``` - -#### Defined in - -[src/account/get-account-config-from-environment.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-account-config-from-environment.ts#L13) - -___ - -### getAccountInformation - -▸ **getAccountInformation**(`sender`, `algod`): `Promise`\<[`AccountInformation`](index.md#accountinformation)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The address of the sender/account to look up | -| `algod` | `AlgodClient` | The algod instance | - -#### Returns - -`Promise`\<[`AccountInformation`](index.md#accountinformation)\> - -The account information - -**`Deprecated`** - -Use `algorand.account.getInformation(sender)` or `new AccountManager(clientManager).getInformation(sender)` instead. - -Returns the given sender account's current status, balance and spendable amounts. - -**`Example`** - -```typescript -const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; -const accountInfo = await account.getInformation(address, algod); -``` - -[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountinformation) - -#### Defined in - -[src/account/account.ts:156](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L156) - -___ - -### getAlgoClient - -▸ **getAlgoClient**(`config?`): `Algodv2` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config?` | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) | The config if you want to override the default (getting config from process.env) | - -#### Returns - -`Algodv2` - -**`Deprecated`** - -Use `ClientManager.getAlgodClient(config)` or `ClientManager.getAlgodClientFromEnvironment()` instead. - -Returns an algod SDK client that automatically retries transient failures on idempotent calls - -**`Example`** - -```typescript - // Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN - // Automatically detects if you are using PureStake to switch in the right header name for ALGOD_TOKEN - const algod = getAlgoClient() - await algod.healthCheck().do() - ``` - -**`Example`** - -```typescript - const algod = getAlgoClient(getAlgoNodeConfig('testnet', 'algod')) - await algod.healthCheck().do() -``` - -**`Example`** - -```typescript - const algod = getAlgoClient(getAlgoNodeConfig('mainnet', 'algod')) - await algod.healthCheck().do() -``` - -**`Example`** - -```typescript - const algod = getAlgoClient({server: 'http://localhost', port: '4001', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) - await algod.healthCheck().do() -``` - -#### Defined in - -[src/network-client.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L88) - -___ - -### getAlgoIndexerClient - -▸ **getAlgoIndexerClient**(`config?`): `Indexer` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config?` | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) | The config if you want to override the default (getting config from process.env) | - -#### Returns - -`Indexer` - -**`Deprecated`** - -Use `ClientManager.getIndexerClient(config, overrideIntDecoding)` or `ClientManager.getIndexerClientFromEnvironment(overrideIntDecoding)` instead. - -Returns an indexer SDK client that automatically retries transient failures on idempotent calls - -**`Example`** - -```typescript - // Uses process.env.INDEXER_SERVER, process.env.INDEXER_PORT and process.env.INDEXER_TOKEN - const indexer = getAlgoIndexerClient() - await indexer.makeHealthCheck().do() - ``` - -**`Example`** - -```typescript - const indexer = getAlgoIndexerClient(getAlgoNodeConfig('testnet', 'indexer')) - await indexer.makeHealthCheck().do() -``` - -**`Example`** - -```typescript - const indexer = getAlgoIndexerClient(getAlgoNodeConfig('mainnet', 'indexer')) - await indexer.makeHealthCheck().do() -``` - -**`Example`** - -```typescript - const indexer = getAlgoIndexerClient({server: 'http://localhost', port: '8980', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) - await indexer.makeHealthCheck().do() -``` - -#### Defined in - -[src/network-client.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L121) - -___ - -### getAlgoKmdClient - -▸ **getAlgoKmdClient**(`config?`): `Kmd` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `config?` | [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) | The config if you want to override the default (getting config from process.env) | - -#### Returns - -`Kmd` - -**`Deprecated`** - -Use `ClientManager.getKmdClient(config)` or `ClientManager.getKmdClientFromEnvironment()` instead. - -Returns a KMD SDK client that automatically retries transient failures on idempotent calls. - -KMD client allows you to export private keys, which is useful to get the default account in a LocalNet network. - -**`Example`** - -```typescript - // Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN - const kmd = getAlgoKmdClient() - ``` - -**`Example`** - -```typescript - const kmd = getAlgoKmdClient({server: 'http://localhost', port: '4002', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) -``` - -#### Defined in - -[src/network-client.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L144) - -___ - -### getAlgoNodeConfig - -▸ **getAlgoNodeConfig**(`network`, `config`): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `network` | ``"testnet"`` \| ``"mainnet"`` | Which network to connect to - TestNet or MainNet | -| `config` | ``"algod"`` \| ``"indexer"`` | Which algod config to return - Algod or Indexer | - -#### Returns - -[`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -**`Deprecated`** - -Use `ClientManager.getAlgoNodeConfig(network, config)` instead. - -Returns the Algorand configuration to point to the AlgoNode service - -#### Defined in - -[src/network-client.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L43) - -___ - -### getAlgodConfigFromEnvironment - -▸ **getAlgodConfigFromEnvironment**(): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -#### Returns - -[`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -**`Deprecated`** - -Use `ClientManager.getAlgodConfigFromEnvironment()` instead. - -Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment not algod-side) - -#### Defined in - -[src/network-client.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L22) - -___ - -### getAppArgsForABICall - -▸ **getAppArgsForABICall**(`args`, `from`): `Promise`\<\{ `appAccounts`: `undefined` \| `string`[] ; `appForeignApps`: `undefined` \| `number`[] = args.apps; `appForeignAssets`: `undefined` \| `number`[] = args.assets; `boxes`: `undefined` \| `BoxReference`[] ; `lease`: `undefined` \| `Uint8Array` ; `method`: `ABIMethod` ; `methodArgs`: (`string` \| `number` \| `bigint` \| `boolean` \| `Uint8Array` \| `ABIValue`[] \| `TransactionWithSigner`)[] = methodArgs; `rekeyTo`: `undefined` \| `string` ; `sender`: `string` ; `signer`: `TransactionSigner` = signer }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `args` | [`ABIAppCallArgs`](types_app.md#abiappcallargs) | The ABI app call args | -| `from` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The transaction signer | - -#### Returns - -`Promise`\<\{ `appAccounts`: `undefined` \| `string`[] ; `appForeignApps`: `undefined` \| `number`[] = args.apps; `appForeignAssets`: `undefined` \| `number`[] = args.assets; `boxes`: `undefined` \| `BoxReference`[] ; `lease`: `undefined` \| `Uint8Array` ; `method`: `ABIMethod` ; `methodArgs`: (`string` \| `number` \| `bigint` \| `boolean` \| `Uint8Array` \| `ABIValue`[] \| `TransactionWithSigner`)[] = methodArgs; `rekeyTo`: `undefined` \| `string` ; `sender`: `string` ; `signer`: `TransactionSigner` = signer }\> - -The parameters ready to pass into `addMethodCall` within AtomicTransactionComposer - -**`Deprecated`** - -Use `TransactionComposer` methods to construct transactions instead. - -Returns the app args ready to load onto an ABI method call in `AtomicTransactionComposer` - -#### Defined in - -[src/app.ts:378](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L378) - -___ - -### getAppArgsForTransaction - -▸ **getAppArgsForTransaction**(`args?`): `undefined` \| \{ `accounts`: `undefined` \| `string`[] ; `appArgs`: `undefined` \| `Uint8Array`[] ; `boxes`: `undefined` \| `BoxReference`[] ; `foreignApps`: `undefined` \| `number`[] = args.apps; `foreignAssets`: `undefined` \| `number`[] = args.assets; `lease`: `undefined` \| `Uint8Array` } - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `args?` | [`RawAppCallArgs`](../interfaces/types_app.RawAppCallArgs.md) | The app call args | - -#### Returns - -`undefined` \| \{ `accounts`: `undefined` \| `string`[] ; `appArgs`: `undefined` \| `Uint8Array`[] ; `boxes`: `undefined` \| `BoxReference`[] ; `foreignApps`: `undefined` \| `number`[] = args.apps; `foreignAssets`: `undefined` \| `number`[] = args.assets; `lease`: `undefined` \| `Uint8Array` } - -The args ready to load into a `Transaction` - -**`Deprecated`** - -Use `TransactionComposer` methods to construct transactions instead. - -Returns the app args ready to load onto an app `Transaction` object - -#### Defined in - -[src/app.ts:356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L356) - -___ - -### getAppBoxNames - -▸ **getAppBoxNames**(`appId`, `algod`): `Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `number` \| `bigint` | The ID of the app return box names for | -| `algod` | `AlgodClient` | An algod client instance | - -#### Returns - -`Promise`\<[`BoxName`](../interfaces/types_app.BoxName.md)[]\> - -The current box names - -**`Deprecated`** - -Use `algorand.app.getBoxNames` instead. -Returns the names of the boxes for the given app. - -#### Defined in - -[src/app.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L276) - -___ - -### getAppBoxValue - -▸ **getAppBoxValue**(`appId`, `boxName`, `algod`): `Promise`\<`Uint8Array`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `number` \| `bigint` | The ID of the app return box names for | -| `boxName` | `string` \| `Uint8Array` \| [`BoxName`](../interfaces/types_app.BoxName.md) | The name of the box to return either as a string, binary array or `BoxName` | -| `algod` | `AlgodClient` | An algod client instance | - -#### Returns - -`Promise`\<`Uint8Array`\> - -The current box value as a byte array - -**`Deprecated`** - -Use `algorand.app.getBoxValue` instead. -Returns the value of the given box name for the given app. - -#### Defined in - -[src/app.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L288) - -___ - -### getAppBoxValueFromABIType - -▸ **getAppBoxValueFromABIType**(`request`, `algod`): `Promise`\<`ABIValue`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `request` | [`BoxValueRequestParams`](../interfaces/types_app.BoxValueRequestParams.md) | The parameters for the box value request | -| `algod` | `AlgodClient` | An algod client instance | - -#### Returns - -`Promise`\<`ABIValue`\> - -The current box value as an ABI value - -**`Deprecated`** - -Use `algorand.app.getBoxValueFromABIType` instead. -Returns the value of the given box name for the given app decoded based on the given ABI type. - -#### Defined in - -[src/app.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L314) - -___ - -### getAppBoxValues - -▸ **getAppBoxValues**(`appId`, `boxNames`, `algod`): `Promise`\<`Uint8Array`[]\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `number` | The ID of the app return box names for | -| `boxNames` | (`string` \| `Uint8Array` \| [`BoxName`](../interfaces/types_app.BoxName.md))[] | The names of the boxes to return either as a string, binary array or `BoxName` | -| `algod` | `AlgodClient` | An algod client instance | - -#### Returns - -`Promise`\<`Uint8Array`[]\> - -The current box values as a byte array in the same order as the passed in box names - -**`Deprecated`** - -Use `algorand.app.getBoxValues` instead. -Returns the value of the given box names for the given app. - -#### Defined in - -[src/app.ts:300](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L300) - -___ - -### getAppBoxValuesFromABIType - -▸ **getAppBoxValuesFromABIType**(`request`, `algod`): `Promise`\<`ABIValue`[]\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `request` | [`BoxValuesRequestParams`](../interfaces/types_app.BoxValuesRequestParams.md) | The parameters for the box value request | -| `algod` | `AlgodClient` | An algod client instance | - -#### Returns - -`Promise`\<`ABIValue`[]\> - -The current box values as an ABI value in the same order as the passed in box names - -**`Deprecated`** - -Use `algorand.app.getBoxValuesFromABIType` instead. -Returns the value of the given box names for the given app decoded based on the given ABI type. - -#### Defined in - -[src/app.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L329) - -___ - -### getAppById - -▸ **getAppById**(`appId`, `algod`): `Promise`\<`Application`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `number` \| `bigint` | The id of the app | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<`Application`\> - -The data about the app - -**`Deprecated`** - -Use `algorand.app.getById` instead. - -Gets the current data for the given app from algod. - -#### Defined in - -[src/app.ts:406](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L406) - -___ - -### getAppClient - -▸ **getAppClient**(`appDetails`, `algod`): [`ApplicationClient`](../classes/types_app_client.ApplicationClient.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appDetails` | [`AppSpecAppDetails`](types_app_client.md#appspecappdetails) | The details of the app | -| `algod` | `AlgodClient` | An algod instance | - -#### Returns - -[`ApplicationClient`](../classes/types_app_client.ApplicationClient.md) - -The application client - -**`Deprecated`** - -Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or -`algorand.client.getAppClientByCreatorAndName`. -If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, -which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. - -Create a new ApplicationClient instance - -**`Example`** - -```ts -Resolve by creator and name -const client = algokit.getAppClient( - { - resolveBy: 'creatorAndName', - app: {appSpec}, - sender: {account}, - creatorAddress: {creator}, - findExistingUsing: indexerClient, - }, - algodClient, - ) -``` - -**`Example`** - -```ts -Resolve by id: -const client = algokit.getAppClient( - { - resolveBy: 'id', - app: {appSpec}, - sender: {account}, - id: {id}, - }, - algodClient, -) -``` - -#### Defined in - -[src/app-client.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L40) - -___ - -### getAppClientByCreatorAndName - -▸ **getAppClientByCreatorAndName**(`appDetails`, `algod`): [`ApplicationClient`](../classes/types_app_client.ApplicationClient.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appDetails` | [`AppSpecAppDetailsByCreatorAndName`](types_app_client.md#appspecappdetailsbycreatorandname) | The details of the app by creator and name | -| `algod` | `AlgodClient` | An algod instance | - -#### Returns - -[`ApplicationClient`](../classes/types_app_client.ApplicationClient.md) - -The application client - -**`Deprecated`** - -Use `AppClient` instead e.g. via `algorand.client.getAppClientByCreatorAndName`. -If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, -which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. - -Create a new ApplicationClient instance by creator and name - -**`Example`** - -```ts -const client = algokit.getAppClientByCreatorAndName( - { - app: appSpec, - sender: account, - creatorAddress: account, - findExistingUsing: indexerClient, - }, - algodClient, - ) -``` - -#### Defined in - -[src/app-client.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L93) - -___ - -### getAppClientById - -▸ **getAppClientById**(`appDetails`, `algod`): [`ApplicationClient`](../classes/types_app_client.ApplicationClient.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appDetails` | [`AppSpecAppDetailsById`](types_app_client.md#appspecappdetailsbyid) | The details of the app | -| `algod` | `AlgodClient` | An algod instance | - -#### Returns - -[`ApplicationClient`](../classes/types_app_client.ApplicationClient.md) - -The application client - -**`Deprecated`** - -Use `AppClient` instead e.g. via `algorand.client.getAppClientById`. -If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, -which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. - -Create a new ApplicationClient instance by id - -**`Example`** - -```ts -const client = algokit.getAppClientById( - { - app: {appSpec}, - sender: {account}, - id: {id}, - }, - algodClient, - ) -``` - -#### Defined in - -[src/app-client.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-client.ts#L66) - -___ - -### getAppDeploymentTransactionNote - -▸ **getAppDeploymentTransactionNote**(`metadata`): [`Arc2TransactionNote`](types_transaction.md#arc2transactionnote) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `metadata` | [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) | The metadata of the deployment | - -#### Returns - -[`Arc2TransactionNote`](types_transaction.md#arc2transactionnote) - -The transaction note as a utf-8 string - -**`Deprecated`** - -Use `{ dAppName: APP_DEPLOY_NOTE_DAPP, data: metadata, format: 'j' }` instead. - -Return the transaction note for an app deployment. - -#### Defined in - -[src/app-deploy.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L271) - -___ - -### getAppGlobalState - -▸ **getAppGlobalState**(`appId`, `algod`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `number` \| `bigint` | The ID of the app return global state for | -| `algod` | `AlgodClient` | An algod client instance | - -#### Returns - -`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -The current global state - -**`Deprecated`** - -Use `algorand.app.getGlobalState` instead. - -Returns the current global state values for the given app ID - -#### Defined in - -[src/app.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L252) - -___ - -### getAppLocalState - -▸ **getAppLocalState**(`appId`, `account`, `algod`): `Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appId` | `number` \| `bigint` | The ID of the app return global state for | -| `account` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | Either the string address of an account or an account object for the account to get local state for the given app | -| `algod` | `AlgodClient` | An algod client instance | - -#### Returns - -`Promise`\<[`AppState`](../interfaces/types_app.AppState.md)\> - -The current local state for the given (app, account) combination - -**`Deprecated`** - -Use `algorand.app.getLocalState` instead. - -Returns the current global state values for the given app ID and account - -#### Defined in - -[src/app.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L265) - -___ - -### getAppOnCompleteAction - -▸ **getAppOnCompleteAction**(`onCompletionAction?`): `OnApplicationComplete` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onCompletionAction?` | [`AppCallType`](types_app.md#appcalltype) \| `OnApplicationComplete` | The on completion action | - -#### Returns - -`OnApplicationComplete` - -The `algosdk.OnApplicationComplete` - -**`Deprecated`** - -Use `algosdk.OnApplicationComplete` directly instead. - -Returns a `algosdk.OnApplicationComplete` for the given onCompleteAction. - -If given `undefined` will return `OnApplicationComplete.NoOpOC`. - -If given an `AppCallType` will convert the string enum to the correct underlying `algosdk.OnApplicationComplete`. - -#### Defined in - -[src/app.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L154) - -___ - -### getAtomicTransactionComposerTransactions - -▸ **getAtomicTransactionComposerTransactions**(`atc`): `TransactionWithSigner`[] - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `atc` | `AtomicTransactionComposer` | The atomic transaction composer | - -#### Returns - -`TransactionWithSigner`[] - -The array of transactions with signers - -**`Deprecated`** - -Use `atc.clone().buildGroup()` instead. - -Returns the array of transactions currently present in the given `AtomicTransactionComposer` - -#### Defined in - -[src/transaction/transaction.ts:1133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1133) - -___ - -### getBoxReference - -▸ **getBoxReference**(`box`): `algosdk.BoxReference` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `box` | [`BoxReference`](../interfaces/types_app.BoxReference.md) \| [`BoxIdentifier`](types_app.md#boxidentifier) \| `BoxReference` | The box to return a reference for | - -#### Returns - -`algosdk.BoxReference` - -The box reference ready to pass into a `Transaction` - -**`Deprecated`** - -Use `AppManager.getBoxReference()` instead. - -Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`. - -#### Defined in - -[src/app.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L389) - -___ - -### getConfigFromEnvOrDefaults - -▸ **getConfigFromEnvOrDefaults**(): [`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md) - -#### Returns - -[`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md) - -**`Deprecated`** - -Use `ClientManager.getConfigFromEnvironmentOrLocalNet()` instead. - -Retrieve configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment not algod-side) - -#### Defined in - -[src/network-client.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L13) - -___ - -### getCreatorAppsByName - -▸ **getCreatorAppsByName**(`creatorAccount`, `indexer`): `Promise`\<[`AppLookup`](../interfaces/types_app.AppLookup.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `creatorAccount` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The account (with private key loaded) or string address of an account that is the creator of the apps you want to search for | -| `indexer` | `IndexerClient` | An indexer client | - -#### Returns - -`Promise`\<[`AppLookup`](../interfaces/types_app.AppLookup.md)\> - -A name-based lookup of the app information (id, address) - -**`Deprecated`** - -Use `algorand.appDeployer.getCreatorAppsByName` instead. - -Returns a lookup of name => app metadata (id, address, ...metadata) for all apps created by the given account that have an `AppDeployNote` in the transaction note of the creation transaction. - -**Note:** It's recommended this is only called once and then stored since it's a somewhat expensive operation (multiple indexer calls). - -#### Defined in - -[src/app-deploy.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L244) - -___ - -### getDefaultLocalNetConfig - -▸ **getDefaultLocalNetConfig**(`configOrPort`): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `configOrPort` | `number` \| ``"algod"`` \| ``"indexer"`` \| ``"kmd"`` | Which algod config to return - algod, kmd, or indexer OR a port number | - -#### Returns - -[`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -**`Deprecated`** - -Use `ClientManager.getDefaultLocalNetConfig(configOrPort)` instead. - -Returns the Algorand configuration to point to the default LocalNet - -#### Defined in - -[src/network-client.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L54) - -___ - -### getDispenserAccount - -▸ **getDispenserAccount**(`algod`, `kmd?`): `Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](../classes/types_account.SigningAccount.md) }\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `algod` | `AlgodClient` | An algod client | -| `kmd?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables | - -#### Returns - -`Promise`\<`Address` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) & \{ `account`: [`SigningAccount`](../classes/types_account.SigningAccount.md) }\> - -**`Deprecated`** - -Use `algorand.account.dispenserFromEnvironment()` or `new AccountManager(clientManager).dispenserFromEnvironment()` instead - -Returns an account (with private key loaded) that can act as a dispenser - -If running on LocalNet then it will return the default dispenser account automatically, - otherwise it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC - -#### Defined in - -[src/account/get-dispenser-account.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/get-dispenser-account.ts#L19) - -___ - -### getIndexerConfigFromEnvironment - -▸ **getIndexerConfigFromEnvironment**(): [`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -#### Returns - -[`AlgoClientConfig`](../interfaces/types_network_client.AlgoClientConfig.md) - -**`Deprecated`** - -Use `ClientManager.getIndexerConfigFromEnvironment()` instead. - -Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment not algod-side) - -#### Defined in - -[src/network-client.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L31) - -___ - -### getKmdWalletAccount - -▸ **getKmdWalletAccount**(`walletAccount`, `algod`, `kmdClient?`): `Promise`\<`Account` \| `undefined`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `walletAccount` | `Object` | The details of the wallet, with: * `name`: The name of the wallet to retrieve an account from * `predicate`: An optional filter to use to find the account (otherwise it will return a random account from the wallet) | -| `walletAccount.name` | `string` | - | -| `walletAccount.predicate?` | (`account`: `Record`\<`string`, `any`\>) => `boolean` | - | -| `algod` | `AlgodClient` | An algod client | -| `kmdClient?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables | - -#### Returns - -`Promise`\<`Account` \| `undefined`\> - -**`Deprecated`** - -use `algorand.account.kmd.getWalletAccount(name, predicate)` or `new KMDAccountManager(clientManager).getWalletAccount(name, predicate)` instead. - -Returns an Algorand account with private key loaded from the given KMD wallet (identified by name). - -**`Example`** - -```typescript -const defaultDispenserAccount = await getKmdWalletAccount(algod, - 'unencrypted-default-wallet', - a => a.status !== 'Offline' && a.amount > 1_000_000_000 -) -``` - -#### Defined in - -[src/localnet/get-kmd-wallet-account.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-kmd-wallet-account.ts#L27) - -___ - -### getLocalNetDispenserAccount - -▸ **getLocalNetDispenserAccount**(`algod`, `kmd?`): `Promise`\<`Account`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `algod` | `AlgodClient` | An algod client | -| `kmd?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables | - -#### Returns - -`Promise`\<`Account`\> - -**`Deprecated`** - -Use `algorand.account.kmd.getLocalNetDispenserAccount()` instead. - -Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts) - -#### Defined in - -[src/localnet/get-localnet-dispenser-account.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-localnet-dispenser-account.ts#L15) - -___ - -### getOrCreateKmdWalletAccount - -▸ **getOrCreateKmdWalletAccount**(`walletAccount`, `algod`, `kmdClient?`): `Promise`\<`Account`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `walletAccount` | `Object` | The wallet details with: * `name`: The name of the wallet to retrieve / create * `fundWith`: The number of Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account | -| `walletAccount.fundWith?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | - | -| `walletAccount.name` | `string` | - | -| `algod` | `AlgodClient` | An algod client | -| `kmdClient?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables | - -#### Returns - -`Promise`\<`Account`\> - -An Algorand account with private key loaded - either one that already existed in the given KMD wallet, or a new one that is funded for you - -**`Deprecated`** - -use `algorand.account.kmd.getOrCreateWalletAccount(name, fundWith)` or `new KMDAccountManager(clientManager).getOrCreateWalletAccount(name, fundWith)` instead. - -Gets an account with private key loaded from a KMD wallet of the given name, or alternatively creates one with funds in it via a KMD wallet of the given name. - -This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet). - -This significantly speeds up local dev time and improves experience since you can write code that *just works* first go without manual config in a fresh LocalNet. - -If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development! - -#### Defined in - -[src/localnet/get-or-create-kmd-wallet-account.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/get-or-create-kmd-wallet-account.ts#L28) - -___ - -### getSenderAddress - -▸ **getSenderAddress**(`sender`): `string` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `sender` | `string` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | A transaction sender | - -#### Returns - -`string` - -The public address - -**`Deprecated`** - -Use `algorand.client` to interact with accounts, and use `.addr` to get the address -and/or move from using `SendTransactionFrom` to `TransactionSignerAccount` and use `.addr` instead. - -Returns the public address of the given transaction sender. - -#### Defined in - -[src/transaction/transaction.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L110) - -___ - -### getSenderTransactionSigner - -▸ **getSenderTransactionSigner**(`val`): `TransactionSigner` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `val` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | - -#### Returns - -`TransactionSigner` - -A transaction signer - -**`Deprecated`** - -Use `TransactionSignerAccount` instead of `SendTransactionFrom` or use -`algosdk.makeBasicAccountTransactionSigner` / `algosdk.makeLogicSigAccountTransactionSigner`. - -Returns a `TransactionSigner` for the given transaction sender. -This function has memoization, so will return the same transaction signer for a given sender. - -#### Defined in - -[src/transaction/transaction.ts:168](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L168) - -___ - -### getTestNetDispenserApiClient - -▸ **getTestNetDispenserApiClient**(`params?`): [`TestNetDispenserApiClient`](../classes/types_dispenser_client.TestNetDispenserApiClient.md) - -#### Parameters - -| Name | Type | Default value | Description | -| :------ | :------ | :------ | :------ | -| `params` | ``null`` \| [`TestNetDispenserApiClientParams`](../interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md) | `null` | An object containing parameters for the TestNetDispenserApiClient class. Or null if you want the client to load the access token from the environment variable `ALGOKIT_DISPENSER_ACCESS_TOKEN`. | - -#### Returns - -[`TestNetDispenserApiClient`](../classes/types_dispenser_client.TestNetDispenserApiClient.md) - -An instance of the TestNetDispenserApiClient class. - -**`Deprecated`** - -Use `clientManager.getTestNetDispenser` or `clientManager.getTestNetDispenserFromEnvironment` instead - -Create a new TestNetDispenserApiClient instance. -Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token. - -**`Example`** - -```ts -const client = algokit.getTestNetDispenserApiClient( - { - authToken: 'your_auth_token', - requestTimeout: 15, - } -) -``` - -#### Defined in - -[src/dispenser-client.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/dispenser-client.ts#L21) - -___ - -### getTransactionParams - -▸ **getTransactionParams**(`params`, `algod`): `Promise`\<`SuggestedParams`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `undefined` \| `SuggestedParams` | Optionally provide parameters to use | -| `algod` | `AlgodClient` | Algod algod | - -#### Returns - -`Promise`\<`SuggestedParams`\> - -The suggested transaction parameters - -**`Deprecated`** - -Use `suggestedParams ? { ...suggestedParams } : await algod.getTransactionParams().do()` instead - -Returns suggested transaction parameters from algod unless some are already provided. - -#### Defined in - -[src/transaction/transaction.ts:1111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1111) - -___ - -### getTransactionWithSigner - -▸ **getTransactionWithSigner**(`transaction`, `defaultSender?`): `Promise`\<`TransactionWithSigner`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transaction` | `Transaction` \| [`TransactionToSign`](../interfaces/types_transaction.TransactionToSign.md) \| `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> \| `TransactionWithSigner` | One of: A TransactionWithSigner object (returned as is), a TransactionToSign object (signer is obtained from the signer property), a Transaction object (signer is extracted from the defaultSender parameter), an async SendTransactionResult returned by one of algokit utils' helpers (signer is obtained from the defaultSender parameter) | -| `defaultSender?` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The default sender to be used to obtain a signer where the object provided to the transaction parameter does not include a signer. | - -#### Returns - -`Promise`\<`TransactionWithSigner`\> - -A TransactionWithSigner object. - -**`Deprecated`** - -Use `AlgorandClient` / `TransactionComposer` to construct transactions instead or -construct an `algosdk.TransactionWithSigner` manually instead. - -Given a transaction in a variety of supported formats, returns a TransactionWithSigner object ready to be passed to an -AtomicTransactionComposer's addTransaction method. - -#### Defined in - -[src/transaction/transaction.ts:127](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L127) - -___ - -### isLocalNet - -▸ **isLocalNet**(`algod`): `Promise`\<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `algod` | `AlgodClient` | - -#### Returns - -`Promise`\<`boolean`\> - -**`Deprecated`** - -Use `await algorand.client.isLocalNet()` or `await new ClientManager({ algod }).isLocalNet()` instead. - -Returns true if the algod client is pointing to a LocalNet Algorand network - -#### Defined in - -[src/localnet/is-localnet.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/localnet/is-localnet.ts#L9) - -___ - -### isMainNet - -▸ **isMainNet**(`algod`): `Promise`\<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `algod` | `AlgodClient` | - -#### Returns - -`Promise`\<`boolean`\> - -**`Deprecated`** - -Use `await algorand.client.isMainNet()` or `await new ClientManager({ algod }).isMainNet()` instead. - -#### Defined in - -[src/network-client.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L154) - -___ - -### isSchemaIsBroken - -▸ **isSchemaIsBroken**(`before`, `after`): `boolean` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `before` | `ApplicationStateSchema` | The existing schema | -| `after` | `ApplicationStateSchema` | The new schema | - -#### Returns - -`boolean` - -Whether or not there is a breaking change - -**`Deprecated`** - -Use `before.numByteSlice < after.numByteSlice || before.numUint < after.numUint` instead. - -Returns true is there is a breaking change in the application state schema from before to after. - i.e. if the schema becomes larger, since applications can't ask for more schema after creation. - Otherwise, there is no error, the app just doesn't store data in the extra schema :( - -#### Defined in - -[src/app-deploy.ts:229](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L229) - -___ - -### isTestNet - -▸ **isTestNet**(`algod`): `Promise`\<`boolean`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `algod` | `AlgodClient` | - -#### Returns - -`Promise`\<`boolean`\> - -**`Deprecated`** - -Use `await algorand.client.isTestNet()` or `await new ClientManager({ algod }).isTestNet()` instead. - -#### Defined in - -[src/network-client.ts:149](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/network-client.ts#L149) - -___ - -### microAlgo - -▸ **microAlgo**(`microAlgos`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -Returns an amount of µAlgo using AlgoAmount - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `microAlgos` | `number` \| `bigint` | The amount of µAlgo | - -#### Returns - -[`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -#### Defined in - -[src/amount.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L82) - -___ - -### microAlgos - -▸ **microAlgos**(`microAlgos`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -Returns an amount of µAlgo using AlgoAmount - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `microAlgos` | `number` \| `bigint` | The amount of µAlgo | - -#### Returns - -[`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -#### Defined in - -[src/amount.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L75) - -___ - -### mnemonicAccount - -▸ **mnemonicAccount**(`mnemonicSecret`): `Account` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `mnemonicSecret` | `string` | The mnemonic secret representing the private key of an account; **Note: Be careful how the mnemonic is handled**, never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system. | - -#### Returns - -`Account` - -**`Deprecated`** - -Use `algorand.account.fromMnemonic(mnemonicSecret)` or `algosdk.mnemonicToSecretKey(mnemonicSecret)` instead. - -Returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret. - -This is a wrapper around algosdk.mnemonicToSecretKey to provide a more friendly/obvious name. - -#### Defined in - -[src/account/mnemonic-account.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/mnemonic-account.ts#L14) - -___ - -### mnemonicAccountFromEnvironment - -▸ **mnemonicAccountFromEnvironment**(`account`, `algod`, `kmdClient?`): `Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `account` | `string` \| \{ `fundWith?`: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) ; `name`: `string` } | The details of the account to get, either the name identifier (string) or an object with: * `name`: string: The name identifier of the account * `fundWith`: The amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account | -| `algod` | `AlgodClient` | An algod client | -| `kmdClient?` | `KmdClient` | An optional KMD client to use to create an account (when targeting LocalNet), if not specified then a default KMD client will be loaded from environment variables | - -#### Returns - -`Promise`\<`Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md)\> - -The requested account with private key loaded from the environment variables or when targeting LocalNet from KMD (idempotently creating and funding the account) - -**`Deprecated`** - -Use `algorand.account.fromEnvironment(name, fundWith)` or `new AccountManager(clientManager).fromEnvironment()` instead. - -Returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier. - -Note: This function expects to run in a Node.js environment. - -## Convention: -* **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**, - never commit it into source control and ideally load it via a secret storage service rather than the file system. - If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts) -* **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you - -This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet). - -**`Example`** - -If you have a mnemonic secret loaded into `process.env.MY_ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: -```typescript -const account = await mnemonicAccountFromEnvironment('MY_ACCOUNT', algod) -``` - -If that code runs against LocalNet then a wallet called `MY_ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. -If not running against LocalNet then it will use proces.env.MY_ACCOUNT_MNEMONIC as the private key and (if present) process.env.MY_ACCOUNT_SENDER as the sender address. - -#### Defined in - -[src/account/account.ts:97](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L97) - -___ - -### multisigAccount - -▸ **multisigAccount**(`multisigParams`, `signingAccounts`): [`MultisigAccount`](../classes/types_account.MultisigAccount.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `multisigParams` | `MultisigMetadata` | The parameters that define the multisig account | -| `signingAccounts` | (`default` \| [`SigningAccount`](../classes/types_account.SigningAccount.md))[] | The signers that are currently present | - -#### Returns - -[`MultisigAccount`](../classes/types_account.MultisigAccount.md) - -A multisig account wrapper - -**`Deprecated`** - -Use `algorand.account.multisig(multisigParams, signingAccounts)` or `new MultisigAccount(multisigParams, signingAccounts)` instead. - -Returns an account wrapper that supports partial or full multisig signing. - -#### Defined in - -[src/account/account.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L24) - -___ - -### performAtomicTransactionComposerSimulate - -▸ **performAtomicTransactionComposerSimulate**(`atc`, `algod`, `options?`): `Promise`\<`SimulateResponse`\> - -Performs a simulation of the transactions loaded into the given AtomicTransactionComposer. -Uses empty transaction signers for all transactions. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `atc` | `AtomicTransactionComposer` | The AtomicTransactionComposer with transaction(s) loaded. | -| `algod` | `AlgodClient` | An Algod client to perform the simulation. | -| `options?` | `Omit`\<\{ `allowEmptySignatures?`: `boolean` ; `allowMoreLogging?`: `boolean` ; `allowUnnamedResources?`: `boolean` ; `execTraceConfig?`: `SimulateTraceConfig` ; `extraOpcodeBudget?`: `number` \| `bigint` ; `fixSigners?`: `boolean` ; `round?`: `number` \| `bigint` ; `txnGroups`: `SimulateRequestTransactionGroup`[] }, ``"txnGroups"``\> | - | - -#### Returns - -`Promise`\<`SimulateResponse`\> - -The simulation result, which includes various details about how the transactions would be processed. - -#### Defined in - -[src/transaction/perform-atomic-transaction-composer-simulate.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/perform-atomic-transaction-composer-simulate.ts#L14) - -___ - -### performTemplateSubstitution - -▸ **performTemplateSubstitution**(`tealCode`, `templateParams?`): `string` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealCode` | `string` | The TEAL logic to compile | -| `templateParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any parameters to replace in the .teal file before compiling | - -#### Returns - -`string` - -The TEAL code with replacements - -**`Deprecated`** - -Use `AppManager.replaceTealTemplateParams` instead - -Performs template substitution of a teal file. - -Looks for `TMPL_{parameter}` for template replacements. - -#### Defined in - -[src/app-deploy.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L309) - -___ - -### performTemplateSubstitutionAndCompile - -▸ **performTemplateSubstitutionAndCompile**(`tealCode`, `algod`, `templateParams?`, `deploymentMetadata?`): `Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealCode` | `string` | The TEAL logic to compile | -| `algod` | `AlgodClient` | An algod client | -| `templateParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Any parameters to replace in the .teal file before compiling | -| `deploymentMetadata?` | [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) | The deployment metadata the app will be deployed with | - -#### Returns - -`Promise`\<[`CompiledTeal`](../interfaces/types_app.CompiledTeal.md)\> - -The information about the compiled code - -**`Deprecated`** - -Use `algorand.appManager.compileTealTemplate` instead. - -Performs template substitution of a teal file and compiles it, returning the compiled result. - -Looks for `TMPL_{parameter}` for template replacements. - -#### Defined in - -[src/app-deploy.ts:326](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L326) - -___ - -### persistSourceMaps - -▸ **persistSourceMaps**(`_params`): `Promise`\<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_params` | `unknown` | - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the source maps have been persisted. - -**`Deprecated`** - -Use latest version of `AlgoKit AVM Debugger` VSCode extension instead. It will automatically manage your sourcemaps. - -This function persists the source maps for the given sources. - -#### Defined in - -[src/debugging/debugging.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/debugging/debugging.ts#L8) - -___ - -### populateAppCallResources - -▸ **populateAppCallResources**(`atc`, `algod`): `Promise`\<`AtomicTransactionComposer`\> - -Take an existing Atomic Transaction Composer and return a new one with the required -app call resources populated into it - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `atc` | `AtomicTransactionComposer` | The ATC containing the txn group | -| `algod` | `AlgodClient` | The algod client to use for the simulation | - -#### Returns - -`Promise`\<`AtomicTransactionComposer`\> - -A new ATC with the resources populated into the transactions - -#### Defined in - -[src/transaction/transaction.ts:382](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L382) - -___ - -### prepareGroupForSending - -▸ **prepareGroupForSending**(`atc`, `algod`, `sendParams`, `additionalAtcContext?`): `Promise`\<`AtomicTransactionComposer`\> - -Take an existing Atomic Transaction Composer and return a new one with changes applied to the transactions -based on the supplied sendParams to prepare it for sending. -Please note, that before calling `.execute()` on the returned ATC, you must call `.buildGroup()`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `atc` | `AtomicTransactionComposer` | The ATC containing the txn group | -| `algod` | `AlgodClient` | The algod client to use for the simulation | -| `sendParams` | [`SendParams`](../interfaces/types_transaction.SendParams.md) | The send params for the transaction group | -| `additionalAtcContext?` | [`AdditionalAtomicTransactionComposerContext`](../interfaces/types_transaction.AdditionalAtomicTransactionComposerContext.md) | Additional ATC context used to determine how best to change the transactions in the group | - -#### Returns - -`Promise`\<`AtomicTransactionComposer`\> - -A new ATC with the changes applied - -#### Defined in - -[src/transaction/transaction.ts:401](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L401) - -___ - -### randomAccount - -▸ **randomAccount**(): `Account` - -#### Returns - -`Account` - -**`Deprecated`** - -Use `algorand.account.random()` or `algosdk.generateAccount()` instead. - -Returns a new, random Algorand account with secret key loaded. - -This is a wrapper around algosdk.generateAccount to provide a more friendly/obvious name. - -#### Defined in - -[src/account/account.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L60) - -___ - -### rekeyAccount - -▸ **rekeyAccount**(`rekey`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `rekey` | [`AlgoRekeyParams`](../interfaces/types_transfer.AlgoRekeyParams.md) | The rekey definition | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) - -**`Deprecated`** - -Use `algorand.account.rekeyAccount()` instead - -Rekey an account to a new address. - -**Note:** Please be careful with this function and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). - -**`Example`** - -```typescript -await algokit.rekeyAccount({ from, rekeyTo }, algod) -``` - -#### Defined in - -[src/transfer/transfer.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L125) - -___ - -### rekeyedAccount - -▸ **rekeyedAccount**(`signer`, `sender`): [`SigningAccount`](../classes/types_account.SigningAccount.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `signer` | `default` | The account, with private key loaded, that is signing | -| `sender` | `string` | The address of the rekeyed account that will act as a sender | - -#### Returns - -[`SigningAccount`](../classes/types_account.SigningAccount.md) - -The SigningAccount wrapper - -**`Deprecated`** - -Use `algorand.account.rekeyed(sender, account)` or `new SigningAccount(account, sender)` instead. - -Returns an account wrapper that supports a rekeyed account. - -#### Defined in - -[src/account/account.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L36) - -___ - -### replaceDeployTimeControlParams - -▸ **replaceDeployTimeControlParams**(`tealCode`, `params`): `string` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealCode` | `string` | The TEAL code to substitute | -| `params` | `Object` | The deploy-time deployment control parameter value to replace | -| `params.deletable?` | `boolean` | - | -| `params.updatable?` | `boolean` | - | - -#### Returns - -`string` - -The replaced TEAL code - -**`Deprecated`** - -Use `AppManager.replaceTealTemplateDeployTimeControlParams` instead - -Replaces deploy-time deployment control parameters within the given teal code. - -* `TMPL_UPDATABLE` for updatability / immutability control -* `TMPL_DELETABLE` for deletability / permanence control - -Note: If these values are not undefined, but the corresponding `TMPL_*` value - isn't in the teal code it will throw an exception. - -#### Defined in - -[src/app-deploy.ts:294](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L294) - -___ - -### sendAtomicTransactionComposer - -▸ **sendAtomicTransactionComposer**(`atcSend`, `algod`): `Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md)\> - -Signs and sends transactions that have been collected by an `AtomicTransactionComposer`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `atcSend` | [`AtomicTransactionComposerToSend`](../interfaces/types_transaction.AtomicTransactionComposerToSend.md) | The parameters controlling the send, including `atc` The `AtomicTransactionComposer` and params to control send behaviour | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md)\> - -An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`) - -#### Defined in - -[src/transaction/transaction.ts:776](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L776) - -___ - -### sendGroupOfTransactions - -▸ **sendGroupOfTransactions**(`groupSend`, `algod`): `Promise`\<`Omit`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md), ``"returns"``\>\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `groupSend` | [`TransactionGroupToSend`](../interfaces/types_transaction.TransactionGroupToSend.md) | The group details to send, with: * `transactions`: The array of transactions to send along with their signing account * `sendParams`: The parameters to dictate how the group is sent | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<`Omit`\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md), ``"returns"``\>\> - -An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`) - -**`Deprecated`** - -Use `TransactionComposer` (`algorand.newGroup()`) or `AtomicTransactionComposer` to construct and send group transactions instead. - -Signs and sends a group of [up to 16](https://dev.algorand.co/concepts/transactions/atomic-txn-groups/#create-transactions) transactions to the chain - -#### Defined in - -[src/transaction/transaction.ts:956](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L956) - -___ - -### sendTransaction - -▸ **sendTransaction**(`send`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `send` | `Object` | The details for the transaction to prepare/send, including: * `transaction`: The unsigned transaction * `from`: The account to sign the transaction with: either an account with private key loaded or a logic signature account * `config`: The sending configuration for this transaction | -| `send.from` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | - | -| `send.sendParams?` | [`SendTransactionParams`](../interfaces/types_transaction.SendTransactionParams.md) | - | -| `send.transaction` | `Transaction` | - | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -An object with transaction (`transaction`) and (if `skipWaiting` is `false` or `undefined`) confirmation (`confirmation`) - -**`Deprecated`** - -Use `AlgorandClient` / `TransactionComposer` to send transactions. - -Prepares a transaction for sending and then (if instructed) signs and sends the given transaction to the chain. - -#### Defined in - -[src/transaction/transaction.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L209) - -___ - -### signTransaction - -▸ **signTransaction**(`transaction`, `signer`): `Promise`\<`Uint8Array`\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transaction` | `Transaction` | The transaction to sign | -| `signer` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | The signer to sign | - -#### Returns - -`Promise`\<`Uint8Array`\> - -The signed transaction as a `Uint8Array` - -**`Deprecated`** - -Use `AlgorandClient` / `TransactionComposer` to sign transactions -or use the relevant underlying `account.signTxn` / `algosdk.signLogicSigTransactionObject` -/ `multiSigAccount.sign` / `TransactionSigner` methods directly. - -Signs a single transaction by the given signer. - -#### Defined in - -[src/transaction/transaction.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L186) - -___ - -### stripTealComments - -▸ **stripTealComments**(`tealCode`): `string` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tealCode` | `string` | The TEAL logic to compile | - -#### Returns - -`string` - -The TEAL without comments - -**`Deprecated`** - -Use `AppManager.stripTealComments` instead. - -Remove comments from TEAL Code - -#### Defined in - -[src/app-deploy.ts:351](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app-deploy.ts#L351) - -___ - -### transactionFees - -▸ **transactionFees**(`numberOfTransactions`): [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -Returns an amount of µAlgo to cover standard fees for the given number of transactions using AlgoAmount - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `numberOfTransactions` | `number` | The of standard transaction fees to return the amount of Algo | - -#### Returns - -[`AlgoAmount`](../classes/types_amount.AlgoAmount.md) - -#### Defined in - -[src/amount.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L89) - -___ - -### transactionSignerAccount - -▸ **transactionSignerAccount**(`signer`, `sender`): [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `signer` | `TransactionSigner` | The transaction signer | -| `sender` | `string` | The address of sender account | - -#### Returns - -[`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -The SigningAccount wrapper - -**`Deprecated`** - -Use `algorand.account.getSigner(sender)` (after previously registering the signer with `setSigner`) or `{ addr: sender, signer }` instead. - -Returns an account wrapper that supports a transaction signer with associated sender address. - -#### Defined in - -[src/account/account.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/account/account.ts#L48) - -___ - -### transferAlgos - -▸ **transferAlgos**(`transfer`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transfer` | [`AlgoTransferParams`](../interfaces/types_transfer.AlgoTransferParams.md) | The transfer definition | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) - -**`Deprecated`** - -Use `algorand.send.payment()` / `algorand.createTransaction.payment()` instead - -Transfer Algo between two accounts. - -**`Example`** - -```typescript -await algokit.transferAlgos({ from, to, amount: algokit.algo(1) }, algod) -``` - -#### Defined in - -[src/transfer/transfer-algos.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer-algos.ts#L22) - -___ - -### transferAsset - -▸ **transferAsset**(`transfer`, `algod`): `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transfer` | [`TransferAssetParams`](../interfaces/types_transfer.TransferAssetParams.md) | The transfer definition | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> - -The transaction object and optionally the confirmation if it was sent to the chain (`skipSending` is `false` or unset) - -**`Deprecated`** - -Use `algorand.send.assetTransfer()` / `algorand.createTransaction.assetTransfer()` instead - -Transfer asset between two accounts. - -**`Example`** - -```typescript -await algokit.transferAsset({ from, to, assetId, amount }, algod) -``` - -#### Defined in - -[src/transfer/transfer.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transfer/transfer.ts#L90) - -___ - -### updateApp - -▸ **updateApp**(`update`, `algod`): `Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `update` | [`UpdateAppParams`](../interfaces/types_app.UpdateAppParams.md) | The parameters to update the app with | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<`Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\> & [`AppCallTransactionResult`](types_app.md#appcalltransactionresult)\> - -The transaction send result and the compilation result - -**`Deprecated`** - -Use `algorand.send.appUpdate()` / `algorand.createTransaction.appUpdate()` / `algorand.send.appUpdateMethodCall()` -/ `algorand.createTransaction.appUpdateMethodCall()` instead - -Updates a smart contract app. - -#### Defined in - -[src/app.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/app.ts#L104) - -___ - -### waitForConfirmation - -▸ **waitForConfirmation**(`transactionId`, `maxRoundsToWait`, `algod`): `Promise`\<`PendingTransactionResponse`\> - -Wait until the transaction is confirmed or rejected, or until `timeout` -number of rounds have passed. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `transactionId` | `string` | The transaction ID to wait for | -| `maxRoundsToWait` | `number` \| `bigint` | Maximum number of rounds to wait | -| `algod` | `AlgodClient` | An algod client | - -#### Returns - -`Promise`\<`PendingTransactionResponse`\> - -Pending transaction information - -**`Throws`** - -Throws an error if the transaction is not confirmed or rejected in the next `timeout` rounds - -#### Defined in - -[src/transaction/transaction.ts:1000](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction/transaction.ts#L1000) diff --git a/docs/code/modules/testing.md b/docs/code/modules/testing.md deleted file mode 100644 index 04738d4e..00000000 --- a/docs/code/modules/testing.md +++ /dev/null @@ -1,243 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / testing - -# Module: testing - -## Table of contents - -### Classes - -- [TestLogger](../classes/testing.TestLogger.md) -- [TransactionLogger](../classes/testing.TransactionLogger.md) - -### Functions - -- [algoKitLogCaptureFixture](testing.md#algokitlogcapturefixture) -- [algorandFixture](testing.md#algorandfixture) -- [getTestAccount](testing.md#gettestaccount) -- [runWhenIndexerCaughtUp](testing.md#runwhenindexercaughtup) - -## Functions - -### algoKitLogCaptureFixture - -▸ **algoKitLogCaptureFixture**(): [`AlgoKitLogCaptureFixture`](../interfaces/types_testing.AlgoKitLogCaptureFixture.md) - -Creates a test fixture for capturing AlgoKit logs. - -#### Returns - -[`AlgoKitLogCaptureFixture`](../interfaces/types_testing.AlgoKitLogCaptureFixture.md) - -The fixture - -**`Example`** - -```typescript -const logs = algoKitLogCaptureFixture() - -beforeEach(logs.beforeEach) -afterEach(logs.afterEach) - -test('My test', () => { - const capturedLogs = logs.testLogger.capturedLogs -}) -``` - -#### Defined in - -[src/testing/fixtures/algokit-log-capture-fixture.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algokit-log-capture-fixture.ts#L22) - -___ - -### algorandFixture - -▸ **algorandFixture**(`fixtureConfig?`): [`AlgorandFixture`](../interfaces/types_testing.AlgorandFixture.md) - -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 (or their respective config) if you want to test against -an explicitly defined network. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fixtureConfig?` | [`AlgorandFixtureConfig`](../interfaces/types_testing.AlgorandFixtureConfig.md) | The fixture configuration | - -#### Returns - -[`AlgorandFixture`](../interfaces/types_testing.AlgorandFixture.md) - -The fixture - -**`Example`** - -```typescript -const fixture = algorandFixture() - -beforeEach(fixture.newScope, 10_000) - -test('My test', async () => { - const {algod, indexer, testAccount, ...} = fixture.context - // test things... -}) -``` - -**`Example`** - -```typescript -const fixture = algorandFixture() - -beforeAll(fixture.newScope, 10_000) - -test('My test', async () => { - const {algod, indexer, testAccount, ...} = fixture.context - // test things... -}) -``` - -**`Example`** - -```typescript -const fixture = algorandFixture({ - algod: new Algodv2('localhost', 12345, 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'), - // ... -}) - -beforeEach(fixture.newScope, 10_000) - -test('My test', async () => { - const {algod, indexer, testAccount, ...} = fixture.context - // test things... -}) -``` - -#### Defined in - -[src/testing/fixtures/algorand-fixture.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algorand-fixture.ts#L60) - -▸ **algorandFixture**(`fixtureConfig`, `config`): [`AlgorandFixture`](../interfaces/types_testing.AlgorandFixture.md) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `fixtureConfig` | `undefined` \| [`AlgorandFixtureConfig`](../interfaces/types_testing.AlgorandFixtureConfig.md) | The fixture configuration | -| `config` | [`AlgoConfig`](../interfaces/types_network_client.AlgoConfig.md) | The fixture configuration | - -#### Returns - -[`AlgorandFixture`](../interfaces/types_testing.AlgorandFixture.md) - -The fixture - -**`Deprecated`** - -Config can be passed in directly to fixture config now. - -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. - -#### Defined in - -[src/testing/fixtures/algorand-fixture.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algorand-fixture.ts#L75) - -___ - -### getTestAccount - -▸ **getTestAccount**(`params`, `algod`, `kmd?`): `Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)\> - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`GetTestAccountParams`](../interfaces/types_testing.GetTestAccountParams.md) | The config for the test account to generate | -| `algod` | `AlgodClient` | An algod client | -| `kmd?` | `KmdClient` | A KMD client, if not specified then a default KMD client will be loaded from environment variables and if not found fallback to the default LocalNet KMD client | - -#### Returns - -`Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)\> - -The account, with private key loaded - -**`Deprecated`** - -Use `getTestAccount(params, algorandClient)` instead. The `algorandClient` object can be created using `AlgorandClient.fromClients({ algod, kmd })`. - -Creates an ephemeral Algorand account for the purposes of testing. -Returns a newly created random test account that is funded from the dispenser -DO NOT USE THIS TO CREATE A MAINNET ACCOUNT! -Note: By default this will log the mnemonic of the account. - -#### Defined in - -[src/testing/account.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L21) - -▸ **getTestAccount**(`params`, `algorand`): `Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)\> - -Creates an ephemeral Algorand account for the purposes of testing. -Returns a newly created random test account that is funded from the dispenser -DO NOT USE THIS TO CREATE A MAINNET ACCOUNT! -Note: By default this will log the mnemonic of the account. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | [`GetTestAccountParams`](../interfaces/types_testing.GetTestAccountParams.md) | The config for the test account to generate | -| `algorand` | [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md) | An AlgorandClient client | - -#### Returns - -`Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md)\> - -The account, with private key loaded - -#### Defined in - -[src/testing/account.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L35) - -___ - -### runWhenIndexerCaughtUp - -▸ **runWhenIndexerCaughtUp**\<`T`\>(`run`): `Promise`\<`T`\> - -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. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `run` | () => `Promise`\<`T`\> | The code to run | - -#### Returns - -`Promise`\<`T`\> - -The result (as a promise), or throws if the indexer didn't catch up in time - -**`Example`** - -```typescript -const transaction = await runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(txnId).do()) -``` - -#### Defined in - -[src/testing/indexer.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/indexer.ts#L12) diff --git a/docs/code/modules/types_account.md b/docs/code/modules/types_account.md deleted file mode 100644 index d6b8656c..00000000 --- a/docs/code/modules/types_account.md +++ /dev/null @@ -1,100 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/account - -# Module: types/account - -## Table of contents - -### Classes - -- [MultisigAccount](../classes/types_account.MultisigAccount.md) -- [SigningAccount](../classes/types_account.SigningAccount.md) - -### Interfaces - -- [AccountConfig](../interfaces/types_account.AccountConfig.md) -- [TransactionSignerAccount](../interfaces/types_account.TransactionSignerAccount.md) - -### Type Aliases - -- [AccountAssetInformation](types_account.md#accountassetinformation) -- [AccountInformation](types_account.md#accountinformation) - -### Variables - -- [DISPENSER\_ACCOUNT](types_account.md#dispenser_account) - -## Type Aliases - -### AccountAssetInformation - -Ƭ **AccountAssetInformation**: `Object` - -Account asset holding information at a given round. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assetId` | `bigint` | The ID of the asset held. | -| `balance` | `bigint` | The current balance of that asset holding. | -| `frozen` | `boolean` | Whether or not the asset is frozen for the account. | -| `round` | `bigint` | The round as at which the holding was correct. | - -#### Defined in - -[src/types/account.ts:278](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L278) - -___ - -### AccountInformation - -Ƭ **AccountInformation**: `Object` - -Account information at a given round. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `address` | `Address` | The account public key | -| `amountWithoutPendingRewards` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | The amount of Algo in the account, without the pending rewards. | -| `appsLocalState?` | `ApplicationLocalState`[] | Applications local data stored in this account. | -| `appsTotalExtraPages?` | `number` | The sum of all extra application program pages for this account. | -| `appsTotalSchema?` | `ApplicationStateSchema` | (tsch) stores the sum of all of the local schemas and global schemas in this account. Note: the raw account uses `StateSchema` for this type. | -| `assets?` | `AssetHolding`[] | Assets held by this account. | -| `authAddr?` | `Address` | The address against which signing should be checked. If empty, the address of the current account is used. This field can be updated in any transaction by setting the `RekeyTo` field. | -| `balance` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | The balance of Algo currently held by the account. | -| `createdApps?` | `Application`[] | Parameters of applications created by this account including app global data. | -| `createdAssets?` | `Asset`[] | (apar) parameters of assets created by this account. Note: the raw account uses `map[int] -> Asset` for this type. | -| `lastHeartbeatRound?` | `bigint` | The round in which this account last went online, or explicitly renewed their online status. | -| `lastProposedRound?` | `bigint` | The round in which this account last proposed the block. | -| `minBalance` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | Algo balance required to be held by the account. The requirement grows based on asset and application usage. | -| `participation?` | `AccountParticipation` | AccountParticipation describes the parameters used by this account in consensus protocol. | -| `pendingRewards` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | Amount of Algo of pending rewards in this account. | -| `rewardBase?` | `number` | Used as part of the rewards computation. Only applicable to accounts which are participating. | -| `rewards` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | Total rewards of Algo the account has received, including pending rewards. | -| `sigType?` | `string` | Indicates what type of signature is used by this account, must be one of: * sig * msig * lsig | -| `status` | `string` | Delegation status of the account's Algo: * Offline - indicates that the associated account is delegated. * Online - indicates that the associated account used as part of the delegation pool. * NotParticipating - indicates that the associated account is neither a delegator nor a delegate. | -| `totalAppsOptedIn` | `number` | The count of all applications that have been opted in, equivalent to the count of application local data (AppLocalState objects) stored in this account. | -| `totalAssetsOptedIn` | `number` | The count of all assets that have been opted in, equivalent to the count of AssetHolding objects held by this account. | -| `totalBoxBytes?` | `number` | The total number of bytes used by this account's app's box keys and values. | -| `totalBoxes?` | `number` | The number of existing boxes created by this account's app. | -| `totalCreatedApps` | `number` | The count of all apps (AppParams objects) created by this account. | -| `totalCreatedAssets` | `number` | The count of all assets (AssetParams objects) created by this account. | -| `validAsOfRound` | `bigint` | The round number for which this information is relevant. | - -#### Defined in - -[src/types/account.ts:129](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L129) - -## Variables - -### DISPENSER\_ACCOUNT - -• `Const` **DISPENSER\_ACCOUNT**: ``"DISPENSER"`` - -The account name identifier used for fund dispensing in test environments - -#### Defined in - -[src/types/account.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L17) diff --git a/docs/code/modules/types_account_manager.md b/docs/code/modules/types_account_manager.md deleted file mode 100644 index 350a05f4..00000000 --- a/docs/code/modules/types_account_manager.md +++ /dev/null @@ -1,48 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/account-manager - -# Module: types/account-manager - -## Table of contents - -### Classes - -- [AccountManager](../classes/types_account_manager.AccountManager.md) - -### Interfaces - -- [EnsureFundedResult](../interfaces/types_account_manager.EnsureFundedResult.md) - -### Functions - -- [getAccountTransactionSigner](types_account_manager.md#getaccounttransactionsigner) - -## Functions - -### getAccountTransactionSigner - -▸ **getAccountTransactionSigner**(`val`): `TransactionSigner` - -Returns a `TransactionSigner` for the given account that can sign a transaction. -This function has memoization, so will return the same transaction signer for a given account. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `val` | [`MultisigAccount`](../classes/types_account.MultisigAccount.md) \| `default` \| [`SigningAccount`](../classes/types_account.SigningAccount.md) \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) \| `LogicSigAccount` | - -#### Returns - -`TransactionSigner` - -A transaction signer - -**`Example`** - -```typescript -const signer = getAccountTransactionSigner(account) -``` - -#### Defined in - -[src/types/account-manager.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L35) diff --git a/docs/code/modules/types_account_manager_spec.md b/docs/code/modules/types_account_manager_spec.md deleted file mode 100644 index b23ce63b..00000000 --- a/docs/code/modules/types_account_manager_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/account-manager.spec - -# Module: types/account-manager.spec diff --git a/docs/code/modules/types_algo_http_client_with_retry.md b/docs/code/modules/types_algo_http_client_with_retry.md deleted file mode 100644 index eab9cd99..00000000 --- a/docs/code/modules/types_algo_http_client_with_retry.md +++ /dev/null @@ -1,9 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/algo-http-client-with-retry - -# Module: types/algo-http-client-with-retry - -## Table of contents - -### Classes - -- [AlgoHttpClientWithRetry](../classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md) diff --git a/docs/code/modules/types_algorand_client.md b/docs/code/modules/types_algorand_client.md deleted file mode 100644 index 434929f7..00000000 --- a/docs/code/modules/types_algorand_client.md +++ /dev/null @@ -1,9 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/algorand-client - -# Module: types/algorand-client - -## Table of contents - -### Classes - -- [AlgorandClient](../classes/types_algorand_client.AlgorandClient.md) diff --git a/docs/code/modules/types_algorand_client_asset_spec.md b/docs/code/modules/types_algorand_client_asset_spec.md deleted file mode 100644 index 7b7d0d62..00000000 --- a/docs/code/modules/types_algorand_client_asset_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/algorand-client.asset.spec - -# Module: types/algorand-client.asset.spec diff --git a/docs/code/modules/types_algorand_client_spec.md b/docs/code/modules/types_algorand_client_spec.md deleted file mode 100644 index 2a3fb2a0..00000000 --- a/docs/code/modules/types_algorand_client_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/algorand-client.spec - -# Module: types/algorand-client.spec diff --git a/docs/code/modules/types_algorand_client_transaction_creator.md b/docs/code/modules/types_algorand_client_transaction_creator.md deleted file mode 100644 index e6433b17..00000000 --- a/docs/code/modules/types_algorand_client_transaction_creator.md +++ /dev/null @@ -1,9 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/algorand-client-transaction-creator - -# Module: types/algorand-client-transaction-creator - -## Table of contents - -### Classes - -- [AlgorandClientTransactionCreator](../classes/types_algorand_client_transaction_creator.AlgorandClientTransactionCreator.md) diff --git a/docs/code/modules/types_algorand_client_transaction_sender.md b/docs/code/modules/types_algorand_client_transaction_sender.md deleted file mode 100644 index 92412c20..00000000 --- a/docs/code/modules/types_algorand_client_transaction_sender.md +++ /dev/null @@ -1,9 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/algorand-client-transaction-sender - -# Module: types/algorand-client-transaction-sender - -## Table of contents - -### Classes - -- [AlgorandClientTransactionSender](../classes/types_algorand_client_transaction_sender.AlgorandClientTransactionSender.md) diff --git a/docs/code/modules/types_algorand_client_transfer_spec.md b/docs/code/modules/types_algorand_client_transfer_spec.md deleted file mode 100644 index 6987b9a6..00000000 --- a/docs/code/modules/types_algorand_client_transfer_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/algorand-client.transfer.spec - -# Module: types/algorand-client.transfer.spec diff --git a/docs/code/modules/types_amount.md b/docs/code/modules/types_amount.md deleted file mode 100644 index 43c8ec04..00000000 --- a/docs/code/modules/types_amount.md +++ /dev/null @@ -1,9 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/amount - -# Module: types/amount - -## Table of contents - -### Classes - -- [AlgoAmount](../classes/types_amount.AlgoAmount.md) diff --git a/docs/code/modules/types_amount_spec.md b/docs/code/modules/types_amount_spec.md deleted file mode 100644 index 7d6ebe8c..00000000 --- a/docs/code/modules/types_amount_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/amount.spec - -# Module: types/amount.spec diff --git a/docs/code/modules/types_app.md b/docs/code/modules/types_app.md deleted file mode 100644 index 1bea6f34..00000000 --- a/docs/code/modules/types_app.md +++ /dev/null @@ -1,279 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/app - -# Module: types/app - -## Table of contents - -### Enumerations - -- [OnSchemaBreak](../enums/types_app.OnSchemaBreak.md) -- [OnUpdate](../enums/types_app.OnUpdate.md) - -### Interfaces - -- [AppCallParams](../interfaces/types_app.AppCallParams.md) -- [AppCallTransactionResultOfType](../interfaces/types_app.AppCallTransactionResultOfType.md) -- [AppCompilationResult](../interfaces/types_app.AppCompilationResult.md) -- [AppDeployMetadata](../interfaces/types_app.AppDeployMetadata.md) -- [AppDeploymentParams](../interfaces/types_app.AppDeploymentParams.md) -- [AppLookup](../interfaces/types_app.AppLookup.md) -- [AppMetadata](../interfaces/types_app.AppMetadata.md) -- [AppReference](../interfaces/types_app.AppReference.md) -- [AppState](../interfaces/types_app.AppState.md) -- [AppStorageSchema](../interfaces/types_app.AppStorageSchema.md) -- [BoxName](../interfaces/types_app.BoxName.md) -- [BoxReference](../interfaces/types_app.BoxReference.md) -- [BoxValueRequestParams](../interfaces/types_app.BoxValueRequestParams.md) -- [BoxValuesRequestParams](../interfaces/types_app.BoxValuesRequestParams.md) -- [CompiledTeal](../interfaces/types_app.CompiledTeal.md) -- [CoreAppCallArgs](../interfaces/types_app.CoreAppCallArgs.md) -- [CreateAppParams](../interfaces/types_app.CreateAppParams.md) -- [RawAppCallArgs](../interfaces/types_app.RawAppCallArgs.md) -- [TealTemplateParams](../interfaces/types_app.TealTemplateParams.md) -- [UpdateAppParams](../interfaces/types_app.UpdateAppParams.md) - -### Type Aliases - -- [ABIAppCallArg](types_app.md#abiappcallarg) -- [ABIAppCallArgs](types_app.md#abiappcallargs) -- [ABIReturn](types_app.md#abireturn) -- [AppCallArgs](types_app.md#appcallargs) -- [AppCallTransactionResult](types_app.md#appcalltransactionresult) -- [AppCallType](types_app.md#appcalltype) -- [AppReturn](types_app.md#appreturn) -- [BoxIdentifier](types_app.md#boxidentifier) -- [SendAppCreateTransactionResult](types_app.md#sendappcreatetransactionresult) -- [SendAppTransactionResult](types_app.md#sendapptransactionresult) -- [SendAppUpdateTransactionResult](types_app.md#sendappupdatetransactionresult) - -### Variables - -- [ABI\_RETURN\_PREFIX](types_app.md#abi_return_prefix) -- [APP\_DEPLOY\_NOTE\_DAPP](types_app.md#app_deploy_note_dapp) -- [APP\_PAGE\_MAX\_SIZE](types_app.md#app_page_max_size) -- [DELETABLE\_TEMPLATE\_NAME](types_app.md#deletable_template_name) -- [UPDATABLE\_TEMPLATE\_NAME](types_app.md#updatable_template_name) - -## Type Aliases - -### ABIAppCallArg - -Ƭ **ABIAppCallArg**: `ABIArgument` \| [`TransactionToSign`](../interfaces/types_transaction.TransactionToSign.md) \| `Transaction` \| `Promise`\<[`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md)\> \| [`SendTransactionResult`](../interfaces/types_transaction.SendTransactionResult.md) \| `undefined` - -An argument for an ABI method, either a primitive value, or a transaction with or without signer, or the unawaited async return value of an algokit method that returns a `SendTransactionResult` - -#### Defined in - -[src/types/app.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L102) - -___ - -### ABIAppCallArgs - -Ƭ **ABIAppCallArgs**: [`CoreAppCallArgs`](../interfaces/types_app.CoreAppCallArgs.md) & \{ `method`: `ABIMethodParams` \| `ABIMethod` ; `methodArgs`: [`ABIAppCallArg`](types_app.md#abiappcallarg)[] } - -App call args for an ABI call - -#### Defined in - -[src/types/app.ts:113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L113) - -___ - -### ABIReturn - -Ƭ **ABIReturn**: \{ `decodeError`: `undefined` ; `method`: `ABIMethod` ; `rawReturnValue`: `Uint8Array` ; `returnValue`: `ABIValue` } \| \{ `decodeError`: `Error` ; `method?`: `undefined` ; `rawReturnValue?`: `undefined` ; `returnValue?`: `undefined` } - -The return value of an ABI method call - -#### Defined in - -[src/types/app.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L235) - -___ - -### AppCallArgs - -Ƭ **AppCallArgs**: [`RawAppCallArgs`](../interfaces/types_app.RawAppCallArgs.md) \| [`ABIAppCallArgs`](types_app.md#abiappcallargs) - -Arguments to pass to an app call either: - * The raw app call values to pass through into the transaction (after processing); or - * An ABI method definition (method and args) - -#### Defined in - -[src/types/app.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L124) - -___ - -### AppCallTransactionResult - -Ƭ **AppCallTransactionResult**: [`AppCallTransactionResultOfType`](../interfaces/types_app.AppCallTransactionResultOfType.md)\<[`ABIReturn`](types_app.md#abireturn)\> - -Result from calling an app - -#### Defined in - -[src/types/app.ts:232](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L232) - -___ - -### AppCallType - -Ƭ **AppCallType**: ``"no_op"`` \| ``"opt_in"`` \| ``"close_out"`` \| ``"clear_state"`` \| ``"update_application"`` \| ``"delete_application"`` - -**`Deprecated`** - -Use `algosdk.OnApplicationComplete` directly instead. - -The type of call / [on-completion action](https://dev.algorand.co/concepts/smart-contracts/overview#smart-contract-lifecycle) for a smart contract call. - -Equivalent of `algosdk.OnApplicationComplete`, but as a more convenient string enum. - -* `no_op`: Normal smart contract call, no special on-complete action -* `opt_in`: Opt-in to smart contract local storage -* `close_out`: Close-out local storage storage -* `clear_state`: Clear local storage state -* `update_application`: Update the smart contract -* `delete_application`: Delete the smart contract - -#### Defined in - -[src/types/app.ts:180](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L180) - -___ - -### AppReturn - -Ƭ **AppReturn**\<`TReturn`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `TReturn` | - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `return?` | `TReturn` | The ABI method call return value | - -#### Defined in - -[src/types/app.ts:340](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L340) - -___ - -### BoxIdentifier - -Ƭ **BoxIdentifier**: `string` \| `Uint8Array` \| [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) - -**`Deprecated`** - -Use `types/app-manager/BoxIdentifier` instead. - -Something that identifies a box name - either a: - * `Uint8Array` - * `string` (that will be encoded to a Uint8Array) - * `SendTransactionFrom` (encoded into the public key address of the corresponding account) - -#### Defined in - -[src/types/app.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L70) - -___ - -### SendAppCreateTransactionResult - -Ƭ **SendAppCreateTransactionResult**: [`Expand`](types_expand.md#expand)\<[`SendAppUpdateTransactionResult`](types_app.md#sendappupdatetransactionresult) & \{ `appAddress`: `Address` ; `appId`: `bigint` }\> - -Result from sending a single app transaction. - -#### Defined in - -[src/types/app.ts:357](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L357) - -___ - -### SendAppTransactionResult - -Ƭ **SendAppTransactionResult**: [`Expand`](types_expand.md#expand)\<[`SendSingleTransactionResult`](types_transaction.md#sendsingletransactionresult) & \{ `return?`: [`ABIReturn`](types_app.md#abireturn) }\> - -Result from sending a single app transaction. - -#### Defined in - -[src/types/app.ts:346](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L346) - -___ - -### SendAppUpdateTransactionResult - -Ƭ **SendAppUpdateTransactionResult**: [`Expand`](types_expand.md#expand)\<[`SendAppTransactionResult`](types_app.md#sendapptransactionresult) & `Partial`\<[`AppCompilationResult`](../interfaces/types_app.AppCompilationResult.md)\>\> - -Result from sending a single app transaction. - -#### Defined in - -[src/types/app.ts:354](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L354) - -## Variables - -### ABI\_RETURN\_PREFIX - -• `Const` **ABI\_RETURN\_PREFIX**: `Uint8Array` - -First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values - -#### Defined in - -[src/types/app.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L36) - -___ - -### APP\_DEPLOY\_NOTE\_DAPP - -• `Const` **APP\_DEPLOY\_NOTE\_DAPP**: ``"ALGOKIT_DEPLOYER"`` - -The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix - -#### Defined in - -[src/types/app.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L30) - -___ - -### APP\_PAGE\_MAX\_SIZE - -• `Const` **APP\_PAGE\_MAX\_SIZE**: ``2048`` - -The maximum number of bytes in a single app code page - -#### Defined in - -[src/types/app.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L33) - -___ - -### DELETABLE\_TEMPLATE\_NAME - -• `Const` **DELETABLE\_TEMPLATE\_NAME**: ``"TMPL_DELETABLE"`` - -The name of the TEAL template variable for deploy-time permanence control - -#### Defined in - -[src/types/app.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L27) - -___ - -### UPDATABLE\_TEMPLATE\_NAME - -• `Const` **UPDATABLE\_TEMPLATE\_NAME**: ``"TMPL_UPDATABLE"`` - -The name of the TEAL template variable for deploy-time immutability control - -#### Defined in - -[src/types/app.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L24) diff --git a/docs/code/modules/types_app_arc56.md b/docs/code/modules/types_app_arc56.md deleted file mode 100644 index 676a48ca..00000000 --- a/docs/code/modules/types_app_arc56.md +++ /dev/null @@ -1,346 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/app-arc56 - -# Module: types/app-arc56 - -## Table of contents - -### Classes - -- [Arc56Method](../classes/types_app_arc56.Arc56Method.md) - -### Interfaces - -- [Arc56Contract](../interfaces/types_app_arc56.Arc56Contract.md) -- [Event](../interfaces/types_app_arc56.Event.md) -- [Method](../interfaces/types_app_arc56.Method.md) -- [ProgramSourceInfo](../interfaces/types_app_arc56.ProgramSourceInfo.md) -- [StorageKey](../interfaces/types_app_arc56.StorageKey.md) -- [StorageMap](../interfaces/types_app_arc56.StorageMap.md) -- [StructField](../interfaces/types_app_arc56.StructField.md) - -### Type Aliases - -- [ABIStruct](types_app_arc56.md#abistruct) -- [ABIType](types_app_arc56.md#abitype) -- [AVMBytes](types_app_arc56.md#avmbytes) -- [AVMString](types_app_arc56.md#avmstring) -- [AVMType](types_app_arc56.md#avmtype) -- [AVMUint64](types_app_arc56.md#avmuint64) -- [Arc56MethodArg](types_app_arc56.md#arc56methodarg) -- [Arc56MethodReturnType](types_app_arc56.md#arc56methodreturntype) -- [StructName](types_app_arc56.md#structname) - -### Functions - -- [getABIDecodedValue](types_app_arc56.md#getabidecodedvalue) -- [getABIEncodedValue](types_app_arc56.md#getabiencodedvalue) -- [getABIStructFromABITuple](types_app_arc56.md#getabistructfromabituple) -- [getABITupleFromABIStruct](types_app_arc56.md#getabituplefromabistruct) -- [getABITupleTypeFromABIStructDefinition](types_app_arc56.md#getabitupletypefromabistructdefinition) -- [getArc56Method](types_app_arc56.md#getarc56method) -- [getArc56ReturnValue](types_app_arc56.md#getarc56returnvalue) - -## Type Aliases - -### ABIStruct - -Ƭ **ABIStruct**: `Object` - -Decoded ARC-56 struct as a struct rather than a tuple. - -#### Index signature - -▪ [key: `string`]: [`ABIStruct`](types_app_arc56.md#abistruct) \| `algosdk.ABIValue` - -#### Defined in - -[src/types/app-arc56.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L108) - -___ - -### ABIType - -Ƭ **ABIType**: `string` - -An ABI-encoded type - -#### Defined in - -[src/types/app-arc56.ts:436](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L436) - -___ - -### AVMBytes - -Ƭ **AVMBytes**: ``"AVMBytes"`` - -Raw byteslice without the length prefixed that is specified in ARC-4 - -#### Defined in - -[src/types/app-arc56.ts:442](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L442) - -___ - -### AVMString - -Ƭ **AVMString**: ``"AVMString"`` - -A utf-8 string without the length prefix that is specified in ARC-4 - -#### Defined in - -[src/types/app-arc56.ts:445](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L445) - -___ - -### AVMType - -Ƭ **AVMType**: [`AVMBytes`](types_app_arc56.md#avmbytes) \| [`AVMString`](types_app_arc56.md#avmstring) \| [`AVMUint64`](types_app_arc56.md#avmuint64) - -A native AVM type - -#### Defined in - -[src/types/app-arc56.ts:451](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L451) - -___ - -### AVMUint64 - -Ƭ **AVMUint64**: ``"AVMUint64"`` - -A 64-bit unsigned integer - -#### Defined in - -[src/types/app-arc56.ts:448](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L448) - -___ - -### Arc56MethodArg - -Ƭ **Arc56MethodArg**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`Method`](../interfaces/types_app_arc56.Method.md)[``"args"``][`number`], ``"type"``\> & \{ `type`: `algosdk.ABIArgumentType` }\> - -Type to describe an argument within an `Arc56Method`. - -#### Defined in - -[src/types/app-arc56.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L6) - -___ - -### Arc56MethodReturnType - -Ƭ **Arc56MethodReturnType**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`Method`](../interfaces/types_app_arc56.Method.md)[``"returns"``], ``"type"``\> & \{ `type`: `algosdk.ABIReturnType` }\> - -Type to describe a return type within an `Arc56Method`. - -#### Defined in - -[src/types/app-arc56.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L13) - -___ - -### StructName - -Ƭ **StructName**: `string` - -The name of a defined struct - -#### Defined in - -[src/types/app-arc56.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L439) - -## Functions - -### getABIDecodedValue - -▸ **getABIDecodedValue**(`value`, `type`, `structs`): `algosdk.ABIValue` \| [`ABIStruct`](types_app_arc56.md#abistruct) - -Returns the decoded ABI value (or struct for a struct type) -for the given raw Algorand value given an ARC-56 type and defined ARC-56 structs. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `value` | `number` \| `bigint` \| `Uint8Array` | The raw Algorand value (bytes or uint64) | -| `type` | `string` | The ARC-56 type - either an ABI Type string or a struct name | -| `structs` | `Record`\<`string`, [`StructField`](../interfaces/types_app_arc56.StructField.md)[]\> | The defined ARC-56 structs | - -#### Returns - -`algosdk.ABIValue` \| [`ABIStruct`](types_app_arc56.md#abistruct) - -The decoded ABI value or struct - -#### Defined in - -[src/types/app-arc56.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L120) - -___ - -### getABIEncodedValue - -▸ **getABIEncodedValue**(`value`, `type`, `structs`): `Uint8Array` - -Returns the ABI-encoded value for the given value. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `value` | `ABIValue` \| [`ABIStruct`](types_app_arc56.md#abistruct) | The value to encode either already in encoded binary form (`Uint8Array`), a decoded ABI value or an ARC-56 struct | -| `type` | `string` | The ARC-56 type - either an ABI Type string or a struct name | -| `structs` | `Record`\<`string`, [`StructField`](../interfaces/types_app_arc56.StructField.md)[]\> | The defined ARC-56 structs | - -#### Returns - -`Uint8Array` - -The binary ABI-encoded value - -#### Defined in - -[src/types/app-arc56.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L142) - -___ - -### getABIStructFromABITuple - -▸ **getABIStructFromABITuple**\<`TReturn`\>(`decodedABITuple`, `structFields`, `structs`): `TReturn` - -Converts a decoded ABI tuple as a struct. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TReturn` | extends [`ABIStruct`](types_app_arc56.md#abistruct) = `Record`\<`string`, `any`\> | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `decodedABITuple` | `ABIValue`[] | The decoded ABI tuple value | -| `structFields` | [`StructField`](../interfaces/types_app_arc56.StructField.md)[] | The struct fields from an ARC-56 app spec | -| `structs` | `Record`\<`string`, [`StructField`](../interfaces/types_app_arc56.StructField.md)[]\> | - | - -#### Returns - -`TReturn` - -The struct as a Record - -#### Defined in - -[src/types/app-arc56.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L70) - -___ - -### getABITupleFromABIStruct - -▸ **getABITupleFromABIStruct**(`struct`, `structFields`, `structs`): `algosdk.ABIValue`[] - -Converts an ARC-56 struct as an ABI tuple. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `struct` | [`ABIStruct`](types_app_arc56.md#abistruct) | The struct to convert | -| `structFields` | [`StructField`](../interfaces/types_app_arc56.StructField.md)[] | The struct fields from an ARC-56 app spec | -| `structs` | `Record`\<`string`, [`StructField`](../interfaces/types_app_arc56.StructField.md)[]\> | - | - -#### Returns - -`algosdk.ABIValue`[] - -The struct as a decoded ABI tuple - -#### Defined in - -[src/types/app-arc56.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L94) - -___ - -### getABITupleTypeFromABIStructDefinition - -▸ **getABITupleTypeFromABIStructDefinition**(`struct`, `structs`): `algosdk.ABITupleType` - -Returns the `ABITupleType` for the given ARC-56 struct definition - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `struct` | [`StructField`](../interfaces/types_app_arc56.StructField.md)[] | The ARC-56 struct definition | -| `structs` | `Record`\<`string`, [`StructField`](../interfaces/types_app_arc56.StructField.md)[]\> | - | - -#### Returns - -`algosdk.ABITupleType` - -The `ABITupleType` - -#### Defined in - -[src/types/app-arc56.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L48) - -___ - -### getArc56Method - -▸ **getArc56Method**(`methodNameOrSignature`, `appSpec`): [`Arc56Method`](../classes/types_app_arc56.Arc56Method.md) - -Returns the ARC-56 ABI method object for a given method name or signature and ARC-56 app spec. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `methodNameOrSignature` | `string` | The method name or method signature to call if an ABI call is being emitted. e.g. `my_method` or `my_method(unit64,string)bytes` | -| `appSpec` | [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) | The app spec for the app | - -#### Returns - -[`Arc56Method`](../classes/types_app_arc56.Arc56Method.md) - -The `Arc56Method` - -#### Defined in - -[src/types/app-arc56.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L172) - -___ - -### getArc56ReturnValue - -▸ **getArc56ReturnValue**\<`TReturn`\>(`returnValue`, `method`, `structs`): `TReturn` - -Checks for decode errors on the AppCallTransactionResult and maps the return value to the specified generic type - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TReturn` | extends `undefined` \| `ABIValue` \| [`ABIStruct`](types_app_arc56.md#abistruct) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `returnValue` | `undefined` \| [`ABIReturn`](types_app.md#abireturn) | The smart contract response | -| `method` | [`Method`](../interfaces/types_app_arc56.Method.md) \| [`Arc56Method`](../classes/types_app_arc56.Arc56Method.md) | The method that was called | -| `structs` | `Record`\<`string`, [`StructField`](../interfaces/types_app_arc56.StructField.md)[]\> | The struct fields from the app spec | - -#### Returns - -`TReturn` - -The smart contract response with an updated return value - -#### Defined in - -[src/types/app-arc56.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L203) diff --git a/docs/code/modules/types_app_client.md b/docs/code/modules/types_app_client.md deleted file mode 100644 index 9bf2c350..00000000 --- a/docs/code/modules/types_app_client.md +++ /dev/null @@ -1,347 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/app-client - -# Module: types/app-client - -## Table of contents - -### Classes - -- [AppClient](../classes/types_app_client.AppClient.md) -- [ApplicationClient](../classes/types_app_client.ApplicationClient.md) - -### Interfaces - -- [AppClientCallABIArgs](../interfaces/types_app_client.AppClientCallABIArgs.md) -- [AppClientCallCoreParams](../interfaces/types_app_client.AppClientCallCoreParams.md) -- [AppClientCompilationParams](../interfaces/types_app_client.AppClientCompilationParams.md) -- [AppClientCompilationResult](../interfaces/types_app_client.AppClientCompilationResult.md) -- [AppClientDeployCallInterfaceParams](../interfaces/types_app_client.AppClientDeployCallInterfaceParams.md) -- [AppClientDeployCoreParams](../interfaces/types_app_client.AppClientDeployCoreParams.md) -- [AppClientDeployParams](../interfaces/types_app_client.AppClientDeployParams.md) -- [AppClientParams](../interfaces/types_app_client.AppClientParams.md) -- [AppSourceMaps](../interfaces/types_app_client.AppSourceMaps.md) -- [FundAppAccountParams](../interfaces/types_app_client.FundAppAccountParams.md) -- [ResolveAppById](../interfaces/types_app_client.ResolveAppById.md) -- [ResolveAppByIdBase](../interfaces/types_app_client.ResolveAppByIdBase.md) -- [SourceMapExport](../interfaces/types_app_client.SourceMapExport.md) - -### Type Aliases - -- [AppClientBareCallParams](types_app_client.md#appclientbarecallparams) -- [AppClientCallArgs](types_app_client.md#appclientcallargs) -- [AppClientCallParams](types_app_client.md#appclientcallparams) -- [AppClientCallRawArgs](types_app_client.md#appclientcallrawargs) -- [AppClientClearStateParams](types_app_client.md#appclientclearstateparams) -- [AppClientCreateOnComplete](types_app_client.md#appclientcreateoncomplete) -- [AppClientCreateParams](types_app_client.md#appclientcreateparams) -- [AppClientMethodCallParams](types_app_client.md#appclientmethodcallparams) -- [AppClientUpdateParams](types_app_client.md#appclientupdateparams) -- [AppDetails](types_app_client.md#appdetails) -- [AppDetailsBase](types_app_client.md#appdetailsbase) -- [AppSpecAppDetails](types_app_client.md#appspecappdetails) -- [AppSpecAppDetailsBase](types_app_client.md#appspecappdetailsbase) -- [AppSpecAppDetailsByCreatorAndName](types_app_client.md#appspecappdetailsbycreatorandname) -- [AppSpecAppDetailsById](types_app_client.md#appspecappdetailsbyid) -- [CallOnComplete](types_app_client.md#calloncomplete) -- [CloneAppClientParams](types_app_client.md#cloneappclientparams) -- [FundAppParams](types_app_client.md#fundappparams) -- [ResolveAppByCreatorAndName](types_app_client.md#resolveappbycreatorandname) -- [ResolveAppByCreatorAndNameBase](types_app_client.md#resolveappbycreatorandnamebase) -- [ResolveAppClientByCreatorAndName](types_app_client.md#resolveappclientbycreatorandname) -- [ResolveAppClientByNetwork](types_app_client.md#resolveappclientbynetwork) - -## Type Aliases - -### AppClientBareCallParams - -Ƭ **AppClientBareCallParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`CommonAppCallParams`](types_composer.md#commonappcallparams), ``"appId"`` \| ``"sender"`` \| ``"onComplete"``\> & \{ `sender?`: `Address` \| `string` }\> - -AppClient common parameters for a bare app call - -#### Defined in - -[src/types/app-client.ts:355](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L355) - -___ - -### AppClientCallArgs - -Ƭ **AppClientCallArgs**: [`AppClientCallRawArgs`](types_app_client.md#appclientcallrawargs) \| [`AppClientCallABIArgs`](../interfaces/types_app_client.AppClientCallABIArgs.md) - -The arguments to pass to an Application Client smart contract call - -#### Defined in - -[src/types/app-client.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L205) - -___ - -### AppClientCallParams - -Ƭ **AppClientCallParams**: [`AppClientCallArgs`](types_app_client.md#appclientcallargs) & [`AppClientCallCoreParams`](../interfaces/types_app_client.AppClientCallCoreParams.md) - -Parameters to construct a ApplicationClient contract call - -#### Defined in - -[src/types/app-client.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L218) - -___ - -### AppClientCallRawArgs - -Ƭ **AppClientCallRawArgs**: [`RawAppCallArgs`](../interfaces/types_app.RawAppCallArgs.md) - -#### Defined in - -[src/types/app-client.ts:197](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L197) - -___ - -### AppClientClearStateParams - -Ƭ **AppClientClearStateParams**: [`AppClientCallRawArgs`](types_app_client.md#appclientcallrawargs) & [`AppClientCallCoreParams`](../interfaces/types_app_client.AppClientCallCoreParams.md) - -Parameters to construct a ApplicationClient clear state contract call - -#### Defined in - -[src/types/app-client.ts:221](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L221) - -___ - -### AppClientCreateOnComplete - -Ƭ **AppClientCreateOnComplete**: `Object` - -On-complete action parameter for creating a contract using ApplicationClient - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onCompleteAction?` | `Exclude`\<[`AppCallType`](types_app.md#appcalltype), ``"clear_state"``\> \| `Exclude`\<`OnApplicationComplete`, `OnApplicationComplete.ClearStateOC`\> | Override the on-completion action for the create call; defaults to NoOp | - -#### Defined in - -[src/types/app-client.ts:233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L233) - -___ - -### AppClientCreateParams - -Ƭ **AppClientCreateParams**: [`AppClientCallParams`](types_app_client.md#appclientcallparams) & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`AppClientCreateOnComplete`](types_app_client.md#appclientcreateoncomplete) & \{ `schema?`: `Partial`\<[`AppStorageSchema`](../interfaces/types_app.AppStorageSchema.md)\> } - -Parameters for creating a contract using ApplicationClient - -#### Defined in - -[src/types/app-client.ts:239](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L239) - -___ - -### AppClientMethodCallParams - -Ƭ **AppClientMethodCallParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`CommonAppCallParams`](types_composer.md#commonappcallparams), ``"appId"`` \| ``"sender"`` \| ``"method"`` \| ``"args"``\> & \{ `args?`: (`ABIValue` \| [`ABIStruct`](types_app_arc56.md#abistruct) \| [`AppMethodCallTransactionArgument`](types_composer.md#appmethodcalltransactionargument) \| `undefined`)[] ; `method`: `string` ; `sender?`: `Address` \| `string` }\> - -AppClient common parameters for an ABI method call - -#### Defined in - -[src/types/app-client.ts:363](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L363) - -___ - -### AppClientUpdateParams - -Ƭ **AppClientUpdateParams**: [`AppClientCallParams`](types_app_client.md#appclientcallparams) & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) - -Parameters for updating a contract using ApplicationClient - -#### Defined in - -[src/types/app-client.ts:247](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L247) - -___ - -### AppDetails - -Ƭ **AppDetails**: [`AppDetailsBase`](types_app_client.md#appdetailsbase) & [`ResolveAppById`](../interfaces/types_app_client.ResolveAppById.md) \| [`ResolveAppByCreatorAndName`](types_app_client.md#resolveappbycreatorandname) - -The details of an AlgoKit Utils deployed app - -#### Defined in - -[src/types/app-client.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L135) - -___ - -### AppDetailsBase - -Ƭ **AppDetailsBase**: `Object` - -The details of an AlgoKit Utils deployed app - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `deployTimeParams?` | [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) | Optionally provide any deploy-time parameters to replace in the TEAL code; if specified here will get used in calls to `deploy`, `create` and `update` unless overridden in those calls | -| `params?` | `SuggestedParams` | Default suggested params object to use | -| `sender?` | [`SendTransactionFrom`](types_transaction.md#sendtransactionfrom) | Default sender to use for transactions issued by this application client | - -#### Defined in - -[src/types/app-client.ts:123](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L123) - -___ - -### AppSpecAppDetails - -Ƭ **AppSpecAppDetails**: [`AppSpecAppDetailsBase`](types_app_client.md#appspecappdetailsbase) & [`AppDetails`](types_app_client.md#appdetails) - -The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app - -#### Defined in - -[src/types/app-client.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L153) - -___ - -### AppSpecAppDetailsBase - -Ƭ **AppSpecAppDetailsBase**: `Object` - -The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `app` | [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) \| `string` | The ARC-0032 application spec as either: * Parsed JSON `AppSpec` * Raw JSON string | - -#### Defined in - -[src/types/app-client.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L138) - -___ - -### AppSpecAppDetailsByCreatorAndName - -Ƭ **AppSpecAppDetailsByCreatorAndName**: [`AppSpecAppDetailsBase`](types_app_client.md#appspecappdetailsbase) & [`AppDetailsBase`](types_app_client.md#appdetailsbase) & [`ResolveAppByCreatorAndNameBase`](types_app_client.md#resolveappbycreatorandnamebase) - -The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by creator and name - -#### Defined in - -[src/types/app-client.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L150) - -___ - -### AppSpecAppDetailsById - -Ƭ **AppSpecAppDetailsById**: [`AppSpecAppDetailsBase`](types_app_client.md#appspecappdetailsbase) & [`AppDetailsBase`](types_app_client.md#appdetailsbase) & [`ResolveAppByIdBase`](../interfaces/types_app_client.ResolveAppByIdBase.md) - -The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by id - -#### Defined in - -[src/types/app-client.ts:147](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L147) - -___ - -### CallOnComplete - -Ƭ **CallOnComplete**: `Object` - -onComplete parameter for a non-update app call - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `onComplete?` | `Exclude`\<`OnApplicationComplete`, `OnApplicationComplete.UpdateApplicationOC`\> | On-complete of the call; defaults to no-op | - -#### Defined in - -[src/types/app-client.ts:349](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L349) - -___ - -### CloneAppClientParams - -Ƭ **CloneAppClientParams**: [`Expand`](types_expand.md#expand)\<`Partial`\<`Omit`\<[`AppClientParams`](../interfaces/types_app_client.AppClientParams.md), ``"algorand"`` \| ``"appSpec"``\>\>\> - -Parameters to clone an app client - -#### Defined in - -[src/types/app-client.ts:346](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L346) - -___ - -### FundAppParams - -Ƭ **FundAppParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`PaymentParams`](types_composer.md#paymentparams), ``"receiver"`` \| ``"sender"``\> & [`SendParams`](../interfaces/types_transaction.SendParams.md) & \{ `sender?`: `Address` \| `string` }\> - -Parameters for funding an app account - -#### Defined in - -[src/types/app-client.ts:388](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L388) - -___ - -### ResolveAppByCreatorAndName - -Ƭ **ResolveAppByCreatorAndName**: [`ResolveAppByCreatorAndNameBase`](types_app_client.md#resolveappbycreatorandnamebase) & \{ `resolveBy`: ``"creatorAndName"`` } - -Configuration to resolve app by creator and name `getCreatorAppsByName` - -#### Defined in - -[src/types/app-client.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L104) - -___ - -### ResolveAppByCreatorAndNameBase - -Ƭ **ResolveAppByCreatorAndNameBase**: `Object` - -Configuration to resolve app by creator and name `getCreatorAppsByName` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `creatorAddress` | `Address` \| `string` | The address of the app creator account to resolve the app by | -| `findExistingUsing` | `Indexer` \| [`AppLookup`](../interfaces/types_app.AppLookup.md) | The mechanism to find an existing app instance metadata for the given creator and name; either: * An indexer instance to search the creator account apps; or * The cached value of the existing apps for the given creator from `getCreatorAppsByName` | -| `name?` | `string` | The optional name override to resolve the app by within the creator account (default: uses the name in the ABI contract) | - -#### Defined in - -[src/types/app-client.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L91) - -___ - -### ResolveAppClientByCreatorAndName - -Ƭ **ResolveAppClientByCreatorAndName**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppClientParams`](../interfaces/types_app_client.AppClientParams.md), ``"appId"``\> & \{ `appLookupCache?`: [`AppLookup`](../interfaces/types_app_deployer.AppLookup.md) ; `creatorAddress`: `Address` \| `string` ; `ignoreCache?`: `boolean` }\> - -Resolve an app client instance by looking up an app created by the given creator with the given name - -#### Defined in - -[src/types/app-client.ts:397](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L397) - -___ - -### ResolveAppClientByNetwork - -Ƭ **ResolveAppClientByNetwork**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppClientParams`](../interfaces/types_app_client.AppClientParams.md), ``"appId"``\>\> - -Resolve an app client instance by looking up the current network. - -#### Defined in - -[src/types/app-client.ts:411](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L411) diff --git a/docs/code/modules/types_app_client_spec.md b/docs/code/modules/types_app_client_spec.md deleted file mode 100644 index 7811b27e..00000000 --- a/docs/code/modules/types_app_client_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/app-client.spec - -# Module: types/app-client.spec diff --git a/docs/code/modules/types_app_deployer.md b/docs/code/modules/types_app_deployer.md deleted file mode 100644 index 2005dce9..00000000 --- a/docs/code/modules/types_app_deployer.md +++ /dev/null @@ -1,93 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/app-deployer - -# Module: types/app-deployer - -## Table of contents - -### Classes - -- [AppDeployer](../classes/types_app_deployer.AppDeployer.md) - -### Interfaces - -- [AppLookup](../interfaces/types_app_deployer.AppLookup.md) -- [AppMetadata](../interfaces/types_app_deployer.AppMetadata.md) - -### Type Aliases - -- [AppDeployParams](types_app_deployer.md#appdeployparams) -- [AppDeployResult](types_app_deployer.md#appdeployresult) -- [DeployAppDeleteMethodCall](types_app_deployer.md#deployappdeletemethodcall) -- [DeployAppDeleteParams](types_app_deployer.md#deployappdeleteparams) -- [DeployAppUpdateMethodCall](types_app_deployer.md#deployappupdatemethodcall) -- [DeployAppUpdateParams](types_app_deployer.md#deployappupdateparams) - -## Type Aliases - -### AppDeployParams - -Ƭ **AppDeployParams**: [`Expand`](types_expand.md#expand)\<[`SendParams`](../interfaces/types_transaction.SendParams.md) & \{ `createParams`: [`AppCreateParams`](types_composer.md#appcreateparams) \| [`AppCreateMethodCall`](types_composer.md#appcreatemethodcall) ; `deleteParams`: [`DeployAppDeleteParams`](types_app_deployer.md#deployappdeleteparams) \| [`DeployAppDeleteMethodCall`](types_app_deployer.md#deployappdeletemethodcall) ; `deployTimeParams?`: [`TealTemplateParams`](../interfaces/types_app.TealTemplateParams.md) ; `existingDeployments?`: [`AppLookup`](../interfaces/types_app_deployer.AppLookup.md) ; `ignoreCache?`: `boolean` ; `metadata`: [`AppDeployMetadata`](../interfaces/types_app.AppDeployMetadata.md) ; `onSchemaBreak?`: ``"replace"`` \| ``"fail"`` \| ``"append"`` \| [`OnSchemaBreak`](../enums/types_app.OnSchemaBreak.md) ; `onUpdate?`: ``"update"`` \| ``"replace"`` \| ``"fail"`` \| ``"append"`` \| [`OnUpdate`](../enums/types_app.OnUpdate.md) ; `updateParams`: [`DeployAppUpdateParams`](types_app_deployer.md#deployappupdateparams) \| [`DeployAppUpdateMethodCall`](types_app_deployer.md#deployappupdatemethodcall) }\> - -The parameters to idempotently deploy an app - -#### Defined in - -[src/types/app-deployer.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L39) - -___ - -### AppDeployResult - -Ƭ **AppDeployResult**: [`Expand`](types_expand.md#expand)\<\{ `operationPerformed`: ``"create"`` } & `Omit`\<[`AppMetadata`](../interfaces/types_app_deployer.AppMetadata.md), ``"appId"`` \| ``"appAddress"``\> & [`SendAppCreateTransactionResult`](types_app.md#sendappcreatetransactionresult)\> \| [`Expand`](types_expand.md#expand)\<\{ `operationPerformed`: ``"update"`` } & [`AppMetadata`](../interfaces/types_app_deployer.AppMetadata.md) & [`SendAppUpdateTransactionResult`](types_app.md#sendappupdatetransactionresult)\> \| [`Expand`](types_expand.md#expand)\<\{ `operationPerformed`: ``"replace"`` } & `Omit`\<[`AppMetadata`](../interfaces/types_app_deployer.AppMetadata.md), ``"appId"`` \| ``"appAddress"``\> & [`SendAppCreateTransactionResult`](types_app.md#sendappcreatetransactionresult) & \{ `deleteResult`: [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md) ; `deleteReturn?`: [`ABIReturn`](types_app.md#abireturn) }\> \| [`Expand`](types_expand.md#expand)\<\{ `operationPerformed`: ``"nothing"`` } & [`AppMetadata`](../interfaces/types_app_deployer.AppMetadata.md)\> - -#### Defined in - -[src/types/app-deployer.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L99) - -___ - -### DeployAppDeleteMethodCall - -Ƭ **DeployAppDeleteMethodCall**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppDeleteMethodCall`](types_composer.md#appdeletemethodcall), ``"appId"``\>\> - -Params to specify a delete method call for an app deployment - -#### Defined in - -[src/types/app-deployer.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L36) - -___ - -### DeployAppDeleteParams - -Ƭ **DeployAppDeleteParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppDeleteParams`](types_composer.md#appdeleteparams), ``"appId"``\>\> - -Params to specify a transaction for an app deployment - -#### Defined in - -[src/types/app-deployer.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L34) - -___ - -### DeployAppUpdateMethodCall - -Ƭ **DeployAppUpdateMethodCall**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppUpdateMethodCall`](types_composer.md#appupdatemethodcall), ``"appId"`` \| ``"approvalProgram"`` \| ``"clearStateProgram"``\>\> - -Params to specify an update method call for an app deployment - -#### Defined in - -[src/types/app-deployer.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L32) - -___ - -### DeployAppUpdateParams - -Ƭ **DeployAppUpdateParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppUpdateParams`](types_composer.md#appupdateparams), ``"appId"`` \| ``"approvalProgram"`` \| ``"clearStateProgram"``\>\> - -Params to specify an update transaction for an app deployment - -#### Defined in - -[src/types/app-deployer.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L30) diff --git a/docs/code/modules/types_app_factory.md b/docs/code/modules/types_app_factory.md deleted file mode 100644 index 7d8f752c..00000000 --- a/docs/code/modules/types_app_factory.md +++ /dev/null @@ -1,124 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/app-factory - -# Module: types/app-factory - -## Table of contents - -### Classes - -- [AppFactory](../classes/types_app_factory.AppFactory.md) - -### Interfaces - -- [AppFactoryParams](../interfaces/types_app_factory.AppFactoryParams.md) - -### Type Aliases - -- [AppFactoryAppClientParams](types_app_factory.md#appfactoryappclientparams) -- [AppFactoryCreateMethodCallParams](types_app_factory.md#appfactorycreatemethodcallparams) -- [AppFactoryCreateParams](types_app_factory.md#appfactorycreateparams) -- [AppFactoryDeployParams](types_app_factory.md#appfactorydeployparams) -- [AppFactoryResolveAppClientByCreatorAndNameParams](types_app_factory.md#appfactoryresolveappclientbycreatorandnameparams) -- [CreateOnComplete](types_app_factory.md#createoncomplete) -- [CreateSchema](types_app_factory.md#createschema) - -## Type Aliases - -### AppFactoryAppClientParams - -Ƭ **AppFactoryAppClientParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppClientParams`](../interfaces/types_app_client.AppClientParams.md), ``"algorand"`` \| ``"appSpec"``\>\> - -Params to get an app client by ID from an app factory. - -#### Defined in - -[src/types/app-factory.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L134) - -___ - -### AppFactoryCreateMethodCallParams - -Ƭ **AppFactoryCreateMethodCallParams**: [`Expand`](types_expand.md#expand)\<[`AppClientMethodCallParams`](types_app_client.md#appclientmethodcallparams) & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`CreateOnComplete`](types_app_factory.md#createoncomplete) & [`CreateSchema`](types_app_factory.md#createschema)\> - -Params to specify a create method call for an app - -#### Defined in - -[src/types/app-factory.ts:129](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L129) - -___ - -### AppFactoryCreateParams - -Ƭ **AppFactoryCreateParams**: [`Expand`](types_expand.md#expand)\<[`AppClientBareCallParams`](types_app_client.md#appclientbarecallparams) & [`AppClientCompilationParams`](../interfaces/types_app_client.AppClientCompilationParams.md) & [`CreateOnComplete`](types_app_factory.md#createoncomplete) & [`CreateSchema`](types_app_factory.md#createschema)\> - -Params to specify a bare (raw) create call for an app - -#### Defined in - -[src/types/app-factory.ts:126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L126) - -___ - -### AppFactoryDeployParams - -Ƭ **AppFactoryDeployParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppDeployParams`](types_app_deployer.md#appdeployparams), ``"createParams"`` \| ``"updateParams"`` \| ``"deleteParams"`` \| ``"metadata"``\> & \{ `appName?`: `string` ; `createParams?`: [`Expand`](types_expand.md#expand)\<[`AppClientMethodCallParams`](types_app_client.md#appclientmethodcallparams) & [`CreateOnComplete`](types_app_factory.md#createoncomplete) & [`CreateSchema`](types_app_factory.md#createschema)\> \| [`Expand`](types_expand.md#expand)\<[`AppClientBareCallParams`](types_app_client.md#appclientbarecallparams) & [`CreateOnComplete`](types_app_factory.md#createoncomplete) & [`CreateSchema`](types_app_factory.md#createschema)\> ; `deletable?`: `boolean` ; `deleteParams?`: [`AppClientMethodCallParams`](types_app_client.md#appclientmethodcallparams) \| [`AppClientBareCallParams`](types_app_client.md#appclientbarecallparams) ; `updatable?`: `boolean` ; `updateParams?`: [`AppClientMethodCallParams`](types_app_client.md#appclientmethodcallparams) \| [`AppClientBareCallParams`](types_app_client.md#appclientbarecallparams) }\> - -Parameters to define a deployment for an `AppFactory` - -#### Defined in - -[src/types/app-factory.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L140) - -___ - -### AppFactoryResolveAppClientByCreatorAndNameParams - -Ƭ **AppFactoryResolveAppClientByCreatorAndNameParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`ResolveAppClientByCreatorAndName`](types_app_client.md#resolveappclientbycreatorandname), ``"algorand"`` \| ``"appSpec"``\>\> - -Params to get an app client by creator address and name from an app factory. - -#### Defined in - -[src/types/app-factory.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L137) - -___ - -### CreateOnComplete - -Ƭ **CreateOnComplete**: `Object` - -onComplete parameter for a create app call - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `onComplete?` | `Exclude`\<`OnApplicationComplete`, `OnApplicationComplete.ClearStateOC`\> | - -#### Defined in - -[src/types/app-factory.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L102) - -___ - -### CreateSchema - -Ƭ **CreateSchema**: `Object` - -Specifies a schema used for creating an app - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extraProgramPages?` | `number` | Number of extra pages required for the programs. Defaults to the number needed for the programs in this call if not specified. This is immutable once the app is created. | -| `schema?` | \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } | The state schema for the app. This is immutable once the app is created. By default uses the ARC32/ARC-56 spec. | -| `schema.globalByteSlices` | `number` | The number of byte slices saved in global state. | -| `schema.globalInts` | `number` | The number of integers saved in global state. | -| `schema.localByteSlices` | `number` | The number of byte slices saved in local state. | -| `schema.localInts` | `number` | The number of integers saved in local state. | - -#### Defined in - -[src/types/app-factory.ts:107](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L107) diff --git a/docs/code/modules/types_app_factory_and_client_spec.md b/docs/code/modules/types_app_factory_and_client_spec.md deleted file mode 100644 index 3143cddb..00000000 --- a/docs/code/modules/types_app_factory_and_client_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/app-factory-and-client.spec - -# Module: types/app-factory-and-client.spec diff --git a/docs/code/modules/types_app_manager.md b/docs/code/modules/types_app_manager.md deleted file mode 100644 index fa8b9f9d..00000000 --- a/docs/code/modules/types_app_manager.md +++ /dev/null @@ -1,36 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/app-manager - -# Module: types/app-manager - -## Table of contents - -### Classes - -- [AppManager](../classes/types_app_manager.AppManager.md) - -### Interfaces - -- [AppInformation](../interfaces/types_app_manager.AppInformation.md) -- [BoxReference](../interfaces/types_app_manager.BoxReference.md) -- [BoxValueRequestParams](../interfaces/types_app_manager.BoxValueRequestParams.md) -- [BoxValuesRequestParams](../interfaces/types_app_manager.BoxValuesRequestParams.md) - -### Type Aliases - -- [BoxIdentifier](types_app_manager.md#boxidentifier) - -## Type Aliases - -### BoxIdentifier - -Ƭ **BoxIdentifier**: `string` \| `Uint8Array` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -Something that identifies an app box name - either a: - * `Uint8Array` (the actual binary of the box name) - * `string` (that will be encoded to a `Uint8Array`) - * `TransactionSignerAccount` (that will be encoded into the - public key address of the corresponding account) - -#### Defined in - -[src/types/app-manager.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L57) diff --git a/docs/code/modules/types_app_spec.md b/docs/code/modules/types_app_spec.md deleted file mode 100644 index e66569bc..00000000 --- a/docs/code/modules/types_app_spec.md +++ /dev/null @@ -1,170 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/app-spec - -# Module: types/app-spec - -## Table of contents - -### Interfaces - -- [AppSources](../interfaces/types_app_spec.AppSources.md) -- [AppSpec](../interfaces/types_app_spec.AppSpec.md) -- [CallConfig](../interfaces/types_app_spec.CallConfig.md) -- [DeclaredSchemaValueSpec](../interfaces/types_app_spec.DeclaredSchemaValueSpec.md) -- [Hint](../interfaces/types_app_spec.Hint.md) -- [ReservedSchemaValueSpec](../interfaces/types_app_spec.ReservedSchemaValueSpec.md) -- [Schema](../interfaces/types_app_spec.Schema.md) -- [SchemaSpec](../interfaces/types_app_spec.SchemaSpec.md) -- [StateSchemaSpec](../interfaces/types_app_spec.StateSchemaSpec.md) -- [Struct](../interfaces/types_app_spec.Struct.md) - -### Type Aliases - -- [ABIType](types_app_spec.md#abitype) -- [AVMType](types_app_spec.md#avmtype) -- [CallConfigValue](types_app_spec.md#callconfigvalue) -- [DefaultArgument](types_app_spec.md#defaultargument) -- [FieldName](types_app_spec.md#fieldname) -- [HintSpec](types_app_spec.md#hintspec) -- [StateSchema](types_app_spec.md#stateschema) -- [StructElement](types_app_spec.md#structelement) - -### Functions - -- [arc32ToArc56](types_app_spec.md#arc32toarc56) - -## Type Aliases - -### ABIType - -Ƭ **ABIType**: `string` - -The string name of an ABI type - -#### Defined in - -[src/types/app-spec.ts:212](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L212) - -___ - -### AVMType - -Ƭ **AVMType**: ``"uint64"`` \| ``"bytes"`` - -AVM data type - -#### Defined in - -[src/types/app-spec.ts:268](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L268) - -___ - -### CallConfigValue - -Ƭ **CallConfigValue**: ``"NEVER"`` \| ``"CALL"`` \| ``"CREATE"`` \| ``"ALL"`` - -The various call configs: - * `NEVER`: Will not be called - * `CALL`: Can be called during a non-create call i.e. app id != 0 - * `CREATE`: Can be called during a create call i.e. app id = 0 - * `ALL`: Can be during a create OR non-create call - -#### Defined in - -[src/types/app-spec.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L183) - -___ - -### DefaultArgument - -Ƭ **DefaultArgument**: \{ `data`: `ABIMethodParams` ; `source`: ``"abi-method"`` } \| \{ `data`: `string` ; `source`: ``"global-state"`` } \| \{ `data`: `string` ; `source`: ``"local-state"`` } \| \{ `data`: `string` \| `number` ; `source`: ``"constant"`` } - -Defines a strategy for obtaining a default value for a given ABI arg. - -#### Defined in - -[src/types/app-spec.ts:228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L228) - -___ - -### FieldName - -Ƭ **FieldName**: `string` - -The name of a field - -#### Defined in - -[src/types/app-spec.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L209) - -___ - -### HintSpec - -Ƭ **HintSpec**: `Record`\<`string`, [`Hint`](../interfaces/types_app_spec.Hint.md)\> - -A lookup of encoded method call spec to hint - -#### Defined in - -[src/types/app-spec.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L167) - -___ - -### StateSchema - -Ƭ **StateSchema**: `Object` - -Schema spec summary for global or local storage - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `num_byte_slices` | `number` | Number of byte slots | -| `num_uints` | `number` | Number of uint slots | - -#### Defined in - -[src/types/app-spec.ts:317](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L317) - -___ - -### StructElement - -Ƭ **StructElement**: [[`FieldName`](types_app_spec.md#fieldname), [`ABIType`](types_app_spec.md#abitype)] - -The elements of the struct/tuple: `FieldName`, `ABIType` - -#### Defined in - -[src/types/app-spec.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L215) - -## Functions - -### arc32ToArc56 - -▸ **arc32ToArc56**(`appSpec`): [`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -Converts an ARC-32 Application Specification to an ARC-56 Contract - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `appSpec` | [`AppSpec`](../interfaces/types_app_spec.AppSpec.md) | The ARC-32 Application Specification | - -#### Returns - -[`Arc56Contract`](../interfaces/types_app_arc56.Arc56Contract.md) - -The ARC-56 Contract - -**`Example`** - -```typescript -const arc56AppSpec = arc32ToArc56(arc32AppSpec) -``` - -#### Defined in - -[src/types/app-spec.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L16) diff --git a/docs/code/modules/types_asset.md b/docs/code/modules/types_asset.md deleted file mode 100644 index d4ac1a55..00000000 --- a/docs/code/modules/types_asset.md +++ /dev/null @@ -1,12 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/asset - -# Module: types/asset - -## Table of contents - -### Interfaces - -- [AssetBulkOptInOutParams](../interfaces/types_asset.AssetBulkOptInOutParams.md) -- [AssetOptInParams](../interfaces/types_asset.AssetOptInParams.md) -- [AssetOptOutParams](../interfaces/types_asset.AssetOptOutParams.md) -- [CreateAssetParams](../interfaces/types_asset.CreateAssetParams.md) diff --git a/docs/code/modules/types_asset_manager.md b/docs/code/modules/types_asset_manager.md deleted file mode 100644 index 90f4864a..00000000 --- a/docs/code/modules/types_asset_manager.md +++ /dev/null @@ -1,14 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/asset-manager - -# Module: types/asset-manager - -## Table of contents - -### Classes - -- [AssetManager](../classes/types_asset_manager.AssetManager.md) - -### Interfaces - -- [AssetInformation](../interfaces/types_asset_manager.AssetInformation.md) -- [BulkAssetOptInOutResult](../interfaces/types_asset_manager.BulkAssetOptInOutResult.md) diff --git a/docs/code/modules/types_async_event_emitter.md b/docs/code/modules/types_async_event_emitter.md deleted file mode 100644 index 6fda8746..00000000 --- a/docs/code/modules/types_async_event_emitter.md +++ /dev/null @@ -1,44 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/async-event-emitter - -# Module: types/async-event-emitter - -## Table of contents - -### Classes - -- [AsyncEventEmitter](../classes/types_async_event_emitter.AsyncEventEmitter.md) - -### Type Aliases - -- [AsyncEventListener](types_async_event_emitter.md#asynceventlistener) - -## Type Aliases - -### AsyncEventListener - -Ƭ **AsyncEventListener**\<`T`\>: (`event`: `T`, `eventName`: `string` \| `symbol`) => `Promise`\<`void`\> \| `void` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Type declaration - -▸ (`event`, `eventName`): `Promise`\<`void`\> \| `void` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `T` | -| `eventName` | `string` \| `symbol` | - -##### Returns - -`Promise`\<`void`\> \| `void` - -#### Defined in - -[src/types/async-event-emitter.ts:3](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L3) diff --git a/docs/code/modules/types_async_event_emitter_spec.md b/docs/code/modules/types_async_event_emitter_spec.md deleted file mode 100644 index a8f81215..00000000 --- a/docs/code/modules/types_async_event_emitter_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/async-event-emitter.spec - -# Module: types/async-event-emitter.spec diff --git a/docs/code/modules/types_client_manager.md b/docs/code/modules/types_client_manager.md deleted file mode 100644 index b8713d2d..00000000 --- a/docs/code/modules/types_client_manager.md +++ /dev/null @@ -1,122 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/client-manager - -# Module: types/client-manager - -## Table of contents - -### Classes - -- [ClientManager](../classes/types_client_manager.ClientManager.md) - -### Interfaces - -- [AlgoSdkClients](../interfaces/types_client_manager.AlgoSdkClients.md) -- [TypedAppClient](../interfaces/types_client_manager.TypedAppClient.md) -- [TypedAppFactory](../interfaces/types_client_manager.TypedAppFactory.md) - -### Type Aliases - -- [ClientAppClientByNetworkParams](types_client_manager.md#clientappclientbynetworkparams) -- [ClientAppClientParams](types_client_manager.md#clientappclientparams) -- [ClientAppFactoryParams](types_client_manager.md#clientappfactoryparams) -- [ClientResolveAppClientByCreatorAndNameParams](types_client_manager.md#clientresolveappclientbycreatorandnameparams) -- [ClientTypedAppClientByCreatorAndNameParams](types_client_manager.md#clienttypedappclientbycreatorandnameparams) -- [ClientTypedAppClientByNetworkParams](types_client_manager.md#clienttypedappclientbynetworkparams) -- [ClientTypedAppClientParams](types_client_manager.md#clienttypedappclientparams) -- [ClientTypedAppFactoryParams](types_client_manager.md#clienttypedappfactoryparams) - -## Type Aliases - -### ClientAppClientByNetworkParams - -Ƭ **ClientAppClientByNetworkParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppClientParams`](../interfaces/types_app_client.AppClientParams.md), ``"algorand"`` \| ``"appId"``\>\> - -Params to get an app client by network from `ClientManager`. - -#### Defined in - -[src/types/client-manager.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L33) - -___ - -### ClientAppClientParams - -Ƭ **ClientAppClientParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppClientParams`](../interfaces/types_app_client.AppClientParams.md), ``"algorand"``\>\> - -Params to get an app client by ID from `ClientManager`. - -#### Defined in - -[src/types/client-manager.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L30) - -___ - -### ClientAppFactoryParams - -Ƭ **ClientAppFactoryParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppFactoryParams`](../interfaces/types_app_factory.AppFactoryParams.md), ``"algorand"``\>\> - -Params to get an app factory from `ClientManager`. - -#### Defined in - -[src/types/client-manager.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L24) - -___ - -### ClientResolveAppClientByCreatorAndNameParams - -Ƭ **ClientResolveAppClientByCreatorAndNameParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`ResolveAppClientByCreatorAndName`](types_app_client.md#resolveappclientbycreatorandname), ``"algorand"``\>\> - -Params to get an app client by creator address and name from `ClientManager`. - -#### Defined in - -[src/types/client-manager.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L27) - -___ - -### ClientTypedAppClientByCreatorAndNameParams - -Ƭ **ClientTypedAppClientByCreatorAndNameParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`ResolveAppClientByCreatorAndName`](types_app_client.md#resolveappclientbycreatorandname), ``"algorand"`` \| ``"appSpec"``\>\> - -Params to get a typed app client by creator address and name from `ClientManager`. - -#### Defined in - -[src/types/client-manager.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L36) - -___ - -### ClientTypedAppClientByNetworkParams - -Ƭ **ClientTypedAppClientByNetworkParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppClientParams`](../interfaces/types_app_client.AppClientParams.md), ``"algorand"`` \| ``"appSpec"`` \| ``"appId"``\>\> - -Params to get a typed app client by network from `ClientManager`. - -#### Defined in - -[src/types/client-manager.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L42) - -___ - -### ClientTypedAppClientParams - -Ƭ **ClientTypedAppClientParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppClientParams`](../interfaces/types_app_client.AppClientParams.md), ``"algorand"`` \| ``"appSpec"``\>\> - -Params to get a typed app client by ID from `ClientManager`. - -#### Defined in - -[src/types/client-manager.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L39) - -___ - -### ClientTypedAppFactoryParams - -Ƭ **ClientTypedAppFactoryParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`AppFactoryParams`](../interfaces/types_app_factory.AppFactoryParams.md), ``"algorand"`` \| ``"appSpec"``\>\> - -Params to get a typed app factory from `ClientManager`. - -#### Defined in - -[src/types/client-manager.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L45) diff --git a/docs/code/modules/types_client_manager_spec.md b/docs/code/modules/types_client_manager_spec.md deleted file mode 100644 index b9db10a3..00000000 --- a/docs/code/modules/types_client_manager_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/client-manager.spec - -# Module: types/client-manager.spec diff --git a/docs/code/modules/types_composer.md b/docs/code/modules/types_composer.md deleted file mode 100644 index 9a1e0b8f..00000000 --- a/docs/code/modules/types_composer.md +++ /dev/null @@ -1,433 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/composer - -# Module: types/composer - -## Table of contents - -### Classes - -- [TransactionComposer](../classes/types_composer.TransactionComposer.md) - -### Interfaces - -- [BuiltTransactions](../interfaces/types_composer.BuiltTransactions.md) - -### Type Aliases - -- [AppCallMethodCall](types_composer.md#appcallmethodcall) -- [AppCallParams](types_composer.md#appcallparams) -- [AppCreateMethodCall](types_composer.md#appcreatemethodcall) -- [AppCreateParams](types_composer.md#appcreateparams) -- [AppDeleteMethodCall](types_composer.md#appdeletemethodcall) -- [AppDeleteParams](types_composer.md#appdeleteparams) -- [AppMethodCall](types_composer.md#appmethodcall) -- [AppMethodCallParams](types_composer.md#appmethodcallparams) -- [AppMethodCallTransactionArgument](types_composer.md#appmethodcalltransactionargument) -- [AppUpdateMethodCall](types_composer.md#appupdatemethodcall) -- [AppUpdateParams](types_composer.md#appupdateparams) -- [AssetConfigParams](types_composer.md#assetconfigparams) -- [AssetCreateParams](types_composer.md#assetcreateparams) -- [AssetDestroyParams](types_composer.md#assetdestroyparams) -- [AssetFreezeParams](types_composer.md#assetfreezeparams) -- [AssetOptInParams](types_composer.md#assetoptinparams) -- [AssetOptOutParams](types_composer.md#assetoptoutparams) -- [AssetTransferParams](types_composer.md#assettransferparams) -- [CommonAppCallParams](types_composer.md#commonappcallparams) -- [CommonTransactionParams](types_composer.md#commontransactionparams) -- [OfflineKeyRegistrationParams](types_composer.md#offlinekeyregistrationparams) -- [OnlineKeyRegistrationParams](types_composer.md#onlinekeyregistrationparams) -- [PaymentParams](types_composer.md#paymentparams) -- [RawSimulateOptions](types_composer.md#rawsimulateoptions) -- [SimulateOptions](types_composer.md#simulateoptions) -- [SkipSignaturesSimulateOptions](types_composer.md#skipsignaturessimulateoptions) -- [TransactionComposerParams](types_composer.md#transactioncomposerparams) -- [Txn](types_composer.md#txn) - -### Variables - -- [MAX\_TRANSACTION\_GROUP\_SIZE](types_composer.md#max_transaction_group_size) - -## Type Aliases - -### AppCallMethodCall - -Ƭ **AppCallMethodCall**: [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppMethodCallParams`](types_composer.md#appmethodcallparams)\> - -Parameters to define an ABI method call transaction. - -#### Defined in - -[src/types/composer.ts:426](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L426) - -___ - -### AppCallParams - -Ƭ **AppCallParams**: [`CommonAppCallParams`](types_composer.md#commonappcallparams) & \{ `onComplete?`: `Exclude`\<`algosdk.OnApplicationComplete`, `algosdk.OnApplicationComplete.UpdateApplicationOC`\> } - -Parameters to define an application call transaction. - -#### Defined in - -[src/types/composer.ts:402](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L402) - -___ - -### AppCreateMethodCall - -Ƭ **AppCreateMethodCall**: [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppCreateParams`](types_composer.md#appcreateparams)\> - -Parameters to define an ABI method call create transaction. - -#### Defined in - -[src/types/composer.ts:420](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L420) - -___ - -### AppCreateParams - -Ƭ **AppCreateParams**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`CommonAppCallParams`](types_composer.md#commonappcallparams), ``"appId"``\> & \{ `approvalProgram`: `string` \| `Uint8Array` ; `clearStateProgram`: `string` \| `Uint8Array` ; `extraProgramPages?`: `number` ; `onComplete?`: `Exclude`\<`algosdk.OnApplicationComplete`, `algosdk.OnApplicationComplete.ClearStateOC`\> ; `schema?`: \{ `globalByteSlices`: `number` ; `globalInts`: `number` ; `localByteSlices`: `number` ; `localInts`: `number` } }\> - -Parameters to define an app create transaction - -#### Defined in - -[src/types/composer.ts:365](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L365) - -___ - -### AppDeleteMethodCall - -Ƭ **AppDeleteMethodCall**: [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppDeleteParams`](types_composer.md#appdeleteparams)\> - -Parameters to define an ABI method call delete transaction. - -#### Defined in - -[src/types/composer.ts:424](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L424) - -___ - -### AppDeleteParams - -Ƭ **AppDeleteParams**: [`CommonAppCallParams`](types_composer.md#commonappcallparams) & \{ `onComplete?`: `algosdk.OnApplicationComplete.DeleteApplicationOC` } - -Parameters to define an application delete call transaction. - -#### Defined in - -[src/types/composer.ts:415](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L415) - -___ - -### AppMethodCall - -Ƭ **AppMethodCall**\<`T`\>: [`Expand`](types_expand.md#expand)\<`Omit`\<`T`, ``"args"``\>\> & \{ `args?`: (`algosdk.ABIValue` \| `TransactionWithSigner` \| `Transaction` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppCreateParams`](types_composer.md#appcreateparams)\> \| [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppUpdateParams`](types_composer.md#appupdateparams)\> \| [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppMethodCallParams`](types_composer.md#appmethodcallparams)\> \| `undefined`)[] ; `method`: `algosdk.ABIMethod` } - -Parameters to define an ABI method call. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[src/types/composer.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L439) - -___ - -### AppMethodCallParams - -Ƭ **AppMethodCallParams**: [`CommonAppCallParams`](types_composer.md#commonappcallparams) & \{ `onComplete?`: `Exclude`\<`algosdk.OnApplicationComplete`, `algosdk.OnApplicationComplete.UpdateApplicationOC` \| `algosdk.OnApplicationComplete.ClearStateOC`\> } - -Common parameters to define an ABI method call transaction. - -#### Defined in - -[src/types/composer.ts:407](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L407) - -___ - -### AppMethodCallTransactionArgument - -Ƭ **AppMethodCallTransactionArgument**: `TransactionWithSigner` \| `Transaction` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppCreateParams`](types_composer.md#appcreateparams)\> \| [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppUpdateParams`](types_composer.md#appupdateparams)\> \| [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppMethodCallParams`](types_composer.md#appmethodcallparams)\> - -Types that can be used to define a transaction argument for an ABI call transaction. - -#### Defined in - -[src/types/composer.ts:429](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L429) - -___ - -### AppUpdateMethodCall - -Ƭ **AppUpdateMethodCall**: [`AppMethodCall`](types_composer.md#appmethodcall)\<[`AppUpdateParams`](types_composer.md#appupdateparams)\> - -Parameters to define an ABI method call update transaction. - -#### Defined in - -[src/types/composer.ts:422](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L422) - -___ - -### AppUpdateParams - -Ƭ **AppUpdateParams**: [`Expand`](types_expand.md#expand)\<[`CommonAppCallParams`](types_composer.md#commonappcallparams) & \{ `approvalProgram`: `string` \| `Uint8Array` ; `clearStateProgram`: `string` \| `Uint8Array` ; `onComplete?`: `algosdk.OnApplicationComplete.UpdateApplicationOC` }\> - -Parameters to define an app update transaction - -#### Defined in - -[src/types/composer.ts:391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L391) - -___ - -### AssetConfigParams - -Ƭ **AssetConfigParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` ; `clawback?`: `string` \| `Address` ; `freeze?`: `string` \| `Address` ; `manager`: `string` \| `Address` \| `undefined` ; `reserve?`: `string` \| `Address` } - -Parameters to define an asset reconfiguration transaction. - -**Note:** The manager, reserve, freeze, and clawback addresses -are immutably empty if they are not set. If manager is not set then -all fields are immutable from that point forward. - -#### Defined in - -[src/types/composer.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L218) - -___ - -### AssetCreateParams - -Ƭ **AssetCreateParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `assetName?`: `string` ; `clawback?`: `string` \| `Address` ; `decimals?`: `number` ; `defaultFrozen?`: `boolean` ; `freeze?`: `string` \| `Address` ; `manager?`: `string` \| `Address` ; `metadataHash?`: `string` \| `Uint8Array` ; `reserve?`: `string` \| `Address` ; `total`: `bigint` ; `unitName?`: `string` ; `url?`: `string` } - -Parameters to define an asset create transaction. - -The account that sends this transaction will automatically be opted in to the asset and will hold all units after creation. - -#### Defined in - -[src/types/composer.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L102) - -___ - -### AssetDestroyParams - -Ƭ **AssetDestroyParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } - -Parameters to define an asset destroy transaction. - -Created assets can be destroyed only by the asset manager account. All of the assets must be owned by the creator of the asset before the asset can be deleted. - -#### Defined in - -[src/types/composer.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L276) - -___ - -### AssetFreezeParams - -Ƭ **AssetFreezeParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `account`: `string` \| `Address` ; `assetId`: `bigint` ; `frozen`: `boolean` } - -Parameters to define an asset freeze transaction. - -#### Defined in - -[src/types/composer.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L263) - -___ - -### AssetOptInParams - -Ƭ **AssetOptInParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` } - -Parameters to define an asset opt-in transaction. - -#### Defined in - -[src/types/composer.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L304) - -___ - -### AssetOptOutParams - -Ƭ **AssetOptOutParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `assetId`: `bigint` ; `creator`: `string` \| `Address` } - -Parameters to define an asset opt-out transaction. - -#### Defined in - -[src/types/composer.ts:310](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L310) - -___ - -### AssetTransferParams - -Ƭ **AssetTransferParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `amount`: `bigint` ; `assetId`: `bigint` ; `clawbackTarget?`: `string` \| `Address` ; `closeAssetTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } - -Parameters to define an asset transfer transaction. - -#### Defined in - -[src/types/composer.ts:282](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L282) - -___ - -### CommonAppCallParams - -Ƭ **CommonAppCallParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `accountReferences?`: (`string` \| `Address`)[] ; `appId`: `bigint` ; `appReferences?`: `bigint`[] ; `args?`: `Uint8Array`[] ; `assetReferences?`: `bigint`[] ; `boxReferences?`: ([`BoxReference`](../interfaces/types_app_manager.BoxReference.md) \| [`BoxIdentifier`](types_app_manager.md#boxidentifier))[] ; `onComplete?`: `algosdk.OnApplicationComplete` } - -Common parameters for defining an application call transaction. - -#### Defined in - -[src/types/composer.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L343) - -___ - -### CommonTransactionParams - -Ƭ **CommonTransactionParams**: `Object` - -Common parameters for defining a transaction. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `extraFee?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. | -| `firstValidRound?` | `bigint` | Set the first round this transaction is valid. If left undefined, the value from algod will be used. We recommend you only set this when you intentionally want this to be some time in the future. | -| `lastValidRound?` | `bigint` | The last round this transaction is valid. It is recommended to use `validityWindow` instead. | -| `lease?` | `Uint8Array` \| `string` | Prevent multiple transactions with the same lease being included within the validity window. A [lease](https://dev.algorand.co/concepts/transactions/leases) enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). | -| `maxFee?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. | -| `note?` | `Uint8Array` \| `string` | Note to attach to the transaction. Max of 1000 bytes. | -| `rekeyTo?` | `string` \| `Address` | Change the signing key of the sender to the given address. **Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). | -| `sender` | `string` \| `Address` | The address of the account sending the transaction. | -| `signer?` | `algosdk.TransactionSigner` \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) | The function used to sign transaction(s); if not specified then an attempt will be made to find a registered signer for the given `sender` or use a default signer (if configured). | -| `staticFee?` | [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) | The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. | -| `validityWindow?` | `number` \| `bigint` | How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. | - -#### Defined in - -[src/types/composer.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L45) - -___ - -### OfflineKeyRegistrationParams - -Ƭ **OfflineKeyRegistrationParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `preventAccountFromEverParticipatingAgain?`: `boolean` } - -Parameters to define an offline key registration transaction. - -#### Defined in - -[src/types/composer.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L337) - -___ - -### OnlineKeyRegistrationParams - -Ƭ **OnlineKeyRegistrationParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `selectionKey`: `Uint8Array` ; `stateProofKey?`: `Uint8Array` ; `voteFirst`: `bigint` ; `voteKey`: `Uint8Array` ; `voteKeyDilution`: `bigint` ; `voteLast`: `bigint` } - -Parameters to define an online key registration transaction. - -#### Defined in - -[src/types/composer.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L321) - -___ - -### PaymentParams - -Ƭ **PaymentParams**: [`CommonTransactionParams`](types_composer.md#commontransactionparams) & \{ `amount`: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md) ; `closeRemainderTo?`: `string` \| `Address` ; `receiver`: `string` \| `Address` } - -Parameters to define a payment transaction. - -#### Defined in - -[src/types/composer.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L86) - -___ - -### RawSimulateOptions - -Ƭ **RawSimulateOptions**: [`Expand`](types_expand.md#expand)\<`Omit`\<`ConstructorParameters`\[``0``], ``"txnGroups"``\>\> - -The raw API options to control a simulate request. -See algod API docs for more information: https://dev.algorand.co/reference/rest-apis/algod/#simulatetransaction - -#### Defined in - -[src/types/composer.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L39) - -___ - -### SimulateOptions - -Ƭ **SimulateOptions**: [`Expand`](types_expand.md#expand)\<`Partial`\<[`SkipSignaturesSimulateOptions`](types_composer.md#skipsignaturessimulateoptions)\> & [`RawSimulateOptions`](types_composer.md#rawsimulateoptions)\> - -All options to control a simulate request - -#### Defined in - -[src/types/composer.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L42) - -___ - -### SkipSignaturesSimulateOptions - -Ƭ **SkipSignaturesSimulateOptions**: [`Expand`](types_expand.md#expand)\<`Omit`\<[`RawSimulateOptions`](types_composer.md#rawsimulateoptions), ``"fixSigners"`` \| ``"allowEmptySignatures"``\> & \{ `skipSignatures`: `boolean` }\> - -Options to control a simulate request, that does not require transaction signing - -#### Defined in - -[src/types/composer.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L27) - -___ - -### TransactionComposerParams - -Ƭ **TransactionComposerParams**: `Object` - -Parameters to create an `TransactionComposer`. - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `algod` | `algosdk.Algodv2` | The algod client to use to get suggestedParams and send the transaction group | -| `appManager?` | [`AppManager`](../classes/types_app_manager.AppManager.md) | An existing `AppManager` to use to manage app compilation and cache compilation results. If not specified than an ephemeral one will be created. | -| `defaultValidityWindow?` | `bigint` | How many rounds a transaction should be valid for by default; if not specified then will be 10 rounds (or 1000 rounds if issuing transactions to LocalNet). | -| `getSigner` | (`address`: `string` \| `Address`) => `algosdk.TransactionSigner` | - | -| `getSuggestedParams?` | () => `Promise`\<`algosdk.SuggestedParams`\> | - | - -#### Defined in - -[src/types/composer.ts:479](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L479) - -___ - -### Txn - -Ƭ **Txn**: [`PaymentParams`](types_composer.md#paymentparams) & \{ `type`: ``"pay"`` } \| [`AssetCreateParams`](types_composer.md#assetcreateparams) & \{ `type`: ``"assetCreate"`` } \| [`AssetConfigParams`](types_composer.md#assetconfigparams) & \{ `type`: ``"assetConfig"`` } \| [`AssetFreezeParams`](types_composer.md#assetfreezeparams) & \{ `type`: ``"assetFreeze"`` } \| [`AssetDestroyParams`](types_composer.md#assetdestroyparams) & \{ `type`: ``"assetDestroy"`` } \| [`AssetTransferParams`](types_composer.md#assettransferparams) & \{ `type`: ``"assetTransfer"`` } \| [`AssetOptInParams`](types_composer.md#assetoptinparams) & \{ `type`: ``"assetOptIn"`` } \| [`AssetOptOutParams`](types_composer.md#assetoptoutparams) & \{ `type`: ``"assetOptOut"`` } \| [`AppCallParams`](types_composer.md#appcallparams) \| [`AppCreateParams`](types_composer.md#appcreateparams) \| [`AppUpdateParams`](types_composer.md#appupdateparams) & \{ `type`: ``"appCall"`` } \| [`OnlineKeyRegistrationParams`](types_composer.md#onlinekeyregistrationparams) \| [`OfflineKeyRegistrationParams`](types_composer.md#offlinekeyregistrationparams) & \{ `type`: ``"keyReg"`` } \| `algosdk.TransactionWithSigner` & \{ `type`: ``"txnWithSigner"`` } \| \{ `atc`: `algosdk.AtomicTransactionComposer` ; `type`: ``"atc"`` } \| [`AppCallMethodCall`](types_composer.md#appcallmethodcall) \| [`AppCreateMethodCall`](types_composer.md#appcreatemethodcall) \| [`AppUpdateMethodCall`](types_composer.md#appupdatemethodcall) & \{ `type`: ``"methodCall"`` } - -#### Defined in - -[src/types/composer.ts:463](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L463) - -## Variables - -### MAX\_TRANSACTION\_GROUP\_SIZE - -• `Const` **MAX\_TRANSACTION\_GROUP\_SIZE**: ``16`` - -#### Defined in - -[src/types/composer.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L24) diff --git a/docs/code/modules/types_config.md b/docs/code/modules/types_config.md deleted file mode 100644 index 966bc693..00000000 --- a/docs/code/modules/types_config.md +++ /dev/null @@ -1,13 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/config - -# Module: types/config - -## Table of contents - -### Classes - -- [UpdatableConfig](../classes/types_config.UpdatableConfig.md) - -### Interfaces - -- [Config](../interfaces/types_config.Config.md) diff --git a/docs/code/modules/types_debugging.md b/docs/code/modules/types_debugging.md deleted file mode 100644 index dc0fe6ac..00000000 --- a/docs/code/modules/types_debugging.md +++ /dev/null @@ -1,79 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/debugging - -# Module: types/debugging - -## Table of contents - -### Interfaces - -- [AVMTracesEventData](../interfaces/types_debugging.AVMTracesEventData.md) -- [TealSourceDebugEventData](../interfaces/types_debugging.TealSourceDebugEventData.md) -- [TealSourcesDebugEventData](../interfaces/types_debugging.TealSourcesDebugEventData.md) - -### Variables - -- [ALGOKIT\_DIR](types_debugging.md#algokit_dir) -- [DEFAULT\_MAX\_SEARCH\_DEPTH](types_debugging.md#default_max_search_depth) -- [SOURCES\_DIR](types_debugging.md#sources_dir) -- [TEAL\_FILE\_EXT](types_debugging.md#teal_file_ext) -- [TEAL\_SOURCEMAP\_EXT](types_debugging.md#teal_sourcemap_ext) - -## Variables - -### ALGOKIT\_DIR - -• `Const` **ALGOKIT\_DIR**: ``".algokit"`` - -The directory name for AlgoKit project related files - -#### Defined in - -[src/types/debugging.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L9) - -___ - -### DEFAULT\_MAX\_SEARCH\_DEPTH - -• `Const` **DEFAULT\_MAX\_SEARCH\_DEPTH**: ``10`` - -The default maximum search depth for file operations - -#### Defined in - -[src/types/debugging.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L21) - -___ - -### SOURCES\_DIR - -• `Const` **SOURCES\_DIR**: ``"sources"`` - -The directory name for debug source files - -#### Defined in - -[src/types/debugging.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L12) - -___ - -### TEAL\_FILE\_EXT - -• `Const` **TEAL\_FILE\_EXT**: ``".teal"`` - -The file extension for TEAL files - -#### Defined in - -[src/types/debugging.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L15) - -___ - -### TEAL\_SOURCEMAP\_EXT - -• `Const` **TEAL\_SOURCEMAP\_EXT**: ``".teal.map"`` - -The file extension for TEAL source map files - -#### Defined in - -[src/types/debugging.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L18) diff --git a/docs/code/modules/types_dispenser_client.md b/docs/code/modules/types_dispenser_client.md deleted file mode 100644 index 014fde5a..00000000 --- a/docs/code/modules/types_dispenser_client.md +++ /dev/null @@ -1,15 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/dispenser-client - -# Module: types/dispenser-client - -## Table of contents - -### Classes - -- [TestNetDispenserApiClient](../classes/types_dispenser_client.TestNetDispenserApiClient.md) - -### Interfaces - -- [DispenserFundResponse](../interfaces/types_dispenser_client.DispenserFundResponse.md) -- [DispenserLimitResponse](../interfaces/types_dispenser_client.DispenserLimitResponse.md) -- [TestNetDispenserApiClientParams](../interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md) diff --git a/docs/code/modules/types_dispenser_client_spec.md b/docs/code/modules/types_dispenser_client_spec.md deleted file mode 100644 index 1da387b6..00000000 --- a/docs/code/modules/types_dispenser_client_spec.md +++ /dev/null @@ -1,3 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/dispenser-client.spec - -# Module: types/dispenser-client.spec diff --git a/docs/code/modules/types_expand.md b/docs/code/modules/types_expand.md deleted file mode 100644 index 44f1b341..00000000 --- a/docs/code/modules/types_expand.md +++ /dev/null @@ -1,28 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/expand - -# Module: types/expand - -## Table of contents - -### Type Aliases - -- [Expand](types_expand.md#expand) - -## Type Aliases - -### Expand - -Ƭ **Expand**\<`T`\>: `T` extends (...`args`: infer A) => infer R ? (...`args`: [`Expand`](types_expand.md#expand)\<`A`\>) => [`Expand`](types_expand.md#expand)\<`R`\> : `T` extends infer O ? \{ [K in keyof O]: O[K] } : `never` - -Expands types for IntelliSense so they are more human readable -See https://stackoverflow.com/a/69288824 - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[src/types/expand.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/expand.ts#L5) diff --git a/docs/code/modules/types_indexer.md b/docs/code/modules/types_indexer.md deleted file mode 100644 index 4127fed9..00000000 --- a/docs/code/modules/types_indexer.md +++ /dev/null @@ -1,610 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/indexer - -# Module: types/indexer - -## Table of contents - -### Enumerations - -- [AccountStatus](../enums/types_indexer.AccountStatus.md) -- [ApplicationOnComplete](../enums/types_indexer.ApplicationOnComplete.md) -- [SignatureType](../enums/types_indexer.SignatureType.md) - -### Interfaces - -- [LookupAssetHoldingsOptions](../interfaces/types_indexer.LookupAssetHoldingsOptions.md) - -### Type Aliases - -- [AccountLookupResult](types_indexer.md#accountlookupresult) -- [AccountParticipation](types_indexer.md#accountparticipation) -- [AccountResult](types_indexer.md#accountresult) -- [AccountStateDelta](types_indexer.md#accountstatedelta) -- [AppLocalState](types_indexer.md#applocalstate) -- [ApplicationCreatedLookupResult](types_indexer.md#applicationcreatedlookupresult) -- [ApplicationLookupResult](types_indexer.md#applicationlookupresult) -- [ApplicationParams](types_indexer.md#applicationparams) -- [ApplicationResult](types_indexer.md#applicationresult) -- [ApplicationTransactionResult](types_indexer.md#applicationtransactionresult) -- [AssetBalancesLookupResult](types_indexer.md#assetbalanceslookupresult) -- [AssetConfigTransactionResult](types_indexer.md#assetconfigtransactionresult) -- [AssetFreezeTransactionResult](types_indexer.md#assetfreezetransactionresult) -- [AssetHolding](types_indexer.md#assetholding) -- [AssetLookupResult](types_indexer.md#assetlookupresult) -- [AssetParams](types_indexer.md#assetparams) -- [AssetResult](types_indexer.md#assetresult) -- [AssetTransferTransactionResult](types_indexer.md#assettransfertransactionresult) -- [AssetsCreatedLookupResult](types_indexer.md#assetscreatedlookupresult) -- [AssetsLookupResult](types_indexer.md#assetslookupresult) -- [EvalDelta](types_indexer.md#evaldelta) -- [EvalDeltaKeyValue](types_indexer.md#evaldeltakeyvalue) -- [KeyRegistrationTransactionResult](types_indexer.md#keyregistrationtransactionresult) -- [LogicTransactionSignature](types_indexer.md#logictransactionsignature) -- [MerkleArrayProof](types_indexer.md#merklearrayproof) -- [MiniAssetHolding](types_indexer.md#miniassetholding) -- [MultisigTransactionSignature](types_indexer.md#multisigtransactionsignature) -- [MultisigTransactionSubSignature](types_indexer.md#multisigtransactionsubsignature) -- [PaymentTransactionResult](types_indexer.md#paymenttransactionresult) -- [StateDelta](types_indexer.md#statedelta) -- [StateProofTransactionResult](types_indexer.md#stateprooftransactionresult) -- [StateSchema](types_indexer.md#stateschema) -- [TransactionLookupResult](types_indexer.md#transactionlookupresult) -- [TransactionResult](types_indexer.md#transactionresult) -- [TransactionSearchResults](types_indexer.md#transactionsearchresults) -- [TransactionSignature](types_indexer.md#transactionsignature) - -## Type Aliases - -### AccountLookupResult - -Ƭ **AccountLookupResult**: `indexerModels.AccountResponse` - -**`Deprecated`** - -Use `algosdk.indexerModels.AccountResponse`. Indexer result for an account lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-id - -#### Defined in - -[src/types/indexer.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L8) - -___ - -### AccountParticipation - -Ƭ **AccountParticipation**: `indexerModels.AccountParticipation` - -**`Deprecated`** - -Use `algosdk.indexerModels.AccountParticipation`. Indexer AccountParticipation describes the parameters used by this account in consensus protocol. https://dev.algorand.co/reference/rest-apis/indexer#accountparticipation - -#### Defined in - -[src/types/indexer.ts:199](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L199) - -___ - -### AccountResult - -Ƭ **AccountResult**: `indexerModels.Account` - -**`Deprecated`** - -Use `algosdk.indexerModels.Account`. Indexer Account information at a given round https://dev.algorand.co/reference/rest-apis/indexer#account - -#### Defined in - -[src/types/indexer.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L45) - -___ - -### AccountStateDelta - -Ƭ **AccountStateDelta**: `indexerModels.AccountStateDelta` - -**`Deprecated`** - -Use `algosdk.indexerModels.AccountStateDelta`. - -#### Defined in - -[src/types/indexer.ts:145](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L145) - -___ - -### AppLocalState - -Ƭ **AppLocalState**: `indexerModels.ApplicationLocalState` - -**`Deprecated`** - -Use `algosdk.indexerModels.ApplicationLocalState`. Indexer Stores local state associated with an application. https://dev.algorand.co/reference/rest-apis/indexer#applicationlocalstate - -#### Defined in - -[src/types/indexer.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L202) - -___ - -### ApplicationCreatedLookupResult - -Ƭ **ApplicationCreatedLookupResult**: `indexerModels.ApplicationsResponse` - -**`Deprecated`** - -Use `algosdk.indexerModels.ApplicationsResponse`. Indexer result for an account's created applications, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-idcreated-applications - -#### Defined in - -[src/types/indexer.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L17) - -___ - -### ApplicationLookupResult - -Ƭ **ApplicationLookupResult**: `indexerModels.ApplicationResponse` - -**`Deprecated`** - -Use `algosdk.indexerModels.ApplicationResponse`. Indexer result for an application lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2applicationsapplication-id - -#### Defined in - -[src/types/indexer.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L39) - -___ - -### ApplicationParams - -Ƭ **ApplicationParams**: `indexerModels.ApplicationParams` - -**`Deprecated`** - -Use `algosdk.indexerModels.ApplicationParams`. Indexer Stores the global information associated with an application https://dev.algorand.co/reference/rest-apis/indexer#applicationparams - -#### Defined in - -[src/types/indexer.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L154) - -___ - -### ApplicationResult - -Ƭ **ApplicationResult**: `indexerModels.Application` - -**`Deprecated`** - -Use `algosdk.indexerModels.Application`. Indexer result of looking up an application - -#### Defined in - -[src/types/indexer.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L122) - -___ - -### ApplicationTransactionResult - -Ƭ **ApplicationTransactionResult**: `indexerModels.TransactionApplication` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionApplication`. Indexer Fields for an application transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionapplication - -#### Defined in - -[src/types/indexer.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L99) - -___ - -### AssetBalancesLookupResult - -Ƭ **AssetBalancesLookupResult**: `indexerModels.AssetBalancesResponse` - -**`Deprecated`** - -Use `algosdk.indexerModels.AssetBalancesResponse`. Indexer result for an asset's account holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-idbalances - -#### Defined in - -[src/types/indexer.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L33) - -___ - -### AssetConfigTransactionResult - -Ƭ **AssetConfigTransactionResult**: `indexerModels.TransactionAssetConfig` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionAssetConfig`. Indexer Fields for asset allocation, re-configuration, and destruction. -https://dev.algorand.co/reference/rest-apis/indexer#transactionassetconfig - -A zero value for asset-id indicates asset creation. A zero value for the params indicates asset destruction. - -#### Defined in - -[src/types/indexer.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L106) - -___ - -### AssetFreezeTransactionResult - -Ƭ **AssetFreezeTransactionResult**: `indexerModels.TransactionAssetFreeze` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionAssetFreeze`. Indexer Fields for an asset freeze transaction. https://dev.algorand.co/reference/rest-apis/indexer#transactionassetfreeze - -#### Defined in - -[src/types/indexer.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L109) - -___ - -### AssetHolding - -Ƭ **AssetHolding**: `indexerModels.AssetHolding` - -**`Deprecated`** - -Use `algosdk.indexerModels.AssetHolding`. Indexer Describes an asset held by an account. https://dev.algorand.co/reference/rest-apis/indexer#assetholding - -#### Defined in - -[src/types/indexer.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L205) - -___ - -### AssetLookupResult - -Ƭ **AssetLookupResult**: `indexerModels.AssetResponse` - -**`Deprecated`** - -Use `algosdk.indexerModels.AssetResponse`. Indexer result for an asset lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-id - -#### Defined in - -[src/types/indexer.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L20) - -___ - -### AssetParams - -Ƭ **AssetParams**: `indexerModels.AssetParams` - -**`Deprecated`** - -Use `algosdk.indexerModels.AssetParams`. Indexer AssetParams specifies the parameters for an asset. https://dev.algorand.co/reference/rest-apis/indexer#assetparams - -#### Defined in - -[src/types/indexer.ts:176](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L176) - -___ - -### AssetResult - -Ƭ **AssetResult**: `indexerModels.Asset` - -**`Deprecated`** - -Use `algosdk.indexerModels.Asset`. Indexer Fields to specify both the unique identifier and the parameters for an asset. https://dev.algorand.co/reference/rest-apis/indexer#asset - -#### Defined in - -[src/types/indexer.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L118) - -___ - -### AssetTransferTransactionResult - -Ƭ **AssetTransferTransactionResult**: `indexerModels.TransactionAssetTransfer` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionAssetTransfer`. Indexer Fields for an asset transfer transaction. https://dev.algorand.co/reference/rest-apis/indexer#transactionassettransfer - -#### Defined in - -[src/types/indexer.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L112) - -___ - -### AssetsCreatedLookupResult - -Ƭ **AssetsCreatedLookupResult**: `indexerModels.AssetsResponse` - -**`Deprecated`** - -Use `algosdk.indexerModels.AssetsResponse`. Indexer result for an account's created assets, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-idcreated-assets - -#### Defined in - -[src/types/indexer.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L14) - -___ - -### AssetsLookupResult - -Ƭ **AssetsLookupResult**: `indexerModels.AssetHoldingsResponse` - -**`Deprecated`** - -Use `algosdk.indexerModels.AssetHoldingsResponse`. Indexer result for an account's asset holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-idassets - -#### Defined in - -[src/types/indexer.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L11) - -___ - -### EvalDelta - -Ƭ **EvalDelta**: `indexerModels.EvalDelta` - -**`Deprecated`** - -Use `algosdk.indexerModels.EvalDelta`. Indexer Represents a TEAL value delta. https://dev.algorand.co/reference/rest-apis/indexer#evaldelta - -#### Defined in - -[src/types/indexer.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L151) - -___ - -### EvalDeltaKeyValue - -Ƭ **EvalDeltaKeyValue**: `indexerModels.EvalDeltaKeyValue` - -**`Deprecated`** - -Use `algosdk.indexerModels.EvalDeltaKeyValue`. - -#### Defined in - -[src/types/indexer.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L142) - -___ - -### KeyRegistrationTransactionResult - -Ƭ **KeyRegistrationTransactionResult**: `indexerModels.TransactionKeyreg` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionKeyreg`. Indexer Fields for a `keyreg` transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionkeyreg - -#### Defined in - -[src/types/indexer.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L115) - -___ - -### LogicTransactionSignature - -Ƭ **LogicTransactionSignature**: `indexerModels.TransactionSignatureLogicsig` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionSignatureLogicsig`. Indexer [lsig] Programatic transaction signature. - -https://dev.algorand.co/reference/rest-apis/indexer#transactionsignaturelogicsig - -https://dev.algorand.co/concepts/smart-contracts/logic-sigs - -#### Defined in - -[src/types/indexer.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L133) - -___ - -### MerkleArrayProof - -Ƭ **MerkleArrayProof**: `indexerModels.MerkleArrayProof` - -**`Deprecated`** - -Use `algosdk.indexerModels.MerkleArrayProof`. Indexer Merkle array Proof. - -Proof is used to convince a verifier about membership of leaves: h0,h1...hn -at indexes i0,i1...in on a tree. The verifier has a trusted value of the tree -root hash. - -Path is bounded by MaxNumLeaves since there could be multiple reveals, and -given the distribution of the elt positions and the depth of the tree, -the path length can increase up to 2^MaxTreeDepth / 2 - -Consider two different reveals for the same tree: -``` -. z5 -. z3 z4 -. y z z1 z2 -. q r s t u v w x -. a b c d e f g h i j k l m n o p -. ^ -. hints: [a, r, z, z4] -. len(hints) = 4 -``` -You need a to combine with b to get q, need r to combine with the computed q and get y, and so on. - -The worst case is this: -``` -. z5 -. z3 z4 -. y z z1 z2 -. q r s t u v w x -. a b c d e f g h i j k l m n o p -. ^ ^ ^ ^ ^ ^ ^ ^ -. -. hints: [b, d, e, g, j, l, m, o] -. len(hints) = 2^4/2 -``` - -#### Defined in - -[src/types/indexer.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L96) - -___ - -### MiniAssetHolding - -Ƭ **MiniAssetHolding**: `indexerModels.MiniAssetHolding` - -**`Deprecated`** - -Use `algosdk.indexerModels.MiniAssetHolding`. Indexer Describes an asset holding for an account of a known asset. https://dev.algorand.co/reference/rest-apis/indexer#miniassetholding - -#### Defined in - -[src/types/indexer.ts:208](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L208) - -___ - -### MultisigTransactionSignature - -Ƭ **MultisigTransactionSignature**: `indexerModels.TransactionSignatureMultisig` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionSignatureMultisig`. Indexer [msig] structure holding multiple subsignatures. https://dev.algorand.co/reference/rest-apis/indexer#transactionsignaturemultisig - -#### Defined in - -[src/types/indexer.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L136) - -___ - -### MultisigTransactionSubSignature - -Ƭ **MultisigTransactionSubSignature**: `indexerModels.TransactionSignatureMultisigSubsignature` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionSignatureMultisigSubsignature`. Indexer Sub-signature for a multisig signature https://dev.algorand.co/reference/rest-apis/indexer#transactionsignaturemultisigsubsignature - -#### Defined in - -[src/types/indexer.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L139) - -___ - -### PaymentTransactionResult - -Ƭ **PaymentTransactionResult**: `indexerModels.TransactionPayment` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionPayment`. Indexer Fields for a payment transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionpayment - -#### Defined in - -[src/types/indexer.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L48) - -___ - -### StateDelta - -Ƭ **StateDelta**: [`EvalDeltaKeyValue`](types_indexer.md#evaldeltakeyvalue)[] - -**`Deprecated`** - -Use `algosdk.indexerModels.EvalDeltaKeyValue[]`. - -#### Defined in - -[src/types/indexer.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L148) - -___ - -### StateProofTransactionResult - -Ƭ **StateProofTransactionResult**: `indexerModels.TransactionStateProof` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionStateProof`. Indexer Fields for a state proof transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionstateproof. - -See also https://dev.algorand.co/concepts/protocol/state-proofs/, -https://github.com/algorand/go-algorand/blob/master/data/transactions/stateproof.go, -https://github.com/algorand/go-algorand/blob/master/crypto/stateproof/structs.go, -https://github.com/algorand/go-algorand/blob/master/data/stateproofmsg/message.go, and -https://dev.algorand.co/reference/rest-apis/algod/#stateproof. - -#### Defined in - -[src/types/indexer.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L58) - -___ - -### StateSchema - -Ƭ **StateSchema**: `indexerModels.StateSchema` - -**`Deprecated`** - -Use `algosdk.indexerModels.StateSchema`. Indexer Represents a [apls] local-state or [apgs] global-state schema. -https://dev.algorand.co/reference/rest-apis/indexer#stateschema - -These schemas determine how much storage may be used in a local-state or global-state for an application. - -The more space used, the larger minimum balance must be maintained in the account holding the data. - -#### Defined in - -[src/types/indexer.ts:163](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L163) - -___ - -### TransactionLookupResult - -Ƭ **TransactionLookupResult**: `indexerModels.TransactionResponse` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionResponse`. Indexer result for a transaction lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2transactionstxid - -#### Defined in - -[src/types/indexer.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L36) - -___ - -### TransactionResult - -Ƭ **TransactionResult**: `indexerModels.Transaction` - -**`Deprecated`** - -Use `algosdk.indexerModels.Transaction`. Indexer result for a transaction, https://dev.algorand.co/reference/rest-apis/indexer#transaction - -#### Defined in - -[src/types/indexer.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L42) - -___ - -### TransactionSearchResults - -Ƭ **TransactionSearchResults**: `indexerModels.TransactionsResponse` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionsResponse`. Indexer result for a transaction search, https://dev.algorand.co/reference/rest-apis/indexer#get-v2transactions - -#### Defined in - -[src/types/indexer.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L5) - -___ - -### TransactionSignature - -Ƭ **TransactionSignature**: `indexerModels.TransactionSignature` - -**`Deprecated`** - -Use `algosdk.indexerModels.TransactionSignature`. Indexer Validation signature associated with some data. Only one of the signatures should be provided. https://dev.algorand.co/reference/rest-apis/indexer#transactionsignature - -#### Defined in - -[src/types/indexer.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L125) diff --git a/docs/code/modules/types_kmd_account_manager.md b/docs/code/modules/types_kmd_account_manager.md deleted file mode 100644 index 82245a15..00000000 --- a/docs/code/modules/types_kmd_account_manager.md +++ /dev/null @@ -1,9 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/kmd-account-manager - -# Module: types/kmd-account-manager - -## Table of contents - -### Classes - -- [KmdAccountManager](../classes/types_kmd_account_manager.KmdAccountManager.md) diff --git a/docs/code/modules/types_lifecycle_events.md b/docs/code/modules/types_lifecycle_events.md deleted file mode 100644 index f8ef9844..00000000 --- a/docs/code/modules/types_lifecycle_events.md +++ /dev/null @@ -1,34 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/lifecycle-events - -# Module: types/lifecycle-events - -## Table of contents - -### Enumerations - -- [EventType](../enums/types_lifecycle_events.EventType.md) - -### Type Aliases - -- [EventDataMap](types_lifecycle_events.md#eventdatamap) - -## Type Aliases - -### EventDataMap - -Ƭ **EventDataMap**: `Object` - -#### Index signature - -▪ [key: `string`]: `unknown` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `AppCompiled` | [`TealSourcesDebugEventData`](../interfaces/types_debugging.TealSourcesDebugEventData.md) | -| `TxnGroupSimulated` | [`AVMTracesEventData`](../interfaces/types_debugging.AVMTracesEventData.md) | - -#### Defined in - -[src/types/lifecycle-events.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/lifecycle-events.ts#L8) diff --git a/docs/code/modules/types_logging.md b/docs/code/modules/types_logging.md deleted file mode 100644 index 50c37060..00000000 --- a/docs/code/modules/types_logging.md +++ /dev/null @@ -1,93 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/logging - -# Module: types/logging - -## Table of contents - -### Type Aliases - -- [Logger](types_logging.md#logger) - -### Variables - -- [consoleLogger](types_logging.md#consolelogger) -- [infoConsoleLogger](types_logging.md#infoconsolelogger) -- [nullLogger](types_logging.md#nulllogger) -- [verboseConsoleLogger](types_logging.md#verboseconsolelogger) -- [warningConsoleLogger](types_logging.md#warningconsolelogger) - -## Type Aliases - -### Logger - -Ƭ **Logger**: `Object` - -General purpose logger type, compatible with Winston and others. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `debug` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` | -| `error` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` | -| `info` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` | -| `verbose` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` | -| `warn` | (`message`: `string`, ...`optionalParams`: `unknown`[]) => `void` | - -#### Defined in - -[src/types/logging.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L5) - -## Variables - -### consoleLogger - -• `Const` **consoleLogger**: [`Logger`](types_logging.md#logger) - -A logger implementation that writes to console - -#### Defined in - -[src/types/logging.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L14) - -___ - -### infoConsoleLogger - -• `Const` **infoConsoleLogger**: [`Logger`](types_logging.md#logger) - -#### Defined in - -[src/types/logging.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L22) - -___ - -### nullLogger - -• `Const` **nullLogger**: [`Logger`](types_logging.md#logger) - -A logger implementation that does nothing - -#### Defined in - -[src/types/logging.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L47) - -___ - -### verboseConsoleLogger - -• `Const` **verboseConsoleLogger**: [`Logger`](types_logging.md#logger) - -#### Defined in - -[src/types/logging.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L30) - -___ - -### warningConsoleLogger - -• `Const` **warningConsoleLogger**: [`Logger`](types_logging.md#logger) - -#### Defined in - -[src/types/logging.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L38) diff --git a/docs/code/modules/types_logic_error.md b/docs/code/modules/types_logic_error.md deleted file mode 100644 index 7f856b15..00000000 --- a/docs/code/modules/types_logic_error.md +++ /dev/null @@ -1,13 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/logic-error - -# Module: types/logic-error - -## Table of contents - -### Classes - -- [LogicError](../classes/types_logic_error.LogicError.md) - -### Interfaces - -- [LogicErrorDetails](../interfaces/types_logic_error.LogicErrorDetails.md) diff --git a/docs/code/modules/types_network_client.md b/docs/code/modules/types_network_client.md deleted file mode 100644 index 9967140b..00000000 --- a/docs/code/modules/types_network_client.md +++ /dev/null @@ -1,39 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/network-client - -# Module: types/network-client - -## Table of contents - -### Interfaces - -- [AlgoClientConfig](../interfaces/types_network_client.AlgoClientConfig.md) -- [AlgoConfig](../interfaces/types_network_client.AlgoConfig.md) -- [NetworkDetails](../interfaces/types_network_client.NetworkDetails.md) - -### Functions - -- [genesisIdIsLocalNet](types_network_client.md#genesisidislocalnet) - -## Functions - -### genesisIdIsLocalNet - -▸ **genesisIdIsLocalNet**(`genesisId`): `boolean` - -Returns true if the given network genesisId is associated with a LocalNet network. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `genesisId` | `string` | The network genesis ID | - -#### Returns - -`boolean` - -Whether the given genesis ID is associated with a LocalNet network - -#### Defined in - -[src/types/network-client.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L42) diff --git a/docs/code/modules/types_testing.md b/docs/code/modules/types_testing.md deleted file mode 100644 index 103b93f9..00000000 --- a/docs/code/modules/types_testing.md +++ /dev/null @@ -1,14 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/testing - -# Module: types/testing - -## Table of contents - -### Interfaces - -- [AlgoKitLogCaptureFixture](../interfaces/types_testing.AlgoKitLogCaptureFixture.md) -- [AlgorandFixture](../interfaces/types_testing.AlgorandFixture.md) -- [AlgorandFixtureConfig](../interfaces/types_testing.AlgorandFixtureConfig.md) -- [AlgorandTestAutomationContext](../interfaces/types_testing.AlgorandTestAutomationContext.md) -- [GetTestAccountParams](../interfaces/types_testing.GetTestAccountParams.md) -- [LogSnapshotConfig](../interfaces/types_testing.LogSnapshotConfig.md) diff --git a/docs/code/modules/types_transaction.md b/docs/code/modules/types_transaction.md deleted file mode 100644 index f10bdc91..00000000 --- a/docs/code/modules/types_transaction.md +++ /dev/null @@ -1,91 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/transaction - -# Module: types/transaction - -## Table of contents - -### Interfaces - -- [AdditionalAtomicTransactionComposerContext](../interfaces/types_transaction.AdditionalAtomicTransactionComposerContext.md) -- [AtomicTransactionComposerToSend](../interfaces/types_transaction.AtomicTransactionComposerToSend.md) -- [ConfirmedTransactionResult](../interfaces/types_transaction.ConfirmedTransactionResult.md) -- [ConfirmedTransactionResults](../interfaces/types_transaction.ConfirmedTransactionResults.md) -- [SendAtomicTransactionComposerResults](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) -- [SendParams](../interfaces/types_transaction.SendParams.md) -- [SendTransactionParams](../interfaces/types_transaction.SendTransactionParams.md) -- [SendTransactionResult](../interfaces/types_transaction.SendTransactionResult.md) -- [SendTransactionResults](../interfaces/types_transaction.SendTransactionResults.md) -- [TransactionGroupToSend](../interfaces/types_transaction.TransactionGroupToSend.md) -- [TransactionToSign](../interfaces/types_transaction.TransactionToSign.md) - -### Type Aliases - -- [Arc2TransactionNote](types_transaction.md#arc2transactionnote) -- [SendSingleTransactionResult](types_transaction.md#sendsingletransactionresult) -- [SendTransactionFrom](types_transaction.md#sendtransactionfrom) -- [TransactionNote](types_transaction.md#transactionnote) -- [TransactionNoteData](types_transaction.md#transactionnotedata) - -## Type Aliases - -### Arc2TransactionNote - -Ƭ **Arc2TransactionNote**: \{ `dAppName`: `string` ; `data`: `string` ; `format`: ``"m"`` \| ``"b"`` \| ``"u"`` } \| \{ `dAppName`: `string` ; `data`: [`TransactionNoteData`](types_transaction.md#transactionnotedata) ; `format`: ``"j"`` } - -ARC-0002 compatible transaction note components https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md - -#### Defined in - -[src/types/transaction.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L16) - -___ - -### SendSingleTransactionResult - -Ƭ **SendSingleTransactionResult**: [`Expand`](types_expand.md#expand)\<[`SendAtomicTransactionComposerResults`](../interfaces/types_transaction.SendAtomicTransactionComposerResults.md) & [`ConfirmedTransactionResult`](../interfaces/types_transaction.ConfirmedTransactionResult.md)\> - -Result from sending a single transaction. - -#### Defined in - -[src/types/transaction.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L50) - -___ - -### SendTransactionFrom - -Ƭ **SendTransactionFrom**: `Account` \| [`SigningAccount`](../classes/types_account.SigningAccount.md) \| `LogicSigAccount` \| [`MultisigAccount`](../classes/types_account.MultisigAccount.md) \| [`TransactionSignerAccount`](../interfaces/types_account.TransactionSignerAccount.md) - -Core account abstraction when signing/sending transactions - -This type is used across the entire AlgoKit Utils library and allows you to pass through -many types of accounts, including: -* `Account` - The in-built `algosdk.Account` type for mnemonic accounts -* `SigningAccount` - An AlgoKit Utils class that wraps Account to provide support for rekeyed accounts -* `LogicSigAccount` - The in-built `algosdk.LogicSigAccount` type for logic signatures -* `MultisigAccount` - An AlgoKit Utils class that wraps a multisig account and provides mechanisms to get a multisig account -* `TransactionSignerAccount` - An AlgoKit Utils class that wraps the in-built `algosdk.TransactionSigner` along with the sender address - -#### Defined in - -[src/types/transaction.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L108) - -___ - -### TransactionNote - -Ƭ **TransactionNote**: `Uint8Array` \| [`TransactionNoteData`](types_transaction.md#transactionnotedata) \| [`Arc2TransactionNote`](types_transaction.md#arc2transactionnote) - -#### Defined in - -[src/types/transaction.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L12) - -___ - -### TransactionNoteData - -Ƭ **TransactionNoteData**: `string` \| ``null`` \| `undefined` \| `number` \| `any`[] \| `Record`\<`string`, `any`\> - -#### Defined in - -[src/types/transaction.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L14) diff --git a/docs/code/modules/types_transfer.md b/docs/code/modules/types_transfer.md deleted file mode 100644 index c68345fb..00000000 --- a/docs/code/modules/types_transfer.md +++ /dev/null @@ -1,13 +0,0 @@ -[@algorandfoundation/algokit-utils](../README.md) / types/transfer - -# Module: types/transfer - -## Table of contents - -### Interfaces - -- [AlgoRekeyParams](../interfaces/types_transfer.AlgoRekeyParams.md) -- [AlgoTransferParams](../interfaces/types_transfer.AlgoTransferParams.md) -- [EnsureFundedParams](../interfaces/types_transfer.EnsureFundedParams.md) -- [EnsureFundedReturnType](../interfaces/types_transfer.EnsureFundedReturnType.md) -- [TransferAssetParams](../interfaces/types_transfer.TransferAssetParams.md) diff --git a/docs/code/testing/README.md b/docs/code/testing/README.md new file mode 100644 index 00000000..032650d1 --- /dev/null +++ b/docs/code/testing/README.md @@ -0,0 +1,22 @@ +[**@algorandfoundation/algokit-utils**](../README.md) + +*** + +[@algorandfoundation/algokit-utils](../README.md) / testing + +# testing + +## Classes + +- [TestLogger](classes/TestLogger.md) +- [TransactionLogger](classes/TransactionLogger.md) + +## Variables + +- [algoKitLogCaptureFixture](variables/algoKitLogCaptureFixture.md) + +## Functions + +- [algorandFixture](functions/algorandFixture.md) +- [getTestAccount](functions/getTestAccount.md) +- [runWhenIndexerCaughtUp](functions/runWhenIndexerCaughtUp.md) diff --git a/docs/code/testing/classes/TestLogger.md b/docs/code/testing/classes/TestLogger.md new file mode 100644 index 00000000..82b06dff --- /dev/null +++ b/docs/code/testing/classes/TestLogger.md @@ -0,0 +1,234 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [testing](../README.md) / TestLogger + +# Class: TestLogger + +Defined in: [src/testing/test-logger.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L8) + +Exposes an AlgoKit logger which captures log messages, while wrapping an original logger. +This is useful for automated testing. + +## Implements + +- [`Logger`](../../types/logging/type-aliases/Logger.md) + +## Constructors + +### Constructor + +> **new TestLogger**(`originalLogger?`): `TestLogger` + +Defined in: [src/testing/test-logger.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L16) + +Create a new test logger that wraps the given logger if provided. + +#### Parameters + +##### originalLogger? + +[`Logger`](../../types/logging/type-aliases/Logger.md) + +The optional original logger to wrap. + +#### Returns + +`TestLogger` + +## Accessors + +### capturedLogs + +#### Get Signature + +> **get** **capturedLogs**(): `string`[] + +Defined in: [src/testing/test-logger.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L22) + +Returns all logs captured thus far. + +##### Returns + +`string`[] + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: [src/testing/test-logger.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L27) + +Clears all logs captured so far. + +#### Returns + +`void` + +*** + +### debug() + +> **debug**(`message`, ...`optionalParams`): `void` + +Defined in: [src/testing/test-logger.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L89) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` + +#### Implementation of + +`Logger.debug` + +*** + +### error() + +> **error**(`message`, ...`optionalParams`): `void` + +Defined in: [src/testing/test-logger.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L73) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` + +#### Implementation of + +`Logger.error` + +*** + +### getLogSnapshot() + +> **getLogSnapshot**(`config?`): `string` + +Defined in: [src/testing/test-logger.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L47) + +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 + +#### Parameters + +##### config? + +[`LogSnapshotConfig`](../../types/testing/interfaces/LogSnapshotConfig.md) + +The snapshot configuration + +#### Returns + +`string` + +The snapshotted logs. + +#### Example + +```typescript +const logger = new TestLogger() +... +expect(logger.getLogSnapshot()).toMatchSnapshot() +``` + +*** + +### info() + +> **info**(`message`, ...`optionalParams`): `void` + +Defined in: [src/testing/test-logger.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L81) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` + +#### Implementation of + +`Logger.info` + +*** + +### verbose() + +> **verbose**(`message`, ...`optionalParams`): `void` + +Defined in: [src/testing/test-logger.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L85) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` + +#### Implementation of + +`Logger.verbose` + +*** + +### warn() + +> **warn**(`message`, ...`optionalParams`): `void` + +Defined in: [src/testing/test-logger.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L77) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` + +#### Implementation of + +`Logger.warn` diff --git a/docs/code/testing/classes/TransactionLogger.md b/docs/code/testing/classes/TransactionLogger.md new file mode 100644 index 00000000..a88b2b41 --- /dev/null +++ b/docs/code/testing/classes/TransactionLogger.md @@ -0,0 +1,116 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [testing](../README.md) / TransactionLogger + +# Class: TransactionLogger + +Defined in: [src/testing/transaction-logger.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L11) + +Allows you to keep track of Algorand transaction IDs by wrapping an `Algodv2` in a proxy. +Useful for automated tests. + +## Constructors + +### Constructor + +> **new TransactionLogger**(): `TransactionLogger` + +#### Returns + +`TransactionLogger` + +## Accessors + +### sentTransactionIds + +#### Get Signature + +> **get** **sentTransactionIds**(): readonly `string`[] + +Defined in: [src/testing/transaction-logger.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L17) + +The list of transaction IDs that has been logged thus far. + +##### Returns + +readonly `string`[] + +## Methods + +### capture() + +> **capture**(`algod`): `AlgodClient` + +Defined in: [src/testing/transaction-logger.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L48) + +Return a proxy that wraps the given Algodv2 with this transaction logger. + +#### Parameters + +##### algod + +`AlgodClient` + +The `Algodv2` to wrap + +#### Returns + +`AlgodClient` + +The wrapped `Algodv2`, any transactions sent using this algod instance will be logged by this transaction logger + +*** + +### clear() + +> **clear**(): `void` + +Defined in: [src/testing/transaction-logger.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L24) + +Clear all logged IDs. + +#### Returns + +`void` + +*** + +### logRawTransaction() + +> **logRawTransaction**(`signedTransactions`): `void` + +Defined in: [src/testing/transaction-logger.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L31) + +The method that captures raw transactions and stores the transaction IDs. + +#### Parameters + +##### signedTransactions + +`Uint8Array`\<`ArrayBufferLike`\> | `Uint8Array`\<`ArrayBufferLike`\>[] + +#### Returns + +`void` + +*** + +### waitForIndexer() + +> **waitForIndexer**(`indexer`): `Promise`\<`void`\> + +Defined in: [src/testing/transaction-logger.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/transaction-logger.ts#L53) + +Wait until all logged transactions IDs appear in the given `Indexer`. + +#### Parameters + +##### indexer + +`IndexerClient` + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/code/testing/functions/algorandFixture.md b/docs/code/testing/functions/algorandFixture.md new file mode 100644 index 00000000..faf73077 --- /dev/null +++ b/docs/code/testing/functions/algorandFixture.md @@ -0,0 +1,108 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [testing](../README.md) / algorandFixture + +# Function: algorandFixture() + +## Call Signature + +> **algorandFixture**(`fixtureConfig?`): [`AlgorandFixture`](../../types/testing/interfaces/AlgorandFixture.md) + +Defined in: [src/testing/fixtures/algorand-fixture.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algorand-fixture.ts#L60) + +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 (or their respective config) if you want to test against +an explicitly defined network. + +### Parameters + +#### fixtureConfig? + +[`AlgorandFixtureConfig`](../../types/testing/interfaces/AlgorandFixtureConfig.md) + +The fixture configuration + +### Returns + +[`AlgorandFixture`](../../types/testing/interfaces/AlgorandFixture.md) + +The fixture + +### Examples + +```typescript +const fixture = algorandFixture() + +beforeEach(fixture.newScope, 10_000) + +test('My test', async () => { + const {algod, indexer, testAccount, ...} = fixture.context + // test things... +}) +``` + +```typescript +const fixture = algorandFixture() + +beforeAll(fixture.newScope, 10_000) + +test('My test', async () => { + const {algod, indexer, testAccount, ...} = fixture.context + // test things... +}) +``` + +```typescript +const fixture = algorandFixture({ + algod: new Algodv2('localhost', 12345, 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'), + // ... +}) + +beforeEach(fixture.newScope, 10_000) + +test('My test', async () => { + const {algod, indexer, testAccount, ...} = fixture.context + // test things... +}) +``` + +## Call Signature + +> **algorandFixture**(`fixtureConfig`, `config`): [`AlgorandFixture`](../../types/testing/interfaces/AlgorandFixture.md) + +Defined in: [src/testing/fixtures/algorand-fixture.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algorand-fixture.ts#L75) + +### Parameters + +#### fixtureConfig + +The fixture configuration + +`undefined` | [`AlgorandFixtureConfig`](../../types/testing/interfaces/AlgorandFixtureConfig.md) + +#### config + +[`AlgoConfig`](../../types/network-client/interfaces/AlgoConfig.md) + +The fixture configuration + +### Returns + +[`AlgorandFixture`](../../types/testing/interfaces/AlgorandFixture.md) + +The fixture + +### Deprecated + +Config can be passed in directly to fixture config now. + +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. diff --git a/docs/code/testing/functions/getTestAccount.md b/docs/code/testing/functions/getTestAccount.md new file mode 100644 index 00000000..7f25c1f9 --- /dev/null +++ b/docs/code/testing/functions/getTestAccount.md @@ -0,0 +1,79 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [testing](../README.md) / getTestAccount + +# Function: getTestAccount() + +## Call Signature + +> **getTestAccount**(`params`, `algod`, `kmd?`): `Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../../types/account/interfaces/TransactionSignerAccount.md)\> + +Defined in: [src/testing/account.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L21) + +### Parameters + +#### params + +[`GetTestAccountParams`](../../types/testing/interfaces/GetTestAccountParams.md) + +The config for the test account to generate + +#### algod + +`AlgodClient` + +An algod client + +#### kmd? + +`KmdClient` + +A KMD client, if not specified then a default KMD client will be loaded from environment variables and if not found fallback to the default LocalNet KMD client + +### Returns + +`Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../../types/account/interfaces/TransactionSignerAccount.md)\> + +The account, with private key loaded + +### Deprecated + +Use `getTestAccount(params, algorandClient)` instead. The `algorandClient` object can be created using `AlgorandClient.fromClients({ algod, kmd })`. + +Creates an ephemeral Algorand account for the purposes of testing. +Returns a newly created random test account that is funded from the dispenser +DO NOT USE THIS TO CREATE A MAINNET ACCOUNT! +Note: By default this will log the mnemonic of the account. + +## Call Signature + +> **getTestAccount**(`params`, `algorand`): `Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../../types/account/interfaces/TransactionSignerAccount.md)\> + +Defined in: [src/testing/account.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L35) + +Creates an ephemeral Algorand account for the purposes of testing. +Returns a newly created random test account that is funded from the dispenser +DO NOT USE THIS TO CREATE A MAINNET ACCOUNT! +Note: By default this will log the mnemonic of the account. + +### Parameters + +#### params + +[`GetTestAccountParams`](../../types/testing/interfaces/GetTestAccountParams.md) + +The config for the test account to generate + +#### algorand + +[`AlgorandClient`](../../types/algorand-client/classes/AlgorandClient.md) + +An AlgorandClient client + +### Returns + +`Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../../types/account/interfaces/TransactionSignerAccount.md)\> + +The account, with private key loaded diff --git a/docs/code/testing/functions/runWhenIndexerCaughtUp.md b/docs/code/testing/functions/runWhenIndexerCaughtUp.md new file mode 100644 index 00000000..b28401e4 --- /dev/null +++ b/docs/code/testing/functions/runWhenIndexerCaughtUp.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [testing](../README.md) / runWhenIndexerCaughtUp + +# Function: runWhenIndexerCaughtUp() + +> **runWhenIndexerCaughtUp**\<`T`\>(`run`): `Promise`\<`T`\> + +Defined in: [src/testing/indexer.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/indexer.ts#L12) + +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. + +## Type Parameters + +### T + +`T` + +## Parameters + +### run + +() => `Promise`\<`T`\> + +The code to run + +## Returns + +`Promise`\<`T`\> + +The result (as a promise), or throws if the indexer didn't catch up in time + +## Example + +```typescript +const transaction = await runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(txnId).do()) +``` diff --git a/docs/code/testing/variables/algoKitLogCaptureFixture.md b/docs/code/testing/variables/algoKitLogCaptureFixture.md new file mode 100644 index 00000000..f8f8931d --- /dev/null +++ b/docs/code/testing/variables/algoKitLogCaptureFixture.md @@ -0,0 +1,32 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / [testing](../README.md) / algoKitLogCaptureFixture + +# Variable: algoKitLogCaptureFixture() + +> `const` **algoKitLogCaptureFixture**: () => [`AlgoKitLogCaptureFixture`](../../types/testing/interfaces/AlgoKitLogCaptureFixture.md) + +Defined in: [src/testing/fixtures/algokit-log-capture-fixture.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/fixtures/algokit-log-capture-fixture.ts#L22) + +Creates a test fixture for capturing AlgoKit logs. + +## Returns + +[`AlgoKitLogCaptureFixture`](../../types/testing/interfaces/AlgoKitLogCaptureFixture.md) + +The fixture + +## Example + +```typescript +const logs = algoKitLogCaptureFixture() + +beforeEach(logs.beforeEach) +afterEach(logs.afterEach) + +test('My test', () => { + const capturedLogs = logs.testLogger.capturedLogs +}) +``` diff --git a/docs/code/types/account-manager.spec/README.md b/docs/code/types/account-manager.spec/README.md new file mode 100644 index 00000000..32c07c96 --- /dev/null +++ b/docs/code/types/account-manager.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/account-manager.spec + +# types/account-manager.spec diff --git a/docs/code/types/account-manager/README.md b/docs/code/types/account-manager/README.md new file mode 100644 index 00000000..6744e715 --- /dev/null +++ b/docs/code/types/account-manager/README.md @@ -0,0 +1,19 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/account-manager + +# types/account-manager + +## Classes + +- [AccountManager](classes/AccountManager.md) + +## Interfaces + +- [EnsureFundedResult](interfaces/EnsureFundedResult.md) + +## Variables + +- [getAccountTransactionSigner](variables/getAccountTransactionSigner.md) diff --git a/docs/code/types/account-manager/classes/AccountManager.md b/docs/code/types/account-manager/classes/AccountManager.md new file mode 100644 index 00000000..af8d5219 --- /dev/null +++ b/docs/code/types/account-manager/classes/AccountManager.md @@ -0,0 +1,873 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account-manager](../README.md) / AccountManager + +# Class: AccountManager + +Defined in: [src/types/account-manager.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L46) + +Creates and keeps track of signing accounts that can sign transactions for a sending address. + +## Constructors + +### Constructor + +> **new AccountManager**(`clientManager`): `AccountManager` + +Defined in: [src/types/account-manager.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L60) + +Create a new account manager. + +#### Parameters + +##### clientManager + +[`ClientManager`](../../client-manager/classes/ClientManager.md) + +The ClientManager client to use for algod and kmd clients + +#### Returns + +`AccountManager` + +#### Example + +```typescript +const accountManager = new AccountManager(clientManager) +``` + +## Accessors + +### kmd + +#### Get Signature + +> **get** **kmd**(): [`KmdAccountManager`](../../kmd-account-manager/classes/KmdAccountManager.md) + +Defined in: [src/types/account-manager.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L81) + +KMD account manager that allows you to easily get and create accounts using KMD. + +##### Example + +```typescript +const kmdManager = accountManager.kmd; +``` + +##### Returns + +[`KmdAccountManager`](../../kmd-account-manager/classes/KmdAccountManager.md) + +The `KmdAccountManager` instance. + +## Methods + +### dispenserFromEnvironment() + +> **dispenserFromEnvironment**(): `Promise`\<`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +Defined in: [src/types/account-manager.ts:441](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L441) + +Returns an account (with private key loaded) that can act as a dispenser from +environment variables, or against default LocalNet if no environment variables present. + +Note: requires a Node.js environment to execute. + +If present, it will load the account mnemonic stored in process.env.DISPENSER_MNEMONIC and optionally +process.env.DISPENSER_SENDER if it's a rekeyed account. + +#### Returns + +`Promise`\<`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +The account + +#### Example + +```typescript +const account = await accountManager.dispenserFromEnvironment() +``` + +*** + +### ensureFunded() + +> **ensureFunded**(`accountToFund`, `dispenserAccount`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| `object` & [`EnsureFundedResult`](../interfaces/EnsureFundedResult.md)\> + +Defined in: [src/types/account-manager.ts:561](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L561) + +Funds a given account using a dispenser account as a funding source such that +the given account has a certain amount of Algo free to spend (accounting for +Algo locked in minimum balance requirement). + +https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr + +#### Parameters + +##### accountToFund + +The account to fund + +`string` | `Address` + +##### dispenserAccount + +The account to use as a dispenser funding source + +`string` | `Address` + +##### minSpendingBalance + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) + +##### options? + +`object` & [`SendParams`](../../transaction/interfaces/SendParams.md) & `Omit`\<[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md), `"sender"`\> + +Optional parameters to control the funding increment, transaction or execution of the transaction + +#### Returns + +`Promise`\<`undefined` \| `object` & [`EnsureFundedResult`](../interfaces/EnsureFundedResult.md)\> + +- The result of executing the dispensing transaction and the `amountFunded` if funds were needed. +- `undefined` if no funds were needed. + +#### Example + +```typescript +// Basic example +await accountManager.ensureFunded("ACCOUNTADDRESS", "DISPENSERADDRESS", algokit.algo(1)) +// With configuration +await accountManager.ensureFunded("ACCOUNTADDRESS", "DISPENSERADDRESS", algokit.algo(1), + { minFundingIncrement: algokit.algo(2), fee: (1000).microAlgo(), suppressLog: true } +) +``` + +*** + +### ensureFundedFromEnvironment() + +> **ensureFundedFromEnvironment**(`accountToFund`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| `object` & [`EnsureFundedResult`](../interfaces/EnsureFundedResult.md)\> + +Defined in: [src/types/account-manager.ts:623](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L623) + +Funds a given account using a dispenser account retrieved from the environment, +per the `dispenserFromEnvironment` method, as a funding source such that +the given account has a certain amount of Algo free to spend (accounting for +Algo locked in minimum balance requirement). + +**Note:** requires a Node.js environment to execute. + +The dispenser account is retrieved from the account mnemonic stored in +process.env.DISPENSER_MNEMONIC and optionally process.env.DISPENSER_SENDER +if it's a rekeyed account, or against default LocalNet if no environment variables present. + +https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr + +#### Parameters + +##### accountToFund + +The account to fund + +`string` | `Address` + +##### minSpendingBalance + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) + +##### options? + +`object` & [`SendParams`](../../transaction/interfaces/SendParams.md) & `Omit`\<[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md), `"sender"`\> + +Optional parameters to control the funding increment, transaction or execution of the transaction + +#### Returns + +`Promise`\<`undefined` \| `object` & [`EnsureFundedResult`](../interfaces/EnsureFundedResult.md)\> + +- The result of executing the dispensing transaction and the `amountFunded` if funds were needed. +- `undefined` if no funds were needed. + +#### Example + +```typescript +// Basic example +await accountManager.ensureFundedFromEnvironment("ACCOUNTADDRESS", algokit.algo(1)) +// With configuration +await accountManager.ensureFundedFromEnvironment("ACCOUNTADDRESS", algokit.algo(1), + { minFundingIncrement: algokit.algo(2), fee: (1000).microAlgo(), suppressLog: true } +) +``` + +*** + +### ensureFundedFromTestNetDispenserApi() + +> **ensureFundedFromTestNetDispenserApi**(`accountToFund`, `dispenserClient`, `minSpendingBalance`, `options?`): `Promise`\<`undefined` \| [`EnsureFundedResult`](../interfaces/EnsureFundedResult.md)\> + +Defined in: [src/types/account-manager.ts:679](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L679) + +Funds a given account using the TestNet Dispenser API as a funding source such that +the account has a certain amount of Algo free to spend (accounting for Algo locked +in minimum balance requirement). + +https://dev.algorand.co/concepts/smart-contracts/costs-constraints#mbr + +#### Parameters + +##### accountToFund + +The account to fund + +`string` | `Address` + +##### dispenserClient + +[`TestNetDispenserApiClient`](../../dispenser-client/classes/TestNetDispenserApiClient.md) + +The TestNet dispenser funding client + +##### minSpendingBalance + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) + +##### options? + +Optional parameters to control the funding increment, transaction or execution of the transaction + +###### minFundingIncrement? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +#### Returns + +`Promise`\<`undefined` \| [`EnsureFundedResult`](../interfaces/EnsureFundedResult.md)\> + +- The result of executing the dispensing transaction and the `amountFunded` if funds were needed. +- `undefined` if no funds were needed. + +#### Example + +```typescript +// Basic example +await accountManager.ensureFundedFromTestNetDispenserApi("ACCOUNTADDRESS", algorand.client.getTestNetDispenserFromEnvironment(), algokit.algo(1)) +// With configuration +await accountManager.ensureFundedFromTestNetDispenserApi("ACCOUNTADDRESS", algorand.client.getTestNetDispenserFromEnvironment(), algokit.algo(1), + { minFundingIncrement: algokit.algo(2) } +) +``` + +*** + +### fromEnvironment() + +> **fromEnvironment**(`name`, `fundWith?`): `Promise`\<`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +Defined in: [src/types/account-manager.ts:334](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L334) + +Tracks and returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier. + +Note: This function expects to run in a Node.js environment. + +## Convention: +* **Non-LocalNet:** will load process.env['{NAME}_MNEMONIC'] as a mnemonic secret; **Note: Be careful how the mnemonic is handled**, + never commit it into source control and ideally load it via a secret storage service rather than the file system. + If process.env['{NAME}_SENDER'] is defined then it will use that for the sender address (i.e. to support rekeyed accounts) +* **LocalNet:** will load the account from a KMD wallet called {NAME} and if that wallet doesn't exist it will create it and fund the account for you + +This allows you to write code that will work seamlessly in production and local development (LocalNet) without manual config locally (including when you reset the LocalNet). + +#### Parameters + +##### name + +`string` + +The name identifier of the account + +##### fundWith? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The optional amount to fund the account with when it gets created (when targeting LocalNet), if not specified then 1000 ALGO will be funded from the dispenser account + +#### Returns + +`Promise`\<`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +The account + +#### Example + +If you have a mnemonic secret loaded into `process.env.MY_ACCOUNT_MNEMONIC` then you can call the following to get that private key loaded into an account object: +```typescript +const account = await accountManager.fromEnvironment('MY_ACCOUNT') +``` + +If that code runs against LocalNet then a wallet called `MY_ACCOUNT` will automatically be created with an account that is automatically funded with 1000 (default) ALGO from the default LocalNet dispenser. +If not running against LocalNet then it will use proces.env.MY_ACCOUNT_MNEMONIC as the private key and (if present) process.env.MY_ACCOUNT_SENDER as the sender address. + +*** + +### fromKmd() + +> **fromKmd**(`name`, `predicate?`, `sender?`): `Promise`\<`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +Defined in: [src/types/account-manager.ts:370](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L370) + +Tracks and returns an Algorand account with private key loaded from the given KMD wallet (identified by name). + +#### Parameters + +##### name + +`string` + +The name of the wallet to retrieve an account from + +##### predicate? + +(`account`) => `boolean` + +An optional filter to use to find the account (otherwise it will return a random account from the wallet) + +##### sender? + +The optional sender address to use this signer for (aka a rekeyed account) + +`string` | `Address` + +#### Returns + +`Promise`\<`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +The account + +#### Example + +```typescript +const defaultDispenserAccount = await accountManager.fromKmd('unencrypted-default-wallet', + a => a.status !== 'Offline' && a.amount > 1_000_000_000 +) +``` + +*** + +### fromMnemonic() + +> **fromMnemonic**(`mnemonicSecret`, `sender?`): `Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +Defined in: [src/types/account-manager.ts:286](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L286) + +Tracks and returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret. + +#### Parameters + +##### mnemonicSecret + +`string` + +The mnemonic secret representing the private key of an account; **Note: Be careful how the mnemonic is handled**, + never commit it into source control and ideally load it from the environment (ideally via a secret storage service) rather than the file system. + +##### sender? + +The optional sender address to use this signer for (aka a rekeyed account) + +`string` | `Address` + +#### Returns + +`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +The account + +#### Example + +```typescript +const account = accountManager.fromMnemonic("mnemonic secret ...") +const rekeyedAccount = accountManager.fromMnemonic("mnemonic secret ...", "SENDERADDRESS...") +``` + +*** + +### getAccount() + +> **getAccount**(`sender`): [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +Defined in: [src/types/account-manager.ts:222](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L222) + +Returns the `TransactionSignerAccount` for the given sender address. + +If no signer has been registered for that address then an error is thrown. + +#### Parameters + +##### sender + +The sender address + +`string` | `Address` + +#### Returns + +[`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The `TransactionSignerAccount` or throws an error if not found + +#### Example + +```typescript +const sender = accountManager.random() +// ... +// Returns the `TransactionSignerAccount` for `sender` that has previously been registered +const account = accountManager.getAccount(sender) +``` + +*** + +### getInformation() + +> **getInformation**(`sender`): `Promise`\<[`AccountInformation`](../../account/type-aliases/AccountInformation.md)\> + +Defined in: [src/types/account-manager.ts:241](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L241) + +Returns the given sender account's current status, balance and spendable amounts. + +[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountinformation) + +#### Parameters + +##### sender + +The account / address to look up + +`string` | `Address` + +#### Returns + +`Promise`\<[`AccountInformation`](../../account/type-aliases/AccountInformation.md)\> + +The account information + +#### Example + +```typescript +const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; +const accountInfo = await accountManager.getInformation(address); +``` + +*** + +### getSigner() + +> **getSigner**(`sender`): `TransactionSigner` + +Defined in: [src/types/account-manager.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L202) + +Returns the `TransactionSigner` for the given sender address, ready to sign a transaction for that sender. + +If no signer has been registered for that address then the default signer is used if registered and +if not then an error is thrown. + +#### Parameters + +##### sender + +The sender address + +`string` | `Address` + +#### Returns + +`TransactionSigner` + +The `TransactionSigner` or throws an error if not found and no default signer is set + +#### Example + +```typescript +const signer = accountManager.getSigner("SENDERADDRESS") +``` + +*** + +### localNetDispenser() + +> **localNetDispenser**(): `Promise`\<`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +Defined in: [src/types/account-manager.ts:460](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L460) + +Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts). + +#### Returns + +`Promise`\<`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +The account + +#### Example + +```typescript +const account = await accountManager.localNetDispenser() +``` + +*** + +### logicsig() + +> **logicsig**(`program`, `args?`): `Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +Defined in: [src/types/account-manager.ts:408](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L408) + +Tracks and returns an account that represents a logic signature. + +#### Parameters + +##### program + +`Uint8Array` + +The bytes that make up the compiled logic signature + +##### args? + +`Uint8Array`\<`ArrayBufferLike`\>[] + +The (binary) arguments to pass into the logic signature + +#### Returns + +`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +A logic signature account wrapper + +#### Example + +```typescript +const account = accountManager.logicsig(program, [new Uint8Array(3, ...)]) +``` + +*** + +### multisig() + +> **multisig**(`multisigParams`, `signingAccounts`): `Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +Defined in: [src/types/account-manager.ts:393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L393) + +Tracks and returns an account that supports partial or full multisig signing. + +#### Parameters + +##### multisigParams + +`MultisigMetadata` + +The parameters that define the multisig account + +##### signingAccounts + +(`Account` \| [`SigningAccount`](../../account/classes/SigningAccount.md))[] + +The signers that are currently present + +#### Returns + +`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +A multisig account wrapper + +#### Example + +```typescript +const account = accountManager.multisig({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]}, + [(await accountManager.fromEnvironment('ACCOUNT1')).account]) +``` + +*** + +### random() + +> **random**(): `Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +Defined in: [src/types/account-manager.ts:421](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L421) + +Tracks and returns a new, random Algorand account with secret key loaded. + +#### Returns + +`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +The account + +#### Example + +```typescript +const account = accountManager.random() +``` + +*** + +### rekeyAccount() + +> **rekeyAccount**(`account`, `rekeyTo`, `options?`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/account-manager.ts:503](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L503) + +Rekey an account to a new address. + +**Note:** Please be careful with this function and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +#### Parameters + +##### account + +The account to rekey + +`string` | `Address` + +##### rekeyTo + +The account address or signing account of the account that will be used to authorise transactions for the rekeyed account going forward. + If a signing account is provided that will now be tracked as the signer for `account` in this `AccountManager` + +`string` | `Address` | [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +##### options? + +`Omit`\<[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md), `"sender"`\> & [`SendParams`](../../transaction/interfaces/SendParams.md) + +Any parameters to control the transaction or execution of the transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the transaction and the transaction that was sent + +#### Examples + +```typescript +await accountManager.rekeyAccount({account: "ACCOUNTADDRESS", rekeyTo: "NEWADDRESS"}) +``` + +```typescript +await accountManager.rekeyAccount({account: account1, rekeyTo: newSignerAccount}) +``` + +```typescript +await accountManager.rekeyAccount({ + account: "ACCOUNTADDRESS", + rekeyTo: "NEWADDRESS", + lease: 'lease', + note: 'note', + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### rekeyed() + +> **rekeyed**(`sender`, `account`): `Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +Defined in: [src/types/account-manager.ts:303](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L303) + +Tracks and returns an Algorand account that is a rekeyed version of the given account to a new sender. + +#### Parameters + +##### sender + +The sender address to use as the new sender + +`string` | `Address` + +##### account + +[`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The account to use as the signer for this new rekeyed account + +#### Returns + +`Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object` + +The account + +#### Example + +```typescript +const account = accountManager.fromMnemonic("mnemonic secret ...") +const rekeyedAccount = accountManager.rekeyed(account, "SENDERADDRESS...") +``` + +*** + +### setDefaultSigner() + +> **setDefaultSigner**(`signer`): `AccountManager` + +Defined in: [src/types/account-manager.ts:101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L101) + +Sets the default signer to use if no other signer is specified. + +If this isn't set an a transaction needs signing for a given sender +then an error will be thrown from `getSigner` / `getAccount`. + +#### Parameters + +##### signer + +The signer to use, either a `TransactionSigner` or a `TransactionSignerAccount` + +`TransactionSigner` | [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +#### Returns + +`AccountManager` + +The `AccountManager` so method calls can be chained + +#### Example + +```typescript +const signer = accountManager.random() // Can be anything that returns a `algosdk.TransactionSigner` or `TransactionSignerAccount` +accountManager.setDefaultSigner(signer) + +// When signing a transaction, if there is no signer registered for the sender then the default signer will be used +const signer = accountManager.getSigner("SENDERADDRESS") +``` + +*** + +### setSigner() + +> **setSigner**(`sender`, `signer`): `AccountManager` + +Defined in: [src/types/account-manager.ts:165](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L165) + +Tracks the given `algosdk.TransactionSigner` against the given sender address for later signing. + +#### Parameters + +##### sender + +The sender address to use this signer for + +`string` | `Address` + +##### signer + +`TransactionSigner` + +The `algosdk.TransactionSigner` to sign transactions with for the given sender + +#### Returns + +`AccountManager` + +The `AccountManager` instance for method chaining + +#### Example + +```typescript +const accountManager = new AccountManager(clientManager) + .setSigner("SENDERADDRESS", transactionSigner) +``` + +*** + +### setSignerFromAccount() + +> **setSignerFromAccount**(`account`): `AccountManager` + +Defined in: [src/types/account-manager.ts:149](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L149) + +Tracks the given account for later signing. + +Note: If you are generating accounts via the various methods on `AccountManager` +(like `random`, `fromMnemonic`, `logicsig`, etc.) then they automatically get tracked. + +#### Parameters + +##### account + +The account to register, which can be a `TransactionSignerAccount` or + a `algosdk.Account`, `algosdk.LogicSigAccount`, `SigningAccount` or `MultisigAccount` + +[`MultisigAccount`](../../account/classes/MultisigAccount.md) | `Account` | [`SigningAccount`](../../account/classes/SigningAccount.md) | [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) | `LogicSigAccount` + +#### Returns + +`AccountManager` + +The `AccountManager` instance for method chaining + +#### Example + +```typescript +const accountManager = new AccountManager(clientManager) + .setSignerFromAccount(algosdk.generateAccount()) + .setSignerFromAccount(new algosdk.LogicSigAccount(program, args)) + .setSignerFromAccount(new SigningAccount(mnemonic, sender)) + .setSignerFromAccount(new MultisigAccount({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]}, [account1, account2])) + .setSignerFromAccount({addr: "SENDERADDRESS", signer: transactionSigner}) +``` + +*** + +### setSigners() + +> **setSigners**(`anotherAccountManager`, `overwriteExisting`): `AccountManager` + +Defined in: [src/types/account-manager.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L182) + +Takes all registered signers from the given `AccountManager` and adds them to this `AccountManager`. + +This is useful for situations where you have multiple contexts you are building accounts in such as unit tests. + +#### Parameters + +##### anotherAccountManager + +`AccountManager` + +Another account manager with signers registered + +##### overwriteExisting + +`boolean` = `true` + +Whether or not to overwrite any signers that have the same sender address with the ones in the other account manager or not (default: true) + +#### Returns + +`AccountManager` + +The `AccountManager` instance for method chaining + +#### Example + +```typescript +accountManager2.setSigners(accountManager1); +``` diff --git a/docs/code/types/account-manager/interfaces/EnsureFundedResult.md b/docs/code/types/account-manager/interfaces/EnsureFundedResult.md new file mode 100644 index 00000000..ae24189e --- /dev/null +++ b/docs/code/types/account-manager/interfaces/EnsureFundedResult.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account-manager](../README.md) / EnsureFundedResult + +# Interface: EnsureFundedResult + +Defined in: [src/types/account-manager.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L18) + +Result from performing an ensureFunded call. + +## Properties + +### amountFunded + +> **amountFunded**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/account-manager.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L22) + +The amount that was sent to the account. + +*** + +### transactionId + +> **transactionId**: `string` + +Defined in: [src/types/account-manager.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L20) + +The transaction ID of the transaction that funded the account. diff --git a/docs/code/types/account-manager/variables/getAccountTransactionSigner.md b/docs/code/types/account-manager/variables/getAccountTransactionSigner.md new file mode 100644 index 00000000..fcccd0f1 --- /dev/null +++ b/docs/code/types/account-manager/variables/getAccountTransactionSigner.md @@ -0,0 +1,32 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account-manager](../README.md) / getAccountTransactionSigner + +# Variable: getAccountTransactionSigner() + +> `const` **getAccountTransactionSigner**: (`val`) => `TransactionSigner` + +Defined in: [src/types/account-manager.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L35) + +Returns a `TransactionSigner` for the given account that can sign a transaction. +This function has memoization, so will return the same transaction signer for a given account. + +## Parameters + +### val + +[`MultisigAccount`](../../account/classes/MultisigAccount.md) | `Account` | [`SigningAccount`](../../account/classes/SigningAccount.md) | [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) | `LogicSigAccount` + +## Returns + +`TransactionSigner` + +A transaction signer + +## Example + +```typescript +const signer = getAccountTransactionSigner(account) +``` diff --git a/docs/code/types/account/README.md b/docs/code/types/account/README.md new file mode 100644 index 00000000..47b3833d --- /dev/null +++ b/docs/code/types/account/README.md @@ -0,0 +1,26 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/account + +# types/account + +## Classes + +- [MultisigAccount](classes/MultisigAccount.md) +- [SigningAccount](classes/SigningAccount.md) + +## Interfaces + +- [~~AccountConfig~~](interfaces/AccountConfig.md) +- [TransactionSignerAccount](interfaces/TransactionSignerAccount.md) + +## Type Aliases + +- [AccountAssetInformation](type-aliases/AccountAssetInformation.md) +- [AccountInformation](type-aliases/AccountInformation.md) + +## Variables + +- [DISPENSER\_ACCOUNT](variables/DISPENSER_ACCOUNT.md) diff --git a/docs/code/types/account/classes/MultisigAccount.md b/docs/code/types/account/classes/MultisigAccount.md new file mode 100644 index 00000000..cdbba00d --- /dev/null +++ b/docs/code/types/account/classes/MultisigAccount.md @@ -0,0 +1,159 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account](../README.md) / MultisigAccount + +# Class: MultisigAccount + +Defined in: [src/types/account.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L20) + +Account wrapper that supports partial or full multisig signing. + +## Constructors + +### Constructor + +> **new MultisigAccount**(`multisigParams`, `signingAccounts`): `MultisigAccount` + +Defined in: [src/types/account.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L46) + +#### Parameters + +##### multisigParams + +`MultisigMetadata` + +##### signingAccounts + +(`Account` \| [`SigningAccount`](SigningAccount.md))[] + +#### Returns + +`MultisigAccount` + +## Properties + +### \_addr + +> **\_addr**: `Address` + +Defined in: [src/types/account.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L23) + +*** + +### \_params + +> **\_params**: `MultisigMetadata` + +Defined in: [src/types/account.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L21) + +*** + +### \_signer + +> **\_signer**: `TransactionSigner` + +Defined in: [src/types/account.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L24) + +*** + +### \_signingAccounts + +> **\_signingAccounts**: (`Account` \| [`SigningAccount`](SigningAccount.md))[] + +Defined in: [src/types/account.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L22) + +## Accessors + +### addr + +#### Get Signature + +> **get** **addr**(): `Readonly`\<`Address`\> + +Defined in: [src/types/account.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L37) + +The address of the multisig account + +##### Returns + +`Readonly`\<`Address`\> + +*** + +### params + +#### Get Signature + +> **get** **params**(): `Readonly`\<`MultisigMetadata`\> + +Defined in: [src/types/account.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L27) + +The parameters for the multisig account + +##### Returns + +`Readonly`\<`MultisigMetadata`\> + +*** + +### signer + +#### Get Signature + +> **get** **signer**(): `TransactionSigner` + +Defined in: [src/types/account.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L42) + +The transaction signer for the multisig account + +##### Returns + +`TransactionSigner` + +*** + +### signingAccounts + +#### Get Signature + +> **get** **signingAccounts**(): readonly (`Account` \| [`SigningAccount`](SigningAccount.md))[] + +Defined in: [src/types/account.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L32) + +The list of accounts that are present to sign + +##### Returns + +readonly (`Account` \| [`SigningAccount`](SigningAccount.md))[] + +## Methods + +### sign() + +> **sign**(`transaction`): `Uint8Array` + +Defined in: [src/types/account.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L65) + +Sign the given transaction + +#### Parameters + +##### transaction + +Either a transaction object or a raw, partially signed transaction + +`Uint8Array`\<`ArrayBufferLike`\> | `Transaction` + +#### Returns + +`Uint8Array` + +The transaction signed by the present signers + +#### Example + +```typescript +const signedTxn = multisigAccount.sign(myTransaction) +``` diff --git a/docs/code/types/account/classes/SigningAccount.md b/docs/code/types/account/classes/SigningAccount.md new file mode 100644 index 00000000..ff607732 --- /dev/null +++ b/docs/code/types/account/classes/SigningAccount.md @@ -0,0 +1,109 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account](../README.md) / SigningAccount + +# Class: SigningAccount + +Defined in: [src/types/account.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L79) + +Account wrapper that supports a rekeyed account + +## Implements + +- `default` + +## Constructors + +### Constructor + +> **new SigningAccount**(`account`, `sender`): `SigningAccount` + +Defined in: [src/types/account.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L115) + +#### Parameters + +##### account + +`Account` + +##### sender + +`undefined` | `string` | `Address` + +#### Returns + +`SigningAccount` + +## Accessors + +### addr + +#### Get Signature + +> **get** **addr**(): `Readonly`\<`Address`\> + +Defined in: [src/types/account.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L87) + +Algorand address of the sender + +##### Returns + +`Readonly`\<`Address`\> + +#### Implementation of + +`Account.addr` + +*** + +### sender + +#### Get Signature + +> **get** **sender**(): `Account` + +Defined in: [src/types/account.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L108) + +Algorand account of the sender address and signer private key + +##### Returns + +`Account` + +*** + +### signer + +#### Get Signature + +> **get** **signer**(): `TransactionSigner` + +Defined in: [src/types/account.ts:101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L101) + +Transaction signer for the underlying signing account + +##### Returns + +`TransactionSigner` + +*** + +### sk + +#### Get Signature + +> **get** **sk**(): `Readonly`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +Defined in: [src/types/account.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L94) + +Secret key belonging to the signer + +##### Returns + +`Readonly`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +#### Implementation of + +`Account.sk` diff --git a/docs/code/types/account/interfaces/AccountConfig.md b/docs/code/types/account/interfaces/AccountConfig.md new file mode 100644 index 00000000..c9f369cb --- /dev/null +++ b/docs/code/types/account/interfaces/AccountConfig.md @@ -0,0 +1,56 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account](../README.md) / AccountConfig + +# Interface: ~~AccountConfig~~ + +Defined in: [src/types/account.ts:292](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L292) + +## Deprecated + +The methods that use this can be achieved using `AccountManager` instead. +Config for an account config + +## Properties + +### ~~accountMnemonic~~ + +> **accountMnemonic**: `string` + +Defined in: [src/types/account.ts:294](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L294) + +Mnemonic for an account + +*** + +### ~~accountName~~ + +> **accountName**: `string` + +Defined in: [src/types/account.ts:298](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L298) + +Account name used to retrieve config + +*** + +### ~~senderAddress?~~ + +> `optional` **senderAddress**: `string` + +Defined in: [src/types/account.ts:296](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L296) + +Address of a rekeyed account + +*** + +### ~~senderMnemonic?~~ + +> `optional` **senderMnemonic**: `string` + +Defined in: [src/types/account.ts:301](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L301) + +#### Deprecated + +Renamed to senderAddress in 2.3.1 diff --git a/docs/code/types/account/interfaces/TransactionSignerAccount.md b/docs/code/types/account/interfaces/TransactionSignerAccount.md new file mode 100644 index 00000000..fb67bc53 --- /dev/null +++ b/docs/code/types/account/interfaces/TransactionSignerAccount.md @@ -0,0 +1,27 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account](../README.md) / TransactionSignerAccount + +# Interface: TransactionSignerAccount + +Defined in: [src/types/account.ts:123](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L123) + +A wrapper around `TransactionSigner` that also has the sender address. + +## Properties + +### addr + +> **addr**: `Readonly`\<`Address`\> + +Defined in: [src/types/account.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L124) + +*** + +### signer + +> **signer**: `TransactionSigner` + +Defined in: [src/types/account.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L125) diff --git a/docs/code/types/account/type-aliases/AccountAssetInformation.md b/docs/code/types/account/type-aliases/AccountAssetInformation.md new file mode 100644 index 00000000..add6304f --- /dev/null +++ b/docs/code/types/account/type-aliases/AccountAssetInformation.md @@ -0,0 +1,53 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account](../README.md) / AccountAssetInformation + +# Type Alias: AccountAssetInformation + +> **AccountAssetInformation** = `object` + +Defined in: [src/types/account.ts:278](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L278) + +Account asset holding information at a given round. + +## Properties + +### assetId + +> **assetId**: `bigint` + +Defined in: [src/types/account.ts:280](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L280) + +The ID of the asset held. + +*** + +### balance + +> **balance**: `bigint` + +Defined in: [src/types/account.ts:282](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L282) + +The current balance of that asset holding. + +*** + +### frozen + +> **frozen**: `boolean` + +Defined in: [src/types/account.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L284) + +Whether or not the asset is frozen for the account. + +*** + +### round + +> **round**: `bigint` + +Defined in: [src/types/account.ts:286](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L286) + +The round as at which the holding was correct. diff --git a/docs/code/types/account/type-aliases/AccountInformation.md b/docs/code/types/account/type-aliases/AccountInformation.md new file mode 100644 index 00000000..048deefd --- /dev/null +++ b/docs/code/types/account/type-aliases/AccountInformation.md @@ -0,0 +1,293 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account](../README.md) / AccountInformation + +# Type Alias: AccountInformation + +> **AccountInformation** = `object` + +Defined in: [src/types/account.ts:129](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L129) + +Account information at a given round. + +## Properties + +### address + +> **address**: `Address` + +Defined in: [src/types/account.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L133) + +The account public key + +*** + +### amountWithoutPendingRewards + +> **amountWithoutPendingRewards**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/account.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L141) + +The amount of Algo in the account, without the pending rewards. + +*** + +### appsLocalState? + +> `optional` **appsLocalState**: `ApplicationLocalState`[] + +Defined in: [src/types/account.ts:198](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L198) + +Applications local data stored in this account. + +*** + +### appsTotalExtraPages? + +> `optional` **appsTotalExtraPages**: `number` + +Defined in: [src/types/account.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L203) + +The sum of all extra application program pages for this account. + +*** + +### appsTotalSchema? + +> `optional` **appsTotalSchema**: `ApplicationStateSchema` + +Defined in: [src/types/account.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L209) + +(tsch) stores the sum of all of the local schemas and global schemas in this +account. +Note: the raw account uses `StateSchema` for this type. + +*** + +### assets? + +> `optional` **assets**: `AssetHolding`[] + +Defined in: [src/types/account.ts:214](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L214) + +Assets held by this account. + +*** + +### authAddr? + +> `optional` **authAddr**: `Address` + +Defined in: [src/types/account.ts:221](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L221) + +The address against which signing should be checked. If empty, the +address of the current account is used. This field can be updated in any +transaction by setting the `RekeyTo` field. + +*** + +### balance + +> **balance**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/account.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L136) + +The balance of Algo currently held by the account. + +*** + +### createdApps? + +> `optional` **createdApps**: `Application`[] + +Defined in: [src/types/account.ts:226](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L226) + +Parameters of applications created by this account including app global data. + +*** + +### createdAssets? + +> `optional` **createdAssets**: `Asset`[] + +Defined in: [src/types/account.ts:232](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L232) + +(apar) parameters of assets created by this account. +Note: the raw account uses `map[int] -> Asset` for this type. + +*** + +### lastHeartbeatRound? + +> `optional` **lastHeartbeatRound**: `bigint` + +Defined in: [src/types/account.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L269) + +The round in which this account last went online, or explicitly renewed their +online status. + +*** + +### lastProposedRound? + +> `optional` **lastProposedRound**: `bigint` + +Defined in: [src/types/account.ts:274](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L274) + +The round in which this account last proposed the block. + +*** + +### minBalance + +> **minBalance**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/account.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L148) + +Algo balance required to be held by the account. + +The requirement grows based on asset and application usage. + +*** + +### participation? + +> `optional` **participation**: `AccountParticipation` + +Defined in: [src/types/account.ts:238](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L238) + +AccountParticipation describes the parameters used by this account in consensus +protocol. + +*** + +### pendingRewards + +> **pendingRewards**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/account.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L152) + +Amount of Algo of pending rewards in this account. + +*** + +### rewardBase? + +> `optional` **rewardBase**: `number` + +Defined in: [src/types/account.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L244) + +Used as part of the rewards computation. Only applicable to accounts +which are participating. + +*** + +### rewards + +> **rewards**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/account.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L158) + +Total rewards of Algo the account has received, including pending +rewards. + +*** + +### sigType? + +> `optional` **sigType**: `string` + +Defined in: [src/types/account.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L252) + +Indicates what type of signature is used by this account, must be one of: +* sig +* msig +* lsig + +*** + +### status + +> **status**: `string` + +Defined in: [src/types/account.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L171) + +Delegation status of the account's Algo: +* Offline - indicates that the associated account is delegated. +* Online - indicates that the associated account used as part of the delegation pool. +* NotParticipating - indicates that the associated account is neither a delegator nor a delegate. + +*** + +### totalAppsOptedIn + +> **totalAppsOptedIn**: `number` + +Defined in: [src/types/account.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L177) + +The count of all applications that have been opted in, equivalent to the count +of application local data (AppLocalState objects) stored in this account. + +*** + +### totalAssetsOptedIn + +> **totalAssetsOptedIn**: `number` + +Defined in: [src/types/account.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L183) + +The count of all assets that have been opted in, equivalent to the count of +AssetHolding objects held by this account. + +*** + +### totalBoxBytes? + +> `optional` **totalBoxBytes**: `number` + +Defined in: [src/types/account.ts:258](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L258) + +The total number of bytes used by this account's app's box keys and +values. + +*** + +### totalBoxes? + +> `optional` **totalBoxes**: `number` + +Defined in: [src/types/account.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L263) + +The number of existing boxes created by this account's app. + +*** + +### totalCreatedApps + +> **totalCreatedApps**: `number` + +Defined in: [src/types/account.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L188) + +The count of all apps (AppParams objects) created by this account. + +*** + +### totalCreatedAssets + +> **totalCreatedAssets**: `number` + +Defined in: [src/types/account.ts:193](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L193) + +The count of all assets (AssetParams objects) created by this account. + +*** + +### validAsOfRound + +> **validAsOfRound**: `bigint` + +Defined in: [src/types/account.ts:163](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L163) + +The round number for which this information is relevant. diff --git a/docs/code/types/account/variables/DISPENSER_ACCOUNT.md b/docs/code/types/account/variables/DISPENSER_ACCOUNT.md new file mode 100644 index 00000000..5fe014ac --- /dev/null +++ b/docs/code/types/account/variables/DISPENSER_ACCOUNT.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/account](../README.md) / DISPENSER\_ACCOUNT + +# Variable: DISPENSER\_ACCOUNT + +> `const` **DISPENSER\_ACCOUNT**: `"DISPENSER"` = `'DISPENSER'` + +Defined in: [src/types/account.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L17) + +The account name identifier used for fund dispensing in test environments diff --git a/docs/code/types/algo-http-client-with-retry/README.md b/docs/code/types/algo-http-client-with-retry/README.md new file mode 100644 index 00000000..2e4fb16d --- /dev/null +++ b/docs/code/types/algo-http-client-with-retry/README.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/algo-http-client-with-retry + +# types/algo-http-client-with-retry + +## Classes + +- [AlgoHttpClientWithRetry](classes/AlgoHttpClientWithRetry.md) diff --git a/docs/code/types/algo-http-client-with-retry/classes/AlgoHttpClientWithRetry.md b/docs/code/types/algo-http-client-with-retry/classes/AlgoHttpClientWithRetry.md new file mode 100644 index 00000000..0e6ff51b --- /dev/null +++ b/docs/code/types/algo-http-client-with-retry/classes/AlgoHttpClientWithRetry.md @@ -0,0 +1,147 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/algo-http-client-with-retry](../README.md) / AlgoHttpClientWithRetry + +# Class: AlgoHttpClientWithRetry + +Defined in: [src/types/algo-http-client-with-retry.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L6) + +A HTTP Client that wraps the Algorand SDK HTTP Client with retries + +## Extends + +- `URLTokenBaseHTTPClient` + +## Constructors + +### Constructor + +> **new AlgoHttpClientWithRetry**(`tokenHeader`, `baseServer`, `port?`, `defaultHeaders?`): `AlgoHttpClientWithRetry` + +Defined in: node\_modules/algosdk/dist/types/client/urlTokenBaseHTTPClient.d.ts:27 + +#### Parameters + +##### tokenHeader + +`TokenHeader` + +##### baseServer + +`string` + +##### port? + +`string` | `number` + +##### defaultHeaders? + +`Record`\<`string`, `any`\> + +#### Returns + +`AlgoHttpClientWithRetry` + +#### Inherited from + +`URLTokenBaseHTTPClient.constructor` + +## Methods + +### delete() + +> **delete**(`relativePath`, `data`, `query?`, `requestHeaders?`): `Promise`\<`BaseHTTPClientResponse`\> + +Defined in: [src/types/algo-http-client-with-retry.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L100) + +#### Parameters + +##### relativePath + +`string` + +##### data + +`Uint8Array` + +##### query? + +`Query`\<`string`\> + +##### requestHeaders? + +`Record`\<`string`, `string`\> = `{}` + +#### Returns + +`Promise`\<`BaseHTTPClientResponse`\> + +#### Overrides + +`URLTokenBaseHTTPClient.delete` + +*** + +### get() + +> **get**(`relativePath`, `query?`, `requestHeaders?`): `Promise`\<`BaseHTTPClientResponse`\> + +Defined in: [src/types/algo-http-client-with-retry.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L57) + +#### Parameters + +##### relativePath + +`string` + +##### query? + +`Query`\<`string`\> + +##### requestHeaders? + +`Record`\<`string`, `string`\> = `{}` + +#### Returns + +`Promise`\<`BaseHTTPClientResponse`\> + +#### Overrides + +`URLTokenBaseHTTPClient.get` + +*** + +### post() + +> **post**(`relativePath`, `data`, `query?`, `requestHeaders?`): `Promise`\<`BaseHTTPClientResponse`\> + +Defined in: [src/types/algo-http-client-with-retry.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algo-http-client-with-retry.ts#L91) + +#### Parameters + +##### relativePath + +`string` + +##### data + +`Uint8Array` + +##### query? + +`Query`\<`string`\> + +##### requestHeaders? + +`Record`\<`string`, `string`\> = `{}` + +#### Returns + +`Promise`\<`BaseHTTPClientResponse`\> + +#### Overrides + +`URLTokenBaseHTTPClient.post` diff --git a/docs/code/types/algorand-client-transaction-creator/README.md b/docs/code/types/algorand-client-transaction-creator/README.md new file mode 100644 index 00000000..49e75c3c --- /dev/null +++ b/docs/code/types/algorand-client-transaction-creator/README.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/algorand-client-transaction-creator + +# types/algorand-client-transaction-creator + +## Classes + +- [AlgorandClientTransactionCreator](classes/AlgorandClientTransactionCreator.md) diff --git a/docs/code/types/algorand-client-transaction-creator/classes/AlgorandClientTransactionCreator.md b/docs/code/types/algorand-client-transaction-creator/classes/AlgorandClientTransactionCreator.md new file mode 100644 index 00000000..59af84f9 --- /dev/null +++ b/docs/code/types/algorand-client-transaction-creator/classes/AlgorandClientTransactionCreator.md @@ -0,0 +1,1372 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/algorand-client-transaction-creator](../README.md) / AlgorandClientTransactionCreator + +# Class: AlgorandClientTransactionCreator + +Defined in: [src/types/algorand-client-transaction-creator.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L8) + +Orchestrates creating transactions for `AlgorandClient`. + +## Constructors + +### Constructor + +> **new AlgorandClientTransactionCreator**(`newGroup`): `AlgorandClientTransactionCreator` + +Defined in: [src/types/algorand-client-transaction-creator.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L19) + +Creates a new `AlgorandClientTransactionCreator` + +#### Parameters + +##### newGroup + +() => [`TransactionComposer`](../../composer/classes/TransactionComposer.md) + +A lambda that starts a new `TransactionComposer` transaction group + +#### Returns + +`AlgorandClientTransactionCreator` + +#### Example + +```typescript +const transactionCreator = new AlgorandClientTransactionCreator(() => new TransactionComposer()) +``` + +## Properties + +### appCall() + +> **appCall**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:458](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L458) + +Create an application call transaction. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +[`AppCallParams`](../../composer/type-aliases/AppCallParams.md) + +The parameters for the app call transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The application call transaction + +#### Examples + +```typescript +await algorand.createTransaction.appCall({ sender: 'CREATORADDRESS' }) +``` + +```typescript +await algorand.createTransaction.appCall({ + sender: 'CREATORADDRESS', + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### appCallMethodCall() + +> **appCallMethodCall**: (`params`) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:653](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L653) + +Create an application call with ABI method call transaction. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +[`AppCallMethodCall`](../../composer/type-aliases/AppCallMethodCall.md) + +The parameters for the app call transaction + +#### Returns + +`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +The application ABI method call transaction + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.createTransaction.appCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.createTransaction.appCallMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### appCreate() + +> **appCreate**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:354](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L354) + +Create an application create transaction. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +The parameters for the app creation transaction + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### approvalProgram + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +The program to execute for all OnCompletes other than ClearState as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)). + +###### args? + +`Uint8Array`\<`ArrayBufferLike`\>[] + +Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### clearStateProgram + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +The program to execute for ClearState OnComplete as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)). + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### extraProgramPages? + +`number` + +Number of extra pages required for the programs. +Defaults to the number needed for the programs in this call if not specified. +This is immutable once the app is created. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### schema? + +\{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \} + +The state schema for the app. This is immutable once the app is created. + +###### schema.globalByteSlices + +`number` + +The number of byte slices saved in global state. + +###### schema.globalInts + +`number` + +The number of integers saved in global state. + +###### schema.localByteSlices + +`number` + +The number of byte slices saved in local state. + +###### schema.localInts + +`number` + +The number of integers saved in local state. + +###### sender + +`string` \| `Address` + +The address of the account sending the transaction. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +#### Returns + +`Promise`\<`Transaction`\> + +The application create transaction + +#### Examples + +```typescript +await algorand.createTransaction.appCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) +``` + +```typescript +await algorand.createTransaction.appCreate({ + sender: 'CREATORADDRESS', + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + schema: { + globalInts: 1, + globalByteSlices: 2, + localInts: 3, + localByteSlices: 4 + }, + extraProgramPages: 1, + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### appCreateMethodCall() + +> **appCreateMethodCall**: (`params`) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L513) + +Create an application create call with ABI method call transaction. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +[`AppCreateMethodCall`](../../composer/type-aliases/AppCreateMethodCall.md) + +The parameters for the app creation transaction + +#### Returns + +`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +The application ABI method create transaction + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.createTransaction.appCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.createTransaction.appCreateMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + schema: { + globalInts: 1, + globalByteSlices: 2, + localInts: 3, + localByteSlices: 4 + }, + extraProgramPages: 1, + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### appDelete() + +> **appDelete**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:424](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L424) + +Create an application delete transaction. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +[`AppDeleteParams`](../../composer/type-aliases/AppDeleteParams.md) + +The parameters for the app deletion transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The application delete transaction + +#### Examples + +```typescript +await algorand.createTransaction.appDelete({ sender: 'CREATORADDRESS' }) +``` + +```typescript +await algorand.createTransaction.appDelete({ + sender: 'CREATORADDRESS', + onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### appDeleteMethodCall() + +> **appDeleteMethodCall**: (`params`) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:607](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L607) + +Create an application delete call with ABI method call transaction. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +[`AppDeleteMethodCall`](../../composer/type-aliases/AppDeleteMethodCall.md) + +The parameters for the app deletion transaction + +#### Returns + +`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +The application ABI method delete transaction + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.createTransaction.appDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.createTransaction.appDeleteMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### appUpdate() + +> **appUpdate**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:390](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L390) + +Create an application update transaction. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +The parameters for the app update transaction + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appId + +`bigint` + +ID of the application; 0 if the application is being created. + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### approvalProgram + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +The program to execute for all OnCompletes other than ClearState as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array)) + +###### args? + +`Uint8Array`\<`ArrayBufferLike`\>[] + +Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### clearStateProgram + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +The program to execute for ClearState OnComplete as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array)) + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`UpdateApplicationOC` + +The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### sender + +`string` \| `Address` + +The address of the account sending the transaction. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +#### Returns + +`Promise`\<`Transaction`\> + +The application update transaction + +#### Examples + +```typescript +await algorand.createTransaction.appUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) +``` + +```typescript +await algorand.createTransaction.appUpdate({ + sender: 'CREATORADDRESS', + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### appUpdateMethodCall() + +> **appUpdateMethodCall**: (`params`) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:561](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L561) + +Create an application update call with ABI method call transaction. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +[`AppUpdateMethodCall`](../../composer/type-aliases/AppUpdateMethodCall.md) + +The parameters for the app update transaction + +#### Returns + +`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +The application ABI method update transaction + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.createTransaction.appUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.createTransaction.appUpdateMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### assetConfig() + +> **assetConfig**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L151) + +Create an asset config transaction to reconfigure an existing Algorand Standard Asset. + +**Note:** The manager, reserve, freeze, and clawback addresses +are immutably empty if they are not set. If manager is not set then +all fields are immutable from that point forward. + +#### Parameters + +##### params + +[`AssetConfigParams`](../../composer/type-aliases/AssetConfigParams.md) + +The parameters for the asset config transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The asset config transaction + +#### Examples + +```typescript +await algorand.createTransaction.assetConfig({ sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" }) +``` + +```typescript +await algorand.createTransaction.assetConfig({ + sender: 'MANAGERADDRESS', + assetId: 123456n, + manager: 'MANAGERADDRESS', + reserve: 'RESERVEADDRESS', + freeze: 'FREEZEADDRESS', + clawback: 'CLAWBACKADDRESS', + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### assetCreate() + +> **assetCreate**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L115) + +Create a create Algorand Standard Asset transaction. + +The account that sends this transaction will automatically be +opted in to the asset and will hold all units after creation. + +#### Parameters + +##### params + +[`AssetCreateParams`](../../composer/type-aliases/AssetCreateParams.md) + +The parameters for the asset creation transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The asset create transaction + +#### Examples + +```typescript +await algorand.createTransaction.assetCreate({ sender: "CREATORADDRESS", total: 100n}) +``` + +```typescript +await algorand.createTransaction.assetCreate({ + sender: 'CREATORADDRESS', + total: 100n, + decimals: 2, + assetName: 'asset', + unitName: 'unit', + url: 'url', + metadataHash: 'metadataHash', + defaultFrozen: false, + manager: 'MANAGERADDRESS', + reserve: 'RESERVEADDRESS', + freeze: 'FREEZEADDRESS', + clawback: 'CLAWBACKADDRESS', + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### assetDestroy() + +> **assetDestroy**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:213](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L213) + +Create an Algorand Standard Asset destroy transaction. + +Created assets can be destroyed only by the asset manager account. +All of the assets must be owned by the creator of the asset before +the asset can be deleted. + +#### Parameters + +##### params + +[`AssetDestroyParams`](../../composer/type-aliases/AssetDestroyParams.md) + +The parameters for the asset destroy transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The asset destroy transaction + +#### Examples + +```typescript +await algorand.createTransaction.assetDestroy({ sender: "MANAGERADDRESS", assetId: 123456n }) +``` + +```typescript +await algorand.createTransaction.assetDestroy({ + sender: 'MANAGERADDRESS', + assetId: 123456n, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### assetFreeze() + +> **assetFreeze**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L181) + +Create an Algorand Standard Asset freeze transaction. + +#### Parameters + +##### params + +[`AssetFreezeParams`](../../composer/type-aliases/AssetFreezeParams.md) + +The parameters for the asset freeze transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The asset freeze transaction + +#### Examples + +```typescript +await algorand.createTransaction.assetFreeze({ sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true }) +``` + +```typescript +await algorand.createTransaction.assetFreeze({ + sender: 'MANAGERADDRESS', + assetId: 123456n, + account: 'ACCOUNTADDRESS', + frozen: true, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### assetOptIn() + +> **assetOptIn**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:274](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L274) + +Create an Algorand Standard Asset opt-in transaction. + +#### Parameters + +##### params + +[`AssetOptInParams`](../../composer/type-aliases/AssetOptInParams.md) + +The parameters for the asset opt-in transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The asset opt-in transaction + +#### Examples + +```typescript +await algorand.createTransaction.assetOptIn({ sender: "SENDERADDRESS", assetId: 123456n }) +``` + +```typescript +await algorand.createTransaction.assetOptIn({ + sender: 'SENDERADDRESS', + assetId: 123456n, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### assetOptOut() + +> **assetOptOut**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L311) + +Create an asset opt-out transaction. + +*Note:* If the account has a balance of the asset, +it will lose those assets + +#### Parameters + +##### params + +[`AssetOptOutParams`](../../composer/type-aliases/AssetOptOutParams.md) + +The parameters for the asset opt-out transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The asset opt-out transaction + +#### Examples + +```typescript +await algorand.createTransaction.assetOptOut({ sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true }) +``` + +```typescript +await algorand.createTransaction.assetOptOut({ sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true }) +``` + +```typescript +await algorand.createTransaction.assetOptOut({ + sender: 'SENDERADDRESS', + assetId: 123456n, + creator: 'CREATORADDRESS', + ensureZeroBalance: true, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### assetTransfer() + +> **assetTransfer**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:246](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L246) + +Create an Algorand Standard Asset transfer transaction. + +#### Parameters + +##### params + +[`AssetTransferParams`](../../composer/type-aliases/AssetTransferParams.md) + +The parameters for the asset transfer transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The result of the asset transfer transaction + +#### Examples + +```typescript +await algorand.createTransaction.assetTransfer({ sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" }) +``` + +```typescript +await algorand.createTransaction.assetTransfer({ + sender: 'CLAWBACKADDRESS', + assetId: 123456n, + amount: 1n, + receiver: 'RECEIVERADDRESS', + clawbackTarget: 'HOLDERADDRESS', + // This field needs to be used with caution + closeAssetTo: 'ADDRESSTOCLOSETO' + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### offlineKeyRegistration() + +> **offlineKeyRegistration**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:725](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L725) + +Create an offline key registration transaction. + +#### Parameters + +##### params + +[`OfflineKeyRegistrationParams`](../../composer/type-aliases/OfflineKeyRegistrationParams.md) + +The parameters for the key registration transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The offline key registration transaction + +#### Examples + +```typescript +await algorand.createTransaction.offlineKeyRegistration({ + sender: 'SENDERADDRESS', +}) +``` + +```typescript +await algorand.createTransaction.offlineKeyRegistration({ + sender: 'SENDERADDRESS', + lease: 'lease', + note: 'note', + // Use this with caution, it's generally better to use algorand.account.rekeyAccount + rekeyTo: 'REKEYTOADDRESS', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### onlineKeyRegistration() + +> **onlineKeyRegistration**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:695](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L695) + +Create an online key registration transaction. + +#### Parameters + +##### params + +[`OnlineKeyRegistrationParams`](../../composer/type-aliases/OnlineKeyRegistrationParams.md) + +The parameters for the key registration transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The online key registration transaction + +#### Examples + +```typescript +await algorand.createTransaction.onlineKeyRegistration({ + sender: 'SENDERADDRESS', + voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), + selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), + stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), + voteFirst: 1n, + voteLast: 1000n, + voteKeyDilution: 1n, +}) +``` + +```typescript +await algorand.createTransaction.onlineKeyRegistration({ + sender: 'SENDERADDRESS', + voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), + selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), + stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), + voteFirst: 1n, + voteLast: 1000n, + voteKeyDilution: 1n, + lease: 'lease', + note: 'note', + // Use this with caution, it's generally better to use algorand.account.rekeyAccount + rekeyTo: 'REKEYTOADDRESS', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### payment() + +> **payment**: (`params`) => `Promise`\<`Transaction`\> + +Defined in: [src/types/algorand-client-transaction-creator.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-creator.ts#L74) + +Create a payment transaction to transfer Algo between accounts. + +#### Parameters + +##### params + +[`PaymentParams`](../../composer/type-aliases/PaymentParams.md) + +The parameters for the payment transaction + +#### Returns + +`Promise`\<`Transaction`\> + +The payment transaction + +#### Examples + +```typescript +await algorand.createTransaction.payment({ + sender: 'SENDERADDRESS', + receiver: 'RECEIVERADDRESS', + amount: (4).algo(), +}) +``` + +```typescript +await algorand.createTransaction.payment({ + amount: (4).algo(), + receiver: 'RECEIVERADDRESS', + sender: 'SENDERADDRESS', + closeRemainderTo: 'CLOSEREMAINDERTOADDRESS', + lease: 'lease', + note: 'note', + // Use this with caution, it's generally better to use algorand.account.rekeyAccount + rekeyTo: 'REKEYTOADDRESS', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` diff --git a/docs/code/types/algorand-client-transaction-sender/README.md b/docs/code/types/algorand-client-transaction-sender/README.md new file mode 100644 index 00000000..f6d62ba9 --- /dev/null +++ b/docs/code/types/algorand-client-transaction-sender/README.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/algorand-client-transaction-sender + +# types/algorand-client-transaction-sender + +## Classes + +- [AlgorandClientTransactionSender](classes/AlgorandClientTransactionSender.md) diff --git a/docs/code/types/algorand-client-transaction-sender/classes/AlgorandClientTransactionSender.md b/docs/code/types/algorand-client-transaction-sender/classes/AlgorandClientTransactionSender.md new file mode 100644 index 00000000..451fdd4b --- /dev/null +++ b/docs/code/types/algorand-client-transaction-sender/classes/AlgorandClientTransactionSender.md @@ -0,0 +1,1212 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/algorand-client-transaction-sender](../README.md) / AlgorandClientTransactionSender + +# Class: AlgorandClientTransactionSender + +Defined in: [src/types/algorand-client-transaction-sender.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L36) + +Orchestrates sending transactions for `AlgorandClient`. + +## Constructors + +### Constructor + +> **new AlgorandClientTransactionSender**(`newGroup`, `assetManager`, `appManager`): `AlgorandClientTransactionSender` + +Defined in: [src/types/algorand-client-transaction-sender.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L51) + +Creates a new `AlgorandClientSender` + +#### Parameters + +##### newGroup + +() => [`TransactionComposer`](../../composer/classes/TransactionComposer.md) + +A lambda that starts a new `TransactionComposer` transaction group + +##### assetManager + +[`AssetManager`](../../asset-manager/classes/AssetManager.md) + +An `AssetManager` instance + +##### appManager + +[`AppManager`](../../app-manager/classes/AppManager.md) + +An `AppManager` instance + +#### Returns + +`AlgorandClientTransactionSender` + +#### Example + +```typescript +const transactionSender = new AlgorandClientTransactionSender(() => new TransactionComposer(), assetManager, appManager) +``` + +## Properties + +### appCall() + +> **appCall**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:731](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L731) + +Call a smart contract. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the app call transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the app call transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.appCall({ sender: 'CREATORADDRESS' }) +``` + +```typescript +await algorand.send.appCall({ + sender: 'CREATORADDRESS', + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### appCallMethodCall() + +> **appCallMethodCall**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:971](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L971) + +Call a smart contract via an ABI method. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +`object` & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the app call transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the application ABI method call transaction and the transaction that was sent + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.send.appCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.send.appCallMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### appCreate() + +> **appCreate**: (`params`) => `Promise`\<\{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:594](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L594) + +Create a smart contract. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +`object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the app creation transaction + +#### Returns + +`Promise`\<\{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the app create transaction and the transaction that was sent + +#### Examples + +```typescript +const result = await algorand.send.appCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) +const createdAppId = result.appId +``` + +```typescript +await algorand.send.appCreate({ + sender: 'CREATORADDRESS', + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + schema: { + globalInts: 1, + globalByteSlices: 2, + localInts: 3, + localByteSlices: 4 + }, + extraProgramPages: 1, + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### appCreateMethodCall() + +> **appCreateMethodCall**: (`params`) => `Promise`\<\{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:798](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L798) + +Create a smart contract via an ABI method. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +`object` & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the app creation transaction + +#### Returns + +`Promise`\<\{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the application ABI method create transaction and the transaction that was sent + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +const result = await algorand.send.appCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) +const createdAppId = result.appId +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.send.appCreateMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + schema: { + globalInts: 1, + globalByteSlices: 2, + localInts: 3, + localByteSlices: 4 + }, + extraProgramPages: 1, + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### appDelete() + +> **appDelete**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:686](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L686) + +Delete a smart contract. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the app deletion transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the app delete transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.appDelete({ sender: 'CREATORADDRESS' }) +``` + +```typescript +await algorand.send.appDelete({ + sender: 'CREATORADDRESS', + onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### appDeleteMethodCall() + +> **appDeleteMethodCall**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:914](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L914) + +Delete a smart contract via an ABI method. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +`object` & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the app deletion transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the application ABI method delete transaction and the transaction that was sent + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.send.appDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.send.appDeleteMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### appUpdate() + +> **appUpdate**: (`params`) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:641](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L641) + +Update a smart contract. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +`object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the app update transaction + +#### Returns + +`Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the app update transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.appUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) +``` + +```typescript +await algorand.send.appUpdate({ + sender: 'CREATORADDRESS', + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### appUpdateMethodCall() + +> **appUpdateMethodCall**: (`params`) => `Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:857](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L857) + +Update a smart contract via an ABI method. + +Note: you may prefer to use `algorand.client` to get an app client for more advanced functionality. + +#### Parameters + +##### params + +`object` & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the app update transaction + +#### Returns + +`Promise`\<\{ `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the application ABI method update transaction and the transaction that was sent + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.send.appUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +await algorand.send.appUpdateMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### assetConfig() + +> **assetConfig**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L304) + +Configure an existing Algorand Standard Asset. + +**Note:** The manager, reserve, freeze, and clawback addresses +are immutably empty if they are not set. If manager is not set then +all fields are immutable from that point forward. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the asset config transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the asset config transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.assetConfig({ sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" }) +``` + +```typescript +await algorand.send.assetConfig({ + sender: 'MANAGERADDRESS', + assetId: 123456n, + manager: 'MANAGERADDRESS', + reserve: 'RESERVEADDRESS', + freeze: 'FREEZEADDRESS', + clawback: 'CLAWBACKADDRESS', + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### assetDestroy() + +> **assetDestroy**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:384](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L384) + +Destroys an Algorand Standard Asset. + +Created assets can be destroyed only by the asset manager account. +All of the assets must be owned by the creator of the asset before +the asset can be deleted. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the asset destroy transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the asset destroy transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.assetDestroy({ sender: "MANAGERADDRESS", assetId: 123456n }) +``` + +```typescript +await algorand.send.assetDestroy({ + sender: 'MANAGERADDRESS', + assetId: 123456n, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### assetFreeze() + +> **assetFreeze**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L343) + +Freeze or unfreeze an Algorand Standard Asset for an account. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the asset freeze transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the asset freeze transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.assetFreeze({ sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true }) +``` + +```typescript +await algorand.send.assetFreeze({ + sender: 'MANAGERADDRESS', + assetId: 123456n, + account: 'ACCOUNTADDRESS', + frozen: true, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### assetOptIn() + +> **assetOptIn**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:464](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L464) + +Opt an account into an Algorand Standard Asset. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the asset opt-in transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the asset opt-in transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.assetOptIn({ sender: "SENDERADDRESS", assetId: 123456n }) +``` + +```typescript +await algorand.send.assetOptIn({ + sender: 'SENDERADDRESS', + assetId: 123456n, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### assetTransfer() + +> **assetTransfer**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:426](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L426) + +Transfer an Algorand Standard Asset. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the asset transfer transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the asset transfer transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.assetTransfer({ sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" }) +``` + +```typescript +await algorand.send.assetTransfer({ + sender: 'CLAWBACKADDRESS', + assetId: 123456n, + amount: 1n, + receiver: 'RECEIVERADDRESS', + clawbackTarget: 'HOLDERADDRESS', + // This field needs to be used with caution + closeAssetTo: 'ADDRESSTOCLOSETO' + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### offlineKeyRegistration() + +> **offlineKeyRegistration**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:1050](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L1050) + +Register an offline key. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the key registration transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the offline key registration transaction and the transaction that was sent + +#### Examples + +```typescript +const result = await algorand.send.offlineKeyRegistration({ + sender: 'SENDERADDRESS', +}) +``` + +```typescript +const result = await algorand.send.offlineKeyRegistration({ + sender: 'SENDERADDRESS', + lease: 'lease', + note: 'note', + // Use this with caution, it's generally better to use algorand.account.rekeyAccount + rekeyTo: 'REKEYTOADDRESS', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### onlineKeyRegistration() + +> **onlineKeyRegistration**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:1017](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L1017) + +Register an online key. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the key registration transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the online key registration transaction and the transaction that was sent + +#### Examples + +```typescript +const result = await algorand.send.onlineKeyRegistration({ + sender: 'SENDERADDRESS', + voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), + selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), + stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), + voteFirst: 1n, + voteLast: 1000n, + voteKeyDilution: 1n, +}) +``` + +```typescript +const result = await algorand.send.onlineKeyRegistration({ + sender: 'SENDERADDRESS', + voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), + selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), + stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), + voteFirst: 1n, + voteLast: 1000n, + voteKeyDilution: 1n, + lease: 'lease', + note: 'note', + // Use this with caution, it's generally better to use algorand.account.rekeyAccount + rekeyTo: 'REKEYTOADDRESS', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### payment() + +> **payment**: (`params`) => `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:204](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L204) + +Send a payment transaction to transfer Algo between accounts. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the payment transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the payment transaction and the transaction that was sent + +#### Examples + +```typescript +const result = await algorand.send.payment({ + sender: 'SENDERADDRESS', + receiver: 'RECEIVERADDRESS', + amount: (4).algo(), +}) +``` + +```typescript +const result = await algorand.send.payment({ + amount: (4).algo(), + receiver: 'RECEIVERADDRESS', + sender: 'SENDERADDRESS', + closeRemainderTo: 'CLOSEREMAINDERTOADDRESS', + lease: 'lease', + note: 'note', + // Use this with caution, it's generally better to use algorand.account.rekeyAccount + rekeyTo: 'REKEYTOADDRESS', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +## Methods + +### assetCreate() + +> **assetCreate**(`params`): `Promise`\<\{ `assetId`: `bigint`; `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L255) + +Create a new Algorand Standard Asset. + +The account that sends this transaction will automatically be +opted in to the asset and will hold all units after creation. + +#### Parameters + +##### params + +[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md) & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the asset creation transaction + +#### Returns + +`Promise`\<\{ `assetId`: `bigint`; `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the asset create transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.assetCreate({ sender: "CREATORADDRESS", total: 100n}) +``` + +```typescript +await algorand.send.assetCreate({ + sender: 'CREATORADDRESS', + total: 100n, + decimals: 2, + assetName: 'asset', + unitName: 'unit', + url: 'url', + metadataHash: 'metadataHash', + defaultFrozen: false, + manager: 'MANAGERADDRESS', + reserve: 'RESERVEADDRESS', + freeze: 'FREEZEADDRESS', + clawback: 'CLAWBACKADDRESS', + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### assetOptOut() + +> **assetOptOut**(`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/algorand-client-transaction-sender.ts:511](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L511) + +Opt an account out of an Algorand Standard Asset. + +*Note:* If the account has a balance of the asset, +it will not be able to opt-out unless `ensureZeroBalance` +is set to `false` (but then the account will lose the assets). + +#### Parameters + +##### params + +`Omit`\<[`AssetOptOutParams`](../../composer/type-aliases/AssetOptOutParams.md), `"creator"`\> & `object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters for the asset opt-out transaction + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the asset opt-out transaction and the transaction that was sent + +#### Examples + +```typescript +await algorand.send.assetOptOut({ sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true }) +``` + +```typescript +await algorand.send.assetOptOut({ sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true }) +``` + +```typescript +await algorand.send.assetOptOut({ + sender: 'SENDERADDRESS', + assetId: 123456n, + creator: 'CREATORADDRESS', + ensureZeroBalance: true, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### newGroup() + +> **newGroup**(): [`TransactionComposer`](../../composer/classes/TransactionComposer.md) + +Defined in: [src/types/algorand-client-transaction-sender.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client-transaction-sender.ts#L64) + +Start a new `TransactionComposer` transaction group + +#### Returns + +[`TransactionComposer`](../../composer/classes/TransactionComposer.md) + +A new instance of `TransactionComposer`. + +#### Example + +```ts +const composer = AlgorandClient.mainNet().send.newGroup(); +const result = await composer.addTransaction(payment).send() +``` diff --git a/docs/code/types/algorand-client.asset.spec/README.md b/docs/code/types/algorand-client.asset.spec/README.md new file mode 100644 index 00000000..dc0b7d02 --- /dev/null +++ b/docs/code/types/algorand-client.asset.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/algorand-client.asset.spec + +# types/algorand-client.asset.spec diff --git a/docs/code/types/algorand-client.spec/README.md b/docs/code/types/algorand-client.spec/README.md new file mode 100644 index 00000000..08f27693 --- /dev/null +++ b/docs/code/types/algorand-client.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/algorand-client.spec + +# types/algorand-client.spec diff --git a/docs/code/types/algorand-client.transfer.spec/README.md b/docs/code/types/algorand-client.transfer.spec/README.md new file mode 100644 index 00000000..68079862 --- /dev/null +++ b/docs/code/types/algorand-client.transfer.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/algorand-client.transfer.spec + +# types/algorand-client.transfer.spec diff --git a/docs/code/types/algorand-client/README.md b/docs/code/types/algorand-client/README.md new file mode 100644 index 00000000..ee550edf --- /dev/null +++ b/docs/code/types/algorand-client/README.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/algorand-client + +# types/algorand-client + +## Classes + +- [AlgorandClient](classes/AlgorandClient.md) diff --git a/docs/code/types/algorand-client/classes/AlgorandClient.md b/docs/code/types/algorand-client/classes/AlgorandClient.md new file mode 100644 index 00000000..b438daca --- /dev/null +++ b/docs/code/types/algorand-client/classes/AlgorandClient.md @@ -0,0 +1,593 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/algorand-client](../README.md) / AlgorandClient + +# Class: AlgorandClient + +Defined in: [src/types/algorand-client.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L18) + +A client that brokers easy access to Algorand functionality. + +## Accessors + +### account + +#### Get Signature + +> **get** **account**(): [`AccountManager`](../../account-manager/classes/AccountManager.md) + +Defined in: [src/types/algorand-client.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L175) + +Get or create accounts that can sign transactions. + +##### Example + +```ts +const accountManager = AlgorandClient.mainNet().account; +``` + +##### Returns + +[`AccountManager`](../../account-manager/classes/AccountManager.md) + +The `AccountManager` instance. + +*** + +### app + +#### Get Signature + +> **get** **app**(): [`AppManager`](../../app-manager/classes/AppManager.md) + +Defined in: [src/types/algorand-client.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L195) + +Methods for interacting with apps. + +##### Example + +```ts +const appManager = AlgorandClient.mainNet().app; +``` + +##### Returns + +[`AppManager`](../../app-manager/classes/AppManager.md) + +The `AppManager` instance. + +*** + +### appDeployer + +#### Get Signature + +> **get** **appDeployer**(): [`AppDeployer`](../../app-deployer/classes/AppDeployer.md) + +Defined in: [src/types/algorand-client.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L205) + +Methods for deploying apps and managing app deployment metadata. + +##### Example + +```ts +const deployer = AlgorandClient.mainNet().appDeployer; +``` + +##### Returns + +[`AppDeployer`](../../app-deployer/classes/AppDeployer.md) + +The `AppDeployer` instance. + +*** + +### asset + +#### Get Signature + +> **get** **asset**(): [`AssetManager`](../../asset-manager/classes/AssetManager.md) + +Defined in: [src/types/algorand-client.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L185) + +Methods for interacting with assets. + +##### Example + +```ts +const assetManager = AlgorandClient.mainNet().asset; +``` + +##### Returns + +[`AssetManager`](../../asset-manager/classes/AssetManager.md) + +The `AssetManager` instance. + +*** + +### client + +#### Get Signature + +> **get** **client**(): [`ClientManager`](../../client-manager/classes/ClientManager.md) + +Defined in: [src/types/algorand-client.ts:165](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L165) + +Get clients, including algosdk clients and app clients. + +##### Example + +```ts +const clientManager = AlgorandClient.mainNet().client; +``` + +##### Returns + +[`ClientManager`](../../client-manager/classes/ClientManager.md) + +The `ClientManager` instance. + +*** + +### createTransaction + +#### Get Signature + +> **get** **createTransaction**(): [`AlgorandClientTransactionCreator`](../../algorand-client-transaction-creator/classes/AlgorandClientTransactionCreator.md) + +Defined in: [src/types/algorand-client.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L250) + +Methods for creating a transaction. + +##### Example + +```ts +const payment = await AlgorandClient.mainNet().createTransaction.payment({ + sender: "SENDERADDRESS", + receiver: "RECEIVERADDRESS", + amount: algo(1) +}) +``` + +##### Returns + +[`AlgorandClientTransactionCreator`](../../algorand-client-transaction-creator/classes/AlgorandClientTransactionCreator.md) + +The `AlgorandClientTransactionCreator` instance. + +*** + +### send + +#### Get Signature + +> **get** **send**(): [`AlgorandClientTransactionSender`](../../algorand-client-transaction-sender/classes/AlgorandClientTransactionSender.md) + +Defined in: [src/types/algorand-client.ts:236](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L236) + +Methods for sending a transaction. + +##### Example + +```ts +const result = await AlgorandClient.mainNet().send.payment({ + sender: "SENDERADDRESS", + receiver: "RECEIVERADDRESS", + amount: algo(1) +}) +``` + +##### Returns + +[`AlgorandClientTransactionSender`](../../algorand-client-transaction-sender/classes/AlgorandClientTransactionSender.md) + +The `AlgorandClientTransactionSender` instance. + +## Methods + +### getSuggestedParams() + +> **getSuggestedParams**(): `Promise`\<`SuggestedParams`\> + +Defined in: [src/types/algorand-client.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L144) + +Get suggested params for a transaction (either cached or from algod if the cache is stale or empty) + +#### Returns + +`Promise`\<`SuggestedParams`\> + +The suggested transaction parameters. + +#### Example + +```ts +const params = await AlgorandClient.mainNet().getSuggestedParams(); +``` + +*** + +### newGroup() + +> **newGroup**(): [`TransactionComposer`](../../composer/classes/TransactionComposer.md) + +Defined in: [src/types/algorand-client.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L216) + +Start a new `TransactionComposer` transaction group + +#### Returns + +[`TransactionComposer`](../../composer/classes/TransactionComposer.md) + +A new instance of `TransactionComposer`. + +#### Example + +```ts +const composer = AlgorandClient.mainNet().newGroup(); +const result = await composer.addTransaction(payment).send() +``` + +*** + +### setDefaultSigner() + +> **setDefaultSigner**(`signer`): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L67) + +Sets the default signer to use if no other signer is specified. + +#### Parameters + +##### signer + +The signer to use, either a `TransactionSigner` or a `TransactionSignerAccount` + +`TransactionSigner` | [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +#### Returns + +`AlgorandClient` + +The `AlgorandClient` so method calls can be chained + +#### Example + +```typescript +const signer = new SigningAccount(account, account.addr) +const algorand = AlgorandClient.mainNet().setDefaultSigner(signer) +``` + +*** + +### setDefaultValidityWindow() + +> **setDefaultValidityWindow**(`validityWindow`): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L52) + +Sets the default validity window for transactions. + +#### Parameters + +##### validityWindow + +The number of rounds between the first and last valid rounds + +`number` | `bigint` + +#### Returns + +`AlgorandClient` + +The `AlgorandClient` so method calls can be chained + +#### Example + +```typescript +const algorand = AlgorandClient.mainNet().setDefaultValidityWindow(1000); +``` + +*** + +### setSigner() + +> **setSigner**(`sender`, `signer`): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L103) + +Tracks the given signer against the given sender for later signing. + +#### Parameters + +##### sender + +The sender address to use this signer for + +`string` | `Address` + +##### signer + +`TransactionSigner` + +The signer to sign transactions with for the given sender + +#### Returns + +`AlgorandClient` + +The `AlgorandClient` so method calls can be chained + +#### Example + +```typescript +const signer = new SigningAccount(account, account.addr) +const algorand = AlgorandClient.mainNet().setSigner(signer.addr, signer.signer) +``` + +*** + +### setSignerFromAccount() + +> **setSignerFromAccount**(`account`): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L87) + +Tracks the given account (object that encapsulates an address and a signer) for later signing. + +#### Parameters + +##### account + +The account to register, which can be a `TransactionSignerAccount` or + a `algosdk.Account`, `algosdk.LogicSigAccount`, `SigningAccount` or `MultisigAccount` + +[`MultisigAccount`](../../account/classes/MultisigAccount.md) | `Account` | [`SigningAccount`](../../account/classes/SigningAccount.md) | [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) | `LogicSigAccount` + +#### Returns + +`AlgorandClient` + +The `AlgorandClient` so method calls can be chained + +#### Example + +```typescript +const accountManager = AlgorandClient.mainNet() + .setSignerFromAccount(algosdk.generateAccount()) + .setSignerFromAccount(new algosdk.LogicSigAccount(program, args)) + .setSignerFromAccount(new SigningAccount(account, sender)) + .setSignerFromAccount(new MultisigAccount({version: 1, threshold: 1, addrs: ["ADDRESS1...", "ADDRESS2..."]}, [account1, account2])) + .setSignerFromAccount({addr: "SENDERADDRESS", signer: transactionSigner}) +``` + +*** + +### setSuggestedParamsCache() + +> **setSuggestedParamsCache**(`suggestedParams`, `until?`): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L118) + +Sets a cache value to use for suggested transaction params. + +#### Parameters + +##### suggestedParams + +`SuggestedParams` + +The suggested params to use + +##### until? + +`Date` + +A date until which to cache, or if not specified then the timeout is used + +#### Returns + +`AlgorandClient` + +The `AlgorandClient` so method calls can be chained + +#### Example + +```typescript +const algorand = AlgorandClient.mainNet().setSuggestedParamsCache(suggestedParams, new Date(+new Date() + 3_600_000)) +``` + +*** + +### setSuggestedParamsCacheTimeout() + +> **setSuggestedParamsCacheTimeout**(`timeout`): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L133) + +Sets the timeout for caching suggested params. + +#### Parameters + +##### timeout + +`number` + +The timeout in milliseconds + +#### Returns + +`AlgorandClient` + +The `AlgorandClient` so method calls can be chained + +#### Example + +```typescript +const algorand = AlgorandClient.mainNet().setSuggestedParamsCacheTimeout(10_000) +``` + +*** + +### defaultLocalNet() + +> `static` **defaultLocalNet**(): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:262](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L262) + +Creates an `AlgorandClient` pointing at default LocalNet ports and API token. + +#### Returns + +`AlgorandClient` + +An instance of the `AlgorandClient`. + +#### Example + +```ts +const algorand = AlgorandClient.defaultLocalNet(); +``` + +*** + +### fromClients() + +> `static` **fromClients**(`clients`): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L305) + +Creates an `AlgorandClient` pointing to the given client(s). + +#### Parameters + +##### clients + +[`AlgoSdkClients`](../../client-manager/interfaces/AlgoSdkClients.md) + +The clients to use. + +#### Returns + +`AlgorandClient` + +An instance of the `AlgorandClient`. + +#### Example + +```ts +const algorand = AlgorandClient.fromClients({ algod, indexer, kmd }); +``` + +*** + +### fromConfig() + +> `static` **fromConfig**(`config`): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:339](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L339) + +Creates an `AlgorandClient` from the given config. + +#### Parameters + +##### config + +[`AlgoConfig`](../../network-client/interfaces/AlgoConfig.md) + +The config to use. + +#### Returns + +`AlgorandClient` + +An instance of the `AlgorandClient`. + +#### Example + +```ts +const client = AlgorandClient.fromConfig({ algodConfig, indexerConfig, kmdConfig }); +``` + +*** + +### fromEnvironment() + +> `static` **fromEnvironment**(): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L328) + +Creates an `AlgorandClient` loading the configuration from environment variables. + +Retrieve configurations from environment variables when defined or get default LocalNet configuration if they aren't defined. + +Expects to be called from a Node.js environment. + +If `process.env.ALGOD_SERVER` is defined it will use that along with optional `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN`. + +If `process.env.INDEXER_SERVER` is defined it will use that along with optional `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`. + +If either aren't defined it will use the default LocalNet config. + +It will return a KMD configuration that uses `process.env.KMD_PORT` (or port 4002) if `process.env.ALGOD_SERVER` is defined, +otherwise it will use the default LocalNet config unless it detects testnet or mainnet. + +#### Returns + +`AlgorandClient` + +An instance of the `AlgorandClient`. + +#### Example + +```ts +const client = AlgorandClient.fromEnvironment(); +``` + +*** + +### mainNet() + +> `static` **mainNet**(): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:290](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L290) + +Creates an `AlgorandClient` pointing at MainNet using AlgoNode. + +#### Returns + +`AlgorandClient` + +An instance of the `AlgorandClient`. + +#### Example + +```ts +const algorand = AlgorandClient.mainNet(); +``` + +*** + +### testNet() + +> `static` **testNet**(): `AlgorandClient` + +Defined in: [src/types/algorand-client.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/algorand-client.ts#L276) + +Creates an `AlgorandClient` pointing at TestNet using AlgoNode. + +#### Returns + +`AlgorandClient` + +An instance of the `AlgorandClient`. + +#### Example + +```ts +const algorand = AlgorandClient.testNet(); +``` diff --git a/docs/code/types/amount.spec/README.md b/docs/code/types/amount.spec/README.md new file mode 100644 index 00000000..56e8d55f --- /dev/null +++ b/docs/code/types/amount.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/amount.spec + +# types/amount.spec diff --git a/docs/code/types/amount/README.md b/docs/code/types/amount/README.md new file mode 100644 index 00000000..7ba4408f --- /dev/null +++ b/docs/code/types/amount/README.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/amount + +# types/amount + +## Classes + +- [AlgoAmount](classes/AlgoAmount.md) diff --git a/docs/code/types/amount/classes/AlgoAmount.md b/docs/code/types/amount/classes/AlgoAmount.md new file mode 100644 index 00000000..1b380520 --- /dev/null +++ b/docs/code/types/amount/classes/AlgoAmount.md @@ -0,0 +1,213 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/amount](../README.md) / AlgoAmount + +# Class: AlgoAmount + +Defined in: [src/types/amount.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L4) + +Wrapper class to ensure safe, explicit conversion between µAlgo, Algo and numbers + +## Constructors + +### Constructor + +> **new AlgoAmount**(`amount`): `AlgoAmount` + +Defined in: [src/types/amount.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L37) + +Create a new `AlgoAmount` instance. + +#### Parameters + +##### amount + +An object specifying the amount in Algo or µALGO. Use the key 'algo' for Algo amounts and 'microAlgo' for µALGO. + +\{ `algos`: `number` \| `bigint`; \} | \{ `algo`: `number` \| `bigint`; \} | \{ `microAlgos`: `number` \| `bigint`; \} | \{ `microAlgo`: `number` \| `bigint`; \} + +#### Returns + +`AlgoAmount` + +A new instance of `AlgoAmount` representing the specified amount. + +#### Example + +```typescript +const amount = new AlgoAmount({ algo: 5 }); +``` + +## Accessors + +### algo + +#### Get Signature + +> **get** **algo**(): `number` + +Defined in: [src/types/amount.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L23) + +Return the amount as a number in Algo + +##### Returns + +`number` + +*** + +### algos + +#### Get Signature + +> **get** **algos**(): `number` + +Defined in: [src/types/amount.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L18) + +Return the amount as a number in Algo + +##### Returns + +`number` + +*** + +### microAlgo + +#### Get Signature + +> **get** **microAlgo**(): `bigint` + +Defined in: [src/types/amount.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L13) + +Return the amount as a number in µAlgo + +##### Returns + +`bigint` + +*** + +### microAlgos + +#### Get Signature + +> **get** **microAlgos**(): `bigint` + +Defined in: [src/types/amount.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L8) + +Return the amount as a number in µAlgo + +##### Returns + +`bigint` + +## Methods + +### toString() + +> **toString**(): `string` + +Defined in: [src/types/amount.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L50) + +#### Returns + +`string` + +*** + +### valueOf() + +> **valueOf**(): `number` + +Defined in: [src/types/amount.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L58) + +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 + +#### Returns + +`number` + +*** + +### Algo() + +> `static` **Algo**(`amount`): `AlgoAmount` + +Defined in: [src/types/amount.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L68) + +Create a `AlgoAmount` object representing the given number of Algo + +#### Parameters + +##### amount + +`number` | `bigint` + +#### Returns + +`AlgoAmount` + +*** + +### Algos() + +> `static` **Algos**(`amount`): `AlgoAmount` + +Defined in: [src/types/amount.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L63) + +Create a `AlgoAmount` object representing the given number of Algo + +#### Parameters + +##### amount + +`number` | `bigint` + +#### Returns + +`AlgoAmount` + +*** + +### MicroAlgo() + +> `static` **MicroAlgo**(`amount`): `AlgoAmount` + +Defined in: [src/types/amount.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L78) + +Create a `AlgoAmount` object representing the given number of µAlgo + +#### Parameters + +##### amount + +`number` | `bigint` + +#### Returns + +`AlgoAmount` + +*** + +### MicroAlgos() + +> `static` **MicroAlgos**(`amount`): `AlgoAmount` + +Defined in: [src/types/amount.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L73) + +Create a `AlgoAmount` object representing the given number of µAlgo + +#### Parameters + +##### amount + +`number` | `bigint` + +#### Returns + +`AlgoAmount` diff --git a/docs/code/types/app-arc56/README.md b/docs/code/types/app-arc56/README.md new file mode 100644 index 00000000..569aa234 --- /dev/null +++ b/docs/code/types/app-arc56/README.md @@ -0,0 +1,43 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/app-arc56 + +# types/app-arc56 + +## Classes + +- [Arc56Method](classes/Arc56Method.md) + +## Interfaces + +- [Arc56Contract](interfaces/Arc56Contract.md) +- [Event](interfaces/Event.md) +- [Method](interfaces/Method.md) +- [ProgramSourceInfo](interfaces/ProgramSourceInfo.md) +- [StorageKey](interfaces/StorageKey.md) +- [StorageMap](interfaces/StorageMap.md) +- [StructField](interfaces/StructField.md) + +## Type Aliases + +- [ABIStruct](type-aliases/ABIStruct.md) +- [ABIType](type-aliases/ABIType.md) +- [Arc56MethodArg](type-aliases/Arc56MethodArg.md) +- [Arc56MethodReturnType](type-aliases/Arc56MethodReturnType.md) +- [AVMBytes](type-aliases/AVMBytes.md) +- [AVMString](type-aliases/AVMString.md) +- [AVMType](type-aliases/AVMType.md) +- [AVMUint64](type-aliases/AVMUint64.md) +- [StructName](type-aliases/StructName.md) + +## Functions + +- [getABIDecodedValue](functions/getABIDecodedValue.md) +- [getABIEncodedValue](functions/getABIEncodedValue.md) +- [getABIStructFromABITuple](functions/getABIStructFromABITuple.md) +- [getABITupleFromABIStruct](functions/getABITupleFromABIStruct.md) +- [getABITupleTypeFromABIStructDefinition](functions/getABITupleTypeFromABIStructDefinition.md) +- [getArc56Method](functions/getArc56Method.md) +- [getArc56ReturnValue](functions/getArc56ReturnValue.md) diff --git a/docs/code/types/app-arc56/classes/Arc56Method.md b/docs/code/types/app-arc56/classes/Arc56Method.md new file mode 100644 index 00000000..8758f211 --- /dev/null +++ b/docs/code/types/app-arc56/classes/Arc56Method.md @@ -0,0 +1,270 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / Arc56Method + +# Class: Arc56Method + +Defined in: [src/types/app-arc56.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L22) + +Wrapper around `algosdk.ABIMethod` that represents an ARC-56 ABI method. + +## Extends + +- `ABIMethod` + +## Constructors + +### Constructor + +> **new Arc56Method**(`method`): `Arc56Method` + +Defined in: [src/types/app-arc56.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L26) + +#### Parameters + +##### method + +[`Method`](../interfaces/Method.md) + +#### Returns + +`Arc56Method` + +#### Overrides + +`algosdk.ABIMethod.constructor` + +## Properties + +### args + +> `readonly` **args**: `object`[] + +Defined in: [src/types/app-arc56.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L23) + +#### defaultValue? + +> `optional` **defaultValue**: `object` + +The default value that clients should use. + +##### defaultValue.data + +> **data**: `string` + +Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector + +##### defaultValue.source + +> **source**: `"method"` \| `"box"` \| `"global"` \| `"local"` \| `"literal"` + +Where the default value is coming from +- box: The data key signifies the box key to read the value from +- global: The data key signifies the global state key to read the value from +- local: The data key signifies the local state key to read the value from (for the sender) +- literal: the value is a literal and should be passed directly as the argument +- method: The utf8 signature of the method in this contract to call to get the default value. If the method has arguments, they all must have default values. The method **MUST** be readonly so simulate can be used to get the default value + +##### defaultValue.type? + +> `optional` **type**: `string` + +How the data is encoded. This is the encoding for the data provided here, not the arg type + +#### desc? + +> `optional` **desc**: `string` + +Optional, user-friendly description for the argument + +#### name? + +> `optional` **name**: `string` + +Optional, user-friendly name for the argument + +#### struct? + +> `optional` **struct**: `string` + +If the type is a struct, the name of the struct + +#### type + +> **type**: `ABIArgumentType` + +#### Overrides + +`algosdk.ABIMethod.args` + +*** + +### description? + +> `readonly` `optional` **description**: `string` + +Defined in: node\_modules/algosdk/dist/types/abi/method.d.ts:28 + +#### Inherited from + +`algosdk.ABIMethod.description` + +*** + +### events? + +> `readonly` `optional` **events**: `ARC28Event`[] + +Defined in: node\_modules/algosdk/dist/types/abi/method.d.ts:38 + +#### Inherited from + +`algosdk.ABIMethod.events` + +*** + +### method + +> **method**: [`Method`](../interfaces/Method.md) + +Defined in: [src/types/app-arc56.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L26) + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: node\_modules/algosdk/dist/types/abi/method.d.ts:27 + +#### Inherited from + +`algosdk.ABIMethod.name` + +*** + +### readonly? + +> `readonly` `optional` **readonly**: `boolean` + +Defined in: node\_modules/algosdk/dist/types/abi/method.d.ts:39 + +#### Inherited from + +`algosdk.ABIMethod.readonly` + +*** + +### returns + +> `readonly` **returns**: `object` + +Defined in: [src/types/app-arc56.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L24) + +#### desc? + +> `optional` **desc**: `string` + +Optional, user-friendly description for the return value + +#### struct? + +> `optional` **struct**: `string` + +If the type is a struct, the name of the struct + +#### type + +> **type**: `ABIReturnType` + +#### Overrides + +`algosdk.ABIMethod.returns` + +## Methods + +### getSelector() + +> **getSelector**(): `Uint8Array` + +Defined in: node\_modules/algosdk/dist/types/abi/method.d.ts:42 + +#### Returns + +`Uint8Array` + +#### Inherited from + +`algosdk.ABIMethod.getSelector` + +*** + +### getSignature() + +> **getSignature**(): `string` + +Defined in: node\_modules/algosdk/dist/types/abi/method.d.ts:41 + +#### Returns + +`string` + +#### Inherited from + +`algosdk.ABIMethod.getSignature` + +*** + +### toJSON() + +> **toJSON**(): [`Method`](../interfaces/Method.md) + +Defined in: [src/types/app-arc56.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L38) + +#### Returns + +[`Method`](../interfaces/Method.md) + +#### Overrides + +`algosdk.ABIMethod.toJSON` + +*** + +### txnCount() + +> **txnCount**(): `number` + +Defined in: node\_modules/algosdk/dist/types/abi/method.d.ts:43 + +#### Returns + +`number` + +#### Inherited from + +`algosdk.ABIMethod.txnCount` + +*** + +### fromSignature() + +> `static` **fromSignature**(`signature`): `ABIMethod` + +Defined in: node\_modules/algosdk/dist/types/abi/method.d.ts:45 + +#### Parameters + +##### signature + +`string` + +#### Returns + +`ABIMethod` + +#### Inherited from + +`algosdk.ABIMethod.fromSignature` diff --git a/docs/code/types/app-arc56/functions/getABIDecodedValue.md b/docs/code/types/app-arc56/functions/getABIDecodedValue.md new file mode 100644 index 00000000..e7535d8a --- /dev/null +++ b/docs/code/types/app-arc56/functions/getABIDecodedValue.md @@ -0,0 +1,40 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / getABIDecodedValue + +# Function: getABIDecodedValue() + +> **getABIDecodedValue**(`value`, `type`, `structs`): `ABIValue` \| [`ABIStruct`](../type-aliases/ABIStruct.md) + +Defined in: [src/types/app-arc56.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L120) + +Returns the decoded ABI value (or struct for a struct type) +for the given raw Algorand value given an ARC-56 type and defined ARC-56 structs. + +## Parameters + +### value + +The raw Algorand value (bytes or uint64) + +`number` | `bigint` | `Uint8Array`\<`ArrayBufferLike`\> + +### type + +`string` + +The ARC-56 type - either an ABI Type string or a struct name + +### structs + +`Record`\<`string`, [`StructField`](../interfaces/StructField.md)[]\> + +The defined ARC-56 structs + +## Returns + +`ABIValue` \| [`ABIStruct`](../type-aliases/ABIStruct.md) + +The decoded ABI value or struct diff --git a/docs/code/types/app-arc56/functions/getABIEncodedValue.md b/docs/code/types/app-arc56/functions/getABIEncodedValue.md new file mode 100644 index 00000000..4e409631 --- /dev/null +++ b/docs/code/types/app-arc56/functions/getABIEncodedValue.md @@ -0,0 +1,39 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / getABIEncodedValue + +# Function: getABIEncodedValue() + +> **getABIEncodedValue**(`value`, `type`, `structs`): `Uint8Array` + +Defined in: [src/types/app-arc56.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L142) + +Returns the ABI-encoded value for the given value. + +## Parameters + +### value + +The value to encode either already in encoded binary form (`Uint8Array`), a decoded ABI value or an ARC-56 struct + +`Uint8Array`\<`ArrayBufferLike`\> | `ABIValue` | [`ABIStruct`](../type-aliases/ABIStruct.md) + +### type + +`string` + +The ARC-56 type - either an ABI Type string or a struct name + +### structs + +`Record`\<`string`, [`StructField`](../interfaces/StructField.md)[]\> + +The defined ARC-56 structs + +## Returns + +`Uint8Array` + +The binary ABI-encoded value diff --git a/docs/code/types/app-arc56/functions/getABIStructFromABITuple.md b/docs/code/types/app-arc56/functions/getABIStructFromABITuple.md new file mode 100644 index 00000000..96a4145a --- /dev/null +++ b/docs/code/types/app-arc56/functions/getABIStructFromABITuple.md @@ -0,0 +1,43 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / getABIStructFromABITuple + +# Function: getABIStructFromABITuple() + +> **getABIStructFromABITuple**\<`TReturn`\>(`decodedABITuple`, `structFields`, `structs`): `TReturn` + +Defined in: [src/types/app-arc56.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L70) + +Converts a decoded ABI tuple as a struct. + +## Type Parameters + +### TReturn + +`TReturn` *extends* [`ABIStruct`](../type-aliases/ABIStruct.md) = `Record`\<`string`, `any`\> + +## Parameters + +### decodedABITuple + +`ABIValue`[] + +The decoded ABI tuple value + +### structFields + +[`StructField`](../interfaces/StructField.md)[] + +The struct fields from an ARC-56 app spec + +### structs + +`Record`\<`string`, [`StructField`](../interfaces/StructField.md)[]\> + +## Returns + +`TReturn` + +The struct as a Record diff --git a/docs/code/types/app-arc56/functions/getABITupleFromABIStruct.md b/docs/code/types/app-arc56/functions/getABITupleFromABIStruct.md new file mode 100644 index 00000000..f11e0557 --- /dev/null +++ b/docs/code/types/app-arc56/functions/getABITupleFromABIStruct.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / getABITupleFromABIStruct + +# Function: getABITupleFromABIStruct() + +> **getABITupleFromABIStruct**(`struct`, `structFields`, `structs`): `ABIValue`[] + +Defined in: [src/types/app-arc56.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L94) + +Converts an ARC-56 struct as an ABI tuple. + +## Parameters + +### struct + +[`ABIStruct`](../type-aliases/ABIStruct.md) + +The struct to convert + +### structFields + +[`StructField`](../interfaces/StructField.md)[] + +The struct fields from an ARC-56 app spec + +### structs + +`Record`\<`string`, [`StructField`](../interfaces/StructField.md)[]\> + +## Returns + +`ABIValue`[] + +The struct as a decoded ABI tuple diff --git a/docs/code/types/app-arc56/functions/getABITupleTypeFromABIStructDefinition.md b/docs/code/types/app-arc56/functions/getABITupleTypeFromABIStructDefinition.md new file mode 100644 index 00000000..34dcd89b --- /dev/null +++ b/docs/code/types/app-arc56/functions/getABITupleTypeFromABIStructDefinition.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / getABITupleTypeFromABIStructDefinition + +# Function: getABITupleTypeFromABIStructDefinition() + +> **getABITupleTypeFromABIStructDefinition**(`struct`, `structs`): `ABITupleType` + +Defined in: [src/types/app-arc56.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L48) + +Returns the `ABITupleType` for the given ARC-56 struct definition + +## Parameters + +### struct + +[`StructField`](../interfaces/StructField.md)[] + +The ARC-56 struct definition + +### structs + +`Record`\<`string`, [`StructField`](../interfaces/StructField.md)[]\> + +## Returns + +`ABITupleType` + +The `ABITupleType` diff --git a/docs/code/types/app-arc56/functions/getArc56Method.md b/docs/code/types/app-arc56/functions/getArc56Method.md new file mode 100644 index 00000000..7f322133 --- /dev/null +++ b/docs/code/types/app-arc56/functions/getArc56Method.md @@ -0,0 +1,34 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / getArc56Method + +# Function: getArc56Method() + +> **getArc56Method**(`methodNameOrSignature`, `appSpec`): [`Arc56Method`](../classes/Arc56Method.md) + +Defined in: [src/types/app-arc56.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L172) + +Returns the ARC-56 ABI method object for a given method name or signature and ARC-56 app spec. + +## Parameters + +### methodNameOrSignature + +`string` + +The method name or method signature to call if an ABI call is being emitted. +e.g. `my_method` or `my_method(unit64,string)bytes` + +### appSpec + +[`Arc56Contract`](../interfaces/Arc56Contract.md) + +The app spec for the app + +## Returns + +[`Arc56Method`](../classes/Arc56Method.md) + +The `Arc56Method` diff --git a/docs/code/types/app-arc56/functions/getArc56ReturnValue.md b/docs/code/types/app-arc56/functions/getArc56ReturnValue.md new file mode 100644 index 00000000..f3c27ddc --- /dev/null +++ b/docs/code/types/app-arc56/functions/getArc56ReturnValue.md @@ -0,0 +1,45 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / getArc56ReturnValue + +# Function: getArc56ReturnValue() + +> **getArc56ReturnValue**\<`TReturn`\>(`returnValue`, `method`, `structs`): `TReturn` + +Defined in: [src/types/app-arc56.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L203) + +Checks for decode errors on the AppCallTransactionResult and maps the return value to the specified generic type + +## Type Parameters + +### TReturn + +`TReturn` *extends* `undefined` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue` \| [`ABIStruct`](../type-aliases/ABIStruct.md) + +## Parameters + +### returnValue + +The smart contract response + +`undefined` | [`ABIReturn`](../../app/type-aliases/ABIReturn.md) + +### method + +The method that was called + +[`Method`](../interfaces/Method.md) | [`Arc56Method`](../classes/Arc56Method.md) + +### structs + +`Record`\<`string`, [`StructField`](../interfaces/StructField.md)[]\> + +The struct fields from the app spec + +## Returns + +`TReturn` + +The smart contract response with an updated return value diff --git a/docs/code/types/app-arc56/interfaces/Arc56Contract.md b/docs/code/types/app-arc56/interfaces/Arc56Contract.md new file mode 100644 index 00000000..b14b77c5 --- /dev/null +++ b/docs/code/types/app-arc56/interfaces/Arc56Contract.md @@ -0,0 +1,345 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / Arc56Contract + +# Interface: Arc56Contract + +Defined in: [src/types/app-arc56.ts:231](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L231) + +Describes the entire contract. This interface is an extension of the interface described in ARC-4 + +## Properties + +### arcs + +> **arcs**: `number`[] + +Defined in: [src/types/app-arc56.ts:233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L233) + +The ARCs used and/or supported by this contract. All contracts implicitly support ARC4 and ARC56 + +*** + +### bareActions + +> **bareActions**: `object` + +Defined in: [src/types/app-arc56.ts:281](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L281) + +Supported bare actions for the contract. An action is a combination of call/create and an OnComplete + +#### call + +> **call**: (`"NoOp"` \| `"OptIn"` \| `"DeleteApplication"` \| `"CloseOut"` \| `"ClearState"` \| `"UpdateApplication"`)[] + +OnCompletes this method allows when appID !== 0 + +#### create + +> **create**: (`"NoOp"` \| `"OptIn"` \| `"DeleteApplication"`)[] + +OnCompletes this method allows when appID === 0 + +*** + +### byteCode? + +> `optional` **byteCode**: `object` + +Defined in: [src/types/app-arc56.ts:302](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L302) + +The compiled bytecode for the application. MUST be omitted if included as part of ARC23 + +#### approval + +> **approval**: `string` + +The approval program + +#### clear + +> **clear**: `string` + +The clear program + +*** + +### compilerInfo? + +> `optional` **compilerInfo**: `object` + +Defined in: [src/types/app-arc56.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L309) + +Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present + +#### compiler + +> **compiler**: `"algod"` \| `"puya"` + +The name of the compiler + +#### compilerVersion + +> **compilerVersion**: `object` + +Compiler version information + +##### compilerVersion.commitHash? + +> `optional` **commitHash**: `string` + +##### compilerVersion.major + +> **major**: `number` + +##### compilerVersion.minor + +> **minor**: `number` + +##### compilerVersion.patch + +> **patch**: `number` + +*** + +### desc? + +> `optional` **desc**: `string` + +Defined in: [src/types/app-arc56.ts:237](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L237) + +Optional, user-friendly description for the interface + +*** + +### events? + +> `optional` **events**: [`Event`](Event.md)[] + +Defined in: [src/types/app-arc56.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L321) + +ARC-28 events that MAY be emitted by this contract + +*** + +### methods + +> **methods**: [`Method`](Method.md)[] + +Defined in: [src/types/app-arc56.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L254) + +All of the methods that the contract implements + +*** + +### name + +> **name**: `string` + +Defined in: [src/types/app-arc56.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L235) + +A user-friendly name for the contract + +*** + +### networks? + +> `optional` **networks**: `object` + +Defined in: [src/types/app-arc56.ts:245](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L245) + +Optional object listing the contract instances across different networks. +The key is the base64 genesis hash of the network, and the value contains +information about the deployed contract in the network indicated by the +key. A key containing the human-readable name of the network MAY be +included, but the corresponding genesis hash key MUST also be defined + +#### Index Signature + +\[`network`: `string`\]: `object` + +*** + +### scratchVariables? + +> `optional` **scratchVariables**: `object` + +Defined in: [src/types/app-arc56.ts:332](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L332) + +The scratch variables used during runtime + +#### Index Signature + +\[`name`: `string`\]: `object` + +*** + +### source? + +> `optional` **source**: `object` + +Defined in: [src/types/app-arc56.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L295) + +The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 + +#### approval + +> **approval**: `string` + +The approval program + +#### clear + +> **clear**: `string` + +The clear program + +*** + +### sourceInfo? + +> `optional` **sourceInfo**: `object` + +Defined in: [src/types/app-arc56.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L288) + +Information about the TEAL programs + +#### approval + +> **approval**: [`ProgramSourceInfo`](ProgramSourceInfo.md) + +Approval program information + +#### clear + +> **clear**: [`ProgramSourceInfo`](ProgramSourceInfo.md) + +Clear program information + +*** + +### state + +> **state**: `object` + +Defined in: [src/types/app-arc56.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L255) + +#### keys + +> **keys**: `object` + +Mapping of human-readable names to StorageKey objects + +##### keys.box + +> **box**: `object` + +###### Index Signature + +\[`name`: `string`\]: [`StorageKey`](StorageKey.md) + +##### keys.global + +> **global**: `object` + +###### Index Signature + +\[`name`: `string`\]: [`StorageKey`](StorageKey.md) + +##### keys.local + +> **local**: `object` + +###### Index Signature + +\[`name`: `string`\]: [`StorageKey`](StorageKey.md) + +#### maps + +> **maps**: `object` + +Mapping of human-readable names to StorageMap objects + +##### maps.box + +> **box**: `object` + +###### Index Signature + +\[`name`: `string`\]: [`StorageMap`](StorageMap.md) + +##### maps.global + +> **global**: `object` + +###### Index Signature + +\[`name`: `string`\]: [`StorageMap`](StorageMap.md) + +##### maps.local + +> **local**: `object` + +###### Index Signature + +\[`name`: `string`\]: [`StorageMap`](StorageMap.md) + +#### schema + +> **schema**: `object` + +Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application + +##### schema.global + +> **global**: `object` + +##### schema.global.bytes + +> **bytes**: `number` + +##### schema.global.ints + +> **ints**: `number` + +##### schema.local + +> **local**: `object` + +##### schema.local.bytes + +> **bytes**: `number` + +##### schema.local.ints + +> **ints**: `number` + +*** + +### structs + +> **structs**: `object` + +Defined in: [src/types/app-arc56.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L252) + +Named structs used by the application. Each struct field appears in the same order as ABI encoding. + +#### Index Signature + +\[`structName`: `string`\]: [`StructField`](StructField.md)[] + +*** + +### templateVariables? + +> `optional` **templateVariables**: `object` + +Defined in: [src/types/app-arc56.ts:323](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L323) + +A mapping of template variable names as they appear in the TEAL (not including TMPL_ prefix) to their respective types and values (if applicable) + +#### Index Signature + +\[`name`: `string`\]: `object` diff --git a/docs/code/types/app-arc56/interfaces/Event.md b/docs/code/types/app-arc56/interfaces/Event.md new file mode 100644 index 00000000..609ecaaf --- /dev/null +++ b/docs/code/types/app-arc56/interfaces/Event.md @@ -0,0 +1,65 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / Event + +# Interface: Event + +Defined in: [src/types/app-arc56.ts:417](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L417) + +ARC-28 event + +## Properties + +### args + +> **args**: `object`[] + +Defined in: [src/types/app-arc56.ts:423](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L423) + +The arguments of the event, in order + +#### desc? + +> `optional` **desc**: `string` + +Optional, user-friendly description for the argument + +#### name? + +> `optional` **name**: `string` + +Optional, user-friendly name for the argument + +#### struct? + +> `optional` **struct**: `string` + +If the type is a struct, the name of the struct + +#### type + +> **type**: `string` + +The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. + +*** + +### desc? + +> `optional` **desc**: `string` + +Defined in: [src/types/app-arc56.ts:421](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L421) + +Optional, user-friendly description for the event + +*** + +### name + +> **name**: `string` + +Defined in: [src/types/app-arc56.ts:419](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L419) + +The name of the event diff --git a/docs/code/types/app-arc56/interfaces/Method.md b/docs/code/types/app-arc56/interfaces/Method.md new file mode 100644 index 00000000..1d8aa869 --- /dev/null +++ b/docs/code/types/app-arc56/interfaces/Method.md @@ -0,0 +1,228 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / Method + +# Interface: Method + +Defined in: [src/types/app-arc56.ts:341](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L341) + +Describes a method in the contract. This interface is an extension of the interface described in ARC-4 + +## Properties + +### actions + +> **actions**: `object` + +Defined in: [src/types/app-arc56.ts:382](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L382) + +an action is a combination of call/create and an OnComplete + +#### call + +> **call**: (`"NoOp"` \| `"OptIn"` \| `"DeleteApplication"` \| `"CloseOut"` \| `"ClearState"` \| `"UpdateApplication"`)[] + +OnCompletes this method allows when appID !== 0 + +#### create + +> **create**: (`"NoOp"` \| `"OptIn"` \| `"DeleteApplication"`)[] + +OnCompletes this method allows when appID === 0 + +*** + +### args + +> **args**: `object`[] + +Defined in: [src/types/app-arc56.ts:347](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L347) + +The arguments of the method, in order + +#### defaultValue? + +> `optional` **defaultValue**: `object` + +The default value that clients should use. + +##### defaultValue.data + +> **data**: `string` + +Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector + +##### defaultValue.source + +> **source**: `"method"` \| `"box"` \| `"global"` \| `"local"` \| `"literal"` + +Where the default value is coming from +- box: The data key signifies the box key to read the value from +- global: The data key signifies the global state key to read the value from +- local: The data key signifies the local state key to read the value from (for the sender) +- literal: the value is a literal and should be passed directly as the argument +- method: The utf8 signature of the method in this contract to call to get the default value. If the method has arguments, they all must have default values. The method **MUST** be readonly so simulate can be used to get the default value + +##### defaultValue.type? + +> `optional` **type**: `string` + +How the data is encoded. This is the encoding for the data provided here, not the arg type + +#### desc? + +> `optional` **desc**: `string` + +Optional, user-friendly description for the argument + +#### name? + +> `optional` **name**: `string` + +Optional, user-friendly name for the argument + +#### struct? + +> `optional` **struct**: `string` + +If the type is a struct, the name of the struct + +#### type + +> **type**: `string` + +The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. + +*** + +### desc? + +> `optional` **desc**: `string` + +Defined in: [src/types/app-arc56.ts:345](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L345) + +Optional, user-friendly description for the method + +*** + +### events? + +> `optional` **events**: [`Event`](Event.md)[] + +Defined in: [src/types/app-arc56.ts:391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L391) + +ARC-28 events that MAY be emitted by this method + +*** + +### name + +> **name**: `string` + +Defined in: [src/types/app-arc56.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L343) + +The name of the method + +*** + +### readonly? + +> `optional` **readonly**: `boolean` + +Defined in: [src/types/app-arc56.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L389) + +If this method does not write anything to the ledger (ARC-22) + +*** + +### recommendations? + +> `optional` **recommendations**: `object` + +Defined in: [src/types/app-arc56.ts:393](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L393) + +Information that clients can use when calling the method + +#### accounts? + +> `optional` **accounts**: `string`[] + +Recommended foreign accounts + +#### apps? + +> `optional` **apps**: `number`[] + +Recommended foreign apps + +#### assets? + +> `optional` **assets**: `number`[] + +Recommended foreign assets + +#### boxes? + +> `optional` **boxes**: `object` + +Recommended box references to include + +##### boxes.app? + +> `optional` **app**: `number` + +The app ID for the box + +##### boxes.key + +> **key**: `string` + +The base64 encoded box key + +##### boxes.readBytes + +> **readBytes**: `number` + +The number of bytes being read from the box + +##### boxes.writeBytes + +> **writeBytes**: `number` + +The number of bytes being written to the box + +#### innerTransactionCount? + +> `optional` **innerTransactionCount**: `number` + +The number of inner transactions the caller should cover the fees for + +*** + +### returns + +> **returns**: `object` + +Defined in: [src/types/app-arc56.ts:373](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L373) + +Information about the method's return value + +#### desc? + +> `optional` **desc**: `string` + +Optional, user-friendly description for the return value + +#### struct? + +> `optional` **struct**: `string` + +If the type is a struct, the name of the struct + +#### type + +> **type**: `string` + +The type of the return value, or "void" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct. diff --git a/docs/code/types/app-arc56/interfaces/ProgramSourceInfo.md b/docs/code/types/app-arc56/interfaces/ProgramSourceInfo.md new file mode 100644 index 00000000..bbc9ad4f --- /dev/null +++ b/docs/code/types/app-arc56/interfaces/ProgramSourceInfo.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / ProgramSourceInfo + +# Interface: ProgramSourceInfo + +Defined in: [src/types/app-arc56.ts:497](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L497) + +## Properties + +### pcOffsetMethod + +> **pcOffsetMethod**: `"none"` \| `"cblocks"` + +Defined in: [src/types/app-arc56.ts:504](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L504) + +How the program counter offset is calculated +- none: The pc values in sourceInfo are not offset +- cblocks: The pc values in sourceInfo are offset by the PC of the first op following the last cblock at the top of the program + +*** + +### sourceInfo + +> **sourceInfo**: `SourceInfo`[] + +Defined in: [src/types/app-arc56.ts:499](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L499) + +The source information for the program diff --git a/docs/code/types/app-arc56/interfaces/StorageKey.md b/docs/code/types/app-arc56/interfaces/StorageKey.md new file mode 100644 index 00000000..44528a75 --- /dev/null +++ b/docs/code/types/app-arc56/interfaces/StorageKey.md @@ -0,0 +1,51 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / StorageKey + +# Interface: StorageKey + +Defined in: [src/types/app-arc56.ts:462](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L462) + +Describes a single key in app storage + +## Properties + +### desc? + +> `optional` **desc**: `string` + +Defined in: [src/types/app-arc56.ts:464](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L464) + +Description of what this storage key holds + +*** + +### key + +> **key**: `string` + +Defined in: [src/types/app-arc56.ts:471](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L471) + +The bytes of the key encoded as base64 + +*** + +### keyType + +> **keyType**: `string` + +Defined in: [src/types/app-arc56.ts:466](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L466) + +The type of the key + +*** + +### valueType + +> **valueType**: `string` + +Defined in: [src/types/app-arc56.ts:469](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L469) + +The type of the value diff --git a/docs/code/types/app-arc56/interfaces/StorageMap.md b/docs/code/types/app-arc56/interfaces/StorageMap.md new file mode 100644 index 00000000..391f18ea --- /dev/null +++ b/docs/code/types/app-arc56/interfaces/StorageMap.md @@ -0,0 +1,51 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / StorageMap + +# Interface: StorageMap + +Defined in: [src/types/app-arc56.ts:475](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L475) + +Describes a mapping of key-value pairs in storage + +## Properties + +### desc? + +> `optional` **desc**: `string` + +Defined in: [src/types/app-arc56.ts:477](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L477) + +Description of what the key-value pairs in this mapping hold + +*** + +### keyType + +> **keyType**: `string` + +Defined in: [src/types/app-arc56.ts:479](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L479) + +The type of the keys in the map + +*** + +### prefix? + +> `optional` **prefix**: `string` + +Defined in: [src/types/app-arc56.ts:483](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L483) + +The base64-encoded prefix of the map keys + +*** + +### valueType + +> **valueType**: `string` + +Defined in: [src/types/app-arc56.ts:481](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L481) + +The type of the values in the map diff --git a/docs/code/types/app-arc56/interfaces/StructField.md b/docs/code/types/app-arc56/interfaces/StructField.md new file mode 100644 index 00000000..ea47e50c --- /dev/null +++ b/docs/code/types/app-arc56/interfaces/StructField.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / StructField + +# Interface: StructField + +Defined in: [src/types/app-arc56.ts:454](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L454) + +Information about a single field in a struct + +## Properties + +### name + +> **name**: `string` + +Defined in: [src/types/app-arc56.ts:456](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L456) + +The name of the struct field + +*** + +### type + +> **type**: `string` \| `StructField`[] + +Defined in: [src/types/app-arc56.ts:458](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L458) + +The type of the struct field's value diff --git a/docs/code/types/app-arc56/type-aliases/ABIStruct.md b/docs/code/types/app-arc56/type-aliases/ABIStruct.md new file mode 100644 index 00000000..94cf03e6 --- /dev/null +++ b/docs/code/types/app-arc56/type-aliases/ABIStruct.md @@ -0,0 +1,17 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / ABIStruct + +# Type Alias: ABIStruct + +> **ABIStruct** = `object` + +Defined in: [src/types/app-arc56.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L108) + +Decoded ARC-56 struct as a struct rather than a tuple. + +## Index Signature + +\[`key`: `string`\]: `ABIValue` \| `ABIStruct` diff --git a/docs/code/types/app-arc56/type-aliases/ABIType.md b/docs/code/types/app-arc56/type-aliases/ABIType.md new file mode 100644 index 00000000..7eece125 --- /dev/null +++ b/docs/code/types/app-arc56/type-aliases/ABIType.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / ABIType + +# Type Alias: ABIType + +> **ABIType** = `string` + +Defined in: [src/types/app-arc56.ts:436](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L436) + +An ABI-encoded type diff --git a/docs/code/types/app-arc56/type-aliases/AVMBytes.md b/docs/code/types/app-arc56/type-aliases/AVMBytes.md new file mode 100644 index 00000000..7c6da5f3 --- /dev/null +++ b/docs/code/types/app-arc56/type-aliases/AVMBytes.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / AVMBytes + +# Type Alias: AVMBytes + +> **AVMBytes** = `"AVMBytes"` + +Defined in: [src/types/app-arc56.ts:442](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L442) + +Raw byteslice without the length prefixed that is specified in ARC-4 diff --git a/docs/code/types/app-arc56/type-aliases/AVMString.md b/docs/code/types/app-arc56/type-aliases/AVMString.md new file mode 100644 index 00000000..664e9773 --- /dev/null +++ b/docs/code/types/app-arc56/type-aliases/AVMString.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / AVMString + +# Type Alias: AVMString + +> **AVMString** = `"AVMString"` + +Defined in: [src/types/app-arc56.ts:445](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L445) + +A utf-8 string without the length prefix that is specified in ARC-4 diff --git a/docs/code/types/app-arc56/type-aliases/AVMType.md b/docs/code/types/app-arc56/type-aliases/AVMType.md new file mode 100644 index 00000000..537d384b --- /dev/null +++ b/docs/code/types/app-arc56/type-aliases/AVMType.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / AVMType + +# Type Alias: AVMType + +> **AVMType** = [`AVMBytes`](AVMBytes.md) \| [`AVMString`](AVMString.md) \| [`AVMUint64`](AVMUint64.md) + +Defined in: [src/types/app-arc56.ts:451](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L451) + +A native AVM type diff --git a/docs/code/types/app-arc56/type-aliases/AVMUint64.md b/docs/code/types/app-arc56/type-aliases/AVMUint64.md new file mode 100644 index 00000000..b7f84ed4 --- /dev/null +++ b/docs/code/types/app-arc56/type-aliases/AVMUint64.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / AVMUint64 + +# Type Alias: AVMUint64 + +> **AVMUint64** = `"AVMUint64"` + +Defined in: [src/types/app-arc56.ts:448](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L448) + +A 64-bit unsigned integer diff --git a/docs/code/types/app-arc56/type-aliases/Arc56MethodArg.md b/docs/code/types/app-arc56/type-aliases/Arc56MethodArg.md new file mode 100644 index 00000000..cdfe0694 --- /dev/null +++ b/docs/code/types/app-arc56/type-aliases/Arc56MethodArg.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / Arc56MethodArg + +# Type Alias: Arc56MethodArg + +> **Arc56MethodArg** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`Method`](../interfaces/Method.md)\[`"args"`\]\[`number`\], `"type"`\> & `object`\> + +Defined in: [src/types/app-arc56.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L6) + +Type to describe an argument within an `Arc56Method`. diff --git a/docs/code/types/app-arc56/type-aliases/Arc56MethodReturnType.md b/docs/code/types/app-arc56/type-aliases/Arc56MethodReturnType.md new file mode 100644 index 00000000..ff93c2b6 --- /dev/null +++ b/docs/code/types/app-arc56/type-aliases/Arc56MethodReturnType.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / Arc56MethodReturnType + +# Type Alias: Arc56MethodReturnType + +> **Arc56MethodReturnType** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`Method`](../interfaces/Method.md)\[`"returns"`\], `"type"`\> & `object`\> + +Defined in: [src/types/app-arc56.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L13) + +Type to describe a return type within an `Arc56Method`. diff --git a/docs/code/types/app-arc56/type-aliases/StructName.md b/docs/code/types/app-arc56/type-aliases/StructName.md new file mode 100644 index 00000000..90741e25 --- /dev/null +++ b/docs/code/types/app-arc56/type-aliases/StructName.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-arc56](../README.md) / StructName + +# Type Alias: StructName + +> **StructName** = `string` + +Defined in: [src/types/app-arc56.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-arc56.ts#L439) + +The name of a defined struct diff --git a/docs/code/types/app-client.spec/README.md b/docs/code/types/app-client.spec/README.md new file mode 100644 index 00000000..54fe584d --- /dev/null +++ b/docs/code/types/app-client.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/app-client.spec + +# types/app-client.spec diff --git a/docs/code/types/app-client/README.md b/docs/code/types/app-client/README.md new file mode 100644 index 00000000..d53627c2 --- /dev/null +++ b/docs/code/types/app-client/README.md @@ -0,0 +1,53 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/app-client + +# types/app-client + +## Classes + +- [AppClient](classes/AppClient.md) +- [~~ApplicationClient~~](classes/ApplicationClient.md) + +## Interfaces + +- [AppClientCallABIArgs](interfaces/AppClientCallABIArgs.md) +- [AppClientCallCoreParams](interfaces/AppClientCallCoreParams.md) +- [AppClientCompilationParams](interfaces/AppClientCompilationParams.md) +- [AppClientCompilationResult](interfaces/AppClientCompilationResult.md) +- [AppClientDeployCallInterfaceParams](interfaces/AppClientDeployCallInterfaceParams.md) +- [AppClientDeployCoreParams](interfaces/AppClientDeployCoreParams.md) +- [AppClientDeployParams](interfaces/AppClientDeployParams.md) +- [AppClientParams](interfaces/AppClientParams.md) +- [AppSourceMaps](interfaces/AppSourceMaps.md) +- [FundAppAccountParams](interfaces/FundAppAccountParams.md) +- [ResolveAppById](interfaces/ResolveAppById.md) +- [ResolveAppByIdBase](interfaces/ResolveAppByIdBase.md) +- [SourceMapExport](interfaces/SourceMapExport.md) + +## Type Aliases + +- [AppClientBareCallParams](type-aliases/AppClientBareCallParams.md) +- [AppClientCallArgs](type-aliases/AppClientCallArgs.md) +- [AppClientCallParams](type-aliases/AppClientCallParams.md) +- [AppClientCallRawArgs](type-aliases/AppClientCallRawArgs.md) +- [AppClientClearStateParams](type-aliases/AppClientClearStateParams.md) +- [AppClientCreateOnComplete](type-aliases/AppClientCreateOnComplete.md) +- [AppClientCreateParams](type-aliases/AppClientCreateParams.md) +- [AppClientMethodCallParams](type-aliases/AppClientMethodCallParams.md) +- [AppClientUpdateParams](type-aliases/AppClientUpdateParams.md) +- [AppDetails](type-aliases/AppDetails.md) +- [AppDetailsBase](type-aliases/AppDetailsBase.md) +- [AppSpecAppDetails](type-aliases/AppSpecAppDetails.md) +- [AppSpecAppDetailsBase](type-aliases/AppSpecAppDetailsBase.md) +- [AppSpecAppDetailsByCreatorAndName](type-aliases/AppSpecAppDetailsByCreatorAndName.md) +- [AppSpecAppDetailsById](type-aliases/AppSpecAppDetailsById.md) +- [CallOnComplete](type-aliases/CallOnComplete.md) +- [CloneAppClientParams](type-aliases/CloneAppClientParams.md) +- [FundAppParams](type-aliases/FundAppParams.md) +- [ResolveAppByCreatorAndName](type-aliases/ResolveAppByCreatorAndName.md) +- [ResolveAppByCreatorAndNameBase](type-aliases/ResolveAppByCreatorAndNameBase.md) +- [ResolveAppClientByCreatorAndName](type-aliases/ResolveAppClientByCreatorAndName.md) +- [ResolveAppClientByNetwork](type-aliases/ResolveAppClientByNetwork.md) diff --git a/docs/code/types/app-client/classes/AppClient.md b/docs/code/types/app-client/classes/AppClient.md new file mode 100644 index 00000000..e67764d7 --- /dev/null +++ b/docs/code/types/app-client/classes/AppClient.md @@ -0,0 +1,1367 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClient + +# Class: AppClient + +Defined in: [src/types/app-client.ts:475](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L475) + +ARC-56/ARC-32 application client that allows you to manage calls and +state for a specific deployed instance of an app (with a known app ID). + +## Constructors + +### Constructor + +> **new AppClient**(`params`): `AppClient` + +Defined in: [src/types/app-client.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L513) + +Create a new app client. + +#### Parameters + +##### params + +[`AppClientParams`](../interfaces/AppClientParams.md) + +The parameters to create the app client + +#### Returns + +`AppClient` + +The `AppClient` instance + +#### Example + +```typescript +const appClient = new AppClient({ + appId: 12345678n, + appSpec: appSpec, + algorand: AlgorandClient.mainNet(), +}) + +## Accessors + +### algorand + +#### Get Signature + +> **get** **algorand**(): [`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +Defined in: [src/types/app-client.ts:674](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L674) + +A reference to the underlying `AlgorandClient` this app client is using. + +##### Returns + +[`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +*** + +### appAddress + +#### Get Signature + +> **get** **appAddress**(): `Address` + +Defined in: [src/types/app-client.ts:659](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L659) + +The app address of the app instance this client is linked to. + +##### Returns + +`Address` + +*** + +### appId + +#### Get Signature + +> **get** **appId**(): `bigint` + +Defined in: [src/types/app-client.ts:654](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L654) + +The ID of the app instance this client is linked to. + +##### Returns + +`bigint` + +*** + +### appName + +#### Get Signature + +> **get** **appName**(): `string` + +Defined in: [src/types/app-client.ts:664](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L664) + +The name of the app (from the ARC-32 / ARC-56 app spec or override). + +##### Returns + +`string` + +*** + +### appSpec + +#### Get Signature + +> **get** **appSpec**(): [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +Defined in: [src/types/app-client.ts:669](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L669) + +The ARC-56 app spec being used + +##### Returns + +[`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +*** + +### createTransaction + +#### Get Signature + +> **get** **createTransaction**(): `object` & `object` + +Defined in: [src/types/app-client.ts:698](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L698) + +Create transactions for the current app + +##### Returns + +*** + +### params + +#### Get Signature + +> **get** **params**(): `object` & `object` + +Defined in: [src/types/app-client.ts:693](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L693) + +Get parameters to create transactions for the current app. + +A good mental model for this is that these parameters represent a deferred transaction creation. + +##### Examples + +```typescript +const myMethodCall = appClient.params.call({method: 'my_method', args: [123, 'hello']}) +// ... +await algorand.send.AppMethodCall(myMethodCall) +``` + +```typescript +const myMethodCall = appClient.params.call({method: 'my_method', args: [123, 'hello']}) +await appClient.send.call({method: 'my_method2', args: [myMethodCall]}) +``` + +##### Returns + +*** + +### send + +#### Get Signature + +> **get** **send**(): `object` & `object` + +Defined in: [src/types/app-client.ts:703](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L703) + +Send transactions to the current app + +##### Returns + +*** + +### state + +#### Get Signature + +> **get** **state**(): `object` + +Defined in: [src/types/app-client.ts:708](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L708) + +Get state (local, global, box) from the current app + +##### Returns + +###### box + +> **box**: `object` + +Methods to access box storage for the current app + +###### box.getAll() + +> **getAll**: () => `Promise`\<`Record`\<`string`, `any`\>\> + +Returns all single-key state values in a record keyed by the key name and the value a decoded ABI value. + +###### Returns + +`Promise`\<`Record`\<`string`, `any`\>\> + +###### box.getMap() + +> **getMap**: (`mapName`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md), `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\>\> + +###### Parameters + +###### mapName + +`string` + +The name of the map to read from + +###### Returns + +`Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md), `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\>\> + +###### box.getMapValue() + +> **getMapValue**: (`mapName`, `key`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +###### Parameters + +###### mapName + +`string` + +The name of the map to read from + +###### key + +`any` + +The key within the map (without any map prefix) as either a Buffer with the bytes or a value + that will be converted to bytes by encoding it using the specified ABI key type + in the ARC-56 spec + +###### Returns + +`Promise`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +###### box.getValue() + +> **getValue**: (`name`) => `Promise`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +Returns a single state value for the current app with the value a decoded ABI value. + +###### Parameters + +###### name + +`string` + +The name of the state value to retrieve the value for + +###### Returns + +`Promise`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +###### global + +> **global**: `object` + +Methods to access global state for the current app + +###### global.getAll() + +> **getAll**: () => `Promise`\<`Record`\<`string`, `any`\>\> + +Returns all single-key state values in a record keyed by the key name and the value a decoded ABI value. + +###### Returns + +`Promise`\<`Record`\<`string`, `any`\>\> + +###### global.getMap() + +> **getMap**: (`mapName`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md), `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\>\> + +Returns all map values for the given map. + +###### Parameters + +###### mapName + +`string` + +The name of the map to read from + +###### Returns + +`Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md), `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\>\> + +A map of all key-value pairs in the map as a `Record` + +###### global.getMapValue() + +> **getMapValue**: (`mapName`, `key`, `appState?`) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +Returns a single value from the given map for the current app with the value a decoded ABI value. + +###### Parameters + +###### mapName + +`string` + +The name of the map to read from + +###### key + +`any` + +The key within the map (without any map prefix) as either a Buffer with the bytes or a value + that will be converted to bytes by encoding it using the specified ABI key type + in the ARC-56 spec + +###### appState? + +[`AppState`](../../app/interfaces/AppState.md) + +Optional cached value of the current state + +###### Returns + +`Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +###### global.getValue() + +> **getValue**: (`name`, `appState?`) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +Returns a single state value for the current app with the value a decoded ABI value. + +###### Parameters + +###### name + +`string` + +The name of the state value to retrieve the value for + +###### appState? + +[`AppState`](../../app/interfaces/AppState.md) + +Optional cached value of the current state + +###### Returns + +`Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +###### local() + +> **local**: (`address`) => `object` + +Methods to access local state for the current app + +###### Parameters + +###### address + +The address of the account to get the local state for + +`string` | `Address` + +###### Returns + +###### getAll() + +> **getAll**: () => `Promise`\<`Record`\<`string`, `any`\>\> + +Returns all single-key state values in a record keyed by the key name and the value a decoded ABI value. + +###### Returns + +`Promise`\<`Record`\<`string`, `any`\>\> + +###### getMap() + +> **getMap**: (`mapName`) => `Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md), `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\>\> + +Returns all map values for the given map. + +###### Parameters + +###### mapName + +`string` + +The name of the map to read from + +###### Returns + +`Promise`\<`Map`\<`ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md), `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\>\> + +A map of all key-value pairs in the map as a `Record` + +###### getMapValue() + +> **getMapValue**: (`mapName`, `key`, `appState?`) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +Returns a single value from the given map for the current app with the value a decoded ABI value. + +###### Parameters + +###### mapName + +`string` + +The name of the map to read from + +###### key + +`any` + +The key within the map (without any map prefix) as either a Buffer with the bytes or a value + that will be converted to bytes by encoding it using the specified ABI key type + in the ARC-56 spec + +###### appState? + +[`AppState`](../../app/interfaces/AppState.md) + +Optional cached value of the current state + +###### Returns + +`Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +###### getValue() + +> **getValue**: (`name`, `appState?`) => `Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +Returns a single state value for the current app with the value a decoded ABI value. + +###### Parameters + +###### name + +`string` + +The name of the state value to retrieve the value for + +###### appState? + +[`AppState`](../../app/interfaces/AppState.md) + +Optional cached value of the current state + +###### Returns + +`Promise`\<`undefined` \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md)\> + +## Methods + +### clone() + +> **clone**(`params`): `AppClient` + +Defined in: [src/types/app-client.ts:566](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L566) + +Clone this app client with different params + +#### Parameters + +##### params + +The params to use for the the cloned app client. Omit a param to keep the original value. Set a param to override the original value. Setting to undefined will clear the original value. + +###### appId? + +`bigint` + +The ID of the app instance this client should make calls against. + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +#### Returns + +`AppClient` + +A new app client with the altered params + +#### Example + +```typescript +const appClient2 = appClient.clone({ defaultSender: 'NEW_SENDER_ADDRESS' }) +``` + +*** + +### compile() + +> **compile**(`compilation?`): `Promise`\<[`AppClientCompilationResult`](../interfaces/AppClientCompilationResult.md)\> + +Defined in: [src/types/app-client.ts:932](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L932) + +Compiles the approval and clear state programs (if TEAL templates provided), +performing any provided deploy-time parameter replacement and stores +the source maps. + +If no TEAL templates provided it will use any byte code provided in the app spec. + +Will store any generated source maps for later use in debugging. + +#### Parameters + +##### compilation? + +[`AppClientCompilationParams`](../interfaces/AppClientCompilationParams.md) + +Any compilation parameters to use + +#### Returns + +`Promise`\<[`AppClientCompilationResult`](../interfaces/AppClientCompilationResult.md)\> + +The compiled code and any compilation results (including source maps) + +*** + +### exportSourceMaps() + +> **exportSourceMaps**(): [`AppSourceMaps`](../interfaces/AppSourceMaps.md) + +Defined in: [src/types/app-client.ts:874](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L874) + +Export the current source maps for the app. + +#### Returns + +[`AppSourceMaps`](../interfaces/AppSourceMaps.md) + +The source maps + +*** + +### exposeLogicError() + +> **exposeLogicError**(`e`, `isClearStateProgram?`): `Promise`\<`Error`\> + +Defined in: [src/types/app-client.ts:852](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L852) + +Takes an error that may include a logic error from a call to the current app and re-exposes the +error to include source code information via the source map and ARC-56 spec. + +#### Parameters + +##### e + +`Error` + +The error to parse + +##### isClearStateProgram? + +`boolean` + +Whether or not the code was running the clear state program (defaults to approval program) + +#### Returns + +`Promise`\<`Error`\> + +The new error, or if there was no logic error or source map then the wrapped error with source details + +*** + +### fundAppAccount() + +> **fundAppAccount**(`params`): `Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +Defined in: [src/types/app-client.ts:737](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L737) + +Funds Algo into the app account for this app. + +An alias for `appClient.send.fundAppAccount(params)`. + +#### Parameters + +##### params + +The parameters for the funding transaction + +###### amount + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Amount to send + +###### closeRemainderTo? + +`string` \| `Address` + +If given, close the sender account and send the remaining balance to this address + +*Warning:* Be careful with this parameter as it can lead to loss of funds if not used correctly. + +###### coverAppCallInnerTransactionFees? + +`boolean` + +Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### maxRoundsToWaitForConfirmation? + +`number` + +The number of rounds to wait for confirmation. By default until the latest lastValid has past. + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### populateAppCallResources? + +`boolean` + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### sender? + +`string` \| `Address` + +The optional sender to send the transaction from, will use the application client's default sender by default if specified + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### suppressLog? + +`boolean` + +Whether to suppress log messages from transaction send, default: do not suppress. + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +#### Returns + +`Promise`\<\{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}\> + +The result of the funding + +#### Example + +```typescript +await appClient.fundAppAccount({ amount: algo(1) }) +``` + +*** + +### getABIMethod() + +> **getABIMethod**(`methodNameOrSignature`): [`Arc56Method`](../../app-arc56/classes/Arc56Method.md) + +Defined in: [src/types/app-client.ts:899](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L899) + +Returns the ABI Method spec for the given method string for the app represented by this application client instance + +#### Parameters + +##### methodNameOrSignature + +`string` + +The method name or method signature to call if an ABI call is being emitted. +e.g. `my_method` or `my_method(unit64,string)bytes` + +#### Returns + +[`Arc56Method`](../../app-arc56/classes/Arc56Method.md) + +A tuple with: [ARC-56 `Method`, algosdk `ABIMethod`] + +*** + +### getBoxNames() + +> **getBoxNames**(): `Promise`\<[`BoxName`](../../app/interfaces/BoxName.md)[]\> + +Defined in: [src/types/app-client.ts:774](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L774) + +Returns the names of all current boxes for the current app. + +#### Returns + +`Promise`\<[`BoxName`](../../app/interfaces/BoxName.md)[]\> + +The names of the boxes + +#### Example + +```typescript +const boxNames = await appClient.getBoxNames() +``` + +*** + +### getBoxValue() + +> **getBoxValue**(`name`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +Defined in: [src/types/app-client.ts:787](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L787) + +Returns the value of the given box for the current app. + +#### Parameters + +##### name + +[`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) + +The identifier of the box to return + +#### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +The current box value as a byte array + +#### Example + +```typescript +const boxValue = await appClient.getBoxValue('boxName') +``` + +*** + +### getBoxValueFromABIType() + +> **getBoxValueFromABIType**(`name`, `type`): `Promise`\<`ABIValue`\> + +Defined in: [src/types/app-client.ts:801](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L801) + +Returns the value of the given box for the current app. + +#### Parameters + +##### name + +[`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) + +The identifier of the box to return + +##### type + +`ABIType` + +#### Returns + +`Promise`\<`ABIValue`\> + +The current box value as a byte array + +#### Example + +```typescript +const boxValue = await appClient.getBoxValueFromABIType('boxName', new ABIUintType(32)) +``` + +*** + +### getBoxValues() + +> **getBoxValues**(`filter?`): `Promise`\<`object`[]\> + +Defined in: [src/types/app-client.ts:815](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L815) + +Returns the values of all current boxes for the current app. +Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync. + +#### Parameters + +##### filter? + +(`name`) => `boolean` + +Optional filter to filter which boxes' values are returned + +#### Returns + +`Promise`\<`object`[]\> + +The (name, value) pair of the boxes with values as raw byte arrays + +#### Example + +```typescript +const boxValues = await appClient.getBoxValues() +``` + +*** + +### getBoxValuesFromABIType() + +> **getBoxValuesFromABIType**(`type`, `filter?`): `Promise`\<`object`[]\> + +Defined in: [src/types/app-client.ts:835](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L835) + +Returns the values of all current boxes for the current app decoded using an ABI Type. +Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync. + +#### Parameters + +##### type + +`ABIType` + +The ABI type to decode the values with + +##### filter? + +(`name`) => `boolean` + +Optional filter to filter which boxes' values are returned + +#### Returns + +`Promise`\<`object`[]\> + +The (name, value) pair of the boxes with values as the ABI Value + +#### Example + +```typescript +const boxValues = await appClient.getBoxValuesFromABIType(new ABIUintType(32)) +``` + +*** + +### getGlobalState() + +> **getGlobalState**(): `Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +Defined in: [src/types/app-client.ts:749](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L749) + +Returns raw global state for the current app. + +#### Returns + +`Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +The global state + +#### Example + +```typescript +const globalState = await appClient.getGlobalState() +``` + +*** + +### getLocalState() + +> **getLocalState**(`address`): `Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +Defined in: [src/types/app-client.ts:762](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L762) + +Returns raw local state for the given account address. + +#### Parameters + +##### address + +The address of the account to get the local state for + +`string` | `Address` + +#### Returns + +`Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +The local state + +#### Example + +```typescript +const localState = await appClient.getLocalState('ACCOUNT_ADDRESS') +``` + +*** + +### importSourceMaps() + +> **importSourceMaps**(`sourceMaps`): `void` + +Defined in: [src/types/app-client.ts:888](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L888) + +Import source maps for the app. + +#### Parameters + +##### sourceMaps + +[`AppSourceMaps`](../interfaces/AppSourceMaps.md) + +The source maps to import + +#### Returns + +`void` + +*** + +### processMethodCallReturn() + +> **processMethodCallReturn**\<`TReturn`, `TResult`\>(`result`, `method`): `Promise`\<`Omit`\<`TResult`, `"return"`\> & [`AppReturn`](../../app/type-aliases/AppReturn.md)\<`TReturn`\>\> + +Defined in: [src/types/app-client.ts:913](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L913) + +Checks for decode errors on the SendAppTransactionResult and maps the return value to the specified type +on the ARC-56 method, replacing the `return` property with the decoded type. + +If the return type is an ARC-56 struct then the struct will be returned. + +#### Type Parameters + +##### TReturn + +`TReturn` *extends* `undefined` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md) + +##### TResult + +`TResult` *extends* `object` = \{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \} + +#### Parameters + +##### result + +The SendAppTransactionResult to be mapped + +`TResult` | `Promise`\<`TResult`\> + +##### method + +[`Arc56Method`](../../app-arc56/classes/Arc56Method.md) + +The method that was called + +#### Returns + +`Promise`\<`Omit`\<`TResult`, `"return"`\> & [`AppReturn`](../../app/type-aliases/AppReturn.md)\<`TReturn`\>\> + +The smart contract response with an updated return value + +*** + +### compile() + +> `static` **compile**(`appSpec`, `appManager`, `compilation?`): `Promise`\<[`AppClientCompilationResult`](../interfaces/AppClientCompilationResult.md)\> + +Defined in: [src/types/app-client.ts:1037](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1037) + +Compiles the approval and clear state programs (if TEAL templates provided), +performing any provided deploy-time parameter replacement and returns +the compiled code and any compilation results (including source maps). + +If no TEAL templates provided it will use any byte code provided in the app spec. + +Will store any generated source maps for later use in debugging. + +#### Parameters + +##### appSpec + +[`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +The app spec for the app + +##### appManager + +[`AppManager`](../../app-manager/classes/AppManager.md) + +The app manager to use for compilation + +##### compilation? + +[`AppClientCompilationParams`](../interfaces/AppClientCompilationParams.md) + +Any compilation parameters to use + +#### Returns + +`Promise`\<[`AppClientCompilationResult`](../interfaces/AppClientCompilationResult.md)\> + +The compiled code and any compilation results (including source maps) + +*** + +### exposeLogicError() + +> `static` **exposeLogicError**(`e`, `appSpec`, `details`): `Error` + +Defined in: [src/types/app-client.ts:953](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L953) + +Takes an error that may include a logic error from a call to the current app and re-exposes the +error to include source code information via the source map and ARC-56 spec. + +#### Parameters + +##### e + +`Error` + +The error to parse + +##### appSpec + +[`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +The app spec for the app + +##### details + +Additional information to inform the error + +###### approvalSourceInfo? + +[`ProgramSourceInfo`](../../app-arc56/interfaces/ProgramSourceInfo.md) + +ARC56 approval source info + +###### approvalSourceMap? + +`ProgramSourceMap` + +Approval program source map + +###### clearSourceInfo? + +[`ProgramSourceInfo`](../../app-arc56/interfaces/ProgramSourceInfo.md) + +ARC56 clear source info + +###### clearSourceMap? + +`ProgramSourceMap` + +Clear state program source map + +###### isClearStateProgram? + +`boolean` + +Whether or not the code was running the clear state program (defaults to approval program) + +###### program? + +`Uint8Array`\<`ArrayBufferLike`\> + +program bytes + +#### Returns + +`Error` + +The new error, or if there was no logic error or source map then the wrapped error with source details + +*** + +### fromCreatorAndName() + +> `static` **fromCreatorAndName**(`params`): `Promise`\<`AppClient`\> + +Defined in: [src/types/app-client.ts:594](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L594) + +Returns a new `AppClient` client, resolving the app by creator address and name +using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note). + +#### Parameters + +##### params + +The parameters to create the app client + +###### algorand + +[`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +An `AlgorandClient` instance + +###### appLookupCache? + +[`AppLookup`](../../app-deployer/interfaces/AppLookup.md) + +An optional cached app lookup that matches a name to on-chain details; +either this is needed or indexer is required to be passed in to this `ClientManager` on construction. + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### appSpec + +`string` \| [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) \| [`AppSpec`](../../app-spec/interfaces/AppSpec.md) + +The ARC-56 or ARC-32 application spec as either: + * Parsed JSON ARC-56 `Contract` + * Parsed JSON ARC-32 `AppSpec` + * Raw JSON string (in either ARC-56 or ARC-32 format) + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### creatorAddress + +`string` \| `Address` + +The address of the creator account for the app + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +###### ignoreCache? + +`boolean` + +Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value + +#### Returns + +`Promise`\<`AppClient`\> + +The `AppClient` instance + +#### Example + +```typescript +const appClient = await AppClient.fromCreatorAndName({ + creatorAddress: 'CREATOR_ADDRESS', + name: 'APP_NAME', + appSpec: appSpec, + algorand: AlgorandClient.mainNet(), +}) + +*** + +### fromNetwork() + +> `static` **fromNetwork**(`params`): `Promise`\<`AppClient`\> + +Defined in: [src/types/app-client.ts:619](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L619) + +Returns an `AppClient` instance for the current network based on +pre-determined network-specific app IDs specified in the ARC-56 app spec. + +If no IDs are in the app spec or the network isn't recognised, an error is thrown. + +#### Parameters + +##### params + +The parameters to create the app client + +###### algorand + +[`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +An `AlgorandClient` instance + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### appSpec + +`string` \| [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) \| [`AppSpec`](../../app-spec/interfaces/AppSpec.md) + +The ARC-56 or ARC-32 application spec as either: + * Parsed JSON ARC-56 `Contract` + * Parsed JSON ARC-32 `AppSpec` + * Raw JSON string (in either ARC-56 or ARC-32 format) + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +#### Returns + +`Promise`\<`AppClient`\> + +The `AppClient` instance + +#### Example + +```typescript +const appClient = await AppClient.fromNetwork({ + appSpec: appSpec, + algorand: AlgorandClient.mainNet(), +}) + +*** + +### normaliseAppSpec() + +> `static` **normaliseAppSpec**(`spec`): [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +Defined in: [src/types/app-client.ts:647](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L647) + +Takes a string or parsed JSON object that could be ARC-32 or ARC-56 format and +normalises it into a parsed ARC-56 contract object. + +#### Parameters + +##### spec + +The spec to normalise + +`string` | [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) | [`AppSpec`](../../app-spec/interfaces/AppSpec.md) + +#### Returns + +[`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +The normalised ARC-56 contract object + +#### Example + +```typescript +const arc56AppSpec = AppClient.normaliseAppSpec(appSpec) +``` diff --git a/docs/code/types/app-client/classes/ApplicationClient.md b/docs/code/types/app-client/classes/ApplicationClient.md new file mode 100644 index 00000000..4310bc75 --- /dev/null +++ b/docs/code/types/app-client/classes/ApplicationClient.md @@ -0,0 +1,708 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / ApplicationClient + +# Class: ~~ApplicationClient~~ + +Defined in: [src/types/app-client.ts:1729](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1729) + +## Deprecated + +Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or +`algorand.client.getAppClientByCreatorAndName`. +If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, +which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. + +Application client - a class that wraps an ARC-0032 app spec and provides high productivity methods to deploy and call the app + +## Constructors + +### Constructor + +> **new ApplicationClient**(`appDetails`, `algod`): `ApplicationClient` + +Defined in: [src/types/app-client.ts:1756](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1756) + +#### Parameters + +##### appDetails + +[`AppSpecAppDetails`](../type-aliases/AppSpecAppDetails.md) + +The details of the app + +##### algod + +`AlgodClient` + +An algod instance + +#### Returns + +`ApplicationClient` + +#### Deprecated + +Use `AppClient` instead e.g. via `algorand.client.getAppClientById` or +`algorand.client.getAppClientByCreatorAndName`. +If you want to `create` or `deploy` then use `AppFactory` e.g. via `algorand.client.getAppFactory`, +which will in turn give you an `AppClient` instance against the created/deployed app to make other calls. + +Create a new ApplicationClient instance + +## Methods + +### ~~call()~~ + +> **call**(`call?`): `Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +Defined in: [src/types/app-client.ts:2068](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2068) + +#### Parameters + +##### call? + +[`AppClientCallParams`](../type-aliases/AppClientCallParams.md) + +The call details. + +#### Returns + +`Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +The result of the call + +#### Deprecated + +Use `appClient.send.call` or `appClient.createTransaction.call` from an `AppClient` instance instead. + +Issues a no_op (normal) call to the app. + +*** + +### ~~callOfType()~~ + +> **callOfType**(`call`, `callType`): `Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +Defined in: [src/types/app-client.ts:2150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2150) + +#### Parameters + +##### call + +[`AppClientCallParams`](../type-aliases/AppClientCallParams.md) = `{}` + +The call details. + +##### callType + +The call type + +`"no_op"` | `"opt_in"` | `"close_out"` | `"clear_state"` | `"delete_application"` | `NoOpOC` | `OptInOC` | `CloseOutOC` | `ClearStateOC` | `DeleteApplicationOC` + +#### Returns + +`Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +The result of the call + +#### Deprecated + +Use `appClient.send.call` or `appClient.createTransaction.call` from an `AppClient` instance instead. + +Issues a call to the app with the given call type. + +*** + +### ~~clearState()~~ + +> **clearState**(`call?`): `Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +Defined in: [src/types/app-client.ts:2127](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2127) + +#### Parameters + +##### call? + +[`AppClientClearStateParams`](../type-aliases/AppClientClearStateParams.md) + +The call details. + +#### Returns + +`Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +The result of the call + +#### Deprecated + +Use `appClient.send.clearState` or `appClient.createTransaction.clearState` from an `AppClient` instance instead. + +Issues a clear_state call to the app. + +*** + +### ~~closeOut()~~ + +> **closeOut**(`call?`): `Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +Defined in: [src/types/app-client.ts:2116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2116) + +#### Parameters + +##### call? + +[`AppClientCallParams`](../type-aliases/AppClientCallParams.md) + +The call details. + +#### Returns + +`Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +The result of the call + +#### Deprecated + +Use `appClient.send.closeOut` or `appClient.createTransaction.closeOut` from an `AppClient` instance instead. + +Issues a close_out call to the app. + +*** + +### ~~compile()~~ + +> **compile**(`compilation?`): `Promise`\<\{ `approvalCompiled`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `clearCompiled`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); \}\> + +Defined in: [src/types/app-client.ts:1795](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1795) + +#### Parameters + +##### compilation? + +[`AppClientCompilationParams`](../interfaces/AppClientCompilationParams.md) + +The deploy-time parameters for the compilation + +#### Returns + +`Promise`\<\{ `approvalCompiled`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `clearCompiled`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); \}\> + +The compiled approval and clear state programs + +#### Deprecated + +Use `AppClient.compile()` instead. + +Compiles the approval and clear state programs and sets up the source map. + +*** + +### ~~create()~~ + +> **create**(`create?`): `Promise`\<\{ `appAddress`: `string`; `appId`: `number` \| `bigint`; `compiledApproval`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation?`: `PendingTransactionResponse`; `confirmations?`: `PendingTransactionResponse`[]; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `transaction`: `Transaction`; `transactions`: `Transaction`[]; \}\> + +Defined in: [src/types/app-client.ts:1963](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1963) + +#### Parameters + +##### create? + +[`AppClientCreateParams`](../type-aliases/AppClientCreateParams.md) + +The parameters to create the app with + +#### Returns + +`Promise`\<\{ `appAddress`: `string`; `appId`: `number` \| `bigint`; `compiledApproval`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation?`: `PendingTransactionResponse`; `confirmations?`: `PendingTransactionResponse`[]; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `transaction`: `Transaction`; `transactions`: `Transaction`[]; \}\> + +The details of the created app, or the transaction to create it if `skipSending` and the compilation result + +#### Deprecated + +Use `create` from an `AppFactory` instance instead. + +Creates a smart contract app, returns the details of the created app. + +*** + +### ~~delete()~~ + +> **delete**(`call?`): `Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +Defined in: [src/types/app-client.ts:2138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2138) + +#### Parameters + +##### call? + +[`AppClientCallParams`](../type-aliases/AppClientCallParams.md) + +The call details. + +#### Returns + +`Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +The result of the call + +#### Deprecated + +Use `appClient.send.delete` or `appClient.createTransaction.delete` from an `AppClient` instance instead. + +Issues a delete_application call to the app. + +*** + +### ~~deploy()~~ + +> **deploy**(`deploy?`): `Promise`\<`Partial`\<[`AppCompilationResult`](../../app/interfaces/AppCompilationResult.md)\> & [`AppMetadata`](../../app/interfaces/AppMetadata.md) & `object` \| \{ `appAddress`: `string`; `appId`: `number` \| `bigint`; `compiledApproval`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `number`; `deletable?`: `boolean`; `deleted`: `boolean`; `name`: `string`; `operationPerformed`: `"update"` \| `"create"`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `transaction`: `Transaction`; `transactions`: `Transaction`[]; `updatable?`: `boolean`; `updatedRound`: `number`; `version`: `string`; \} \| \{ `appAddress`: `string`; `appId`: `number` \| `bigint`; `compiledApproval`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `number`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteResult`: [`ConfirmedTransactionResult`](../../transaction/interfaces/ConfirmedTransactionResult.md); `deleteReturn?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `name`: `string`; `operationPerformed`: `"replace"`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `transaction`: `Transaction`; `transactions`: `Transaction`[]; `updatable?`: `boolean`; `updatedRound`: `number`; `version`: `string`; \}\> + +Defined in: [src/types/app-client.ts:1857](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1857) + +#### Parameters + +##### deploy? + +[`AppClientDeployParams`](../interfaces/AppClientDeployParams.md) + +Deployment details + +#### Returns + +`Promise`\<`Partial`\<[`AppCompilationResult`](../../app/interfaces/AppCompilationResult.md)\> & [`AppMetadata`](../../app/interfaces/AppMetadata.md) & `object` \| \{ `appAddress`: `string`; `appId`: `number` \| `bigint`; `compiledApproval`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `number`; `deletable?`: `boolean`; `deleted`: `boolean`; `name`: `string`; `operationPerformed`: `"update"` \| `"create"`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `transaction`: `Transaction`; `transactions`: `Transaction`[]; `updatable?`: `boolean`; `updatedRound`: `number`; `version`: `string`; \} \| \{ `appAddress`: `string`; `appId`: `number` \| `bigint`; `compiledApproval`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `number`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteResult`: [`ConfirmedTransactionResult`](../../transaction/interfaces/ConfirmedTransactionResult.md); `deleteReturn?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `name`: `string`; `operationPerformed`: `"replace"`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `transaction`: `Transaction`; `transactions`: `Transaction`[]; `updatable?`: `boolean`; `updatedRound`: `number`; `version`: `string`; \}\> + +The metadata and transaction result(s) of the deployment, or just the metadata if it didn't need to issue transactions + +#### Deprecated + +Use `deploy` from an `AppFactory` instance instead. + +Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions. + +To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md + +**Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created. + +**Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created. + +*** + +### ~~exportSourceMaps()~~ + +> **exportSourceMaps**(): [`AppSourceMaps`](../interfaces/AppSourceMaps.md) + +Defined in: [src/types/app-client.ts:1825](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1825) + +Export the current source maps for the app. + +#### Returns + +[`AppSourceMaps`](../interfaces/AppSourceMaps.md) + +The source maps + +*** + +### ~~exposeLogicError()~~ + +> **exposeLogicError**(`e`, `isClear?`): `Error` + +Defined in: [src/types/app-client.ts:2459](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2459) + +Takes an error that may include a logic error from a smart contract call and re-exposes the error to include source code information via the source map. +This is automatically used within `ApplicationClient` but if you pass `skipSending: true` e.g. if doing a group transaction + then you can use this in a try/catch block to get better debugging information. + +#### Parameters + +##### e + +`Error` + +The error to parse + +##### isClear? + +`boolean` + +Whether or not the code was running the clear state program + +#### Returns + +`Error` + +The new error, or if there was no logic error or source map then the wrapped error with source details + +*** + +### ~~fundAppAccount()~~ + +> **fundAppAccount**(`fund`): `Promise`\<[`SendTransactionResult`](../../transaction/interfaces/SendTransactionResult.md) \| \{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \} & `object`\> + +Defined in: [src/types/app-client.ts:2189](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2189) + +Funds Algo into the app account for this app. + +#### Parameters + +##### fund + +The parameters for the funding or the funding amount + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) | [`FundAppAccountParams`](../interfaces/FundAppAccountParams.md) + +#### Returns + +`Promise`\<[`SendTransactionResult`](../../transaction/interfaces/SendTransactionResult.md) \| \{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \} & `object`\> + +The result of the funding + +*** + +### ~~getABIMethod()~~ + +> **getABIMethod**(`method`): `undefined` \| `ABIMethod` + +Defined in: [src/types/app-client.ts:2423](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2423) + +Returns the ABI Method for the given method name string for the app represented by this application client instance + +#### Parameters + +##### method + +`string` + +Either the name of the method or the ABI method spec definition string + +#### Returns + +`undefined` \| `ABIMethod` + +The ABI method for the given method + +*** + +### ~~getABIMethodParams()~~ + +> **getABIMethodParams**(`method`): `undefined` \| `ABIMethodParams` + +Defined in: [src/types/app-client.ts:2401](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2401) + +#### Parameters + +##### method + +`string` + +Either the name of the method or the ABI method spec definition string + +#### Returns + +`undefined` \| `ABIMethodParams` + +The ABI method params for the given method + +#### Deprecated + +Use `appClient.getABIMethod` instead. + +Returns the ABI Method parameters for the given method name string for the app represented by this application client instance + +*** + +### ~~getAppReference()~~ + +> **getAppReference**(): `Promise`\<[`AppReference`](../../app/interfaces/AppReference.md) \| [`AppMetadata`](../../app/interfaces/AppMetadata.md)\> + +Defined in: [src/types/app-client.ts:2435](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2435) + +#### Returns + +`Promise`\<[`AppReference`](../../app/interfaces/AppReference.md) \| [`AppMetadata`](../../app/interfaces/AppMetadata.md)\> + +The app reference, or if deployed using the `deploy` method, the app metadata too + +#### Deprecated + +Use `appClient.appId` and `appClient.appAddress` from an `AppClient` instance instead. + +Gets the reference information for the current application instance. +`appId` will be 0 if it can't find an app. + +*** + +### ~~getBoxNames()~~ + +> **getBoxNames**(): `Promise`\<[`BoxName`](../../app/interfaces/BoxName.md)[]\> + +Defined in: [src/types/app-client.ts:2240](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2240) + +Returns the names of all current boxes for the current app. + +#### Returns + +`Promise`\<[`BoxName`](../../app/interfaces/BoxName.md)[]\> + +The names of the boxes + +*** + +### ~~getBoxValue()~~ + +> **getBoxValue**(`name`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +Defined in: [src/types/app-client.ts:2255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2255) + +Returns the value of the given box for the current app. + +#### Parameters + +##### name + +The name of the box to return either as a string, binary array or `BoxName` + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BoxName`](../../app/interfaces/BoxName.md) + +#### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +The current box value as a byte array + +*** + +### ~~getBoxValueFromABIType()~~ + +> **getBoxValueFromABIType**(`name`, `type`): `Promise`\<`ABIValue`\> + +Defined in: [src/types/app-client.ts:2271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2271) + +Returns the value of the given box for the current app. + +#### Parameters + +##### name + +The name of the box to return either as a string, binary array or `BoxName` + +`string` | `Uint8Array`\<`ArrayBufferLike`\> | [`BoxName`](../../app/interfaces/BoxName.md) + +##### type + +`ABIType` + +#### Returns + +`Promise`\<`ABIValue`\> + +The current box value as a byte array + +*** + +### ~~getBoxValues()~~ + +> **getBoxValues**(`filter?`): `Promise`\<`object`[]\> + +Defined in: [src/types/app-client.ts:2287](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2287) + +Returns the values of all current boxes for the current app. +Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync. + +#### Parameters + +##### filter? + +(`name`) => `boolean` + +Optional filter to filter which boxes' values are returned + +#### Returns + +`Promise`\<`object`[]\> + +The (name, value) pair of the boxes with values as raw byte arrays + +*** + +### ~~getBoxValuesFromABIType()~~ + +> **getBoxValuesFromABIType**(`type`, `filter?`): `Promise`\<`object`[]\> + +Defined in: [src/types/app-client.ts:2309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2309) + +Returns the values of all current boxes for the current app decoded using an ABI Type. +Note: This will issue multiple HTTP requests (one per box) and it's not an atomic operation so values may be out of sync. + +#### Parameters + +##### type + +`ABIType` + +The ABI type to decode the values with + +##### filter? + +(`name`) => `boolean` + +Optional filter to filter which boxes' values are returned + +#### Returns + +`Promise`\<`object`[]\> + +The (name, value) pair of the boxes with values as the ABI Value + +*** + +### ~~getCallArgs()~~ + +> **getCallArgs**(`args`, `sender`): `Promise`\<`undefined` \| [`AppCallArgs`](../../app/type-aliases/AppCallArgs.md)\> + +Defined in: [src/types/app-client.ts:2335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2335) + +#### Parameters + +##### args + +The call args specific to this application client + +`undefined` | [`AppClientCallArgs`](../type-aliases/AppClientCallArgs.md) + +##### sender + +[`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +The sender of this call. Will be used to fetch any default argument values if applicable + +#### Returns + +`Promise`\<`undefined` \| [`AppCallArgs`](../../app/type-aliases/AppCallArgs.md)\> + +The call args ready to pass into an app call + +#### Deprecated + +Use `appClient.params.*` from an `AppClient` instance instead. + +Returns the arguments for an app call for the given ABI method or raw method specification. + +*** + +### ~~getGlobalState()~~ + +> **getGlobalState**(): `Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +Defined in: [src/types/app-client.ts:2212](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2212) + +Returns global state for the current app. + +#### Returns + +`Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +The global state + +*** + +### ~~getLocalState()~~ + +> **getLocalState**(`account`): `Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +Defined in: [src/types/app-client.ts:2226](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2226) + +Returns local state for the given account / account address. + +#### Parameters + +##### account + +`string` | [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +#### Returns + +`Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +The global state + +*** + +### ~~importSourceMaps()~~ + +> **importSourceMaps**(`sourceMaps`): `void` + +Defined in: [src/types/app-client.ts:1839](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L1839) + +Import source maps for the app. + +#### Parameters + +##### sourceMaps + +[`AppSourceMaps`](../interfaces/AppSourceMaps.md) + +The source maps to import + +#### Returns + +`void` + +*** + +### ~~optIn()~~ + +> **optIn**(`call?`): `Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +Defined in: [src/types/app-client.ts:2105](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2105) + +#### Parameters + +##### call? + +[`AppClientCallParams`](../type-aliases/AppClientCallParams.md) + +The call details. + +#### Returns + +`Promise`\<[`AppCallTransactionResult`](../../app/type-aliases/AppCallTransactionResult.md)\> + +The result of the call + +#### Deprecated + +Use `appClient.send.optIn` or `appClient.createTransaction.optIn` from an `AppClient` instance instead. + +Issues a opt_in call to the app. + +*** + +### ~~update()~~ + +> **update**(`update?`): `Promise`\<\{ `compiledApproval`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation?`: `PendingTransactionResponse`; `confirmations?`: `PendingTransactionResponse`[]; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `transaction`: `Transaction`; `transactions`: `Transaction`[]; \}\> + +Defined in: [src/types/app-client.ts:2027](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L2027) + +#### Parameters + +##### update? + +[`AppClientUpdateParams`](../type-aliases/AppClientUpdateParams.md) + +The parameters to update the app with + +#### Returns + +`Promise`\<\{ `compiledApproval`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation?`: `PendingTransactionResponse`; `confirmations?`: `PendingTransactionResponse`[]; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `transaction`: `Transaction`; `transactions`: `Transaction`[]; \}\> + +The transaction send result and the compilation result + +#### Deprecated + +Use `appClient.send.update` or `appClient.createTransaction.update` from an `AppClient` instance instead. + +Updates the smart contract app. diff --git a/docs/code/types/app-client/interfaces/AppClientCallABIArgs.md b/docs/code/types/app-client/interfaces/AppClientCallABIArgs.md new file mode 100644 index 00000000..7fcfb3e8 --- /dev/null +++ b/docs/code/types/app-client/interfaces/AppClientCallABIArgs.md @@ -0,0 +1,123 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientCallABIArgs + +# Interface: AppClientCallABIArgs + +Defined in: [src/types/app-client.ts:199](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L199) + +## Extends + +- `Omit`\<[`ABIAppCallArgs`](../../app/type-aliases/ABIAppCallArgs.md), `"method"`\> + +## Properties + +### accounts? + +> `optional` **accounts**: (`string` \| `Address`)[] + +Defined in: [src/types/app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L79) + +The address of any accounts to load in + +#### Inherited from + +`Omit.accounts` + +*** + +### apps? + +> `optional` **apps**: `number`[] + +Defined in: [src/types/app.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L81) + +IDs of any apps to load into the foreignApps array + +#### Inherited from + +`Omit.apps` + +*** + +### assets? + +> `optional` **assets**: `number`[] + +Defined in: [src/types/app.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L83) + +IDs of any assets to load into the foreignAssets array + +#### Inherited from + +`Omit.assets` + +*** + +### boxes? + +> `optional` **boxes**: ([`BoxReference`](../../app/interfaces/BoxReference.md) \| [`BoxIdentifier`](../../app/type-aliases/BoxIdentifier.md) \| `BoxReference`)[] + +Defined in: [src/types/app.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L77) + +Any box references to load + +#### Inherited from + +`Omit.boxes` + +*** + +### lease? + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75) + +The optional lease for the transaction + +#### Inherited from + +`Omit.lease` + +*** + +### method + +> **method**: `string` + +Defined in: [src/types/app-client.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L201) + +If calling an ABI method then either the name of the method, or the ABI signature + +*** + +### methodArgs + +> **methodArgs**: [`ABIAppCallArg`](../../app/type-aliases/ABIAppCallArg.md)[] + +Defined in: [src/types/app.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L117) + +The ABI method args to pass in + +#### Inherited from + +`Omit.methodArgs` + +*** + +### rekeyTo? + +> `optional` **rekeyTo**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L88) + +Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction. + +**Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first. + +#### Inherited from + +`Omit.rekeyTo` diff --git a/docs/code/types/app-client/interfaces/AppClientCallCoreParams.md b/docs/code/types/app-client/interfaces/AppClientCallCoreParams.md new file mode 100644 index 00000000..faa35049 --- /dev/null +++ b/docs/code/types/app-client/interfaces/AppClientCallCoreParams.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientCallCoreParams + +# Interface: AppClientCallCoreParams + +Defined in: [src/types/app-client.ts:208](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L208) + +Common (core) parameters to construct a ApplicationClient contract call + +## Properties + +### note? + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/app-client.ts:212](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L212) + +The transaction note for the smart contract call + +*** + +### sender? + +> `optional` **sender**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app-client.ts:210](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L210) + +The optional sender to send the transaction from, will use the application client's default sender by default if specified + +*** + +### sendParams? + +> `optional` **sendParams**: [`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md) + +Defined in: [src/types/app-client.ts:214](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L214) + +Parameters to control transaction sending diff --git a/docs/code/types/app-client/interfaces/AppClientCompilationParams.md b/docs/code/types/app-client/interfaces/AppClientCompilationParams.md new file mode 100644 index 00000000..1d93c19b --- /dev/null +++ b/docs/code/types/app-client/interfaces/AppClientCompilationParams.md @@ -0,0 +1,39 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientCompilationParams + +# Interface: AppClientCompilationParams + +Defined in: [src/types/app-client.ts:223](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L223) + +## Properties + +### deletable? + +> `optional` **deletable**: `boolean` + +Defined in: [src/types/app-client.ts:229](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L229) + +Whether or not the contract should have deploy-time permanence control set, undefined = ignore + +*** + +### deployTimeParams? + +> `optional` **deployTimeParams**: [`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Defined in: [src/types/app-client.ts:225](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L225) + +Any deploy-time parameters to replace in the TEAL code + +*** + +### updatable? + +> `optional` **updatable**: `boolean` + +Defined in: [src/types/app-client.ts:227](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L227) + +Whether or not the contract should have deploy-time immutability control set, undefined = ignore diff --git a/docs/code/types/app-client/interfaces/AppClientCompilationResult.md b/docs/code/types/app-client/interfaces/AppClientCompilationResult.md new file mode 100644 index 00000000..8127f286 --- /dev/null +++ b/docs/code/types/app-client/interfaces/AppClientCompilationResult.md @@ -0,0 +1,65 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientCompilationResult + +# Interface: AppClientCompilationResult + +Defined in: [src/types/app-client.ts:280](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L280) + +The result of asking an `AppClient` to compile a program. + +Always contains the compiled bytecode, and may contain the result of compiling TEAL (including sourcemap) if it was available. + +## Extends + +- `Partial`\<[`AppCompilationResult`](../../app/interfaces/AppCompilationResult.md)\> + +## Properties + +### approvalProgram + +> **approvalProgram**: `Uint8Array` + +Defined in: [src/types/app-client.ts:282](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L282) + +The compiled bytecode of the approval program, ready to deploy to algod + +*** + +### clearStateProgram + +> **clearStateProgram**: `Uint8Array` + +Defined in: [src/types/app-client.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L284) + +The compiled bytecode of the clear state program, ready to deploy to algod + +*** + +### compiledApproval? + +> `optional` **compiledApproval**: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md) + +Defined in: [src/types/app.ts:335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L335) + +The result of compiling the approval program + +#### Inherited from + +`Partial.compiledApproval` + +*** + +### compiledClear? + +> `optional` **compiledClear**: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md) + +Defined in: [src/types/app.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L337) + +The result of compiling the clear state program + +#### Inherited from + +`Partial.compiledClear` diff --git a/docs/code/types/app-client/interfaces/AppClientDeployCallInterfaceParams.md b/docs/code/types/app-client/interfaces/AppClientDeployCallInterfaceParams.md new file mode 100644 index 00000000..a2f9824b --- /dev/null +++ b/docs/code/types/app-client/interfaces/AppClientDeployCallInterfaceParams.md @@ -0,0 +1,65 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientDeployCallInterfaceParams + +# Interface: AppClientDeployCallInterfaceParams + +Defined in: [src/types/app-client.ts:178](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L178) + +Call interface parameters to pass into ApplicationClient.deploy + +## Extended by + +- [`AppClientDeployParams`](AppClientDeployParams.md) + +## Properties + +### createArgs? + +> `optional` **createArgs**: [`AppClientCallArgs`](../type-aliases/AppClientCallArgs.md) + +Defined in: [src/types/app-client.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L182) + +Any args to pass to any create transaction that is issued as part of deployment + +*** + +### createOnCompleteAction? + +> `optional` **createOnCompleteAction**: `"no_op"` \| `"opt_in"` \| `"close_out"` \| `"update_application"` \| `"delete_application"` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +Defined in: [src/types/app-client.ts:184](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L184) + +Override the on-completion action for the create call; defaults to NoOp + +*** + +### deleteArgs? + +> `optional` **deleteArgs**: [`AppClientCallArgs`](../type-aliases/AppClientCallArgs.md) + +Defined in: [src/types/app-client.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L188) + +Any args to pass to any delete transaction that is issued as part of deployment + +*** + +### deployTimeParams? + +> `optional` **deployTimeParams**: [`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Defined in: [src/types/app-client.ts:180](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L180) + +Any deploy-time parameters to replace in the TEAL code + +*** + +### updateArgs? + +> `optional` **updateArgs**: [`AppClientCallArgs`](../type-aliases/AppClientCallArgs.md) + +Defined in: [src/types/app-client.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L186) + +Any args to pass to any update transaction that is issued as part of deployment diff --git a/docs/code/types/app-client/interfaces/AppClientDeployCoreParams.md b/docs/code/types/app-client/interfaces/AppClientDeployCoreParams.md new file mode 100644 index 00000000..778b1ab4 --- /dev/null +++ b/docs/code/types/app-client/interfaces/AppClientDeployCoreParams.md @@ -0,0 +1,87 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientDeployCoreParams + +# Interface: AppClientDeployCoreParams + +Defined in: [src/types/app-client.ts:156](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L156) + +Core parameters to pass into ApplicationClient.deploy + +## Extended by + +- [`AppClientDeployParams`](AppClientDeployParams.md) + +## Properties + +### allowDelete? + +> `optional` **allowDelete**: `boolean` + +Defined in: [src/types/app-client.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L170) + +Whether or not to allow deletes in the contract using the deploy-time deletability control if present in your contract. +If this is not specified then it will automatically be determined based on the AppSpec definition + +*** + +### allowUpdate? + +> `optional` **allowUpdate**: `boolean` + +Defined in: [src/types/app-client.ts:166](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L166) + +Whether or not to allow updates in the contract using the deploy-time updatability control if present in your contract. +If this is not specified then it will automatically be determined based on the AppSpec definition + +*** + +### onSchemaBreak? + +> `optional` **onSchemaBreak**: [`OnSchemaBreak`](../../app/enumerations/OnSchemaBreak.md) \| `"replace"` \| `"fail"` \| `"append"` + +Defined in: [src/types/app-client.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L172) + +What action to perform if a schema break is detected + +*** + +### onUpdate? + +> `optional` **onUpdate**: `"replace"` \| `"fail"` \| `"append"` \| [`OnUpdate`](../../app/enumerations/OnUpdate.md) \| `"update"` + +Defined in: [src/types/app-client.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L174) + +What action to perform if a TEAL update is detected + +*** + +### sender? + +> `optional` **sender**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app-client.ts:160](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L160) + +The optional sender to send the transaction from, will use the application client's default sender by default if specified + +*** + +### sendParams? + +> `optional` **sendParams**: `Omit`\<[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md), `"skipSending"` \| `"skipWaiting"`\> + +Defined in: [src/types/app-client.ts:162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L162) + +Parameters to control transaction sending + +*** + +### version? + +> `optional` **version**: `string` + +Defined in: [src/types/app-client.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L158) + +The version of the contract, uses "1.0" by default diff --git a/docs/code/types/app-client/interfaces/AppClientDeployParams.md b/docs/code/types/app-client/interfaces/AppClientDeployParams.md new file mode 100644 index 00000000..2573596f --- /dev/null +++ b/docs/code/types/app-client/interfaces/AppClientDeployParams.md @@ -0,0 +1,195 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientDeployParams + +# Interface: AppClientDeployParams + +Defined in: [src/types/app-client.ts:192](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L192) + +Parameters to pass into ApplicationClient.deploy + +## Extends + +- [`AppClientDeployCoreParams`](AppClientDeployCoreParams.md).[`AppClientDeployCallInterfaceParams`](AppClientDeployCallInterfaceParams.md) + +## Properties + +### allowDelete? + +> `optional` **allowDelete**: `boolean` + +Defined in: [src/types/app-client.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L170) + +Whether or not to allow deletes in the contract using the deploy-time deletability control if present in your contract. +If this is not specified then it will automatically be determined based on the AppSpec definition + +#### Inherited from + +[`AppClientDeployCoreParams`](AppClientDeployCoreParams.md).[`allowDelete`](AppClientDeployCoreParams.md#allowdelete) + +*** + +### allowUpdate? + +> `optional` **allowUpdate**: `boolean` + +Defined in: [src/types/app-client.ts:166](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L166) + +Whether or not to allow updates in the contract using the deploy-time updatability control if present in your contract. +If this is not specified then it will automatically be determined based on the AppSpec definition + +#### Inherited from + +[`AppClientDeployCoreParams`](AppClientDeployCoreParams.md).[`allowUpdate`](AppClientDeployCoreParams.md#allowupdate) + +*** + +### createArgs? + +> `optional` **createArgs**: [`AppClientCallArgs`](../type-aliases/AppClientCallArgs.md) + +Defined in: [src/types/app-client.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L182) + +Any args to pass to any create transaction that is issued as part of deployment + +#### Inherited from + +[`AppClientDeployCallInterfaceParams`](AppClientDeployCallInterfaceParams.md).[`createArgs`](AppClientDeployCallInterfaceParams.md#createargs) + +*** + +### createOnCompleteAction? + +> `optional` **createOnCompleteAction**: `"no_op"` \| `"opt_in"` \| `"close_out"` \| `"update_application"` \| `"delete_application"` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +Defined in: [src/types/app-client.ts:184](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L184) + +Override the on-completion action for the create call; defaults to NoOp + +#### Inherited from + +[`AppClientDeployCallInterfaceParams`](AppClientDeployCallInterfaceParams.md).[`createOnCompleteAction`](AppClientDeployCallInterfaceParams.md#createoncompleteaction) + +*** + +### deleteArgs? + +> `optional` **deleteArgs**: [`AppClientCallArgs`](../type-aliases/AppClientCallArgs.md) + +Defined in: [src/types/app-client.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L188) + +Any args to pass to any delete transaction that is issued as part of deployment + +#### Inherited from + +[`AppClientDeployCallInterfaceParams`](AppClientDeployCallInterfaceParams.md).[`deleteArgs`](AppClientDeployCallInterfaceParams.md#deleteargs) + +*** + +### deployTimeParams? + +> `optional` **deployTimeParams**: [`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Defined in: [src/types/app-client.ts:180](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L180) + +Any deploy-time parameters to replace in the TEAL code + +#### Inherited from + +[`AppClientDeployCallInterfaceParams`](AppClientDeployCallInterfaceParams.md).[`deployTimeParams`](AppClientDeployCallInterfaceParams.md#deploytimeparams) + +*** + +### onSchemaBreak? + +> `optional` **onSchemaBreak**: [`OnSchemaBreak`](../../app/enumerations/OnSchemaBreak.md) \| `"replace"` \| `"fail"` \| `"append"` + +Defined in: [src/types/app-client.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L172) + +What action to perform if a schema break is detected + +#### Inherited from + +[`AppClientDeployCoreParams`](AppClientDeployCoreParams.md).[`onSchemaBreak`](AppClientDeployCoreParams.md#onschemabreak) + +*** + +### onUpdate? + +> `optional` **onUpdate**: `"replace"` \| `"fail"` \| `"append"` \| [`OnUpdate`](../../app/enumerations/OnUpdate.md) \| `"update"` + +Defined in: [src/types/app-client.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L174) + +What action to perform if a TEAL update is detected + +#### Inherited from + +[`AppClientDeployCoreParams`](AppClientDeployCoreParams.md).[`onUpdate`](AppClientDeployCoreParams.md#onupdate) + +*** + +### schema? + +> `optional` **schema**: `Partial`\<[`AppStorageSchema`](../../app/interfaces/AppStorageSchema.md)\> + +Defined in: [src/types/app-client.ts:194](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L194) + +Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used. + +*** + +### sender? + +> `optional` **sender**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app-client.ts:160](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L160) + +The optional sender to send the transaction from, will use the application client's default sender by default if specified + +#### Inherited from + +[`AppClientDeployCoreParams`](AppClientDeployCoreParams.md).[`sender`](AppClientDeployCoreParams.md#sender) + +*** + +### sendParams? + +> `optional` **sendParams**: `Omit`\<[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md), `"skipSending"` \| `"skipWaiting"`\> + +Defined in: [src/types/app-client.ts:162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L162) + +Parameters to control transaction sending + +#### Inherited from + +[`AppClientDeployCoreParams`](AppClientDeployCoreParams.md).[`sendParams`](AppClientDeployCoreParams.md#sendparams) + +*** + +### updateArgs? + +> `optional` **updateArgs**: [`AppClientCallArgs`](../type-aliases/AppClientCallArgs.md) + +Defined in: [src/types/app-client.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L186) + +Any args to pass to any update transaction that is issued as part of deployment + +#### Inherited from + +[`AppClientDeployCallInterfaceParams`](AppClientDeployCallInterfaceParams.md).[`updateArgs`](AppClientDeployCallInterfaceParams.md#updateargs) + +*** + +### version? + +> `optional` **version**: `string` + +Defined in: [src/types/app-client.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L158) + +The version of the contract, uses "1.0" by default + +#### Inherited from + +[`AppClientDeployCoreParams`](AppClientDeployCoreParams.md).[`version`](AppClientDeployCoreParams.md#version) diff --git a/docs/code/types/app-client/interfaces/AppClientParams.md b/docs/code/types/app-client/interfaces/AppClientParams.md new file mode 100644 index 00000000..7882dcdb --- /dev/null +++ b/docs/code/types/app-client/interfaces/AppClientParams.md @@ -0,0 +1,95 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientParams + +# Interface: AppClientParams + +Defined in: [src/types/app-client.ts:316](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L316) + +Parameters to create an app client + +## Properties + +### algorand + +> **algorand**: [`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +Defined in: [src/types/app-client.ts:328](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L328) + +An `AlgorandClient` instance + +*** + +### appId + +> **appId**: `bigint` + +Defined in: [src/types/app-client.ts:318](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L318) + +The ID of the app instance this client should make calls against. + +*** + +### appName? + +> `optional` **appName**: `string` + +Defined in: [src/types/app-client.ts:334](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L334) + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +*** + +### approvalSourceMap? + +> `optional` **approvalSourceMap**: `ProgramSourceMap` + +Defined in: [src/types/app-client.ts:340](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L340) + +Optional source map for the approval program + +*** + +### appSpec + +> **appSpec**: `string` \| [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) \| [`AppSpec`](../../app-spec/interfaces/AppSpec.md) + +Defined in: [src/types/app-client.ts:325](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L325) + +The ARC-56 or ARC-32 application spec as either: + * Parsed JSON ARC-56 `Contract` + * Parsed JSON ARC-32 `AppSpec` + * Raw JSON string (in either ARC-56 or ARC-32 format) + +*** + +### clearSourceMap? + +> `optional` **clearSourceMap**: `ProgramSourceMap` + +Defined in: [src/types/app-client.ts:342](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L342) + +Optional source map for the clear state program + +*** + +### defaultSender? + +> `optional` **defaultSender**: `string` \| `Address` + +Defined in: [src/types/app-client.ts:336](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L336) + +Optional address to use for the account to use as the default sender for calls. + +*** + +### defaultSigner? + +> `optional` **defaultSigner**: `TransactionSigner` + +Defined in: [src/types/app-client.ts:338](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L338) + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). diff --git a/docs/code/types/app-client/interfaces/AppSourceMaps.md b/docs/code/types/app-client/interfaces/AppSourceMaps.md new file mode 100644 index 00000000..d8e00329 --- /dev/null +++ b/docs/code/types/app-client/interfaces/AppSourceMaps.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppSourceMaps + +# Interface: AppSourceMaps + +Defined in: [src/types/app-client.ts:261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L261) + +Source maps for an Algorand app + +## Properties + +### approvalSourceMap + +> **approvalSourceMap**: [`SourceMapExport`](SourceMapExport.md) + +Defined in: [src/types/app-client.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L263) + +The source map of the approval program + +*** + +### clearSourceMap + +> **clearSourceMap**: [`SourceMapExport`](SourceMapExport.md) + +Defined in: [src/types/app-client.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L265) + +The source map of the clear program diff --git a/docs/code/types/app-client/interfaces/FundAppAccountParams.md b/docs/code/types/app-client/interfaces/FundAppAccountParams.md new file mode 100644 index 00000000..9c147728 --- /dev/null +++ b/docs/code/types/app-client/interfaces/FundAppAccountParams.md @@ -0,0 +1,49 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / FundAppAccountParams + +# Interface: FundAppAccountParams + +Defined in: [src/types/app-client.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L250) + +Parameters for funding an app account + +## Properties + +### amount + +> **amount**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/app-client.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L251) + +*** + +### note? + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/app-client.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L255) + +The transaction note for the smart contract call + +*** + +### sender? + +> `optional` **sender**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app-client.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L253) + +The optional sender to send the transaction from, will use the application client's default sender by default if specified + +*** + +### sendParams? + +> `optional` **sendParams**: [`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md) + +Defined in: [src/types/app-client.ts:257](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L257) + +Parameters to control transaction sending diff --git a/docs/code/types/app-client/interfaces/ResolveAppById.md b/docs/code/types/app-client/interfaces/ResolveAppById.md new file mode 100644 index 00000000..5b5de5b4 --- /dev/null +++ b/docs/code/types/app-client/interfaces/ResolveAppById.md @@ -0,0 +1,53 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / ResolveAppById + +# Interface: ResolveAppById + +Defined in: [src/types/app-client.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L117) + +Configuration to resolve app by ID + +## Extends + +- [`ResolveAppByIdBase`](ResolveAppByIdBase.md) + +## Properties + +### id + +> **id**: `number` \| `bigint` + +Defined in: [src/types/app-client.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L112) + +The id of an existing app to call using this client, or 0 if the app hasn't been created yet + +#### Inherited from + +[`ResolveAppByIdBase`](ResolveAppByIdBase.md).[`id`](ResolveAppByIdBase.md#id) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [src/types/app-client.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L114) + +The optional name to use to mark the app when deploying `ApplicationClient.deploy` (default: uses the name in the ABI contract) + +#### Inherited from + +[`ResolveAppByIdBase`](ResolveAppByIdBase.md).[`name`](ResolveAppByIdBase.md#name) + +*** + +### resolveBy + +> **resolveBy**: `"id"` + +Defined in: [src/types/app-client.ts:119](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L119) + +How the app ID is resolved, either by `'id'` or `'creatorAndName'`; must be `'creatorAndName'` if you want to use `deploy` diff --git a/docs/code/types/app-client/interfaces/ResolveAppByIdBase.md b/docs/code/types/app-client/interfaces/ResolveAppByIdBase.md new file mode 100644 index 00000000..757b155f --- /dev/null +++ b/docs/code/types/app-client/interfaces/ResolveAppByIdBase.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / ResolveAppByIdBase + +# Interface: ResolveAppByIdBase + +Defined in: [src/types/app-client.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L110) + +Configuration to resolve app by ID + +## Extended by + +- [`ResolveAppById`](ResolveAppById.md) + +## Properties + +### id + +> **id**: `number` \| `bigint` + +Defined in: [src/types/app-client.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L112) + +The id of an existing app to call using this client, or 0 if the app hasn't been created yet + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [src/types/app-client.ts:114](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L114) + +The optional name to use to mark the app when deploying `ApplicationClient.deploy` (default: uses the name in the ABI contract) diff --git a/docs/code/types/app-client/interfaces/SourceMapExport.md b/docs/code/types/app-client/interfaces/SourceMapExport.md new file mode 100644 index 00000000..7253323c --- /dev/null +++ b/docs/code/types/app-client/interfaces/SourceMapExport.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / SourceMapExport + +# Interface: SourceMapExport + +Defined in: [src/types/app-client.ts:268](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L268) + +## Properties + +### mappings + +> **mappings**: `string` + +Defined in: [src/types/app-client.ts:272](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L272) + +*** + +### names + +> **names**: `string`[] + +Defined in: [src/types/app-client.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L271) + +*** + +### sources + +> **sources**: `string`[] + +Defined in: [src/types/app-client.ts:270](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L270) + +*** + +### version + +> **version**: `number` + +Defined in: [src/types/app-client.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L269) diff --git a/docs/code/types/app-client/type-aliases/AppClientBareCallParams.md b/docs/code/types/app-client/type-aliases/AppClientBareCallParams.md new file mode 100644 index 00000000..283177c9 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppClientBareCallParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientBareCallParams + +# Type Alias: AppClientBareCallParams + +> **AppClientBareCallParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`CommonAppCallParams`](../../composer/type-aliases/CommonAppCallParams.md), `"appId"` \| `"sender"` \| `"onComplete"`\> & `object`\> + +Defined in: [src/types/app-client.ts:355](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L355) + +AppClient common parameters for a bare app call diff --git a/docs/code/types/app-client/type-aliases/AppClientCallArgs.md b/docs/code/types/app-client/type-aliases/AppClientCallArgs.md new file mode 100644 index 00000000..5e105df1 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppClientCallArgs.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientCallArgs + +# Type Alias: AppClientCallArgs + +> **AppClientCallArgs** = [`AppClientCallRawArgs`](AppClientCallRawArgs.md) \| [`AppClientCallABIArgs`](../interfaces/AppClientCallABIArgs.md) + +Defined in: [src/types/app-client.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L205) + +The arguments to pass to an Application Client smart contract call diff --git a/docs/code/types/app-client/type-aliases/AppClientCallParams.md b/docs/code/types/app-client/type-aliases/AppClientCallParams.md new file mode 100644 index 00000000..118123cb --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppClientCallParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientCallParams + +# Type Alias: AppClientCallParams + +> **AppClientCallParams** = [`AppClientCallArgs`](AppClientCallArgs.md) & [`AppClientCallCoreParams`](../interfaces/AppClientCallCoreParams.md) + +Defined in: [src/types/app-client.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L218) + +Parameters to construct a ApplicationClient contract call diff --git a/docs/code/types/app-client/type-aliases/AppClientCallRawArgs.md b/docs/code/types/app-client/type-aliases/AppClientCallRawArgs.md new file mode 100644 index 00000000..9345dd51 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppClientCallRawArgs.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientCallRawArgs + +# Type Alias: AppClientCallRawArgs + +> **AppClientCallRawArgs** = [`RawAppCallArgs`](../../app/interfaces/RawAppCallArgs.md) + +Defined in: [src/types/app-client.ts:197](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L197) diff --git a/docs/code/types/app-client/type-aliases/AppClientClearStateParams.md b/docs/code/types/app-client/type-aliases/AppClientClearStateParams.md new file mode 100644 index 00000000..17b9e65e --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppClientClearStateParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientClearStateParams + +# Type Alias: AppClientClearStateParams + +> **AppClientClearStateParams** = [`AppClientCallRawArgs`](AppClientCallRawArgs.md) & [`AppClientCallCoreParams`](../interfaces/AppClientCallCoreParams.md) + +Defined in: [src/types/app-client.ts:221](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L221) + +Parameters to construct a ApplicationClient clear state contract call diff --git a/docs/code/types/app-client/type-aliases/AppClientCreateOnComplete.md b/docs/code/types/app-client/type-aliases/AppClientCreateOnComplete.md new file mode 100644 index 00000000..73cbcebd --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppClientCreateOnComplete.md @@ -0,0 +1,23 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientCreateOnComplete + +# Type Alias: AppClientCreateOnComplete + +> **AppClientCreateOnComplete** = `object` + +Defined in: [src/types/app-client.ts:233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L233) + +On-complete action parameter for creating a contract using ApplicationClient + +## Properties + +### onCompleteAction? + +> `optional` **onCompleteAction**: `Exclude`\<[`AppCallType`](../../app/type-aliases/AppCallType.md), `"clear_state"`\> \| `Exclude`\<`OnApplicationComplete`, `OnApplicationComplete.ClearStateOC`\> + +Defined in: [src/types/app-client.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L235) + +Override the on-completion action for the create call; defaults to NoOp diff --git a/docs/code/types/app-client/type-aliases/AppClientCreateParams.md b/docs/code/types/app-client/type-aliases/AppClientCreateParams.md new file mode 100644 index 00000000..29ddb582 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppClientCreateParams.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientCreateParams + +# Type Alias: AppClientCreateParams + +> **AppClientCreateParams** = [`AppClientCallParams`](AppClientCallParams.md) & [`AppClientCompilationParams`](../interfaces/AppClientCompilationParams.md) & [`AppClientCreateOnComplete`](AppClientCreateOnComplete.md) & `object` + +Defined in: [src/types/app-client.ts:239](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L239) + +Parameters for creating a contract using ApplicationClient + +## Type declaration + +### schema? + +> `optional` **schema**: `Partial`\<[`AppStorageSchema`](../../app/interfaces/AppStorageSchema.md)\> + +Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used. diff --git a/docs/code/types/app-client/type-aliases/AppClientMethodCallParams.md b/docs/code/types/app-client/type-aliases/AppClientMethodCallParams.md new file mode 100644 index 00000000..7dcf8854 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppClientMethodCallParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientMethodCallParams + +# Type Alias: AppClientMethodCallParams + +> **AppClientMethodCallParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`CommonAppCallParams`](../../composer/type-aliases/CommonAppCallParams.md), `"appId"` \| `"sender"` \| `"method"` \| `"args"`\> & `object`\> + +Defined in: [src/types/app-client.ts:363](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L363) + +AppClient common parameters for an ABI method call diff --git a/docs/code/types/app-client/type-aliases/AppClientUpdateParams.md b/docs/code/types/app-client/type-aliases/AppClientUpdateParams.md new file mode 100644 index 00000000..ee617bc1 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppClientUpdateParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppClientUpdateParams + +# Type Alias: AppClientUpdateParams + +> **AppClientUpdateParams** = [`AppClientCallParams`](AppClientCallParams.md) & [`AppClientCompilationParams`](../interfaces/AppClientCompilationParams.md) + +Defined in: [src/types/app-client.ts:247](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L247) + +Parameters for updating a contract using ApplicationClient diff --git a/docs/code/types/app-client/type-aliases/AppDetails.md b/docs/code/types/app-client/type-aliases/AppDetails.md new file mode 100644 index 00000000..415cfbea --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppDetails.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppDetails + +# Type Alias: AppDetails + +> **AppDetails** = [`AppDetailsBase`](AppDetailsBase.md) & [`ResolveAppById`](../interfaces/ResolveAppById.md) \| [`ResolveAppByCreatorAndName`](ResolveAppByCreatorAndName.md) + +Defined in: [src/types/app-client.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L135) + +The details of an AlgoKit Utils deployed app diff --git a/docs/code/types/app-client/type-aliases/AppDetailsBase.md b/docs/code/types/app-client/type-aliases/AppDetailsBase.md new file mode 100644 index 00000000..c33090dd --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppDetailsBase.md @@ -0,0 +1,44 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppDetailsBase + +# Type Alias: AppDetailsBase + +> **AppDetailsBase** = `object` + +Defined in: [src/types/app-client.ts:123](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L123) + +The details of an AlgoKit Utils deployed app + +## Properties + +### deployTimeParams? + +> `optional` **deployTimeParams**: [`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Defined in: [src/types/app-client.ts:131](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L131) + +Optionally provide any deploy-time parameters to replace in the TEAL code; if specified here will get +used in calls to `deploy`, `create` and `update` unless overridden in those calls + +*** + +### params? + +> `optional` **params**: `SuggestedParams` + +Defined in: [src/types/app-client.ts:127](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L127) + +Default suggested params object to use + +*** + +### sender? + +> `optional` **sender**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app-client.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L125) + +Default sender to use for transactions issued by this application client diff --git a/docs/code/types/app-client/type-aliases/AppSpecAppDetails.md b/docs/code/types/app-client/type-aliases/AppSpecAppDetails.md new file mode 100644 index 00000000..71bb908d --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppSpecAppDetails.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppSpecAppDetails + +# Type Alias: AppSpecAppDetails + +> **AppSpecAppDetails** = [`AppSpecAppDetailsBase`](AppSpecAppDetailsBase.md) & [`AppDetails`](AppDetails.md) + +Defined in: [src/types/app-client.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L153) + +The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app diff --git a/docs/code/types/app-client/type-aliases/AppSpecAppDetailsBase.md b/docs/code/types/app-client/type-aliases/AppSpecAppDetailsBase.md new file mode 100644 index 00000000..573a8a59 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppSpecAppDetailsBase.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppSpecAppDetailsBase + +# Type Alias: AppSpecAppDetailsBase + +> **AppSpecAppDetailsBase** = `object` + +Defined in: [src/types/app-client.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L138) + +The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app + +## Properties + +### app + +> **app**: [`AppSpec`](../../app-spec/interfaces/AppSpec.md) \| `string` + +Defined in: [src/types/app-client.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L143) + +The ARC-0032 application spec as either: + * Parsed JSON `AppSpec` + * Raw JSON string diff --git a/docs/code/types/app-client/type-aliases/AppSpecAppDetailsByCreatorAndName.md b/docs/code/types/app-client/type-aliases/AppSpecAppDetailsByCreatorAndName.md new file mode 100644 index 00000000..46ef2848 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppSpecAppDetailsByCreatorAndName.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppSpecAppDetailsByCreatorAndName + +# Type Alias: AppSpecAppDetailsByCreatorAndName + +> **AppSpecAppDetailsByCreatorAndName** = [`AppSpecAppDetailsBase`](AppSpecAppDetailsBase.md) & [`AppDetailsBase`](AppDetailsBase.md) & [`ResolveAppByCreatorAndNameBase`](ResolveAppByCreatorAndNameBase.md) + +Defined in: [src/types/app-client.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L150) + +The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by creator and name diff --git a/docs/code/types/app-client/type-aliases/AppSpecAppDetailsById.md b/docs/code/types/app-client/type-aliases/AppSpecAppDetailsById.md new file mode 100644 index 00000000..e1eae60d --- /dev/null +++ b/docs/code/types/app-client/type-aliases/AppSpecAppDetailsById.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / AppSpecAppDetailsById + +# Type Alias: AppSpecAppDetailsById + +> **AppSpecAppDetailsById** = [`AppSpecAppDetailsBase`](AppSpecAppDetailsBase.md) & [`AppDetailsBase`](AppDetailsBase.md) & [`ResolveAppByIdBase`](../interfaces/ResolveAppByIdBase.md) + +Defined in: [src/types/app-client.ts:147](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L147) + +The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by id diff --git a/docs/code/types/app-client/type-aliases/CallOnComplete.md b/docs/code/types/app-client/type-aliases/CallOnComplete.md new file mode 100644 index 00000000..85873a6f --- /dev/null +++ b/docs/code/types/app-client/type-aliases/CallOnComplete.md @@ -0,0 +1,23 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / CallOnComplete + +# Type Alias: CallOnComplete + +> **CallOnComplete** = `object` + +Defined in: [src/types/app-client.ts:349](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L349) + +onComplete parameter for a non-update app call + +## Properties + +### onComplete? + +> `optional` **onComplete**: `Exclude`\<`OnApplicationComplete`, `OnApplicationComplete.UpdateApplicationOC`\> + +Defined in: [src/types/app-client.ts:351](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L351) + +On-complete of the call; defaults to no-op diff --git a/docs/code/types/app-client/type-aliases/CloneAppClientParams.md b/docs/code/types/app-client/type-aliases/CloneAppClientParams.md new file mode 100644 index 00000000..aa1fedf5 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/CloneAppClientParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / CloneAppClientParams + +# Type Alias: CloneAppClientParams + +> **CloneAppClientParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Partial`\<`Omit`\<[`AppClientParams`](../interfaces/AppClientParams.md), `"algorand"` \| `"appSpec"`\>\>\> + +Defined in: [src/types/app-client.ts:346](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L346) + +Parameters to clone an app client diff --git a/docs/code/types/app-client/type-aliases/FundAppParams.md b/docs/code/types/app-client/type-aliases/FundAppParams.md new file mode 100644 index 00000000..e9598b0d --- /dev/null +++ b/docs/code/types/app-client/type-aliases/FundAppParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / FundAppParams + +# Type Alias: FundAppParams + +> **FundAppParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`PaymentParams`](../../composer/type-aliases/PaymentParams.md), `"receiver"` \| `"sender"`\> & [`SendParams`](../../transaction/interfaces/SendParams.md) & `object`\> + +Defined in: [src/types/app-client.ts:388](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L388) + +Parameters for funding an app account diff --git a/docs/code/types/app-client/type-aliases/ResolveAppByCreatorAndName.md b/docs/code/types/app-client/type-aliases/ResolveAppByCreatorAndName.md new file mode 100644 index 00000000..1ff5b93e --- /dev/null +++ b/docs/code/types/app-client/type-aliases/ResolveAppByCreatorAndName.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / ResolveAppByCreatorAndName + +# Type Alias: ResolveAppByCreatorAndName + +> **ResolveAppByCreatorAndName** = [`ResolveAppByCreatorAndNameBase`](ResolveAppByCreatorAndNameBase.md) & `object` + +Defined in: [src/types/app-client.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L104) + +Configuration to resolve app by creator and name `getCreatorAppsByName` + +## Type declaration + +### resolveBy + +> **resolveBy**: `"creatorAndName"` + +How the app ID is resolved, either by `'id'` or `'creatorAndName'`; must be `'creatorAndName'` if you want to use `deploy` diff --git a/docs/code/types/app-client/type-aliases/ResolveAppByCreatorAndNameBase.md b/docs/code/types/app-client/type-aliases/ResolveAppByCreatorAndNameBase.md new file mode 100644 index 00000000..e195d27d --- /dev/null +++ b/docs/code/types/app-client/type-aliases/ResolveAppByCreatorAndNameBase.md @@ -0,0 +1,45 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / ResolveAppByCreatorAndNameBase + +# Type Alias: ResolveAppByCreatorAndNameBase + +> **ResolveAppByCreatorAndNameBase** = `object` + +Defined in: [src/types/app-client.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L91) + +Configuration to resolve app by creator and name `getCreatorAppsByName` + +## Properties + +### creatorAddress + +> **creatorAddress**: `Address` \| `string` + +Defined in: [src/types/app-client.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L93) + +The address of the app creator account to resolve the app by + +*** + +### findExistingUsing + +> **findExistingUsing**: `Indexer` \| [`AppLookup`](../../app/interfaces/AppLookup.md) + +Defined in: [src/types/app-client.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L100) + +The mechanism to find an existing app instance metadata for the given creator and name; either: + * An indexer instance to search the creator account apps; or + * The cached value of the existing apps for the given creator from `getCreatorAppsByName` + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [src/types/app-client.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L95) + +The optional name override to resolve the app by within the creator account (default: uses the name in the ABI contract) diff --git a/docs/code/types/app-client/type-aliases/ResolveAppClientByCreatorAndName.md b/docs/code/types/app-client/type-aliases/ResolveAppClientByCreatorAndName.md new file mode 100644 index 00000000..3e04b333 --- /dev/null +++ b/docs/code/types/app-client/type-aliases/ResolveAppClientByCreatorAndName.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / ResolveAppClientByCreatorAndName + +# Type Alias: ResolveAppClientByCreatorAndName + +> **ResolveAppClientByCreatorAndName** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppClientParams`](../interfaces/AppClientParams.md), `"appId"`\> & `object`\> + +Defined in: [src/types/app-client.ts:397](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L397) + +Resolve an app client instance by looking up an app created by the given creator with the given name diff --git a/docs/code/types/app-client/type-aliases/ResolveAppClientByNetwork.md b/docs/code/types/app-client/type-aliases/ResolveAppClientByNetwork.md new file mode 100644 index 00000000..c82c531f --- /dev/null +++ b/docs/code/types/app-client/type-aliases/ResolveAppClientByNetwork.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-client](../README.md) / ResolveAppClientByNetwork + +# Type Alias: ResolveAppClientByNetwork + +> **ResolveAppClientByNetwork** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppClientParams`](../interfaces/AppClientParams.md), `"appId"`\>\> + +Defined in: [src/types/app-client.ts:411](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L411) + +Resolve an app client instance by looking up the current network. diff --git a/docs/code/types/app-deployer/README.md b/docs/code/types/app-deployer/README.md new file mode 100644 index 00000000..ff266e8c --- /dev/null +++ b/docs/code/types/app-deployer/README.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/app-deployer + +# types/app-deployer + +## Classes + +- [AppDeployer](classes/AppDeployer.md) + +## Interfaces + +- [AppLookup](interfaces/AppLookup.md) +- [AppMetadata](interfaces/AppMetadata.md) + +## Type Aliases + +- [AppDeployParams](type-aliases/AppDeployParams.md) +- [AppDeployResult](type-aliases/AppDeployResult.md) +- [DeployAppDeleteMethodCall](type-aliases/DeployAppDeleteMethodCall.md) +- [DeployAppDeleteParams](type-aliases/DeployAppDeleteParams.md) +- [DeployAppUpdateMethodCall](type-aliases/DeployAppUpdateMethodCall.md) +- [DeployAppUpdateParams](type-aliases/DeployAppUpdateParams.md) diff --git a/docs/code/types/app-deployer/classes/AppDeployer.md b/docs/code/types/app-deployer/classes/AppDeployer.md new file mode 100644 index 00000000..ce03a7e5 --- /dev/null +++ b/docs/code/types/app-deployer/classes/AppDeployer.md @@ -0,0 +1,236 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-deployer](../README.md) / AppDeployer + +# Class: AppDeployer + +Defined in: [src/types/app-deployer.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L112) + +Allows management of deployment and deployment metadata of applications. + +## Constructors + +### Constructor + +> **new AppDeployer**(`appManager`, `transactionSender`, `indexer?`): `AppDeployer` + +Defined in: [src/types/app-deployer.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L128) + +Creates an `AppManager` + +#### Parameters + +##### appManager + +[`AppManager`](../../app-manager/classes/AppManager.md) + +An `AppManager` instance + +##### transactionSender + +[`AlgorandClientTransactionSender`](../../algorand-client-transaction-sender/classes/AlgorandClientTransactionSender.md) + +An `AlgorandClientTransactionSender` instance + +##### indexer? + +`IndexerClient` + +An optional indexer instance; supply if you want to indexer to look up app metadata + +#### Returns + +`AppDeployer` + +#### Example + +```ts +const deployer = new AppDeployer(appManager, transactionSender, indexer) +``` + +## Methods + +### deploy() + +> **deploy**(`deployment`): `Promise`\<[`AppDeployResult`](../type-aliases/AppDeployResult.md)\> + +Defined in: [src/types/app-deployer.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L172) + +Idempotently deploy (create if not exists, update if changed) an app against the given name for the given creator account, including deploy-time TEAL template placeholder substitutions (if specified). + +To understand the architecture decisions behind this functionality please see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md + +**Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`. + +**Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created. + +**Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created. + +#### Parameters + +##### deployment + +The arguments to control the app deployment + +###### coverAppCallInnerTransactionFees? + +`boolean` + +Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee + +###### createParams + +\{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `approvalProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `args?`: `Uint8Array`\<`ArrayBufferLike`\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `clearStateProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `extraProgramPages?`: `number`; `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC`; `rekeyTo?`: `string` \| `Address`; `schema?`: \{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \}; `sender`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} \| [`AppCreateMethodCall`](../../composer/type-aliases/AppCreateMethodCall.md) + +Create transaction parameters to use if a create needs to be issued as part of deployment + +###### deleteParams + +\{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: `Uint8Array`\<`ArrayBufferLike`\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `DeleteApplicationOC`; `rekeyTo?`: `string` \| `Address`; `sender`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} \| \{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../../composer/type-aliases/AppMethodCall.md)\<\{ `accountReferences?`: (... \| ...)[]; `appReferences?`: `bigint`[]; `approvalProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `args?`: `Uint8Array`\<...\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: BoxIdentifier \| BoxReference[]; `clearStateProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `extraProgramPages?`: `number`; `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC`; `rekeyTo?`: `string` \| `Address`; `schema?`: \{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \}; `sender`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \}\> \| [`AppMethodCall`](../../composer/type-aliases/AppMethodCall.md)\<\{ `accountReferences?`: (... \| ...)[]; `appId`: `bigint`; `appReferences?`: `bigint`[]; `approvalProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `args?`: `Uint8Array`\<...\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: BoxIdentifier \| BoxReference[]; `clearStateProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `UpdateApplicationOC`; `rekeyTo?`: `string` \| `Address`; `sender`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \}\> \| [`AppMethodCall`](../../composer/type-aliases/AppMethodCall.md)\<[`AppMethodCallParams`](../../composer/type-aliases/AppMethodCallParams.md)\>)[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `method`: `ABIMethod`; `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `DeleteApplicationOC`; `rekeyTo?`: `string` \| `Address`; `sender`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} + +Delete transaction parameters to use if a delete needs to be issued as part of deployment + +###### deployTimeParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Any deploy-time parameters to replace in the TEAL code before compiling it (used if teal code is passed in as a string) + +###### existingDeployments? + +[`AppLookup`](../interfaces/AppLookup.md) + +Optional cached value of the existing apps for the given creator; use this to avoid an indexer lookup + +###### ignoreCache? + +`boolean` + +Whether or not to ignore the app metadata cache and force a lookup, default: use the cache * + +###### maxRoundsToWaitForConfirmation? + +`number` + +The number of rounds to wait for confirmation. By default until the latest lastValid has past. + +###### metadata + +[`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md) + +The deployment metadata + +###### onSchemaBreak? + +[`OnSchemaBreak`](../../app/enumerations/OnSchemaBreak.md) \| `"replace"` \| `"fail"` \| `"append"` + +What action to perform if a schema break (storage schema or extra pages change) is detected: + +* `fail` - Fail the deployment (throw an error, **default**) +* `replace` - Delete the old app and create a new one +* `append` - Deploy a new app and leave the old one as is + +###### onUpdate? + +`"replace"` \| `"fail"` \| `"append"` \| [`OnUpdate`](../../app/enumerations/OnUpdate.md) \| `"update"` + +What action to perform if a TEAL code update is detected: + +* `fail` - Fail the deployment (throw an error, **default**) +* `update` - Update the app with the new TEAL code +* `replace` - Delete the old app and create a new one +* `append` - Deploy a new app and leave the old one as is + +###### populateAppCallResources? + +`boolean` + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. + +###### suppressLog? + +`boolean` + +Whether to suppress log messages from transaction send, default: do not suppress. + +###### updateParams + +\{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: `Uint8Array`\<`ArrayBufferLike`\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `UpdateApplicationOC`; `rekeyTo?`: `string` \| `Address`; `sender`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} \| \{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: (`undefined` \| `Transaction` \| `ABIValue` \| `TransactionWithSigner` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](../../composer/type-aliases/AppMethodCall.md)\<\{ `accountReferences?`: (... \| ...)[]; `appReferences?`: `bigint`[]; `approvalProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `args?`: `Uint8Array`\<...\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: BoxIdentifier \| BoxReference[]; `clearStateProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `extraProgramPages?`: `number`; `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC`; `rekeyTo?`: `string` \| `Address`; `schema?`: \{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \}; `sender`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \}\> \| [`AppMethodCall`](../../composer/type-aliases/AppMethodCall.md)\<\{ `accountReferences?`: (... \| ...)[]; `appId`: `bigint`; `appReferences?`: `bigint`[]; `approvalProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `args?`: `Uint8Array`\<...\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: BoxIdentifier \| BoxReference[]; `clearStateProgram`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `UpdateApplicationOC`; `rekeyTo?`: `string` \| `Address`; `sender`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \}\> \| [`AppMethodCall`](../../composer/type-aliases/AppMethodCall.md)\<[`AppMethodCallParams`](../../composer/type-aliases/AppMethodCallParams.md)\>)[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `method`: `ABIMethod`; `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `UpdateApplicationOC`; `rekeyTo?`: `string` \| `Address`; `sender`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} + +Update transaction parameters to use if an update needs to be issued as part of deployment + +#### Returns + +`Promise`\<[`AppDeployResult`](../type-aliases/AppDeployResult.md)\> + +The result of the deployment + +#### Example + +```ts +const deployResult = await deployer.deploy({ + createParams: { + sender: 'SENDER_ADDRESS', + approvalProgram: 'APPROVAL PROGRAM', + clearStateProgram: 'CLEAR PROGRAM', + schema: { + globalByteSlices: 0, + globalInts: 0, + localByteSlices: 0, + localInts: 0 + } + }, + updateParams: { + sender: 'SENDER_ADDRESS' + }, + deleteParams: { + sender: 'SENDER_ADDRESS' + }, + metadata: { name: 'my_app', version: '2.0', updatable: false, deletable: false }, + onSchemaBreak: 'append', + onUpdate: 'append' + }) +``` + +*** + +### getCreatorAppsByName() + +> **getCreatorAppsByName**(`creatorAddress`, `ignoreCache?`): `Promise`\<[`AppLookup`](../interfaces/AppLookup.md)\> + +Defined in: [src/types/app-deployer.ts:495](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L495) + +Returns a lookup of name => app metadata (id, address, ...metadata) for all apps created by the given account that have +an [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) `AppDeployNote` as the transaction +note of the app creation transaction. + +This function caches the result for the given creator account so that subsequent calls will not require an indexer lookup. + +If the `AppManager` instance wasn't created with an indexer client, this function will throw an error. + +#### Parameters + +##### creatorAddress + +The address of the account that is the creator of the apps you want to search for + +`string` | `Address` + +##### ignoreCache? + +`boolean` + +Whether or not to ignore the cache and force a lookup, default: use the cache + +#### Returns + +`Promise`\<[`AppLookup`](../interfaces/AppLookup.md)\> + +A name-based lookup of the app metadata + +#### Example + +```ts +const result = await deployer.getCreatorAppsByName(creator) diff --git a/docs/code/types/app-deployer/interfaces/AppLookup.md b/docs/code/types/app-deployer/interfaces/AppLookup.md new file mode 100644 index 00000000..5698087c --- /dev/null +++ b/docs/code/types/app-deployer/interfaces/AppLookup.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-deployer](../README.md) / AppLookup + +# Interface: AppLookup + +Defined in: [src/types/app-deployer.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L90) + +A lookup of name -> Algorand app for a creator + +## Properties + +### apps + +> **apps**: `object` + +Defined in: [src/types/app-deployer.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L94) + +A hash map of app name to app metadata + +#### Index Signature + +\[`name`: `string`\]: [`AppMetadata`](AppMetadata.md) + +*** + +### creator + +> **creator**: `Readonly`\<`Address`\> + +Defined in: [src/types/app-deployer.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L92) + +The address of the creator associated with this lookup diff --git a/docs/code/types/app-deployer/interfaces/AppMetadata.md b/docs/code/types/app-deployer/interfaces/AppMetadata.md new file mode 100644 index 00000000..07003c43 --- /dev/null +++ b/docs/code/types/app-deployer/interfaces/AppMetadata.md @@ -0,0 +1,131 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-deployer](../README.md) / AppMetadata + +# Interface: AppMetadata + +Defined in: [src/types/app-deployer.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L74) + +The metadata that can be collected about a deployed app + +## Extends + +- [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md) + +## Properties + +### appAddress + +> **appAddress**: `Address` + +Defined in: [src/types/app-deployer.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L78) + +The Algorand address of the account associated with the app + +*** + +### appId + +> **appId**: `bigint` + +Defined in: [src/types/app-deployer.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L76) + +The id of the app + +*** + +### createdMetadata + +> **createdMetadata**: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md) + +Defined in: [src/types/app-deployer.ts:84](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L84) + +The metadata when the app was created + +*** + +### createdRound + +> **createdRound**: `bigint` + +Defined in: [src/types/app-deployer.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L80) + +The round the app was created + +*** + +### deletable? + +> `optional` **deletable**: `boolean` + +Defined in: [src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) + +Whether or not the app is deletable / permanent / unspecified + +#### Inherited from + +[`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md).[`deletable`](../../app/interfaces/AppDeployMetadata.md#deletable) + +*** + +### deleted + +> **deleted**: `boolean` + +Defined in: [src/types/app-deployer.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L86) + +Whether or not the app is deleted + +*** + +### name + +> **name**: `string` + +Defined in: [src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249) + +The unique name identifier of the app within the creator account + +#### Inherited from + +[`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md).[`name`](../../app/interfaces/AppDeployMetadata.md#name) + +*** + +### updatable? + +> `optional` **updatable**: `boolean` + +Defined in: [src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255) + +Whether or not the app is updatable / immutable / unspecified + +#### Inherited from + +[`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md).[`updatable`](../../app/interfaces/AppDeployMetadata.md#updatable) + +*** + +### updatedRound + +> **updatedRound**: `bigint` + +Defined in: [src/types/app-deployer.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L82) + +The last round that the app was updated + +*** + +### version + +> **version**: `string` + +Defined in: [src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251) + +The version of app that is / will be deployed + +#### Inherited from + +[`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md).[`version`](../../app/interfaces/AppDeployMetadata.md#version) diff --git a/docs/code/types/app-deployer/type-aliases/AppDeployParams.md b/docs/code/types/app-deployer/type-aliases/AppDeployParams.md new file mode 100644 index 00000000..a8769ed4 --- /dev/null +++ b/docs/code/types/app-deployer/type-aliases/AppDeployParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-deployer](../README.md) / AppDeployParams + +# Type Alias: AppDeployParams + +> **AppDeployParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<[`SendParams`](../../transaction/interfaces/SendParams.md) & `object`\> + +Defined in: [src/types/app-deployer.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L39) + +The parameters to idempotently deploy an app diff --git a/docs/code/types/app-deployer/type-aliases/AppDeployResult.md b/docs/code/types/app-deployer/type-aliases/AppDeployResult.md new file mode 100644 index 00000000..1753575d --- /dev/null +++ b/docs/code/types/app-deployer/type-aliases/AppDeployResult.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-deployer](../README.md) / AppDeployResult + +# Type Alias: AppDeployResult + +> **AppDeployResult** = [`Expand`](../../expand/type-aliases/Expand.md)\<`object` & `Omit`\<[`AppMetadata`](../interfaces/AppMetadata.md), `"appId"` \| `"appAddress"`\> & [`SendAppCreateTransactionResult`](../../app/type-aliases/SendAppCreateTransactionResult.md)\> \| [`Expand`](../../expand/type-aliases/Expand.md)\<`object` & [`AppMetadata`](../interfaces/AppMetadata.md) & [`SendAppUpdateTransactionResult`](../../app/type-aliases/SendAppUpdateTransactionResult.md)\> \| [`Expand`](../../expand/type-aliases/Expand.md)\<`object` & `Omit`\<[`AppMetadata`](../interfaces/AppMetadata.md), `"appId"` \| `"appAddress"`\> & [`SendAppCreateTransactionResult`](../../app/type-aliases/SendAppCreateTransactionResult.md) & `object`\> \| [`Expand`](../../expand/type-aliases/Expand.md)\<`object` & [`AppMetadata`](../interfaces/AppMetadata.md)\> + +Defined in: [src/types/app-deployer.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L99) diff --git a/docs/code/types/app-deployer/type-aliases/DeployAppDeleteMethodCall.md b/docs/code/types/app-deployer/type-aliases/DeployAppDeleteMethodCall.md new file mode 100644 index 00000000..318853fd --- /dev/null +++ b/docs/code/types/app-deployer/type-aliases/DeployAppDeleteMethodCall.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-deployer](../README.md) / DeployAppDeleteMethodCall + +# Type Alias: DeployAppDeleteMethodCall + +> **DeployAppDeleteMethodCall** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppDeleteMethodCall`](../../composer/type-aliases/AppDeleteMethodCall.md), `"appId"`\>\> + +Defined in: [src/types/app-deployer.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L36) + +Params to specify a delete method call for an app deployment diff --git a/docs/code/types/app-deployer/type-aliases/DeployAppDeleteParams.md b/docs/code/types/app-deployer/type-aliases/DeployAppDeleteParams.md new file mode 100644 index 00000000..39b39df5 --- /dev/null +++ b/docs/code/types/app-deployer/type-aliases/DeployAppDeleteParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-deployer](../README.md) / DeployAppDeleteParams + +# Type Alias: DeployAppDeleteParams + +> **DeployAppDeleteParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppDeleteParams`](../../composer/type-aliases/AppDeleteParams.md), `"appId"`\>\> + +Defined in: [src/types/app-deployer.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L34) + +Params to specify a transaction for an app deployment diff --git a/docs/code/types/app-deployer/type-aliases/DeployAppUpdateMethodCall.md b/docs/code/types/app-deployer/type-aliases/DeployAppUpdateMethodCall.md new file mode 100644 index 00000000..72b83c43 --- /dev/null +++ b/docs/code/types/app-deployer/type-aliases/DeployAppUpdateMethodCall.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-deployer](../README.md) / DeployAppUpdateMethodCall + +# Type Alias: DeployAppUpdateMethodCall + +> **DeployAppUpdateMethodCall** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppUpdateMethodCall`](../../composer/type-aliases/AppUpdateMethodCall.md), `"appId"` \| `"approvalProgram"` \| `"clearStateProgram"`\>\> + +Defined in: [src/types/app-deployer.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L32) + +Params to specify an update method call for an app deployment diff --git a/docs/code/types/app-deployer/type-aliases/DeployAppUpdateParams.md b/docs/code/types/app-deployer/type-aliases/DeployAppUpdateParams.md new file mode 100644 index 00000000..39646b8c --- /dev/null +++ b/docs/code/types/app-deployer/type-aliases/DeployAppUpdateParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-deployer](../README.md) / DeployAppUpdateParams + +# Type Alias: DeployAppUpdateParams + +> **DeployAppUpdateParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppUpdateParams`](../../composer/type-aliases/AppUpdateParams.md), `"appId"` \| `"approvalProgram"` \| `"clearStateProgram"`\>\> + +Defined in: [src/types/app-deployer.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-deployer.ts#L30) + +Params to specify an update transaction for an app deployment diff --git a/docs/code/types/app-factory-and-client.spec/README.md b/docs/code/types/app-factory-and-client.spec/README.md new file mode 100644 index 00000000..57a649df --- /dev/null +++ b/docs/code/types/app-factory-and-client.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/app-factory-and-client.spec + +# types/app-factory-and-client.spec diff --git a/docs/code/types/app-factory/README.md b/docs/code/types/app-factory/README.md new file mode 100644 index 00000000..cfb7f83f --- /dev/null +++ b/docs/code/types/app-factory/README.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/app-factory + +# types/app-factory + +## Classes + +- [AppFactory](classes/AppFactory.md) + +## Interfaces + +- [AppFactoryParams](interfaces/AppFactoryParams.md) + +## Type Aliases + +- [AppFactoryAppClientParams](type-aliases/AppFactoryAppClientParams.md) +- [AppFactoryCreateMethodCallParams](type-aliases/AppFactoryCreateMethodCallParams.md) +- [AppFactoryCreateParams](type-aliases/AppFactoryCreateParams.md) +- [AppFactoryDeployParams](type-aliases/AppFactoryDeployParams.md) +- [AppFactoryResolveAppClientByCreatorAndNameParams](type-aliases/AppFactoryResolveAppClientByCreatorAndNameParams.md) +- [CreateOnComplete](type-aliases/CreateOnComplete.md) +- [CreateSchema](type-aliases/CreateSchema.md) diff --git a/docs/code/types/app-factory/classes/AppFactory.md b/docs/code/types/app-factory/classes/AppFactory.md new file mode 100644 index 00000000..cde807e1 --- /dev/null +++ b/docs/code/types/app-factory/classes/AppFactory.md @@ -0,0 +1,2002 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-factory](../README.md) / AppFactory + +# Class: AppFactory + +Defined in: [src/types/app-factory.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L170) + +ARC-56/ARC-32 app factory that, for a given app spec, allows you to create +and deploy one or more app instances and to create one or more app clients +to interact with those (or other) app instances. + +## Constructors + +### Constructor + +> **new AppFactory**(`params`): `AppFactory` + +Defined in: [src/types/app-factory.ts:197](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L197) + +Create a new app factory. + +#### Parameters + +##### params + +[`AppFactoryParams`](../interfaces/AppFactoryParams.md) + +The parameters to create the app factory + +#### Returns + +`AppFactory` + +The `AppFactory` instance + +#### Example + +```typescript +const appFactory = new AppFactory({ + appSpec: appSpec, + algorand: AlgorandClient.mainNet(), +}) + +## Properties + +### createTransaction + +> `readonly` **createTransaction**: `object` + +Defined in: [src/types/app-factory.ts:245](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L245) + +Create transactions for the current app + +#### bare + +> **bare**: `object` + +Create bare (raw) transactions for the current app + +##### bare.create() + +> **create**: (`params?`) => `Promise`\<`Transaction`\> + +Create a create app call transaction using a bare (raw) create call. + +Performs deploy-time TEAL template placeholder substitutions (if specified). + +###### Parameters + +###### params? + +The parameters to create the create call transaction + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### args? + +`Uint8Array`\<`ArrayBufferLike`\>[] + +Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### deletable? + +`boolean` + +Whether or not the contract should have deploy-time permanence control set, undefined = ignore + +###### deployTimeParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Any deploy-time parameters to replace in the TEAL code + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### extraProgramPages? + +`number` + +Number of extra pages required for the programs. +Defaults to the number needed for the programs in this call if not specified. +This is immutable once the app is created. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### schema? + +\{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \} + +The state schema for the app. This is immutable once the app is created. By default uses the ARC32/ARC-56 spec. + +###### schema.globalByteSlices + +`number` + +The number of byte slices saved in global state. + +###### schema.globalInts + +`number` + +The number of integers saved in global state. + +###### schema.localByteSlices + +`number` + +The number of byte slices saved in local state. + +###### schema.localInts + +`number` + +The number of integers saved in local state. + +###### sender? + +`string` \| `Address` + +The address of the account sending the transaction, if undefined then the app client's defaultSender is used. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### updatable? + +`boolean` + +Whether or not the contract should have deploy-time immutability control set, undefined = ignore + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +###### Returns + +`Promise`\<`Transaction`\> + +The create call transaction + +#### create() + +> **create**: (`params`) => `Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +Create a create app call transaction using an ABI create call. + +Performs deploy-time TEAL template placeholder substitutions (if specified). + +##### Parameters + +###### params + +The parameters to create the create call transaction + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### args? + +(`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../../composer/type-aliases/AppMethodCallTransactionArgument.md) \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md))[] + +Arguments to the ABI method, either: +* An ABI value +* An ARC-56 struct +* A transaction with explicit signer +* A transaction (where the signer will be automatically assigned) +* An unawaited transaction (e.g. from algorand.createTransaction.transactionType()) +* Another method call (via method call params object) +* undefined (this represents a placeholder for either a default argument or a transaction argument that is fulfilled by another method call argument) + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### deletable? + +`boolean` + +Whether or not the contract should have deploy-time permanence control set, undefined = ignore + +###### deployTimeParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Any deploy-time parameters to replace in the TEAL code + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### extraProgramPages? + +`number` + +Number of extra pages required for the programs. +Defaults to the number needed for the programs in this call if not specified. +This is immutable once the app is created. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### method + +`string` + +The method name or method signature to call if an ABI call is being emitted + +**Examples** + +```ts +Method name +`my_method` +``` + +```ts +Method signature +`my_method(unit64,string)bytes` +``` + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### schema? + +\{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \} + +The state schema for the app. This is immutable once the app is created. By default uses the ARC32/ARC-56 spec. + +###### schema.globalByteSlices + +`number` + +The number of byte slices saved in global state. + +###### schema.globalInts + +`number` + +The number of integers saved in global state. + +###### schema.localByteSlices + +`number` + +The number of byte slices saved in local state. + +###### schema.localInts + +`number` + +The number of integers saved in local state. + +###### sender? + +`string` \| `Address` + +The address of the account sending the transaction, if undefined then the app client's defaultSender is used. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### updatable? + +`boolean` + +Whether or not the contract should have deploy-time immutability control set, undefined = ignore + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +##### Returns + +`Promise`\<\{ `methodCalls`: `Map`\<`number`, `ABIMethod`\>; `signers`: `Map`\<`number`, `TransactionSigner`\>; `transactions`: `Transaction`[]; \}\> + +The create call transaction + +*** + +### send + +> `readonly` **send**: `object` + +Defined in: [src/types/app-factory.ts:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L273) + +Send transactions to the current app + +#### bare + +> **bare**: `object` + +Send bare (raw) transactions for the current app + +##### bare.create() + +> **create**: (`params?`) => `Promise`\<\{ `appClient`: [`AppClient`](../../app-client/classes/AppClient.md); `result`: \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return`: `undefined`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}; \}\> + +Creates an instance of the app using a bare (raw) create call and returns the result +of the creation transaction and an app client to interact with that app instance. + +Performs deploy-time TEAL template placeholder substitutions (if specified). + +###### Parameters + +###### params? + +`object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters to create the app + +###### Returns + +`Promise`\<\{ `appClient`: [`AppClient`](../../app-client/classes/AppClient.md); `result`: \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return`: `undefined`; `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}; \}\> + +The app client and the result of the creation transaction + +#### create() + +> **create**: (`params`) => `Promise`\<\{ `appClient`: [`AppClient`](../../app-client/classes/AppClient.md); `result`: \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}; \}\> + +Creates an instance of the app and returns the result of the creation +transaction and an app client to interact with that app instance. + +Performs deploy-time TEAL template placeholder substitutions (if specified). + +##### Parameters + +###### params + +`object` & [`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters to create the app + +##### Returns + +`Promise`\<\{ `appClient`: [`AppClient`](../../app-client/classes/AppClient.md); `result`: \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \}; \}\> + +The app client and the result of the creation transaction + +## Accessors + +### algorand + +#### Get Signature + +> **get** **algorand**(): [`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +Defined in: [src/types/app-factory.ts:221](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L221) + +Return the algorand client this factory is using. + +##### Returns + +[`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +*** + +### appName + +#### Get Signature + +> **get** **appName**(): `string` + +Defined in: [src/types/app-factory.ts:211](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L211) + +The name of the app (from the ARC-32 / ARC-56 app spec or override). + +##### Returns + +`string` + +*** + +### appSpec + +#### Get Signature + +> **get** **appSpec**(): [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +Defined in: [src/types/app-factory.ts:216](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L216) + +The ARC-56 app spec being used + +##### Returns + +[`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +*** + +### params + +#### Get Signature + +> **get** **params**(): `object` + +Defined in: [src/types/app-factory.ts:240](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L240) + +Get parameters to create transactions (create and deploy related calls) for the current app. + +A good mental model for this is that these parameters represent a deferred transaction creation. + +##### Examples + +```typescript +const createAppParams = appFactory.params.create({method: 'create_method', args: [123, 'hello']}) +// ... +await algorand.send.AppCreateMethodCall(createAppParams) +``` + +```typescript +const createAppParams = appFactory.params.create({method: 'create_method', args: [123, 'hello']}) +await appClient.send.call({method: 'my_method', args: [createAppParams]}) +``` + +##### Returns + +###### bare + +> **bare**: `object` + +###### bare.create() + +> **create**: (`params?`) => `Promise`\<`object` & `object`\> + +Return params for a create bare call, including deploy-time TEAL template replacements and compilation if provided + +###### Parameters + +###### params? + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### args? + +`Uint8Array`\<`ArrayBufferLike`\>[] + +Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### deletable? + +`boolean` + +Whether or not the contract should have deploy-time permanence control set, undefined = ignore + +###### deployTimeParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Any deploy-time parameters to replace in the TEAL code + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### extraProgramPages? + +`number` + +Number of extra pages required for the programs. +Defaults to the number needed for the programs in this call if not specified. +This is immutable once the app is created. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### schema? + +\{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \} + +The state schema for the app. This is immutable once the app is created. By default uses the ARC32/ARC-56 spec. + +###### schema.globalByteSlices + +`number` + +The number of byte slices saved in global state. + +###### schema.globalInts + +`number` + +The number of integers saved in global state. + +###### schema.localByteSlices + +`number` + +The number of byte slices saved in local state. + +###### schema.localInts + +`number` + +The number of integers saved in local state. + +###### sender? + +`string` \| `Address` + +The address of the account sending the transaction, if undefined then the app client's defaultSender is used. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### updatable? + +`boolean` + +Whether or not the contract should have deploy-time immutability control set, undefined = ignore + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +###### Returns + +`Promise`\<`object` & `object`\> + +###### bare.deployDelete() + +> **deployDelete**: (`params?`) => `object` & `object` + +Return params for a deployment delete bare call + +###### Parameters + +###### params? + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### args? + +`Uint8Array`\<`ArrayBufferLike`\>[] + +Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### sender? + +`string` \| `Address` + +The address of the account sending the transaction, if undefined then the app client's defaultSender is used. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +###### Returns + +###### bare.deployUpdate() + +> **deployUpdate**: (`params?`) => `object` & `object` + +Return params for a deployment update bare call + +###### Parameters + +###### params? + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### args? + +`Uint8Array`\<`ArrayBufferLike`\>[] + +Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### sender? + +`string` \| `Address` + +The address of the account sending the transaction, if undefined then the app client's defaultSender is used. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +###### Returns + +###### create() + +> **create**: (`params`) => `Promise`\<`object` & `object`\> + +Return params for a create ABI call, including deploy-time TEAL template replacements and compilation if provided + +###### Parameters + +###### params + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### args? + +(`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../../composer/type-aliases/AppMethodCallTransactionArgument.md) \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md))[] + +Arguments to the ABI method, either: +* An ABI value +* An ARC-56 struct +* A transaction with explicit signer +* A transaction (where the signer will be automatically assigned) +* An unawaited transaction (e.g. from algorand.createTransaction.transactionType()) +* Another method call (via method call params object) +* undefined (this represents a placeholder for either a default argument or a transaction argument that is fulfilled by another method call argument) + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### deletable? + +`boolean` + +Whether or not the contract should have deploy-time permanence control set, undefined = ignore + +###### deployTimeParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Any deploy-time parameters to replace in the TEAL code + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### extraProgramPages? + +`number` + +Number of extra pages required for the programs. +Defaults to the number needed for the programs in this call if not specified. +This is immutable once the app is created. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### method + +`string` + +The method name or method signature to call if an ABI call is being emitted + +**Examples** + +```ts +Method name +`my_method` +``` + +```ts +Method signature +`my_method(unit64,string)bytes` +``` + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### schema? + +\{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \} + +The state schema for the app. This is immutable once the app is created. By default uses the ARC32/ARC-56 spec. + +###### schema.globalByteSlices + +`number` + +The number of byte slices saved in global state. + +###### schema.globalInts + +`number` + +The number of integers saved in global state. + +###### schema.localByteSlices + +`number` + +The number of byte slices saved in local state. + +###### schema.localInts + +`number` + +The number of integers saved in local state. + +###### sender? + +`string` \| `Address` + +The address of the account sending the transaction, if undefined then the app client's defaultSender is used. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### updatable? + +`boolean` + +Whether or not the contract should have deploy-time immutability control set, undefined = ignore + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +###### Returns + +`Promise`\<`object` & `object`\> + +###### deployDelete() + +> **deployDelete**: (`params`) => `object` & `object` + +Return params for a deployment delete ABI call + +###### Parameters + +###### params + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### args? + +(`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../../composer/type-aliases/AppMethodCallTransactionArgument.md) \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md))[] + +Arguments to the ABI method, either: +* An ABI value +* An ARC-56 struct +* A transaction with explicit signer +* A transaction (where the signer will be automatically assigned) +* An unawaited transaction (e.g. from algorand.createTransaction.transactionType()) +* Another method call (via method call params object) +* undefined (this represents a placeholder for either a default argument or a transaction argument that is fulfilled by another method call argument) + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### method + +`string` + +The method name or method signature to call if an ABI call is being emitted + +**Examples** + +```ts +Method name +`my_method` +``` + +```ts +Method signature +`my_method(unit64,string)bytes` +``` + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`OnApplicationComplete` + +The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### sender? + +`string` \| `Address` + +The address of the account sending the transaction, if undefined then the app client's defaultSender is used. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +###### Returns + +###### deployUpdate() + +> **deployUpdate**: (`params`) => `object` & `object` + +Return params for a deployment update ABI call + +###### Parameters + +###### params + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### args? + +(`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../../composer/type-aliases/AppMethodCallTransactionArgument.md) \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md))[] + +Arguments to the ABI method, either: +* An ABI value +* An ARC-56 struct +* A transaction with explicit signer +* A transaction (where the signer will be automatically assigned) +* An unawaited transaction (e.g. from algorand.createTransaction.transactionType()) +* Another method call (via method call params object) +* undefined (this represents a placeholder for either a default argument or a transaction argument that is fulfilled by another method call argument) + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### method + +`string` + +The method name or method signature to call if an ABI call is being emitted + +**Examples** + +```ts +Method name +`my_method` +``` + +```ts +Method signature +`my_method(unit64,string)bytes` +``` + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`OnApplicationComplete` + +The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### sender? + +`string` \| `Address` + +The address of the account sending the transaction, if undefined then the app client's defaultSender is used. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +###### Returns + +## Methods + +### compile() + +> **compile**(`compilation?`): `Promise`\<[`AppClientCompilationResult`](../../app-client/interfaces/AppClientCompilationResult.md)\> + +Defined in: [src/types/app-factory.ts:615](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L615) + +Compiles the approval and clear state programs (if TEAL templates provided), +performing any provided deploy-time parameter replacement and stores +the source maps. + +If no TEAL templates provided it will use any byte code provided in the app spec. + +Will store any generated source maps for later use in debugging. + +#### Parameters + +##### compilation? + +[`AppClientCompilationParams`](../../app-client/interfaces/AppClientCompilationParams.md) + +Optional compilation parameters to use for the compilation + +#### Returns + +`Promise`\<[`AppClientCompilationResult`](../../app-client/interfaces/AppClientCompilationResult.md)\> + +The compilation result + +#### Example + +```typescript +const result = await factory.compile() +``` + +*** + +### deploy() + +> **deploy**(`params`): `Promise`\<\{ `appClient`: [`AppClient`](../../app-client/classes/AppClient.md); `result`: \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `bigint`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteReturn`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `groupId`: `string`; `name`: `string`; `operationPerformed`: `"create"`; `return`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; `updatable?`: `boolean`; `updatedRound`: `bigint`; `version`: `string`; \} \| \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `bigint`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteReturn`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `groupId`: `string`; `name`: `string`; `operationPerformed`: `"update"`; `return`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; `updatable?`: `boolean`; `updatedRound`: `bigint`; `version`: `string`; \} \| \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `bigint`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteResult`: [`ConfirmedTransactionResult`](../../transaction/interfaces/ConfirmedTransactionResult.md); `deleteReturn`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `groupId`: `string`; `name`: `string`; `operationPerformed`: `"replace"`; `return`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; `updatable?`: `boolean`; `updatedRound`: `bigint`; `version`: `string`; \} \| \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `bigint`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteReturn`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `name`: `string`; `operationPerformed`: `"nothing"`; `return`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `updatable?`: `boolean`; `updatedRound`: `bigint`; `version`: `string`; \}; \}\> + +Defined in: [src/types/app-factory.ts:372](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L372) + +Idempotently deploy (create if not exists, update if changed) an app against the given name for the given creator account, including deploy-time TEAL template placeholder substitutions (if specified). + +**Note:** When using the return from this function be sure to check `operationPerformed` to get access to various return properties like `transaction`, `confirmation` and `deleteResult`. + +**Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created. + +**Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created. + +#### Parameters + +##### params + +The arguments to control the app deployment + +###### appName? + +`string` + +Override the app name for this deployment + +###### coverAppCallInnerTransactionFees? + +`boolean` + +Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee + +###### createParams? + +\{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../../composer/type-aliases/AppMethodCallTransactionArgument.md) \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md))[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `extraProgramPages?`: `number`; `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `method`: `string`; `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC`; `rekeyTo?`: `string` \| `Address`; `schema?`: \{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \}; `sender?`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} \| \{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: `Uint8Array`\<`ArrayBufferLike`\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `extraProgramPages?`: `number`; `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC`; `rekeyTo?`: `string` \| `Address`; `schema?`: \{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \}; `sender?`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} + +Create transaction parameters to use if a create needs to be issued as part of deployment + +###### deletable? + +`boolean` + +Whether or not the contract should have deploy-time permanence control set. +`undefined` = use AppFactory constructor value if set or base it on the app spec. + +###### deleteParams? + +\{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: `Uint8Array`\<`ArrayBufferLike`\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `rekeyTo?`: `string` \| `Address`; `sender?`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} \| \{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../../composer/type-aliases/AppMethodCallTransactionArgument.md) \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md))[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `method`: `string`; `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `OnApplicationComplete`; `rekeyTo?`: `string` \| `Address`; `sender?`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} + +Delete transaction parameters to use if a create needs to be issued as part of deployment + +###### deployTimeParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Any deploy-time parameters to replace in the TEAL code before compiling it (used if teal code is passed in as a string) + +###### existingDeployments? + +[`AppLookup`](../../app-deployer/interfaces/AppLookup.md) + +Optional cached value of the existing apps for the given creator; use this to avoid an indexer lookup + +###### ignoreCache? + +`boolean` + +Whether or not to ignore the app metadata cache and force a lookup, default: use the cache * + +###### maxRoundsToWaitForConfirmation? + +`number` + +The number of rounds to wait for confirmation. By default until the latest lastValid has past. + +###### onSchemaBreak? + +[`OnSchemaBreak`](../../app/enumerations/OnSchemaBreak.md) \| `"replace"` \| `"fail"` \| `"append"` + +What action to perform if a schema break (storage schema or extra pages change) is detected: + +* `fail` - Fail the deployment (throw an error, **default**) +* `replace` - Delete the old app and create a new one +* `append` - Deploy a new app and leave the old one as is + +###### onUpdate? + +`"replace"` \| `"fail"` \| `"append"` \| [`OnUpdate`](../../app/enumerations/OnUpdate.md) \| `"update"` + +What action to perform if a TEAL code update is detected: + +* `fail` - Fail the deployment (throw an error, **default**) +* `update` - Update the app with the new TEAL code +* `replace` - Delete the old app and create a new one +* `append` - Deploy a new app and leave the old one as is + +###### populateAppCallResources? + +`boolean` + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. + +###### suppressLog? + +`boolean` + +Whether to suppress log messages from transaction send, default: do not suppress. + +###### updatable? + +`boolean` + +Whether or not the contract should have deploy-time immutability control set. +`undefined` = use AppFactory constructor value if set or base it on the app spec. + +###### updateParams? + +\{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: `Uint8Array`\<`ArrayBufferLike`\>[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `rekeyTo?`: `string` \| `Address`; `sender?`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} \| \{ `accountReferences?`: (`string` \| `Address`)[]; `appReferences?`: `bigint`[]; `args?`: (`undefined` \| `ABIValue` \| [`AppMethodCallTransactionArgument`](../../composer/type-aliases/AppMethodCallTransactionArgument.md) \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md))[]; `assetReferences?`: `bigint`[]; `boxReferences?`: ([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[]; `extraFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `firstValidRound?`: `bigint`; `lastValidRound?`: `bigint`; `lease?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `maxFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `method`: `string`; `note?`: `string` \| `Uint8Array`\<`ArrayBufferLike`\>; `onComplete?`: `OnApplicationComplete`; `rekeyTo?`: `string` \| `Address`; `sender?`: `string` \| `Address`; `signer?`: `TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md); `staticFee?`: [`AlgoAmount`](../../amount/classes/AlgoAmount.md); `validityWindow?`: `number` \| `bigint`; \} + +Update transaction parameters to use if a create needs to be issued as part of deployment + +#### Returns + +`Promise`\<\{ `appClient`: [`AppClient`](../../app-client/classes/AppClient.md); `result`: \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `bigint`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteReturn`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `groupId`: `string`; `name`: `string`; `operationPerformed`: `"create"`; `return`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; `updatable?`: `boolean`; `updatedRound`: `bigint`; `version`: `string`; \} \| \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `bigint`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteReturn`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `groupId`: `string`; `name`: `string`; `operationPerformed`: `"update"`; `return`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; `updatable?`: `boolean`; `updatedRound`: `bigint`; `version`: `string`; \} \| \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `bigint`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteResult`: [`ConfirmedTransactionResult`](../../transaction/interfaces/ConfirmedTransactionResult.md); `deleteReturn`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `groupId`: `string`; `name`: `string`; `operationPerformed`: `"replace"`; `return`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; `updatable?`: `boolean`; `updatedRound`: `bigint`; `version`: `string`; \} \| \{ `appAddress`: `Address`; `appId`: `bigint`; `compiledApproval?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `compiledClear?`: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md); `createdMetadata`: [`AppDeployMetadata`](../../app/interfaces/AppDeployMetadata.md); `createdRound`: `bigint`; `deletable?`: `boolean`; `deleted`: `boolean`; `deleteReturn`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `name`: `string`; `operationPerformed`: `"nothing"`; `return`: `undefined` \| `string` \| `number` \| `bigint` \| `boolean` \| `Address` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue`[] \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md); `updatable?`: `boolean`; `updatedRound`: `bigint`; `version`: `string`; \}; \}\> + +The app client and the result of the deployment + +#### Example + +```ts +const { appClient, result } = await factory.deploy({ + createParams: { + sender: 'SENDER_ADDRESS', + approvalProgram: 'APPROVAL PROGRAM', + clearStateProgram: 'CLEAR PROGRAM', + schema: { + globalByteSlices: 0, + globalInts: 0, + localByteSlices: 0, + localInts: 0 + } + }, + updateParams: { + sender: 'SENDER_ADDRESS' + }, + deleteParams: { + sender: 'SENDER_ADDRESS' + }, + metadata: { name: 'my_app', version: '2.0', updatable: false, deletable: false }, + onSchemaBreak: 'append', + onUpdate: 'append' + }) +``` + +*** + +### exportSourceMaps() + +> **exportSourceMaps**(): [`AppSourceMaps`](../../app-client/interfaces/AppSourceMaps.md) + +Defined in: [src/types/app-factory.ts:496](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L496) + +Export the current source maps for the app. + +#### Returns + +[`AppSourceMaps`](../../app-client/interfaces/AppSourceMaps.md) + +The source maps + +*** + +### exposeLogicError() + +> **exposeLogicError**(`e`, `isClearStateProgram?`): `Error` + +Defined in: [src/types/app-factory.ts:484](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L484) + +Takes an error that may include a logic error from a call to the current app and re-exposes the +error to include source code information via the source map and ARC-56 spec. + +#### Parameters + +##### e + +`Error` + +The error to parse + +##### isClearStateProgram? + +`boolean` + +Whether or not the code was running the clear state program (defaults to approval program) + +#### Returns + +`Error` + +The new error, or if there was no logic error or source map then the wrapped error with source details + +*** + +### getAppClientByCreatorAndName() + +> **getAppClientByCreatorAndName**(`params`): `Promise`\<[`AppClient`](../../app-client/classes/AppClient.md)\> + +Defined in: [src/types/app-factory.ts:465](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L465) + +Returns a new `AppClient` client, resolving the app by creator address and name +using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note). + +Automatically populates appName, defaultSender and source maps from the factory +if not specified in the params. + +#### Parameters + +##### params + +The parameters to create the app client + +###### appLookupCache? + +[`AppLookup`](../../app-deployer/interfaces/AppLookup.md) + +An optional cached app lookup that matches a name to on-chain details; +either this is needed or indexer is required to be passed in to this `ClientManager` on construction. + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### creatorAddress + +`string` \| `Address` + +The address of the creator account for the app + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +###### ignoreCache? + +`boolean` + +Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value + +#### Returns + +`Promise`\<[`AppClient`](../../app-client/classes/AppClient.md)\> + +The `AppClient` instance + +#### Example + +```typescript +const appClient = factory.getAppClientByCreatorAndName({ creatorAddress: 'CREATOR_ADDRESS', appName: 'my_app' }) +``` + +*** + +### getAppClientById() + +> **getAppClientById**(`params`): [`AppClient`](../../app-client/classes/AppClient.md) + +Defined in: [src/types/app-factory.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L439) + +Returns a new `AppClient` client for an app instance of the given ID. + +Automatically populates appName, defaultSender and source maps from the factory +if not specified in the params. + +#### Parameters + +##### params + +The parameters to create the app client + +###### appId + +`bigint` + +The ID of the app instance this client should make calls against. + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +#### Returns + +[`AppClient`](../../app-client/classes/AppClient.md) + +The `AppClient` instance + +#### Example + +```typescript +const appClient = factory.getAppClientById({ appId: 12345n }) +``` + +*** + +### importSourceMaps() + +> **importSourceMaps**(`sourceMaps`): `void` + +Defined in: [src/types/app-factory.ts:513](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L513) + +Import source maps for the app. + +#### Parameters + +##### sourceMaps + +[`AppSourceMaps`](../../app-client/interfaces/AppSourceMaps.md) + +The source maps to import + +#### Returns + +`void` + +*** + +### parseMethodCallReturn() + +> **parseMethodCallReturn**\<`TReturn`, `TResult`\>(`result`, `method`): `Promise`\<`Omit`\<`TResult`, `"return"`\> & [`AppReturn`](../../app/type-aliases/AppReturn.md)\<`TReturn`\>\> + +Defined in: [src/types/app-factory.ts:714](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L714) + +Checks for decode errors on the SendAppTransactionResult and maps the return value to the specified type +on the ARC-56 method. + +If the return type is a struct then the struct will be returned. + +#### Type Parameters + +##### TReturn + +`TReturn` *extends* `undefined` \| `Uint8Array`\<`ArrayBufferLike`\> \| `ABIValue` \| [`ABIStruct`](../../app-arc56/type-aliases/ABIStruct.md) + +##### TResult + +`TResult` *extends* `object` = \{ `confirmation`: `PendingTransactionResponse`; `confirmations`: `PendingTransactionResponse`[]; `groupId`: `string`; `return?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md); `returns?`: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[]; `transaction`: `Transaction`; `transactions`: `Transaction`[]; `txIds`: `string`[]; \} + +#### Parameters + +##### result + +The SendAppTransactionResult to be mapped + +`TResult` | `Promise`\<`TResult`\> + +##### method + +[`Arc56Method`](../../app-arc56/classes/Arc56Method.md) + +The method that was called + +#### Returns + +`Promise`\<`Omit`\<`TResult`, `"return"`\> & [`AppReturn`](../../app/type-aliases/AppReturn.md)\<`TReturn`\>\> + +The smart contract response with an updated return value diff --git a/docs/code/types/app-factory/interfaces/AppFactoryParams.md b/docs/code/types/app-factory/interfaces/AppFactoryParams.md new file mode 100644 index 00000000..1714c218 --- /dev/null +++ b/docs/code/types/app-factory/interfaces/AppFactoryParams.md @@ -0,0 +1,117 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-factory](../README.md) / AppFactoryParams + +# Interface: AppFactoryParams + +Defined in: [src/types/app-factory.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L47) + +Parameters to create an app client + +## Properties + +### algorand + +> **algorand**: [`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +Defined in: [src/types/app-factory.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L56) + +`AlgorandClient` instance + +*** + +### appName? + +> `optional` **appName**: `string` + +Defined in: [src/types/app-factory.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L62) + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name. + +*** + +### appSpec + +> **appSpec**: `string` \| [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) \| [`AppSpec`](../../app-spec/interfaces/AppSpec.md) + +Defined in: [src/types/app-factory.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L53) + +The ARC-56 or ARC-32 application spec as either: + * Parsed JSON ARC-56 `Contract` + * Parsed JSON ARC-32 `AppSpec` + * Raw JSON string (in either ARC-56 or ARC-32 format) + +*** + +### defaultSender? + +> `optional` **defaultSender**: `string` \| `Address` + +Defined in: [src/types/app-factory.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L65) + +Optional address to use for the account to use as the default sender for calls. + +*** + +### defaultSigner? + +> `optional` **defaultSigner**: `TransactionSigner` + +Defined in: [src/types/app-factory.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L68) + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +*** + +### deletable? + +> `optional` **deletable**: `boolean` + +Defined in: [src/types/app-factory.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L89) + +Whether or not the contract should have deploy-time permanence control set, undefined = ignore. +If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. + +Useful if you want to vend multiple contracts from the same factory without specifying this value +for each call. + +*** + +### deployTimeParams? + +> `optional` **deployTimeParams**: [`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Defined in: [src/types/app-factory.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L98) + +Optional deploy-time TEAL template replacement parameters. +If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. + +Useful if you want to vend multiple contracts from the same factory without specifying this value +for each call. + +*** + +### updatable? + +> `optional` **updatable**: `boolean` + +Defined in: [src/types/app-factory.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L80) + +Whether or not the contract should have deploy-time immutability control set, undefined = ignore. +If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. + +Useful if you want to vend multiple contracts from the same factory without specifying this value +for each call. + +*** + +### version? + +> `optional` **version**: `string` + +Defined in: [src/types/app-factory.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L71) + +The version of app that is / will be deployed; defaults to 1.0 diff --git a/docs/code/types/app-factory/type-aliases/AppFactoryAppClientParams.md b/docs/code/types/app-factory/type-aliases/AppFactoryAppClientParams.md new file mode 100644 index 00000000..5f3535c7 --- /dev/null +++ b/docs/code/types/app-factory/type-aliases/AppFactoryAppClientParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-factory](../README.md) / AppFactoryAppClientParams + +# Type Alias: AppFactoryAppClientParams + +> **AppFactoryAppClientParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppClientParams`](../../app-client/interfaces/AppClientParams.md), `"algorand"` \| `"appSpec"`\>\> + +Defined in: [src/types/app-factory.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L134) + +Params to get an app client by ID from an app factory. diff --git a/docs/code/types/app-factory/type-aliases/AppFactoryCreateMethodCallParams.md b/docs/code/types/app-factory/type-aliases/AppFactoryCreateMethodCallParams.md new file mode 100644 index 00000000..6dbbc757 --- /dev/null +++ b/docs/code/types/app-factory/type-aliases/AppFactoryCreateMethodCallParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-factory](../README.md) / AppFactoryCreateMethodCallParams + +# Type Alias: AppFactoryCreateMethodCallParams + +> **AppFactoryCreateMethodCallParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<[`AppClientMethodCallParams`](../../app-client/type-aliases/AppClientMethodCallParams.md) & [`AppClientCompilationParams`](../../app-client/interfaces/AppClientCompilationParams.md) & [`CreateOnComplete`](CreateOnComplete.md) & [`CreateSchema`](CreateSchema.md)\> + +Defined in: [src/types/app-factory.ts:129](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L129) + +Params to specify a create method call for an app diff --git a/docs/code/types/app-factory/type-aliases/AppFactoryCreateParams.md b/docs/code/types/app-factory/type-aliases/AppFactoryCreateParams.md new file mode 100644 index 00000000..9dc7be95 --- /dev/null +++ b/docs/code/types/app-factory/type-aliases/AppFactoryCreateParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-factory](../README.md) / AppFactoryCreateParams + +# Type Alias: AppFactoryCreateParams + +> **AppFactoryCreateParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<[`AppClientBareCallParams`](../../app-client/type-aliases/AppClientBareCallParams.md) & [`AppClientCompilationParams`](../../app-client/interfaces/AppClientCompilationParams.md) & [`CreateOnComplete`](CreateOnComplete.md) & [`CreateSchema`](CreateSchema.md)\> + +Defined in: [src/types/app-factory.ts:126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L126) + +Params to specify a bare (raw) create call for an app diff --git a/docs/code/types/app-factory/type-aliases/AppFactoryDeployParams.md b/docs/code/types/app-factory/type-aliases/AppFactoryDeployParams.md new file mode 100644 index 00000000..533eee72 --- /dev/null +++ b/docs/code/types/app-factory/type-aliases/AppFactoryDeployParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-factory](../README.md) / AppFactoryDeployParams + +# Type Alias: AppFactoryDeployParams + +> **AppFactoryDeployParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppDeployParams`](../../app-deployer/type-aliases/AppDeployParams.md), `"createParams"` \| `"updateParams"` \| `"deleteParams"` \| `"metadata"`\> & `object`\> + +Defined in: [src/types/app-factory.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L140) + +Parameters to define a deployment for an `AppFactory` diff --git a/docs/code/types/app-factory/type-aliases/AppFactoryResolveAppClientByCreatorAndNameParams.md b/docs/code/types/app-factory/type-aliases/AppFactoryResolveAppClientByCreatorAndNameParams.md new file mode 100644 index 00000000..81abe107 --- /dev/null +++ b/docs/code/types/app-factory/type-aliases/AppFactoryResolveAppClientByCreatorAndNameParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-factory](../README.md) / AppFactoryResolveAppClientByCreatorAndNameParams + +# Type Alias: AppFactoryResolveAppClientByCreatorAndNameParams + +> **AppFactoryResolveAppClientByCreatorAndNameParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`ResolveAppClientByCreatorAndName`](../../app-client/type-aliases/ResolveAppClientByCreatorAndName.md), `"algorand"` \| `"appSpec"`\>\> + +Defined in: [src/types/app-factory.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L137) + +Params to get an app client by creator address and name from an app factory. diff --git a/docs/code/types/app-factory/type-aliases/CreateOnComplete.md b/docs/code/types/app-factory/type-aliases/CreateOnComplete.md new file mode 100644 index 00000000..b6fac8e9 --- /dev/null +++ b/docs/code/types/app-factory/type-aliases/CreateOnComplete.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-factory](../README.md) / CreateOnComplete + +# Type Alias: CreateOnComplete + +> **CreateOnComplete** = `object` + +Defined in: [src/types/app-factory.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L102) + +onComplete parameter for a create app call + +## Properties + +### onComplete? + +> `optional` **onComplete**: `Exclude`\<`OnApplicationComplete`, `OnApplicationComplete.ClearStateOC`\> + +Defined in: [src/types/app-factory.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L103) diff --git a/docs/code/types/app-factory/type-aliases/CreateSchema.md b/docs/code/types/app-factory/type-aliases/CreateSchema.md new file mode 100644 index 00000000..cd70c343 --- /dev/null +++ b/docs/code/types/app-factory/type-aliases/CreateSchema.md @@ -0,0 +1,59 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-factory](../README.md) / CreateSchema + +# Type Alias: CreateSchema + +> **CreateSchema** = `object` + +Defined in: [src/types/app-factory.ts:107](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L107) + +Specifies a schema used for creating an app + +## Properties + +### extraProgramPages? + +> `optional` **extraProgramPages**: `number` + +Defined in: [src/types/app-factory.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L122) + +Number of extra pages required for the programs. +Defaults to the number needed for the programs in this call if not specified. +This is immutable once the app is created. + +*** + +### schema? + +> `optional` **schema**: `object` + +Defined in: [src/types/app-factory.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-factory.ts#L109) + +The state schema for the app. This is immutable once the app is created. By default uses the ARC32/ARC-56 spec. + +#### globalByteSlices + +> **globalByteSlices**: `number` + +The number of byte slices saved in global state. + +#### globalInts + +> **globalInts**: `number` + +The number of integers saved in global state. + +#### localByteSlices + +> **localByteSlices**: `number` + +The number of byte slices saved in local state. + +#### localInts + +> **localInts**: `number` + +The number of integers saved in local state. diff --git a/docs/code/types/app-manager/README.md b/docs/code/types/app-manager/README.md new file mode 100644 index 00000000..a00907e5 --- /dev/null +++ b/docs/code/types/app-manager/README.md @@ -0,0 +1,22 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/app-manager + +# types/app-manager + +## Classes + +- [AppManager](classes/AppManager.md) + +## Interfaces + +- [AppInformation](interfaces/AppInformation.md) +- [BoxReference](interfaces/BoxReference.md) +- [BoxValueRequestParams](interfaces/BoxValueRequestParams.md) +- [BoxValuesRequestParams](interfaces/BoxValuesRequestParams.md) + +## Type Aliases + +- [BoxIdentifier](type-aliases/BoxIdentifier.md) diff --git a/docs/code/types/app-manager/classes/AppManager.md b/docs/code/types/app-manager/classes/AppManager.md new file mode 100644 index 00000000..7ec1465b --- /dev/null +++ b/docs/code/types/app-manager/classes/AppManager.md @@ -0,0 +1,624 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-manager](../README.md) / AppManager + +# Class: AppManager + +Defined in: [src/types/app-manager.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L98) + +Allows management of application information. + +## Constructors + +### Constructor + +> **new AppManager**(`algod`): `AppManager` + +Defined in: [src/types/app-manager.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L106) + +Creates an `AppManager` + +#### Parameters + +##### algod + +`AlgodClient` + +An algod instance + +#### Returns + +`AppManager` + +## Methods + +### compileTeal() + +> **compileTeal**(`tealCode`): `Promise`\<[`CompiledTeal`](../../app/interfaces/CompiledTeal.md)\> + +Defined in: [src/types/app-manager.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L125) + +Compiles the given TEAL using algod and returns the result, including source map. + +The result of this compilation is also cached keyed by the TEAL + code so it can be retrieved via `getCompilationResult`. + +This function is re-entrant; it will only compile the same code once. + +#### Parameters + +##### tealCode + +`string` + +The TEAL code + +#### Returns + +`Promise`\<[`CompiledTeal`](../../app/interfaces/CompiledTeal.md)\> + +The information about the compiled file + +#### Example + +```typescript +const compiled = await appManager.compileTeal(tealProgram) +``` + +*** + +### compileTealTemplate() + +> **compileTealTemplate**(`tealTemplateCode`, `templateParams?`, `deploymentMetadata?`): `Promise`\<[`CompiledTeal`](../../app/interfaces/CompiledTeal.md)\> + +Defined in: [src/types/app-manager.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L161) + +Performs template substitution of a teal template and compiles it, returning the compiled result. + +Looks for `TMPL_{parameter}` for template replacements and replaces AlgoKit deploy-time control parameters +if deployment metadata is specified. + +* `TMPL_UPDATABLE` for updatability / immutability control +* `TMPL_DELETABLE` for deletability / permanence control + +#### Parameters + +##### tealTemplateCode + +`string` + +The TEAL logic to compile + +##### templateParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Any parameters to replace in the .teal file before compiling + +##### deploymentMetadata? + +The deployment metadata the app will be deployed with + +###### deletable? + +`boolean` + +###### updatable? + +`boolean` + +#### Returns + +`Promise`\<[`CompiledTeal`](../../app/interfaces/CompiledTeal.md)\> + +The information about the compiled code + +#### Example + +```typescript +const compiled = await appManager.compileTealTemplate(tealTemplate, { TMPL_APP_ID: 12345n }, { updatable: true, deletable: false }) +``` + +*** + +### getBoxNames() + +> **getBoxNames**(`appId`): `Promise`\<[`BoxName`](../../app/interfaces/BoxName.md)[]\> + +Defined in: [src/types/app-manager.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L263) + +Returns the names of the current boxes for the given app. + +#### Parameters + +##### appId + +`bigint` + +The ID of the app return box names for + +#### Returns + +`Promise`\<[`BoxName`](../../app/interfaces/BoxName.md)[]\> + +The current box names + +#### Example + +```typescript +const boxNames = await appManager.getBoxNames(12353n); +``` + +*** + +### getBoxValue() + +> **getBoxValue**(`appId`, `boxName`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +Defined in: [src/types/app-manager.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L284) + +Returns the value of the given box name for the given app. + +#### Parameters + +##### appId + +`bigint` + +The ID of the app return box names for + +##### boxName + +The name of the box to return either as a string, binary array or `BoxName` + +[`BoxName`](../../app/interfaces/BoxName.md) | [`BoxIdentifier`](../type-aliases/BoxIdentifier.md) + +#### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +The current box value as a byte array + +#### Example + +```typescript +const boxValue = await appManager.getBoxValue(12353n, 'boxName'); +``` + +*** + +### getBoxValueFromABIType() + +> **getBoxValueFromABIType**(`request`): `Promise`\<`ABIValue`\> + +Defined in: [src/types/app-manager.ts:314](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L314) + +Returns the value of the given box name for the given app decoded based on the given ABI type. + +#### Parameters + +##### request + +[`BoxValueRequestParams`](../interfaces/BoxValueRequestParams.md) + +The parameters for the box value request + +#### Returns + +`Promise`\<`ABIValue`\> + +The current box value as an ABI value + +#### Example + +```typescript +const boxValue = await appManager.getBoxValueFromABIType({ appId: 12353n, boxName: 'boxName', type: new ABIUintType(32) }); +``` + +*** + +### getBoxValues() + +> **getBoxValues**(`appId`, `boxNames`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>[]\> + +Defined in: [src/types/app-manager.ts:301](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L301) + +Returns the value of the given box names for the given app. + +#### Parameters + +##### appId + +`bigint` + +The ID of the app return box names for + +##### boxNames + +([`BoxName`](../../app/interfaces/BoxName.md) \| [`BoxIdentifier`](../type-aliases/BoxIdentifier.md))[] + +The names of the boxes to return either as a string, binary array or `BoxName` + +#### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>[]\> + +The current box values as a byte array in the same order as the passed in box names + +#### Example + +```typescript +const boxValues = await appManager.getBoxValues(12353n, ['boxName1', 'boxName2']); +``` + +*** + +### getBoxValuesFromABIType() + +> **getBoxValuesFromABIType**(`request`): `Promise`\<`ABIValue`[]\> + +Defined in: [src/types/app-manager.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L329) + +Returns the value of the given box names for the given app decoded based on the given ABI type. + +#### Parameters + +##### request + +[`BoxValuesRequestParams`](../interfaces/BoxValuesRequestParams.md) + +The parameters for the box value request + +#### Returns + +`Promise`\<`ABIValue`[]\> + +The current box values as an ABI value in the same order as the passed in box names + +#### Example + +```typescript +const boxValues = await appManager.getBoxValuesFromABIType({ appId: 12353n, boxNames: ['boxName1', 'boxName2'], type: new ABIUintType(32) }); +``` + +*** + +### getById() + +> **getById**(`appId`): `Promise`\<[`AppInformation`](../interfaces/AppInformation.md)\> + +Defined in: [src/types/app-manager.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L202) + +Returns the current app information for the app with the given ID. + +#### Parameters + +##### appId + +`bigint` + +The ID of the app + +#### Returns + +`Promise`\<[`AppInformation`](../interfaces/AppInformation.md)\> + +The app information + +#### Example + +```typescript +const appInfo = await appManager.getById(12353n); +``` + +*** + +### getCompilationResult() + +> **getCompilationResult**(`tealCode`): `undefined` \| [`CompiledTeal`](../../app/interfaces/CompiledTeal.md) + +Defined in: [src/types/app-manager.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L187) + +Returns a previous compilation result. + +#### Parameters + +##### tealCode + +`string` + +The TEAL code + +#### Returns + +`undefined` \| [`CompiledTeal`](../../app/interfaces/CompiledTeal.md) + +The information about the previously compiled file + or `undefined` if that TEAL code wasn't previously compiled + +#### Example + +```typescript +const compiled = appManager.getCompilationResult(tealProgram) +``` + +*** + +### getGlobalState() + +> **getGlobalState**(`appId`): `Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +Defined in: [src/types/app-manager.ts:229](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L229) + +Returns the current global state values for the given app ID and account address + +#### Parameters + +##### appId + +`bigint` + +The ID of the app to return global state for + +#### Returns + +`Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +The current global state for the given app + +#### Example + +```typescript +const globalState = await appManager.getGlobalState(12353n); +``` + +*** + +### getLocalState() + +> **getLocalState**(`appId`, `address`): `Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +Defined in: [src/types/app-manager.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L244) + +Returns the current local state values for the given app ID and account address + +#### Parameters + +##### appId + +`bigint` + +The ID of the app to return local state for + +##### address + +The string address of the account to get local state for the given app + +`string` | `Address` + +#### Returns + +`Promise`\<[`AppState`](../../app/interfaces/AppState.md)\> + +The current local state for the given (app, account) combination + +#### Example + +```typescript +const localState = await appManager.getLocalState(12353n, 'ACCOUNTADDRESS'); +``` + +*** + +### decodeAppState() + +> `static` **decodeAppState**(`state`): [`AppState`](../../app/interfaces/AppState.md) + +Defined in: [src/types/app-manager.ts:361](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L361) + +Converts an array of global/local state values from the algod api to a more friendly +generic object keyed by the UTF-8 value of the key. + +#### Parameters + +##### state + +`object`[] + +A `global-state`, `local-state`, `global-state-deltas` or `local-state-deltas` + +#### Returns + +[`AppState`](../../app/interfaces/AppState.md) + +An object keyeed by the UTF-8 representation of the key with various parsings of the values + +#### Example + +```typescript +const stateValues = AppManager.decodeAppState(state); +``` + +*** + +### getABIReturn() + +> `static` **getABIReturn**(`confirmation`, `method`): `undefined` \| [`ABIReturn`](../../app/type-aliases/ABIReturn.md) + +Defined in: [src/types/app-manager.ts:414](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L414) + +Returns any ABI return values for the given app call arguments and transaction confirmation. + +#### Parameters + +##### confirmation + +The transaction confirmation from algod + +`undefined` | `PendingTransactionResponse` + +##### method + +The ABI method + +`undefined` | `ABIMethod` + +#### Returns + +`undefined` \| [`ABIReturn`](../../app/type-aliases/ABIReturn.md) + +The return value for the method call + +#### Example + +```typescript +const returnValue = AppManager.getABIReturn(confirmation, ABIMethod.fromSignature('hello(string)void')); +``` + +*** + +### getBoxReference() + +> `static` **getBoxReference**(`boxId`): `BoxReference` + +Defined in: [src/types/app-manager.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L343) + +Returns a `algosdk.BoxReference` given a `BoxIdentifier` or `BoxReference`. + +#### Parameters + +##### boxId + +The box to return a reference for + +[`BoxIdentifier`](../type-aliases/BoxIdentifier.md) | [`BoxReference`](../interfaces/BoxReference.md) + +#### Returns + +`BoxReference` + +The box reference ready to pass into a `algosdk.Transaction` + +#### Example + +```typescript +const boxRef = AppManager.getBoxReference('boxName'); +``` + +*** + +### replaceTealTemplateDeployTimeControlParams() + +> `static` **replaceTealTemplateDeployTimeControlParams**(`tealTemplateCode`, `params`): `string` + +Defined in: [src/types/app-manager.ts:448](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L448) + +Replaces AlgoKit deploy-time deployment control parameters within the given TEAL template code. + +* `TMPL_UPDATABLE` for updatability / immutability control +* `TMPL_DELETABLE` for deletability / permanence control + +Note: If these values are defined, but the corresponding `TMPL_*` value + isn't in the teal code it will throw an exception. + +#### Parameters + +##### tealTemplateCode + +`string` + +The TEAL template code to substitute + +##### params + +The deploy-time deployment control parameter value to replace + +###### deletable? + +`boolean` + +###### updatable? + +`boolean` + +#### Returns + +`string` + +The replaced TEAL code + +#### Example + +```typescript +const tealCode = AppManager.replaceTealTemplateDeployTimeControlParams(tealTemplate, { updatable: true, deletable: false }); +``` + +*** + +### replaceTealTemplateParams() + +> `static` **replaceTealTemplateParams**(`tealTemplateCode`, `templateParams?`): `string` + +Defined in: [src/types/app-manager.ts:483](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L483) + +Performs template substitution of a teal file. + +Looks for `TMPL_{parameter}` for template replacements. + +#### Parameters + +##### tealTemplateCode + +`string` + +The TEAL template code to make parameter replacements in + +##### templateParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Any parameters to replace in the teal code + +#### Returns + +`string` + +The TEAL code with replacements + +#### Example + +```typescript +const tealCode = AppManager.replaceTealTemplateParams(tealTemplate, { TMPL_APP_ID: 12345n }); +``` + +*** + +### stripTealComments() + +> `static` **stripTealComments**(`tealCode`): `string` + +Defined in: [src/types/app-manager.ts:522](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L522) + +Remove comments from TEAL code (useful to reduce code size before compilation). + +#### Parameters + +##### tealCode + +`string` + +The TEAL logic to strip + +#### Returns + +`string` + +The TEAL without comments + +#### Example + +```typescript +const stripped = AppManager.stripTealComments(tealProgram); +``` diff --git a/docs/code/types/app-manager/interfaces/AppInformation.md b/docs/code/types/app-manager/interfaces/AppInformation.md new file mode 100644 index 00000000..5a99652c --- /dev/null +++ b/docs/code/types/app-manager/interfaces/AppInformation.md @@ -0,0 +1,122 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-manager](../README.md) / AppInformation + +# Interface: AppInformation + +Defined in: [src/types/app-manager.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L16) + +Information about an app. + +## Properties + +### appAddress + +> **appAddress**: `Address` + +Defined in: [src/types/app-manager.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L20) + +The escrow address that the app operates with. + +*** + +### appId + +> **appId**: `bigint` + +Defined in: [src/types/app-manager.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L18) + +The ID of the app. + +*** + +### approvalProgram + +> **approvalProgram**: `Uint8Array` + +Defined in: [src/types/app-manager.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L24) + +Approval program. + +*** + +### clearStateProgram + +> **clearStateProgram**: `Uint8Array` + +Defined in: [src/types/app-manager.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L28) + +Clear state program. + +*** + +### creator + +> **creator**: `Address` + +Defined in: [src/types/app-manager.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L33) + +The address that created this application. This is the address where the +parameters and global state for this application can be found. + +*** + +### extraProgramPages? + +> `optional` **extraProgramPages**: `number` + +Defined in: [src/types/app-manager.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L47) + +Any extra pages that are needed for the smart contract. + +*** + +### globalByteSlices + +> **globalByteSlices**: `number` + +Defined in: [src/types/app-manager.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L45) + +The number of allocated byte slices in global state. + +*** + +### globalInts + +> **globalInts**: `number` + +Defined in: [src/types/app-manager.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L43) + +The number of allocated ints in global state. + +*** + +### globalState + +> **globalState**: [`AppState`](../../app/interfaces/AppState.md) + +Defined in: [src/types/app-manager.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L37) + +Current global state values. + +*** + +### localByteSlices + +> **localByteSlices**: `number` + +Defined in: [src/types/app-manager.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L41) + +The number of allocated byte slices in per-user local state. + +*** + +### localInts + +> **localInts**: `number` + +Defined in: [src/types/app-manager.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L39) + +The number of allocated ints in per-user local state. diff --git a/docs/code/types/app-manager/interfaces/BoxReference.md b/docs/code/types/app-manager/interfaces/BoxReference.md new file mode 100644 index 00000000..f48c69a4 --- /dev/null +++ b/docs/code/types/app-manager/interfaces/BoxReference.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-manager](../README.md) / BoxReference + +# Interface: BoxReference + +Defined in: [src/types/app-manager.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L62) + +A grouping of the app ID and name identifier to reference an app box. + +## Properties + +### appId + +> **appId**: `bigint` + +Defined in: [src/types/app-manager.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L66) + +A unique application id + +*** + +### name + +> **name**: [`BoxIdentifier`](../type-aliases/BoxIdentifier.md) + +Defined in: [src/types/app-manager.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L70) + +Identifier for a box name diff --git a/docs/code/types/app-manager/interfaces/BoxValueRequestParams.md b/docs/code/types/app-manager/interfaces/BoxValueRequestParams.md new file mode 100644 index 00000000..6f6bd911 --- /dev/null +++ b/docs/code/types/app-manager/interfaces/BoxValueRequestParams.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-manager](../README.md) / BoxValueRequestParams + +# Interface: BoxValueRequestParams + +Defined in: [src/types/app-manager.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L76) + +Parameters to get and decode a box value as an ABI type. + +## Properties + +### appId + +> **appId**: `bigint` + +Defined in: [src/types/app-manager.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L78) + +The ID of the app return box names for + +*** + +### boxName + +> **boxName**: [`BoxIdentifier`](../type-aliases/BoxIdentifier.md) + +Defined in: [src/types/app-manager.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L80) + +The name of the box to return either as a string, binary array or `BoxName` + +*** + +### type + +> **type**: `ABIType` + +Defined in: [src/types/app-manager.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L82) + +The ABI type to decode the value using diff --git a/docs/code/types/app-manager/interfaces/BoxValuesRequestParams.md b/docs/code/types/app-manager/interfaces/BoxValuesRequestParams.md new file mode 100644 index 00000000..4ff8c742 --- /dev/null +++ b/docs/code/types/app-manager/interfaces/BoxValuesRequestParams.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-manager](../README.md) / BoxValuesRequestParams + +# Interface: BoxValuesRequestParams + +Defined in: [src/types/app-manager.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L88) + +Parameters to get and decode a box value as an ABI type. + +## Properties + +### appId + +> **appId**: `bigint` + +Defined in: [src/types/app-manager.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L90) + +The ID of the app return box names for + +*** + +### boxNames + +> **boxNames**: [`BoxIdentifier`](../type-aliases/BoxIdentifier.md)[] + +Defined in: [src/types/app-manager.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L92) + +The names of the boxes to return either as a string, binary array or BoxName` + +*** + +### type + +> **type**: `ABIType` + +Defined in: [src/types/app-manager.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L94) + +The ABI type to decode the value using diff --git a/docs/code/types/app-manager/type-aliases/BoxIdentifier.md b/docs/code/types/app-manager/type-aliases/BoxIdentifier.md new file mode 100644 index 00000000..921d642e --- /dev/null +++ b/docs/code/types/app-manager/type-aliases/BoxIdentifier.md @@ -0,0 +1,17 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-manager](../README.md) / BoxIdentifier + +# Type Alias: BoxIdentifier + +> **BoxIdentifier** = `string` \| `Uint8Array` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +Defined in: [src/types/app-manager.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-manager.ts#L57) + +Something that identifies an app box name - either a: + * `Uint8Array` (the actual binary of the box name) + * `string` (that will be encoded to a `Uint8Array`) + * `TransactionSignerAccount` (that will be encoded into the + public key address of the corresponding account) diff --git a/docs/code/types/app-spec/README.md b/docs/code/types/app-spec/README.md new file mode 100644 index 00000000..1dfc84bf --- /dev/null +++ b/docs/code/types/app-spec/README.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/app-spec + +# types/app-spec + +## Interfaces + +- [AppSources](interfaces/AppSources.md) +- [AppSpec](interfaces/AppSpec.md) +- [CallConfig](interfaces/CallConfig.md) +- [DeclaredSchemaValueSpec](interfaces/DeclaredSchemaValueSpec.md) +- [Hint](interfaces/Hint.md) +- [ReservedSchemaValueSpec](interfaces/ReservedSchemaValueSpec.md) +- [Schema](interfaces/Schema.md) +- [SchemaSpec](interfaces/SchemaSpec.md) +- [StateSchemaSpec](interfaces/StateSchemaSpec.md) +- [Struct](interfaces/Struct.md) + +## Type Aliases + +- [ABIType](type-aliases/ABIType.md) +- [AVMType](type-aliases/AVMType.md) +- [CallConfigValue](type-aliases/CallConfigValue.md) +- [DefaultArgument](type-aliases/DefaultArgument.md) +- [FieldName](type-aliases/FieldName.md) +- [HintSpec](type-aliases/HintSpec.md) +- [StateSchema](type-aliases/StateSchema.md) +- [StructElement](type-aliases/StructElement.md) + +## Functions + +- [arc32ToArc56](functions/arc32ToArc56.md) diff --git a/docs/code/types/app-spec/functions/arc32ToArc56.md b/docs/code/types/app-spec/functions/arc32ToArc56.md new file mode 100644 index 00000000..f73c10bf --- /dev/null +++ b/docs/code/types/app-spec/functions/arc32ToArc56.md @@ -0,0 +1,33 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / arc32ToArc56 + +# Function: arc32ToArc56() + +> **arc32ToArc56**(`appSpec`): [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +Defined in: [src/types/app-spec.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L16) + +Converts an ARC-32 Application Specification to an ARC-56 Contract + +## Parameters + +### appSpec + +[`AppSpec`](../interfaces/AppSpec.md) + +The ARC-32 Application Specification + +## Returns + +[`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) + +The ARC-56 Contract + +## Example + +```typescript +const arc56AppSpec = arc32ToArc56(arc32AppSpec) +``` diff --git a/docs/code/types/app-spec/interfaces/AppSources.md b/docs/code/types/app-spec/interfaces/AppSources.md new file mode 100644 index 00000000..7c6c6dbb --- /dev/null +++ b/docs/code/types/app-spec/interfaces/AppSources.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / AppSources + +# Interface: AppSources + +Defined in: [src/types/app-spec.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L170) + +The TEAL source of a contract + +## Properties + +### approval + +> **approval**: `string` + +Defined in: [src/types/app-spec.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L172) + +The TEAL source of the approval program + +*** + +### clear + +> **clear**: `string` + +Defined in: [src/types/app-spec.ts:174](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L174) + +The TEAL source of the clear program diff --git a/docs/code/types/app-spec/interfaces/AppSpec.md b/docs/code/types/app-spec/interfaces/AppSpec.md new file mode 100644 index 00000000..eb334ba0 --- /dev/null +++ b/docs/code/types/app-spec/interfaces/AppSpec.md @@ -0,0 +1,71 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / AppSpec + +# Interface: AppSpec + +Defined in: [src/types/app-spec.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L151) + +An ARC-0032 Application Specification see https://github.com/algorandfoundation/ARCs/pull/150 + +## Properties + +### bare\_call\_config + +> **bare\_call\_config**: [`CallConfig`](CallConfig.md) + +Defined in: [src/types/app-spec.ts:163](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L163) + +The config of all BARE calls (i.e. non ABI calls with no args) + +*** + +### contract + +> **contract**: `ABIContractParams` + +Defined in: [src/types/app-spec.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L157) + +The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md + +*** + +### hints + +> **hints**: [`HintSpec`](../type-aliases/HintSpec.md) + +Defined in: [src/types/app-spec.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L153) + +Method call hints + +*** + +### schema + +> **schema**: [`SchemaSpec`](SchemaSpec.md) + +Defined in: [src/types/app-spec.ts:159](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L159) + +The values that make up the local and global state + +*** + +### source + +> **source**: [`AppSources`](AppSources.md) + +Defined in: [src/types/app-spec.ts:155](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L155) + +The TEAL source + +*** + +### state + +> **state**: [`StateSchemaSpec`](StateSchemaSpec.md) + +Defined in: [src/types/app-spec.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L161) + +The rolled-up schema allocation values for local and global state diff --git a/docs/code/types/app-spec/interfaces/CallConfig.md b/docs/code/types/app-spec/interfaces/CallConfig.md new file mode 100644 index 00000000..afe844a1 --- /dev/null +++ b/docs/code/types/app-spec/interfaces/CallConfig.md @@ -0,0 +1,61 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / CallConfig + +# Interface: CallConfig + +Defined in: [src/types/app-spec.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L186) + +Call configuration for a method + +## Properties + +### close\_out? + +> `optional` **close\_out**: [`CallConfigValue`](../type-aliases/CallConfigValue.md) + +Defined in: [src/types/app-spec.ts:192](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L192) + +Close out call config + +*** + +### delete\_application? + +> `optional` **delete\_application**: [`CallConfigValue`](../type-aliases/CallConfigValue.md) + +Defined in: [src/types/app-spec.ts:196](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L196) + +Delete call config + +*** + +### no\_op? + +> `optional` **no\_op**: [`CallConfigValue`](../type-aliases/CallConfigValue.md) + +Defined in: [src/types/app-spec.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L188) + +NoOp call config + +*** + +### opt\_in? + +> `optional` **opt\_in**: [`CallConfigValue`](../type-aliases/CallConfigValue.md) + +Defined in: [src/types/app-spec.ts:190](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L190) + +Opt-in call config + +*** + +### update\_application? + +> `optional` **update\_application**: [`CallConfigValue`](../type-aliases/CallConfigValue.md) + +Defined in: [src/types/app-spec.ts:194](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L194) + +Update call config diff --git a/docs/code/types/app-spec/interfaces/DeclaredSchemaValueSpec.md b/docs/code/types/app-spec/interfaces/DeclaredSchemaValueSpec.md new file mode 100644 index 00000000..3b5c6bb4 --- /dev/null +++ b/docs/code/types/app-spec/interfaces/DeclaredSchemaValueSpec.md @@ -0,0 +1,51 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / DeclaredSchemaValueSpec + +# Interface: DeclaredSchemaValueSpec + +Defined in: [src/types/app-spec.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L271) + +Declared schema value specification + +## Properties + +### descr? + +> `optional` **descr**: `string` + +Defined in: [src/types/app-spec.ts:277](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L277) + +A description of the variable + +*** + +### key + +> **key**: `string` + +Defined in: [src/types/app-spec.ts:275](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L275) + +The name of the key + +*** + +### static? + +> `optional` **static**: `boolean` + +Defined in: [src/types/app-spec.ts:279](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L279) + +Whether or not the value is set statically (at create time only) or dynamically + +*** + +### type + +> **type**: [`AVMType`](../type-aliases/AVMType.md) + +Defined in: [src/types/app-spec.ts:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L273) + +The type of value diff --git a/docs/code/types/app-spec/interfaces/Hint.md b/docs/code/types/app-spec/interfaces/Hint.md new file mode 100644 index 00000000..61082ede --- /dev/null +++ b/docs/code/types/app-spec/interfaces/Hint.md @@ -0,0 +1,45 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / Hint + +# Interface: Hint + +Defined in: [src/types/app-spec.ts:200](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L200) + +Hint information for a given method call to allow client generation + +## Properties + +### call\_config + +> **call\_config**: [`CallConfig`](CallConfig.md) + +Defined in: [src/types/app-spec.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L205) + +*** + +### default\_arguments? + +> `optional` **default\_arguments**: `Record`\<`string`, [`DefaultArgument`](../type-aliases/DefaultArgument.md)\> + +Defined in: [src/types/app-spec.ts:204](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L204) + +*** + +### read\_only? + +> `optional` **read\_only**: `boolean` + +Defined in: [src/types/app-spec.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L203) + +*** + +### structs? + +> `optional` **structs**: `Record`\<`string`, [`Struct`](Struct.md)\> + +Defined in: [src/types/app-spec.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L202) + +Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type diff --git a/docs/code/types/app-spec/interfaces/ReservedSchemaValueSpec.md b/docs/code/types/app-spec/interfaces/ReservedSchemaValueSpec.md new file mode 100644 index 00000000..e7338391 --- /dev/null +++ b/docs/code/types/app-spec/interfaces/ReservedSchemaValueSpec.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / ReservedSchemaValueSpec + +# Interface: ReservedSchemaValueSpec + +Defined in: [src/types/app-spec.ts:283](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L283) + +Reserved schema value specification + +## Properties + +### descr + +> **descr**: `string` + +Defined in: [src/types/app-spec.ts:287](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L287) + +The description of the reserved storage space + +*** + +### max\_keys + +> **max\_keys**: `number` + +Defined in: [src/types/app-spec.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L289) + +The maximum number of slots to reserve + +*** + +### type + +> **type**: [`AVMType`](../type-aliases/AVMType.md) + +Defined in: [src/types/app-spec.ts:285](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L285) + +The type of value diff --git a/docs/code/types/app-spec/interfaces/Schema.md b/docs/code/types/app-spec/interfaces/Schema.md new file mode 100644 index 00000000..4dee34e8 --- /dev/null +++ b/docs/code/types/app-spec/interfaces/Schema.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / Schema + +# Interface: Schema + +Defined in: [src/types/app-spec.ts:301](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L301) + +The storage schema definition + +## Properties + +### declared + +> **declared**: `Record`\<`string`, [`DeclaredSchemaValueSpec`](DeclaredSchemaValueSpec.md)\> + +Defined in: [src/types/app-spec.ts:303](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L303) + +Declared storage schema + +*** + +### reserved + +> **reserved**: `Record`\<`string`, [`ReservedSchemaValueSpec`](ReservedSchemaValueSpec.md)\> + +Defined in: [src/types/app-spec.ts:305](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L305) + +Reserved storage schema diff --git a/docs/code/types/app-spec/interfaces/SchemaSpec.md b/docs/code/types/app-spec/interfaces/SchemaSpec.md new file mode 100644 index 00000000..57909072 --- /dev/null +++ b/docs/code/types/app-spec/interfaces/SchemaSpec.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / SchemaSpec + +# Interface: SchemaSpec + +Defined in: [src/types/app-spec.ts:293](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L293) + +The schema for global and local storage + +## Properties + +### global + +> **global**: [`Schema`](Schema.md) + +Defined in: [src/types/app-spec.ts:297](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L297) + +The global storage schema + +*** + +### local + +> **local**: [`Schema`](Schema.md) + +Defined in: [src/types/app-spec.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L295) + +The local storage schema diff --git a/docs/code/types/app-spec/interfaces/StateSchemaSpec.md b/docs/code/types/app-spec/interfaces/StateSchemaSpec.md new file mode 100644 index 00000000..0eca8ff1 --- /dev/null +++ b/docs/code/types/app-spec/interfaces/StateSchemaSpec.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / StateSchemaSpec + +# Interface: StateSchemaSpec + +Defined in: [src/types/app-spec.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L309) + +The rolled-up schema allocation specification for local and global state + +## Properties + +### global + +> **global**: [`StateSchema`](../type-aliases/StateSchema.md) + +Defined in: [src/types/app-spec.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L311) + +Global storage spec + +*** + +### local + +> **local**: [`StateSchema`](../type-aliases/StateSchema.md) + +Defined in: [src/types/app-spec.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L313) + +Local storage spec diff --git a/docs/code/types/app-spec/interfaces/Struct.md b/docs/code/types/app-spec/interfaces/Struct.md new file mode 100644 index 00000000..46205c4f --- /dev/null +++ b/docs/code/types/app-spec/interfaces/Struct.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / Struct + +# Interface: Struct + +Defined in: [src/types/app-spec.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L218) + +A user-defined struct/tuple type + +## Properties + +### elements + +> **elements**: [`StructElement`](../type-aliases/StructElement.md)[] + +Defined in: [src/types/app-spec.ts:222](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L222) + +The elements (in order) that make up the struct/tuple + +*** + +### name + +> **name**: `string` + +Defined in: [src/types/app-spec.ts:220](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L220) + +The name of the type diff --git a/docs/code/types/app-spec/type-aliases/ABIType.md b/docs/code/types/app-spec/type-aliases/ABIType.md new file mode 100644 index 00000000..1998c96c --- /dev/null +++ b/docs/code/types/app-spec/type-aliases/ABIType.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / ABIType + +# Type Alias: ABIType + +> **ABIType** = `string` + +Defined in: [src/types/app-spec.ts:212](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L212) + +The string name of an ABI type diff --git a/docs/code/types/app-spec/type-aliases/AVMType.md b/docs/code/types/app-spec/type-aliases/AVMType.md new file mode 100644 index 00000000..e22e7aed --- /dev/null +++ b/docs/code/types/app-spec/type-aliases/AVMType.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / AVMType + +# Type Alias: AVMType + +> **AVMType** = `"uint64"` \| `"bytes"` + +Defined in: [src/types/app-spec.ts:268](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L268) + +AVM data type diff --git a/docs/code/types/app-spec/type-aliases/CallConfigValue.md b/docs/code/types/app-spec/type-aliases/CallConfigValue.md new file mode 100644 index 00000000..41e27534 --- /dev/null +++ b/docs/code/types/app-spec/type-aliases/CallConfigValue.md @@ -0,0 +1,17 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / CallConfigValue + +# Type Alias: CallConfigValue + +> **CallConfigValue** = `"NEVER"` \| `"CALL"` \| `"CREATE"` \| `"ALL"` + +Defined in: [src/types/app-spec.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L183) + +The various call configs: + * `NEVER`: Will not be called + * `CALL`: Can be called during a non-create call i.e. app id != 0 + * `CREATE`: Can be called during a create call i.e. app id = 0 + * `ALL`: Can be during a create OR non-create call diff --git a/docs/code/types/app-spec/type-aliases/DefaultArgument.md b/docs/code/types/app-spec/type-aliases/DefaultArgument.md new file mode 100644 index 00000000..05c79247 --- /dev/null +++ b/docs/code/types/app-spec/type-aliases/DefaultArgument.md @@ -0,0 +1,69 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / DefaultArgument + +# Type Alias: DefaultArgument + +> **DefaultArgument** = \{ `data`: `ABIMethodParams`; `source`: `"abi-method"`; \} \| \{ `data`: `string`; `source`: `"global-state"`; \} \| \{ `data`: `string`; `source`: `"local-state"`; \} \| \{ `data`: `string` \| `number`; `source`: `"constant"`; \} + +Defined in: [src/types/app-spec.ts:228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L228) + +Defines a strategy for obtaining a default value for a given ABI arg. + +## Type declaration + +\{ `data`: `ABIMethodParams`; `source`: `"abi-method"`; \} + +### data + +> **data**: `ABIMethodParams` + +### source + +> **source**: `"abi-method"` + +The default value should be fetched by invoking an ABI method + +\{ `data`: `string`; `source`: `"global-state"`; \} + +### data + +> **data**: `string` + +The key of the state variable + +### source + +> **source**: `"global-state"` + +The default value should be fetched from global state + +\{ `data`: `string`; `source`: `"local-state"`; \} + +### data + +> **data**: `string` + +The key of the state variable + +### source + +> **source**: `"local-state"` + +The default value should be fetched from the local state of the sender user + +\{ `data`: `string` \| `number`; `source`: `"constant"`; \} + +### data + +> **data**: `string` \| `number` + +The static default value to use. + +### source + +> **source**: `"constant"` + +The default value is a constant. diff --git a/docs/code/types/app-spec/type-aliases/FieldName.md b/docs/code/types/app-spec/type-aliases/FieldName.md new file mode 100644 index 00000000..6e63e4ee --- /dev/null +++ b/docs/code/types/app-spec/type-aliases/FieldName.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / FieldName + +# Type Alias: FieldName + +> **FieldName** = `string` + +Defined in: [src/types/app-spec.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L209) + +The name of a field diff --git a/docs/code/types/app-spec/type-aliases/HintSpec.md b/docs/code/types/app-spec/type-aliases/HintSpec.md new file mode 100644 index 00000000..35d84754 --- /dev/null +++ b/docs/code/types/app-spec/type-aliases/HintSpec.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / HintSpec + +# Type Alias: HintSpec + +> **HintSpec** = `Record`\<`string`, [`Hint`](../interfaces/Hint.md)\> + +Defined in: [src/types/app-spec.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L167) + +A lookup of encoded method call spec to hint diff --git a/docs/code/types/app-spec/type-aliases/StateSchema.md b/docs/code/types/app-spec/type-aliases/StateSchema.md new file mode 100644 index 00000000..424fd08e --- /dev/null +++ b/docs/code/types/app-spec/type-aliases/StateSchema.md @@ -0,0 +1,33 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / StateSchema + +# Type Alias: StateSchema + +> **StateSchema** = `object` + +Defined in: [src/types/app-spec.ts:317](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L317) + +Schema spec summary for global or local storage + +## Properties + +### num\_byte\_slices + +> **num\_byte\_slices**: `number` + +Defined in: [src/types/app-spec.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L321) + +Number of byte slots + +*** + +### num\_uints + +> **num\_uints**: `number` + +Defined in: [src/types/app-spec.ts:319](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L319) + +Number of uint slots diff --git a/docs/code/types/app-spec/type-aliases/StructElement.md b/docs/code/types/app-spec/type-aliases/StructElement.md new file mode 100644 index 00000000..df7a7615 --- /dev/null +++ b/docs/code/types/app-spec/type-aliases/StructElement.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app-spec](../README.md) / StructElement + +# Type Alias: StructElement + +> **StructElement** = \[[`FieldName`](FieldName.md), [`ABIType`](ABIType.md)\] + +Defined in: [src/types/app-spec.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-spec.ts#L215) + +The elements of the struct/tuple: `FieldName`, `ABIType` diff --git a/docs/code/types/app/README.md b/docs/code/types/app/README.md new file mode 100644 index 00000000..4720c9f3 --- /dev/null +++ b/docs/code/types/app/README.md @@ -0,0 +1,57 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/app + +# types/app + +## Enumerations + +- [OnSchemaBreak](enumerations/OnSchemaBreak.md) +- [OnUpdate](enumerations/OnUpdate.md) + +## Interfaces + +- [AppCallParams](interfaces/AppCallParams.md) +- [AppCallTransactionResultOfType](interfaces/AppCallTransactionResultOfType.md) +- [AppCompilationResult](interfaces/AppCompilationResult.md) +- [AppDeploymentParams](interfaces/AppDeploymentParams.md) +- [AppDeployMetadata](interfaces/AppDeployMetadata.md) +- [AppLookup](interfaces/AppLookup.md) +- [AppMetadata](interfaces/AppMetadata.md) +- [AppReference](interfaces/AppReference.md) +- [AppState](interfaces/AppState.md) +- [AppStorageSchema](interfaces/AppStorageSchema.md) +- [BoxName](interfaces/BoxName.md) +- [~~BoxReference~~](interfaces/BoxReference.md) +- [~~BoxValueRequestParams~~](interfaces/BoxValueRequestParams.md) +- [~~BoxValuesRequestParams~~](interfaces/BoxValuesRequestParams.md) +- [CompiledTeal](interfaces/CompiledTeal.md) +- [CoreAppCallArgs](interfaces/CoreAppCallArgs.md) +- [~~CreateAppParams~~](interfaces/CreateAppParams.md) +- [RawAppCallArgs](interfaces/RawAppCallArgs.md) +- [TealTemplateParams](interfaces/TealTemplateParams.md) +- [~~UpdateAppParams~~](interfaces/UpdateAppParams.md) + +## Type Aliases + +- [ABIAppCallArg](type-aliases/ABIAppCallArg.md) +- [ABIAppCallArgs](type-aliases/ABIAppCallArgs.md) +- [ABIReturn](type-aliases/ABIReturn.md) +- [AppCallArgs](type-aliases/AppCallArgs.md) +- [AppCallTransactionResult](type-aliases/AppCallTransactionResult.md) +- [~~AppCallType~~](type-aliases/AppCallType.md) +- [AppReturn](type-aliases/AppReturn.md) +- [~~BoxIdentifier~~](type-aliases/BoxIdentifier.md) +- [SendAppCreateTransactionResult](type-aliases/SendAppCreateTransactionResult.md) +- [SendAppTransactionResult](type-aliases/SendAppTransactionResult.md) +- [SendAppUpdateTransactionResult](type-aliases/SendAppUpdateTransactionResult.md) + +## Variables + +- [ABI\_RETURN\_PREFIX](variables/ABI_RETURN_PREFIX.md) +- [APP\_DEPLOY\_NOTE\_DAPP](variables/APP_DEPLOY_NOTE_DAPP.md) +- [APP\_PAGE\_MAX\_SIZE](variables/APP_PAGE_MAX_SIZE.md) +- [DELETABLE\_TEMPLATE\_NAME](variables/DELETABLE_TEMPLATE_NAME.md) +- [UPDATABLE\_TEMPLATE\_NAME](variables/UPDATABLE_TEMPLATE_NAME.md) diff --git a/docs/code/types/app/enumerations/OnSchemaBreak.md b/docs/code/types/app/enumerations/OnSchemaBreak.md new file mode 100644 index 00000000..8d8d38f9 --- /dev/null +++ b/docs/code/types/app/enumerations/OnSchemaBreak.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / OnSchemaBreak + +# Enumeration: OnSchemaBreak + +Defined in: [src/types/app.ts:300](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L300) + +What action to perform when deploying an app and a breaking schema change is detected + +## Enumeration Members + +### AppendApp + +> **AppendApp**: `2` + +Defined in: [src/types/app.ts:306](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L306) + +Create a new app + +*** + +### Fail + +> **Fail**: `0` + +Defined in: [src/types/app.ts:302](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L302) + +Fail the deployment + +*** + +### ReplaceApp + +> **ReplaceApp**: `1` + +Defined in: [src/types/app.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L304) + +Delete the app and create a new one in its place diff --git a/docs/code/types/app/enumerations/OnUpdate.md b/docs/code/types/app/enumerations/OnUpdate.md new file mode 100644 index 00000000..88f086be --- /dev/null +++ b/docs/code/types/app/enumerations/OnUpdate.md @@ -0,0 +1,51 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / OnUpdate + +# Enumeration: OnUpdate + +Defined in: [src/types/app.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L288) + +What action to perform when deploying an app and an update is detected in the TEAL code + +## Enumeration Members + +### AppendApp + +> **AppendApp**: `3` + +Defined in: [src/types/app.ts:296](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L296) + +Create a new app + +*** + +### Fail + +> **Fail**: `0` + +Defined in: [src/types/app.ts:290](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L290) + +Fail the deployment + +*** + +### ReplaceApp + +> **ReplaceApp**: `2` + +Defined in: [src/types/app.ts:294](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L294) + +Delete the app and create a new one in its place + +*** + +### UpdateApp + +> **UpdateApp**: `1` + +Defined in: [src/types/app.ts:292](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L292) + +Update the app diff --git a/docs/code/types/app/interfaces/AppCallParams.md b/docs/code/types/app/interfaces/AppCallParams.md new file mode 100644 index 00000000..450952b0 --- /dev/null +++ b/docs/code/types/app/interfaces/AppCallParams.md @@ -0,0 +1,188 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppCallParams + +# Interface: AppCallParams + +Defined in: [src/types/app.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L183) + +Parameters representing a call to an app. + +## Extends + +- [`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md) + +## Properties + +### appId + +> **appId**: `number` \| `bigint` + +Defined in: [src/types/app.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L185) + +The id of the app to call + +*** + +### args? + +> `optional` **args**: [`AppCallArgs`](../type-aliases/AppCallArgs.md) + +Defined in: [src/types/app.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L195) + +The arguments passed in to the app call + +*** + +### atc? + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`atc`](../../transaction/interfaces/SendTransactionParams.md#atc) + +*** + +### callType + +> **callType**: `"no_op"` \| `"opt_in"` \| `"close_out"` \| `"clear_state"` \| `"delete_application"` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `ClearStateOC` \| `DeleteApplicationOC` + +Defined in: [src/types/app.ts:187](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L187) + +The type of call, everything except create (see `createApp`) and update (see `updateApp`) + +*** + +### fee? + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`fee`](../../transaction/interfaces/SendTransactionParams.md#fee) + +*** + +### from + +> **from**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app.ts:189](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L189) + +The account to make the call from + +*** + +### maxFee? + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxFee`](../../transaction/interfaces/SendTransactionParams.md#maxfee) + +*** + +### maxRoundsToWaitForConfirmation? + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxRoundsToWaitForConfirmation`](../../transaction/interfaces/SendTransactionParams.md#maxroundstowaitforconfirmation) + +*** + +### note? + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/app.ts:193](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L193) + +The (optional) transaction note + +*** + +### populateAppCallResources? + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`populateAppCallResources`](../../transaction/interfaces/SendTransactionParams.md#populateappcallresources) + +*** + +### skipSending? + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipSending`](../../transaction/interfaces/SendTransactionParams.md#skipsending) + +*** + +### skipWaiting? + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipWaiting`](../../transaction/interfaces/SendTransactionParams.md#skipwaiting) + +*** + +### suppressLog? + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`suppressLog`](../../transaction/interfaces/SendTransactionParams.md#suppresslog) + +*** + +### transactionParams? + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/app.ts:191](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L191) + +Optional transaction parameters diff --git a/docs/code/types/app/interfaces/AppCallTransactionResultOfType.md b/docs/code/types/app/interfaces/AppCallTransactionResultOfType.md new file mode 100644 index 00000000..f7f5ea40 --- /dev/null +++ b/docs/code/types/app/interfaces/AppCallTransactionResultOfType.md @@ -0,0 +1,88 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppCallTransactionResultOfType + +# Interface: AppCallTransactionResultOfType\ + +Defined in: [src/types/app.ts:226](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L226) + +The result of preparing and/or sending multiple transactions + +## Extends + +- [`SendTransactionResults`](../../transaction/interfaces/SendTransactionResults.md).[`SendTransactionResult`](../../transaction/interfaces/SendTransactionResult.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### confirmation? + +> `optional` **confirmation**: `PendingTransactionResponse` + +Defined in: [src/types/transaction.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L57) + +The response if the transaction was sent and waited for + +#### Inherited from + +[`SendTransactionResult`](../../transaction/interfaces/SendTransactionResult.md).[`confirmation`](../../transaction/interfaces/SendTransactionResult.md#confirmation) + +*** + +### confirmations? + +> `optional` **confirmations**: `PendingTransactionResponse`[] + +Defined in: [src/types/transaction.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L67) + +The responses if the transactions were sent and waited for, +the index of the confirmation will match the index of the underlying transaction + +#### Inherited from + +[`SendTransactionResults`](../../transaction/interfaces/SendTransactionResults.md).[`confirmations`](../../transaction/interfaces/SendTransactionResults.md#confirmations) + +*** + +### return? + +> `optional` **return**: `T` + +Defined in: [src/types/app.ts:228](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L228) + +If an ABI method was called the processed return value + +*** + +### transaction + +> **transaction**: `Transaction` + +Defined in: [src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) + +The transaction + +#### Inherited from + +[`SendTransactionResult`](../../transaction/interfaces/SendTransactionResult.md).[`transaction`](../../transaction/interfaces/SendTransactionResult.md#transaction) + +*** + +### transactions + +> **transactions**: `Transaction`[] + +Defined in: [src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) + +The transactions that have been prepared and/or sent + +#### Inherited from + +[`SendTransactionResults`](../../transaction/interfaces/SendTransactionResults.md).[`transactions`](../../transaction/interfaces/SendTransactionResults.md#transactions) diff --git a/docs/code/types/app/interfaces/AppCompilationResult.md b/docs/code/types/app/interfaces/AppCompilationResult.md new file mode 100644 index 00000000..f6055767 --- /dev/null +++ b/docs/code/types/app/interfaces/AppCompilationResult.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppCompilationResult + +# Interface: AppCompilationResult + +Defined in: [src/types/app.ts:333](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L333) + +The result of compiling the approval and clear state TEAL programs for an app + +## Properties + +### compiledApproval + +> **compiledApproval**: [`CompiledTeal`](CompiledTeal.md) + +Defined in: [src/types/app.ts:335](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L335) + +The result of compiling the approval program + +*** + +### compiledClear + +> **compiledClear**: [`CompiledTeal`](CompiledTeal.md) + +Defined in: [src/types/app.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L337) + +The result of compiling the clear state program diff --git a/docs/code/types/app/interfaces/AppDeployMetadata.md b/docs/code/types/app/interfaces/AppDeployMetadata.md new file mode 100644 index 00000000..5afd5a04 --- /dev/null +++ b/docs/code/types/app/interfaces/AppDeployMetadata.md @@ -0,0 +1,56 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppDeployMetadata + +# Interface: AppDeployMetadata + +Defined in: [src/types/app.ts:247](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L247) + +The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with `APP_DEPLOY_NOTE_PREFIX`. + +## Extended by + +- [`AppMetadata`](../../app-deployer/interfaces/AppMetadata.md) +- [`AppMetadata`](AppMetadata.md) + +## Properties + +### deletable? + +> `optional` **deletable**: `boolean` + +Defined in: [src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) + +Whether or not the app is deletable / permanent / unspecified + +*** + +### name + +> **name**: `string` + +Defined in: [src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249) + +The unique name identifier of the app within the creator account + +*** + +### updatable? + +> `optional` **updatable**: `boolean` + +Defined in: [src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255) + +Whether or not the app is updatable / immutable / unspecified + +*** + +### version + +> **version**: `string` + +Defined in: [src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251) + +The version of app that is / will be deployed diff --git a/docs/code/types/app/interfaces/AppDeploymentParams.md b/docs/code/types/app/interfaces/AppDeploymentParams.md new file mode 100644 index 00000000..b832102b --- /dev/null +++ b/docs/code/types/app/interfaces/AppDeploymentParams.md @@ -0,0 +1,245 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppDeploymentParams + +# Interface: AppDeploymentParams + +Defined in: [src/types/app.ts:310](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L310) + +The parameters to deploy an app + +## Extends + +- `Omit`\<[`CreateAppParams`](CreateAppParams.md), `"onCompleteAction"` \| `"args"` \| `"note"` \| `"skipSending"` \| `"skipWaiting"` \| `"atc"`\> + +## Properties + +### approvalProgram + +> **approvalProgram**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/app.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L135) + +The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) + +#### Inherited from + +`Omit.approvalProgram` + +*** + +### clearStateProgram + +> **clearStateProgram**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/app.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L137) + +The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) + +#### Inherited from + +`Omit.clearStateProgram` + +*** + +### createArgs? + +> `optional` **createArgs**: [`AppCallArgs`](../type-aliases/AppCallArgs.md) + +Defined in: [src/types/app.ts:323](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L323) + +Any args to pass to any create transaction that is issued as part of deployment + +*** + +### createOnCompleteAction? + +> `optional` **createOnCompleteAction**: `"no_op"` \| `"opt_in"` \| `"close_out"` \| `"update_application"` \| `"delete_application"` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +Defined in: [src/types/app.ts:325](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L325) + +Override the on-completion action for the create call; defaults to NoOp + +*** + +### deleteArgs? + +> `optional` **deleteArgs**: [`AppCallArgs`](../type-aliases/AppCallArgs.md) + +Defined in: [src/types/app.ts:329](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L329) + +Any args to pass to any delete transaction that is issued as part of deployment + +*** + +### deployTimeParams? + +> `optional` **deployTimeParams**: [`TealTemplateParams`](TealTemplateParams.md) + +Defined in: [src/types/app.ts:315](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L315) + +Any deploy-time parameters to replace in the TEAL code + +*** + +### existingDeployments? + +> `optional` **existingDeployments**: [`AppLookup`](AppLookup.md) + +Defined in: [src/types/app.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L321) + +Optional cached value of the existing apps for the given creator + +*** + +### fee? + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +`Omit.fee` + +*** + +### from + +> **from**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L133) + +The account (with private key loaded) that will send the transaction + +#### Inherited from + +`Omit.from` + +*** + +### maxFee? + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +`Omit.maxFee` + +*** + +### maxRoundsToWaitForConfirmation? + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +`Omit.maxRoundsToWaitForConfirmation` + +*** + +### metadata + +> **metadata**: [`AppDeployMetadata`](AppDeployMetadata.md) + +Defined in: [src/types/app.ts:313](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L313) + +The deployment metadata + +*** + +### onSchemaBreak? + +> `optional` **onSchemaBreak**: [`OnSchemaBreak`](../enumerations/OnSchemaBreak.md) \| `"replace"` \| `"fail"` \| `"append"` + +Defined in: [src/types/app.ts:317](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L317) + +What action to perform if a schema break is detected + +*** + +### onUpdate? + +> `optional` **onUpdate**: `"replace"` \| `"fail"` \| `"append"` \| [`OnUpdate`](../enumerations/OnUpdate.md) \| `"update"` + +Defined in: [src/types/app.ts:319](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L319) + +What action to perform if a TEAL update is detected + +*** + +### populateAppCallResources? + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +`Omit.populateAppCallResources` + +*** + +### schema + +> **schema**: [`AppStorageSchema`](AppStorageSchema.md) + +Defined in: [src/types/app.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L152) + +The storage schema to request for the created app + +#### Inherited from + +`Omit.schema` + +*** + +### suppressLog? + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +`Omit.suppressLog` + +*** + +### transactionParams? + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/app.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L139) + +Optional transaction parameters + +#### Inherited from + +`Omit.transactionParams` + +*** + +### updateArgs? + +> `optional` **updateArgs**: [`AppCallArgs`](../type-aliases/AppCallArgs.md) + +Defined in: [src/types/app.ts:327](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L327) + +Any args to pass to any update transaction that is issued as part of deployment diff --git a/docs/code/types/app/interfaces/AppLookup.md b/docs/code/types/app/interfaces/AppLookup.md new file mode 100644 index 00000000..8cd7b11e --- /dev/null +++ b/docs/code/types/app/interfaces/AppLookup.md @@ -0,0 +1,27 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppLookup + +# Interface: AppLookup + +Defined in: [src/types/app.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L271) + +A lookup of name -> Algorand app for a creator + +## Properties + +### apps + +> **apps**: `Readonly`\<\{[`name`: `string`]: [`AppMetadata`](AppMetadata.md); \}\> + +Defined in: [src/types/app.ts:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L273) + +*** + +### creator + +> **creator**: `string` + +Defined in: [src/types/app.ts:272](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L272) diff --git a/docs/code/types/app/interfaces/AppMetadata.md b/docs/code/types/app/interfaces/AppMetadata.md new file mode 100644 index 00000000..7d2d9283 --- /dev/null +++ b/docs/code/types/app/interfaces/AppMetadata.md @@ -0,0 +1,139 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppMetadata + +# Interface: AppMetadata + +Defined in: [src/types/app.ts:259](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L259) + +The metadata that can be collected about a deployed app + +## Extends + +- [`AppReference`](AppReference.md).[`AppDeployMetadata`](AppDeployMetadata.md) + +## Properties + +### appAddress + +> **appAddress**: `string` + +Defined in: [src/types/app.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L43) + +The Algorand address of the account associated with the app + +#### Inherited from + +[`AppReference`](AppReference.md).[`appAddress`](AppReference.md#appaddress) + +*** + +### appId + +> **appId**: `number` \| `bigint` + +Defined in: [src/types/app.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L41) + +The id of the app + +#### Inherited from + +[`AppReference`](AppReference.md).[`appId`](AppReference.md#appid) + +*** + +### createdMetadata + +> **createdMetadata**: [`AppDeployMetadata`](AppDeployMetadata.md) + +Defined in: [src/types/app.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L265) + +The metadata when the app was created + +*** + +### createdRound + +> **createdRound**: `number` + +Defined in: [src/types/app.ts:261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L261) + +The round the app was created + +*** + +### deletable? + +> `optional` **deletable**: `boolean` + +Defined in: [src/types/app.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L253) + +Whether or not the app is deletable / permanent / unspecified + +#### Inherited from + +[`AppDeployMetadata`](AppDeployMetadata.md).[`deletable`](AppDeployMetadata.md#deletable) + +*** + +### deleted + +> **deleted**: `boolean` + +Defined in: [src/types/app.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L267) + +Whether or not the app is deleted + +*** + +### name + +> **name**: `string` + +Defined in: [src/types/app.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L249) + +The unique name identifier of the app within the creator account + +#### Inherited from + +[`AppDeployMetadata`](AppDeployMetadata.md).[`name`](AppDeployMetadata.md#name) + +*** + +### updatable? + +> `optional` **updatable**: `boolean` + +Defined in: [src/types/app.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L255) + +Whether or not the app is updatable / immutable / unspecified + +#### Inherited from + +[`AppDeployMetadata`](AppDeployMetadata.md).[`updatable`](AppDeployMetadata.md#updatable) + +*** + +### updatedRound + +> **updatedRound**: `number` + +Defined in: [src/types/app.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L263) + +The last round that the app was updated + +*** + +### version + +> **version**: `string` + +Defined in: [src/types/app.ts:251](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L251) + +The version of app that is / will be deployed + +#### Inherited from + +[`AppDeployMetadata`](AppDeployMetadata.md).[`version`](AppDeployMetadata.md#version) diff --git a/docs/code/types/app/interfaces/AppReference.md b/docs/code/types/app/interfaces/AppReference.md new file mode 100644 index 00000000..6c7a2364 --- /dev/null +++ b/docs/code/types/app/interfaces/AppReference.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppReference + +# Interface: AppReference + +Defined in: [src/types/app.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L39) + +Information about an Algorand app + +## Extended by + +- [`AppMetadata`](AppMetadata.md) + +## Properties + +### appAddress + +> **appAddress**: `string` + +Defined in: [src/types/app.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L43) + +The Algorand address of the account associated with the app + +*** + +### appId + +> **appId**: `number` \| `bigint` + +Defined in: [src/types/app.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L41) + +The id of the app diff --git a/docs/code/types/app/interfaces/AppState.md b/docs/code/types/app/interfaces/AppState.md new file mode 100644 index 00000000..c3fa29de --- /dev/null +++ b/docs/code/types/app/interfaces/AppState.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppState + +# Interface: AppState + +Defined in: [src/types/app.ts:367](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L367) + +Object holding app state values + +## Indexable + +\[`key`: `string`\]: \{ `keyBase64`: `string`; `keyRaw`: `Uint8Array`; `value`: `bigint`; \} \| \{ `keyBase64`: `string`; `keyRaw`: `Uint8Array`; `value`: `string`; `valueBase64`: `string`; `valueRaw`: `Uint8Array`; \} diff --git a/docs/code/types/app/interfaces/AppStorageSchema.md b/docs/code/types/app/interfaces/AppStorageSchema.md new file mode 100644 index 00000000..2247c310 --- /dev/null +++ b/docs/code/types/app/interfaces/AppStorageSchema.md @@ -0,0 +1,61 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppStorageSchema + +# Interface: AppStorageSchema + +Defined in: [src/types/app.ts:199](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L199) + +Parameters representing the storage schema of an app. + +## Properties + +### extraPages? + +> `optional` **extraPages**: `number` + +Defined in: [src/types/app.ts:209](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L209) + +Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size + +*** + +### globalByteSlices + +> **globalByteSlices**: `number` + +Defined in: [src/types/app.ts:207](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L207) + +Restricts number of byte slices in global state + +*** + +### globalInts + +> **globalInts**: `number` + +Defined in: [src/types/app.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L205) + +Restricts number of ints in global state + +*** + +### localByteSlices + +> **localByteSlices**: `number` + +Defined in: [src/types/app.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L203) + +Restricts number of byte slices in per-user local state + +*** + +### localInts + +> **localInts**: `number` + +Defined in: [src/types/app.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L201) + +Restricts number of ints in per-user local state diff --git a/docs/code/types/app/interfaces/BoxName.md b/docs/code/types/app/interfaces/BoxName.md new file mode 100644 index 00000000..d9212553 --- /dev/null +++ b/docs/code/types/app/interfaces/BoxName.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / BoxName + +# Interface: BoxName + +Defined in: [src/types/app.ts:385](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L385) + +The name of a box storage box + +## Properties + +### name + +> **name**: `string` + +Defined in: [src/types/app.ts:387](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L387) + +Name in UTF-8 + +*** + +### nameBase64 + +> **nameBase64**: `string` + +Defined in: [src/types/app.ts:391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L391) + +Name in Base64 + +*** + +### nameRaw + +> **nameRaw**: `Uint8Array` + +Defined in: [src/types/app.ts:389](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L389) + +Name in binary bytes diff --git a/docs/code/types/app/interfaces/BoxReference.md b/docs/code/types/app/interfaces/BoxReference.md new file mode 100644 index 00000000..0b0264b1 --- /dev/null +++ b/docs/code/types/app/interfaces/BoxReference.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / BoxReference + +# Interface: ~~BoxReference~~ + +Defined in: [src/types/app.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L51) + +## Deprecated + +Use `types/app-manager/BoxReference` instead. + +A grouping of the app ID and name of the box in an Uint8Array + +## Properties + +### ~~appId~~ + +> **appId**: `number` \| `bigint` + +Defined in: [src/types/app.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L55) + +A unique application id + +*** + +### ~~name~~ + +> **name**: [`BoxIdentifier`](../type-aliases/BoxIdentifier.md) + +Defined in: [src/types/app.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L59) + +Name of box to reference diff --git a/docs/code/types/app/interfaces/BoxValueRequestParams.md b/docs/code/types/app/interfaces/BoxValueRequestParams.md new file mode 100644 index 00000000..2403ed54 --- /dev/null +++ b/docs/code/types/app/interfaces/BoxValueRequestParams.md @@ -0,0 +1,44 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / BoxValueRequestParams + +# Interface: ~~BoxValueRequestParams~~ + +Defined in: [src/types/app.ts:398](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L398) + +## Deprecated + +Use `types/app-manager/BoxValueRequestParams` instead. +Parameters to get and decode a box value as an ABI type. + +## Properties + +### ~~appId~~ + +> **appId**: `number` \| `bigint` + +Defined in: [src/types/app.ts:400](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L400) + +The ID of the app return box names for + +*** + +### ~~boxName~~ + +> **boxName**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`BoxName`](BoxName.md) + +Defined in: [src/types/app.ts:402](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L402) + +The name of the box to return either as a string, binary array or `BoxName` + +*** + +### ~~type~~ + +> **type**: `ABIType` + +Defined in: [src/types/app.ts:404](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L404) + +The ABI type to decode the value using diff --git a/docs/code/types/app/interfaces/BoxValuesRequestParams.md b/docs/code/types/app/interfaces/BoxValuesRequestParams.md new file mode 100644 index 00000000..dd4680d3 --- /dev/null +++ b/docs/code/types/app/interfaces/BoxValuesRequestParams.md @@ -0,0 +1,44 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / BoxValuesRequestParams + +# Interface: ~~BoxValuesRequestParams~~ + +Defined in: [src/types/app.ts:411](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L411) + +## Deprecated + +Use `types/app-manager/BoxValuesRequestParams` instead. +Parameters to get and decode a box value as an ABI type. + +## Properties + +### ~~appId~~ + +> **appId**: `number` + +Defined in: [src/types/app.ts:413](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L413) + +The ID of the app return box names for + +*** + +### ~~boxNames~~ + +> **boxNames**: (`string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`BoxName`](BoxName.md))[] + +Defined in: [src/types/app.ts:415](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L415) + +The names of the boxes to return either as a string, binary array or BoxName` + +*** + +### ~~type~~ + +> **type**: `ABIType` + +Defined in: [src/types/app.ts:417](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L417) + +The ABI type to decode the value using diff --git a/docs/code/types/app/interfaces/CompiledTeal.md b/docs/code/types/app/interfaces/CompiledTeal.md new file mode 100644 index 00000000..f84e4b87 --- /dev/null +++ b/docs/code/types/app/interfaces/CompiledTeal.md @@ -0,0 +1,61 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / CompiledTeal + +# Interface: CompiledTeal + +Defined in: [src/types/app.ts:213](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L213) + +Information about a compiled teal program + +## Properties + +### compiled + +> **compiled**: `string` + +Defined in: [src/types/app.ts:217](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L217) + +The compiled code + +*** + +### compiledBase64ToBytes + +> **compiledBase64ToBytes**: `Uint8Array` + +Defined in: [src/types/app.ts:221](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L221) + +The base64 encoded code as a byte array + +*** + +### compiledHash + +> **compiledHash**: `string` + +Defined in: [src/types/app.ts:219](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L219) + +The hash returned by the compiler + +*** + +### sourceMap + +> **sourceMap**: `ProgramSourceMap` + +Defined in: [src/types/app.ts:223](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L223) + +Source map from the compilation + +*** + +### teal + +> **teal**: `string` + +Defined in: [src/types/app.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L215) + +Original TEAL code diff --git a/docs/code/types/app/interfaces/CoreAppCallArgs.md b/docs/code/types/app/interfaces/CoreAppCallArgs.md new file mode 100644 index 00000000..d64d1119 --- /dev/null +++ b/docs/code/types/app/interfaces/CoreAppCallArgs.md @@ -0,0 +1,77 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / CoreAppCallArgs + +# Interface: CoreAppCallArgs + +Defined in: [src/types/app.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L73) + +Common app call arguments for ABI and non-ABI (raw) calls + +## Extended by + +- [`RawAppCallArgs`](RawAppCallArgs.md) + +## Properties + +### accounts? + +> `optional` **accounts**: (`string` \| `Address`)[] + +Defined in: [src/types/app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L79) + +The address of any accounts to load in + +*** + +### apps? + +> `optional` **apps**: `number`[] + +Defined in: [src/types/app.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L81) + +IDs of any apps to load into the foreignApps array + +*** + +### assets? + +> `optional` **assets**: `number`[] + +Defined in: [src/types/app.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L83) + +IDs of any assets to load into the foreignAssets array + +*** + +### boxes? + +> `optional` **boxes**: ([`BoxReference`](BoxReference.md) \| [`BoxIdentifier`](../type-aliases/BoxIdentifier.md) \| `BoxReference`)[] + +Defined in: [src/types/app.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L77) + +Any box references to load + +*** + +### lease? + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75) + +The optional lease for the transaction + +*** + +### rekeyTo? + +> `optional` **rekeyTo**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L88) + +Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction. + +**Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first. diff --git a/docs/code/types/app/interfaces/CreateAppParams.md b/docs/code/types/app/interfaces/CreateAppParams.md new file mode 100644 index 00000000..b2386dd7 --- /dev/null +++ b/docs/code/types/app/interfaces/CreateAppParams.md @@ -0,0 +1,236 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / CreateAppParams + +# Interface: ~~CreateAppParams~~ + +Defined in: [src/types/app.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L150) + +## Deprecated + +Use `TransactionComposer` to construct create app transactions instead. + +Parameters that are passed in when creating an app. + +## Extends + +- `CreateOrUpdateAppParams` + +## Properties + +### ~~approvalProgram~~ + +> **approvalProgram**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/app.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L135) + +The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) + +#### Inherited from + +`CreateOrUpdateAppParams.approvalProgram` + +*** + +### ~~args?~~ + +> `optional` **args**: [`AppCallArgs`](../type-aliases/AppCallArgs.md) + +Defined in: [src/types/app.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L143) + +The arguments passed in to the app call + +#### Inherited from + +`CreateOrUpdateAppParams.args` + +*** + +### ~~atc?~~ + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +`CreateOrUpdateAppParams.atc` + +*** + +### ~~clearStateProgram~~ + +> **clearStateProgram**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/app.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L137) + +The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) + +#### Inherited from + +`CreateOrUpdateAppParams.clearStateProgram` + +*** + +### ~~fee?~~ + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +`CreateOrUpdateAppParams.fee` + +*** + +### ~~from~~ + +> **from**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L133) + +The account (with private key loaded) that will send the transaction + +#### Inherited from + +`CreateOrUpdateAppParams.from` + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +`CreateOrUpdateAppParams.maxFee` + +*** + +### ~~maxRoundsToWaitForConfirmation?~~ + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +`CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation` + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/app.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L141) + +The (optional) transaction note + +#### Inherited from + +`CreateOrUpdateAppParams.note` + +*** + +### ~~onCompleteAction?~~ + +> `optional` **onCompleteAction**: `"no_op"` \| `"opt_in"` \| `"close_out"` \| `"update_application"` \| `"delete_application"` \| `NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +Defined in: [src/types/app.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L154) + +Override the on-completion action for the create call; defaults to NoOp + +*** + +### ~~populateAppCallResources?~~ + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +`CreateOrUpdateAppParams.populateAppCallResources` + +*** + +### ~~schema~~ + +> **schema**: [`AppStorageSchema`](AppStorageSchema.md) + +Defined in: [src/types/app.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L152) + +The storage schema to request for the created app + +*** + +### ~~skipSending?~~ + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +`CreateOrUpdateAppParams.skipSending` + +*** + +### ~~skipWaiting?~~ + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +`CreateOrUpdateAppParams.skipWaiting` + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +`CreateOrUpdateAppParams.suppressLog` + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/app.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L139) + +Optional transaction parameters + +#### Inherited from + +`CreateOrUpdateAppParams.transactionParams` diff --git a/docs/code/types/app/interfaces/RawAppCallArgs.md b/docs/code/types/app/interfaces/RawAppCallArgs.md new file mode 100644 index 00000000..15358e2c --- /dev/null +++ b/docs/code/types/app/interfaces/RawAppCallArgs.md @@ -0,0 +1,121 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / RawAppCallArgs + +# Interface: RawAppCallArgs + +Defined in: [src/types/app.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L94) + +App call args with non-ABI (raw) values (minus some processing like encoding strings as binary) + +## Extends + +- [`CoreAppCallArgs`](CoreAppCallArgs.md) + +## Properties + +### accounts? + +> `optional` **accounts**: (`string` \| `Address`)[] + +Defined in: [src/types/app.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L79) + +The address of any accounts to load in + +#### Inherited from + +[`CoreAppCallArgs`](CoreAppCallArgs.md).[`accounts`](CoreAppCallArgs.md#accounts) + +*** + +### appArgs? + +> `optional` **appArgs**: (`string` \| `Uint8Array`\<`ArrayBufferLike`\>)[] + +Defined in: [src/types/app.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L96) + +Any application arguments to pass through + +*** + +### apps? + +> `optional` **apps**: `number`[] + +Defined in: [src/types/app.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L81) + +IDs of any apps to load into the foreignApps array + +#### Inherited from + +[`CoreAppCallArgs`](CoreAppCallArgs.md).[`apps`](CoreAppCallArgs.md#apps) + +*** + +### assets? + +> `optional` **assets**: `number`[] + +Defined in: [src/types/app.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L83) + +IDs of any assets to load into the foreignAssets array + +#### Inherited from + +[`CoreAppCallArgs`](CoreAppCallArgs.md).[`assets`](CoreAppCallArgs.md#assets) + +*** + +### boxes? + +> `optional` **boxes**: ([`BoxReference`](BoxReference.md) \| [`BoxIdentifier`](../type-aliases/BoxIdentifier.md) \| `BoxReference`)[] + +Defined in: [src/types/app.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L77) + +Any box references to load + +#### Inherited from + +[`CoreAppCallArgs`](CoreAppCallArgs.md).[`boxes`](CoreAppCallArgs.md#boxes) + +*** + +### lease? + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/app.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L75) + +The optional lease for the transaction + +#### Inherited from + +[`CoreAppCallArgs`](CoreAppCallArgs.md).[`lease`](CoreAppCallArgs.md#lease) + +*** + +### method? + +> `optional` **method**: `undefined` + +Defined in: [src/types/app.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L98) + +Property to aid intellisense + +*** + +### rekeyTo? + +> `optional` **rekeyTo**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L88) + +Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction. + +**Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first. + +#### Inherited from + +[`CoreAppCallArgs`](CoreAppCallArgs.md).[`rekeyTo`](CoreAppCallArgs.md#rekeyto) diff --git a/docs/code/types/app/interfaces/TealTemplateParams.md b/docs/code/types/app/interfaces/TealTemplateParams.md new file mode 100644 index 00000000..9c856428 --- /dev/null +++ b/docs/code/types/app/interfaces/TealTemplateParams.md @@ -0,0 +1,17 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / TealTemplateParams + +# Interface: TealTemplateParams + +Defined in: [src/types/app.ts:283](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L283) + +Dictionary of deploy-time parameters to replace in a teal template. + +Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`. + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `bigint` \| `Uint8Array`\<`ArrayBufferLike`\> diff --git a/docs/code/types/app/interfaces/UpdateAppParams.md b/docs/code/types/app/interfaces/UpdateAppParams.md new file mode 100644 index 00000000..11a5f314 --- /dev/null +++ b/docs/code/types/app/interfaces/UpdateAppParams.md @@ -0,0 +1,226 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / UpdateAppParams + +# Interface: ~~UpdateAppParams~~ + +Defined in: [src/types/app.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L161) + +## Deprecated + +Use `TransactionComposer` to construct update app transactions instead. + +Parameters that are passed in when updating an app. + +## Extends + +- `CreateOrUpdateAppParams` + +## Properties + +### ~~appId~~ + +> **appId**: `number` \| `bigint` + +Defined in: [src/types/app.ts:163](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L163) + +The id of the app to update + +*** + +### ~~approvalProgram~~ + +> **approvalProgram**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/app.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L135) + +The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) + +#### Inherited from + +`CreateOrUpdateAppParams.approvalProgram` + +*** + +### ~~args?~~ + +> `optional` **args**: [`AppCallArgs`](../type-aliases/AppCallArgs.md) + +Defined in: [src/types/app.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L143) + +The arguments passed in to the app call + +#### Inherited from + +`CreateOrUpdateAppParams.args` + +*** + +### ~~atc?~~ + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +`CreateOrUpdateAppParams.atc` + +*** + +### ~~clearStateProgram~~ + +> **clearStateProgram**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/app.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L137) + +The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) + +#### Inherited from + +`CreateOrUpdateAppParams.clearStateProgram` + +*** + +### ~~fee?~~ + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +`CreateOrUpdateAppParams.fee` + +*** + +### ~~from~~ + +> **from**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L133) + +The account (with private key loaded) that will send the transaction + +#### Inherited from + +`CreateOrUpdateAppParams.from` + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +`CreateOrUpdateAppParams.maxFee` + +*** + +### ~~maxRoundsToWaitForConfirmation?~~ + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +`CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation` + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/app.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L141) + +The (optional) transaction note + +#### Inherited from + +`CreateOrUpdateAppParams.note` + +*** + +### ~~populateAppCallResources?~~ + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +`CreateOrUpdateAppParams.populateAppCallResources` + +*** + +### ~~skipSending?~~ + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +`CreateOrUpdateAppParams.skipSending` + +*** + +### ~~skipWaiting?~~ + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +`CreateOrUpdateAppParams.skipWaiting` + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +`CreateOrUpdateAppParams.suppressLog` + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/app.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L139) + +Optional transaction parameters + +#### Inherited from + +`CreateOrUpdateAppParams.transactionParams` diff --git a/docs/code/types/app/type-aliases/ABIAppCallArg.md b/docs/code/types/app/type-aliases/ABIAppCallArg.md new file mode 100644 index 00000000..81578252 --- /dev/null +++ b/docs/code/types/app/type-aliases/ABIAppCallArg.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / ABIAppCallArg + +# Type Alias: ABIAppCallArg + +> **ABIAppCallArg** = `ABIArgument` \| [`TransactionToSign`](../../transaction/interfaces/TransactionToSign.md) \| `Transaction` \| `Promise`\<[`SendTransactionResult`](../../transaction/interfaces/SendTransactionResult.md)\> \| [`SendTransactionResult`](../../transaction/interfaces/SendTransactionResult.md) \| `undefined` + +Defined in: [src/types/app.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L102) + +An argument for an ABI method, either a primitive value, or a transaction with or without signer, or the unawaited async return value of an algokit method that returns a `SendTransactionResult` diff --git a/docs/code/types/app/type-aliases/ABIAppCallArgs.md b/docs/code/types/app/type-aliases/ABIAppCallArgs.md new file mode 100644 index 00000000..ddc9be06 --- /dev/null +++ b/docs/code/types/app/type-aliases/ABIAppCallArgs.md @@ -0,0 +1,27 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / ABIAppCallArgs + +# Type Alias: ABIAppCallArgs + +> **ABIAppCallArgs** = [`CoreAppCallArgs`](../interfaces/CoreAppCallArgs.md) & `object` + +Defined in: [src/types/app.ts:113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L113) + +App call args for an ABI call + +## Type declaration + +### method + +> **method**: `ABIMethodParams` \| `ABIMethod` + +The ABI method to call + +### methodArgs + +> **methodArgs**: [`ABIAppCallArg`](ABIAppCallArg.md)[] + +The ABI method args to pass in diff --git a/docs/code/types/app/type-aliases/ABIReturn.md b/docs/code/types/app/type-aliases/ABIReturn.md new file mode 100644 index 00000000..3213dfac --- /dev/null +++ b/docs/code/types/app/type-aliases/ABIReturn.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / ABIReturn + +# Type Alias: ABIReturn + +> **ABIReturn** = \{ `decodeError`: `undefined`; `method`: `ABIMethod`; `rawReturnValue`: `Uint8Array`; `returnValue`: `ABIValue`; \} \| \{ `decodeError`: `Error`; `method?`: `undefined`; `rawReturnValue?`: `undefined`; `returnValue?`: `undefined`; \} + +Defined in: [src/types/app.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L235) + +The return value of an ABI method call diff --git a/docs/code/types/app/type-aliases/AppCallArgs.md b/docs/code/types/app/type-aliases/AppCallArgs.md new file mode 100644 index 00000000..df934036 --- /dev/null +++ b/docs/code/types/app/type-aliases/AppCallArgs.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppCallArgs + +# Type Alias: AppCallArgs + +> **AppCallArgs** = [`RawAppCallArgs`](../interfaces/RawAppCallArgs.md) \| [`ABIAppCallArgs`](ABIAppCallArgs.md) + +Defined in: [src/types/app.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L124) + +Arguments to pass to an app call either: + * The raw app call values to pass through into the transaction (after processing); or + * An ABI method definition (method and args) diff --git a/docs/code/types/app/type-aliases/AppCallTransactionResult.md b/docs/code/types/app/type-aliases/AppCallTransactionResult.md new file mode 100644 index 00000000..973aabdc --- /dev/null +++ b/docs/code/types/app/type-aliases/AppCallTransactionResult.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppCallTransactionResult + +# Type Alias: AppCallTransactionResult + +> **AppCallTransactionResult** = [`AppCallTransactionResultOfType`](../interfaces/AppCallTransactionResultOfType.md)\<[`ABIReturn`](ABIReturn.md)\> + +Defined in: [src/types/app.ts:232](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L232) + +Result from calling an app diff --git a/docs/code/types/app/type-aliases/AppCallType.md b/docs/code/types/app/type-aliases/AppCallType.md new file mode 100644 index 00000000..a7d06a3d --- /dev/null +++ b/docs/code/types/app/type-aliases/AppCallType.md @@ -0,0 +1,26 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppCallType + +# Type Alias: ~~AppCallType~~ + +> **AppCallType** = `"no_op"` \| `"opt_in"` \| `"close_out"` \| `"clear_state"` \| `"update_application"` \| `"delete_application"` + +Defined in: [src/types/app.ts:180](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L180) + +## Deprecated + +Use `algosdk.OnApplicationComplete` directly instead. + +The type of call / [on-completion action](https://dev.algorand.co/concepts/smart-contracts/overview#smart-contract-lifecycle) for a smart contract call. + +Equivalent of `algosdk.OnApplicationComplete`, but as a more convenient string enum. + +* `no_op`: Normal smart contract call, no special on-complete action +* `opt_in`: Opt-in to smart contract local storage +* `close_out`: Close-out local storage storage +* `clear_state`: Clear local storage state +* `update_application`: Update the smart contract +* `delete_application`: Delete the smart contract diff --git a/docs/code/types/app/type-aliases/AppReturn.md b/docs/code/types/app/type-aliases/AppReturn.md new file mode 100644 index 00000000..92996716 --- /dev/null +++ b/docs/code/types/app/type-aliases/AppReturn.md @@ -0,0 +1,27 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / AppReturn + +# Type Alias: AppReturn\ + +> **AppReturn**\<`TReturn`\> = `object` + +Defined in: [src/types/app.ts:340](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L340) + +## Type Parameters + +### TReturn + +`TReturn` + +## Properties + +### return? + +> `optional` **return**: `TReturn` + +Defined in: [src/types/app.ts:342](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L342) + +The ABI method call return value diff --git a/docs/code/types/app/type-aliases/BoxIdentifier.md b/docs/code/types/app/type-aliases/BoxIdentifier.md new file mode 100644 index 00000000..6e924ad5 --- /dev/null +++ b/docs/code/types/app/type-aliases/BoxIdentifier.md @@ -0,0 +1,20 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / BoxIdentifier + +# Type Alias: ~~BoxIdentifier~~ + +> **BoxIdentifier** = `string` \| `Uint8Array` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/app.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L70) + +## Deprecated + +Use `types/app-manager/BoxIdentifier` instead. + +Something that identifies a box name - either a: + * `Uint8Array` + * `string` (that will be encoded to a Uint8Array) + * `SendTransactionFrom` (encoded into the public key address of the corresponding account) diff --git a/docs/code/types/app/type-aliases/SendAppCreateTransactionResult.md b/docs/code/types/app/type-aliases/SendAppCreateTransactionResult.md new file mode 100644 index 00000000..748e45a6 --- /dev/null +++ b/docs/code/types/app/type-aliases/SendAppCreateTransactionResult.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / SendAppCreateTransactionResult + +# Type Alias: SendAppCreateTransactionResult + +> **SendAppCreateTransactionResult** = [`Expand`](../../expand/type-aliases/Expand.md)\<[`SendAppUpdateTransactionResult`](SendAppUpdateTransactionResult.md) & `object`\> + +Defined in: [src/types/app.ts:357](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L357) + +Result from sending a single app transaction. diff --git a/docs/code/types/app/type-aliases/SendAppTransactionResult.md b/docs/code/types/app/type-aliases/SendAppTransactionResult.md new file mode 100644 index 00000000..86b2c61d --- /dev/null +++ b/docs/code/types/app/type-aliases/SendAppTransactionResult.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / SendAppTransactionResult + +# Type Alias: SendAppTransactionResult + +> **SendAppTransactionResult** = [`Expand`](../../expand/type-aliases/Expand.md)\<[`SendSingleTransactionResult`](../../transaction/type-aliases/SendSingleTransactionResult.md) & `object`\> + +Defined in: [src/types/app.ts:346](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L346) + +Result from sending a single app transaction. diff --git a/docs/code/types/app/type-aliases/SendAppUpdateTransactionResult.md b/docs/code/types/app/type-aliases/SendAppUpdateTransactionResult.md new file mode 100644 index 00000000..364e27fd --- /dev/null +++ b/docs/code/types/app/type-aliases/SendAppUpdateTransactionResult.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / SendAppUpdateTransactionResult + +# Type Alias: SendAppUpdateTransactionResult + +> **SendAppUpdateTransactionResult** = [`Expand`](../../expand/type-aliases/Expand.md)\<[`SendAppTransactionResult`](SendAppTransactionResult.md) & `Partial`\<[`AppCompilationResult`](../interfaces/AppCompilationResult.md)\>\> + +Defined in: [src/types/app.ts:354](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L354) + +Result from sending a single app transaction. diff --git a/docs/code/types/app/variables/ABI_RETURN_PREFIX.md b/docs/code/types/app/variables/ABI_RETURN_PREFIX.md new file mode 100644 index 00000000..302fb087 --- /dev/null +++ b/docs/code/types/app/variables/ABI_RETURN_PREFIX.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / ABI\_RETURN\_PREFIX + +# Variable: ABI\_RETURN\_PREFIX + +> `const` **ABI\_RETURN\_PREFIX**: `Uint8Array`\<`ArrayBuffer`\> + +Defined in: [src/types/app.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L36) + +First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values diff --git a/docs/code/types/app/variables/APP_DEPLOY_NOTE_DAPP.md b/docs/code/types/app/variables/APP_DEPLOY_NOTE_DAPP.md new file mode 100644 index 00000000..e4f05ea7 --- /dev/null +++ b/docs/code/types/app/variables/APP_DEPLOY_NOTE_DAPP.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / APP\_DEPLOY\_NOTE\_DAPP + +# Variable: APP\_DEPLOY\_NOTE\_DAPP + +> `const` **APP\_DEPLOY\_NOTE\_DAPP**: `"ALGOKIT_DEPLOYER"` = `'ALGOKIT_DEPLOYER'` + +Defined in: [src/types/app.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L30) + +The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix diff --git a/docs/code/types/app/variables/APP_PAGE_MAX_SIZE.md b/docs/code/types/app/variables/APP_PAGE_MAX_SIZE.md new file mode 100644 index 00000000..f07d0232 --- /dev/null +++ b/docs/code/types/app/variables/APP_PAGE_MAX_SIZE.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / APP\_PAGE\_MAX\_SIZE + +# Variable: APP\_PAGE\_MAX\_SIZE + +> `const` **APP\_PAGE\_MAX\_SIZE**: `2048` = `2048` + +Defined in: [src/types/app.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L33) + +The maximum number of bytes in a single app code page diff --git a/docs/code/types/app/variables/DELETABLE_TEMPLATE_NAME.md b/docs/code/types/app/variables/DELETABLE_TEMPLATE_NAME.md new file mode 100644 index 00000000..c6dceb3b --- /dev/null +++ b/docs/code/types/app/variables/DELETABLE_TEMPLATE_NAME.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / DELETABLE\_TEMPLATE\_NAME + +# Variable: DELETABLE\_TEMPLATE\_NAME + +> `const` **DELETABLE\_TEMPLATE\_NAME**: `"TMPL_DELETABLE"` = `'TMPL_DELETABLE'` + +Defined in: [src/types/app.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L27) + +The name of the TEAL template variable for deploy-time permanence control diff --git a/docs/code/types/app/variables/UPDATABLE_TEMPLATE_NAME.md b/docs/code/types/app/variables/UPDATABLE_TEMPLATE_NAME.md new file mode 100644 index 00000000..66b56fbf --- /dev/null +++ b/docs/code/types/app/variables/UPDATABLE_TEMPLATE_NAME.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/app](../README.md) / UPDATABLE\_TEMPLATE\_NAME + +# Variable: UPDATABLE\_TEMPLATE\_NAME + +> `const` **UPDATABLE\_TEMPLATE\_NAME**: `"TMPL_UPDATABLE"` = `'TMPL_UPDATABLE'` + +Defined in: [src/types/app.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app.ts#L24) + +The name of the TEAL template variable for deploy-time immutability control diff --git a/docs/code/types/asset-manager/README.md b/docs/code/types/asset-manager/README.md new file mode 100644 index 00000000..97a728d1 --- /dev/null +++ b/docs/code/types/asset-manager/README.md @@ -0,0 +1,16 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/asset-manager + +# types/asset-manager + +## Classes + +- [AssetManager](classes/AssetManager.md) + +## Interfaces + +- [AssetInformation](interfaces/AssetInformation.md) +- [BulkAssetOptInOutResult](interfaces/BulkAssetOptInOutResult.md) diff --git a/docs/code/types/asset-manager/classes/AssetManager.md b/docs/code/types/asset-manager/classes/AssetManager.md new file mode 100644 index 00000000..ed32d9bf --- /dev/null +++ b/docs/code/types/asset-manager/classes/AssetManager.md @@ -0,0 +1,209 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/asset-manager](../README.md) / AssetManager + +# Class: AssetManager + +Defined in: [src/types/asset-manager.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L138) + +Allows management of asset information. + +## Constructors + +### Constructor + +> **new AssetManager**(`algod`, `newGroup`): `AssetManager` + +Defined in: [src/types/asset-manager.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L151) + +Create a new asset manager. + +#### Parameters + +##### algod + +`AlgodClient` + +An algod client + +##### newGroup + +() => [`TransactionComposer`](../../composer/classes/TransactionComposer.md) + +A function that creates a new `TransactionComposer` transaction group + +#### Returns + +`AssetManager` + +#### Example + +```typescript +const assetManager = new AssetManager(algod, () => new TransactionComposer({algod, () => signer, () => suggestedParams})) +``` + +## Methods + +### bulkOptIn() + +> **bulkOptIn**(`account`, `assetIds`, `options?`): `Promise`\<[`BulkAssetOptInOutResult`](../interfaces/BulkAssetOptInOutResult.md)[]\> + +Defined in: [src/types/asset-manager.ts:233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L233) + +Opt an account in to a list of Algorand Standard Assets. + +Transactions will be sent in batches of 16 as transaction groups. + +#### Parameters + +##### account + +The account to opt-in + +`string` | `Address` + +##### assetIds + +`bigint`[] + +The list of asset IDs to opt-in to + +##### options? + +`Omit`\<[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md), `"sender"`\> & [`SendParams`](../../transaction/interfaces/SendParams.md) + +Any parameters to control the transaction or execution of the transaction + +#### Returns + +`Promise`\<[`BulkAssetOptInOutResult`](../interfaces/BulkAssetOptInOutResult.md)[]\> + +An array of records matching asset ID to transaction ID of the opt in + +#### Example + +```typescript +// Basic example +assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n]) +// With configuration +assetManager.bulkOptIn("ACCOUNTADDRESS", [12345n, 67890n], { maxFee: (1000).microAlgo(), suppressLog: true }) +``` + +*** + +### bulkOptOut() + +> **bulkOptOut**(`account`, `assetIds`, `options?`): `Promise`\<[`BulkAssetOptInOutResult`](../interfaces/BulkAssetOptInOutResult.md)[]\> + +Defined in: [src/types/asset-manager.ts:283](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L283) + +Opt an account out of a list of Algorand Standard Assets. + +Transactions will be sent in batches of 16 as transaction groups. + +#### Parameters + +##### account + +The account to opt-in + +`string` | `Address` + +##### assetIds + +`bigint`[] + +The list of asset IDs to opt-out of + +##### options? + +`Omit`\<[`CommonTransactionParams`](../../composer/type-aliases/CommonTransactionParams.md), `"sender"`\> & [`SendParams`](../../transaction/interfaces/SendParams.md) & `object` + +Any parameters to control the transaction or execution of the transaction + +#### Returns + +`Promise`\<[`BulkAssetOptInOutResult`](../interfaces/BulkAssetOptInOutResult.md)[]\> + +An array of records matching asset ID to transaction ID of the opt in + +#### Example + +```typescript +// Basic example +assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n]) +// With configuration +assetManager.bulkOptOut("ACCOUNTADDRESS", [12345n, 67890n], { ensureZeroBalance: true, maxFee: (1000).microAlgo(), suppressLog: true }) +``` + +*** + +### getAccountInformation() + +> **getAccountInformation**(`sender`, `assetId`): `Promise`\<[`AccountAssetInformation`](../../account/type-aliases/AccountAssetInformation.md)\> + +Defined in: [src/types/asset-manager.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L205) + +Returns the given sender account's asset holding for a given asset. + +#### Parameters + +##### sender + +The address of the sender/account to look up + +`string` | `Address` + +##### assetId + +`bigint` + +The ID of the asset to return a holding for + +#### Returns + +`Promise`\<[`AccountAssetInformation`](../../account/type-aliases/AccountAssetInformation.md)\> + +The account asset holding information + +#### Example + +```typescript +const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA"; +const assetId = 123345n; +const accountInfo = await assetManager.getAccountInformation(address, assetId); +``` + +[Response data schema details](https://dev.algorand.co/reference/rest-apis/algod/#accountassetinformation) + +*** + +### getById() + +> **getById**(`assetId`): `Promise`\<[`AssetInformation`](../interfaces/AssetInformation.md)\> + +Defined in: [src/types/asset-manager.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L167) + +Returns the current asset information for the asset with the given ID. + +#### Parameters + +##### assetId + +`bigint` + +The ID of the asset + +#### Returns + +`Promise`\<[`AssetInformation`](../interfaces/AssetInformation.md)\> + +The asset information + +#### Example + +```typescript +const assetInfo = await assetManager.getById(12353n); +``` diff --git a/docs/code/types/asset-manager/interfaces/AssetInformation.md b/docs/code/types/asset-manager/interfaces/AssetInformation.md new file mode 100644 index 00000000..61ca8f99 --- /dev/null +++ b/docs/code/types/asset-manager/interfaces/AssetInformation.md @@ -0,0 +1,223 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/asset-manager](../README.md) / AssetInformation + +# Interface: AssetInformation + +Defined in: [src/types/asset-manager.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L17) + +Information about an asset. + +## Properties + +### assetId + +> **assetId**: `bigint` + +Defined in: [src/types/asset-manager.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L19) + +The ID of the asset. + +*** + +### assetName? + +> `optional` **assetName**: `string` + +Defined in: [src/types/asset-manager.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L110) + +The optional name of the asset. + +Max size is 32 bytes. + +*** + +### assetNameAsBytes? + +> `optional` **assetNameAsBytes**: `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/asset-manager.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L116) + +The optional name of the asset. + +Max size is 32 bytes. + +*** + +### clawback? + +> `optional` **clawback**: `string` + +Defined in: [src/types/asset-manager.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L92) + +The address of the optional account that can clawback holdings of this asset from any account. + +The clawback account has the ability to **unconditionally take assets from any account**. + +If empty, clawback is not permitted. + +If not set the field is permanently empty. + +*** + +### creator + +> **creator**: `string` + +Defined in: [src/types/asset-manager.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L27) + +The address of the account that created the asset. + +This is the address where the parameters for this asset can be found, +and also the address where unwanted asset units can be sent when +closing out an asset position and opting-out of the asset. + +*** + +### decimals + +> **decimals**: `number` + +Defined in: [src/types/asset-manager.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L43) + +The amount of decimal places the asset was created with. + +* If 0, the asset is not divisible; +* If 1, the base unit of the asset is in tenths; +* If 2, the base unit of the asset is in hundredths; +* If 3, the base unit of the asset is in thousandths; +* and so on up to 19 decimal places. + +*** + +### defaultFrozen? + +> `optional` **defaultFrozen**: `boolean` + +Defined in: [src/types/asset-manager.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L51) + +Whether the asset was frozen by default for all accounts. + +If `true` then for anyone apart from the creator to hold the +asset it needs to be unfrozen per account using an asset freeze +transaction from the `freeze` account. + +*** + +### freeze? + +> `optional` **freeze**: `string` + +Defined in: [src/types/asset-manager.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L81) + +The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account. + +If empty, freezing is not permitted. + +If not set the field is permanently empty. + +*** + +### manager? + +> `optional` **manager**: `string` + +Defined in: [src/types/asset-manager.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L57) + +The address of the optional account that can manage the configuration of the asset and destroy it. + +If not set the asset is permanently immutable. + +*** + +### metadataHash? + +> `optional` **metadataHash**: `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/asset-manager.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L134) + +32-byte hash of some metadata that is relevant to the asset and/or asset holders. + +The format of this metadata is up to the application. + +*** + +### reserve? + +> `optional` **reserve**: `string` + +Defined in: [src/types/asset-manager.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L72) + +The address of the optional account that holds the reserve (uncirculated supply) units of the asset. + +This address has no specific authority in the protocol itself and is informational only. + +Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md) +rely on this field to hold meaningful data. + +It can be used in the case where you want to signal to holders of your asset that the uncirculated units +of the asset reside in an account that is different from the default creator account. + +If not set the field is permanently empty. + +*** + +### total + +> **total**: `bigint` + +Defined in: [src/types/asset-manager.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L33) + +The total amount of the smallest divisible (decimal) units that were created of the asset. + +For example, if `decimals` is, say, 2, then for every 100 `total` there is 1 whole unit. + +*** + +### unitName? + +> `optional` **unitName**: `string` + +Defined in: [src/types/asset-manager.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L98) + +The optional name of the unit of this asset (e.g. ticker name). + +Max size is 8 bytes. + +*** + +### unitNameAsBytes? + +> `optional` **unitNameAsBytes**: `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/asset-manager.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L104) + +The optional name of the unit of this asset (e.g. ticker name). + +Max size is 8 bytes. + +*** + +### url? + +> `optional` **url**: `string` + +Defined in: [src/types/asset-manager.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L122) + +Optional URL where more information about the asset can be retrieved (e.g. metadata). + +Max size is 96 bytes. + +*** + +### urlAsBytes? + +> `optional` **urlAsBytes**: `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/asset-manager.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L128) + +Optional URL where more information about the asset can be retrieved (e.g. metadata). + +Max size is 96 bytes. diff --git a/docs/code/types/asset-manager/interfaces/BulkAssetOptInOutResult.md b/docs/code/types/asset-manager/interfaces/BulkAssetOptInOutResult.md new file mode 100644 index 00000000..22cf4366 --- /dev/null +++ b/docs/code/types/asset-manager/interfaces/BulkAssetOptInOutResult.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/asset-manager](../README.md) / BulkAssetOptInOutResult + +# Interface: BulkAssetOptInOutResult + +Defined in: [src/types/asset-manager.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L9) + +Individual result from performing a bulk opt-in or bulk opt-out for an account against a series of assets. + +## Properties + +### assetId + +> **assetId**: `bigint` + +Defined in: [src/types/asset-manager.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L11) + +The ID of the asset opted into / out of + +*** + +### transactionId + +> **transactionId**: `string` + +Defined in: [src/types/asset-manager.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset-manager.ts#L13) + +The transaction ID of the resulting opt in / out diff --git a/docs/code/types/asset/README.md b/docs/code/types/asset/README.md new file mode 100644 index 00000000..8de29859 --- /dev/null +++ b/docs/code/types/asset/README.md @@ -0,0 +1,14 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/asset + +# types/asset + +## Interfaces + +- [~~AssetBulkOptInOutParams~~](interfaces/AssetBulkOptInOutParams.md) +- [~~AssetOptInParams~~](interfaces/AssetOptInParams.md) +- [~~AssetOptOutParams~~](interfaces/AssetOptOutParams.md) +- [~~CreateAssetParams~~](interfaces/CreateAssetParams.md) diff --git a/docs/code/types/asset/interfaces/AssetBulkOptInOutParams.md b/docs/code/types/asset/interfaces/AssetBulkOptInOutParams.md new file mode 100644 index 00000000..99f040c0 --- /dev/null +++ b/docs/code/types/asset/interfaces/AssetBulkOptInOutParams.md @@ -0,0 +1,83 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/asset](../README.md) / AssetBulkOptInOutParams + +# Interface: ~~AssetBulkOptInOutParams~~ + +Defined in: [src/types/asset.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L92) + +## Deprecated + +Parameters for `assetBulkOptIn` / `assetBulkOptOut` call. + +## Properties + +### ~~account~~ + +> **account**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/asset.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L94) + +The account to opt in/out for + +*** + +### ~~assetIds~~ + +> **assetIds**: `number`[] + +Defined in: [src/types/asset.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L96) + +The IDs of the assets to opt in for / out of + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/asset.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L104) + +The maximum fee that you are happy to pay per transaction (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/asset.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L102) + +The (optional) transaction note + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/asset.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L106) + +Whether to suppress log messages from transaction send, default: do not suppress + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/asset.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L100) + +Optional transaction parameters + +*** + +### ~~validateBalances?~~ + +> `optional` **validateBalances**: `boolean` + +Defined in: [src/types/asset.ts:98](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L98) + +Whether or not to validate the opt-in/out is valid before issuing transactions; default = true diff --git a/docs/code/types/asset/interfaces/AssetOptInParams.md b/docs/code/types/asset/interfaces/AssetOptInParams.md new file mode 100644 index 00000000..e45b60a7 --- /dev/null +++ b/docs/code/types/asset/interfaces/AssetOptInParams.md @@ -0,0 +1,184 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/asset](../README.md) / AssetOptInParams + +# Interface: ~~AssetOptInParams~~ + +Defined in: [src/types/asset.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L70) + +## Deprecated + +Parameters for `assetOptIn` call. + +## Extends + +- [`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md) + +## Extended by + +- [`AssetOptOutParams`](AssetOptOutParams.md) + +## Properties + +### ~~account~~ + +> **account**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/asset.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L72) + +The account to opt in/out for + +*** + +### ~~assetId~~ + +> **assetId**: `number` + +Defined in: [src/types/asset.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L74) + +The ID of the assets to opt in for / out of + +*** + +### ~~atc?~~ + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`atc`](../../transaction/interfaces/SendTransactionParams.md#atc) + +*** + +### ~~fee?~~ + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`fee`](../../transaction/interfaces/SendTransactionParams.md#fee) + +*** + +### ~~lease?~~ + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/asset.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L80) + +An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxFee`](../../transaction/interfaces/SendTransactionParams.md#maxfee) + +*** + +### ~~maxRoundsToWaitForConfirmation?~~ + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxRoundsToWaitForConfirmation`](../../transaction/interfaces/SendTransactionParams.md#maxroundstowaitforconfirmation) + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/asset.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L78) + +The (optional) transaction note + +*** + +### ~~populateAppCallResources?~~ + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`populateAppCallResources`](../../transaction/interfaces/SendTransactionParams.md#populateappcallresources) + +*** + +### ~~skipSending?~~ + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipSending`](../../transaction/interfaces/SendTransactionParams.md#skipsending) + +*** + +### ~~skipWaiting?~~ + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipWaiting`](../../transaction/interfaces/SendTransactionParams.md#skipwaiting) + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`suppressLog`](../../transaction/interfaces/SendTransactionParams.md#suppresslog) + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/asset.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L76) + +Optional transaction parameters diff --git a/docs/code/types/asset/interfaces/AssetOptOutParams.md b/docs/code/types/asset/interfaces/AssetOptOutParams.md new file mode 100644 index 00000000..0662b625 --- /dev/null +++ b/docs/code/types/asset/interfaces/AssetOptOutParams.md @@ -0,0 +1,220 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/asset](../README.md) / AssetOptOutParams + +# Interface: ~~AssetOptOutParams~~ + +Defined in: [src/types/asset.ts:84](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L84) + +## Deprecated + +Parameters for `assetOptOut` call. + +## Extends + +- [`AssetOptInParams`](AssetOptInParams.md) + +## Properties + +### ~~account~~ + +> **account**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/asset.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L72) + +The account to opt in/out for + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`account`](AssetOptInParams.md#account) + +*** + +### ~~assetCreatorAddress?~~ + +> `optional` **assetCreatorAddress**: `string` + +Defined in: [src/types/asset.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L86) + +The address of the creator account for the asset; if unspecified then it looks it up using algod + +*** + +### ~~assetId~~ + +> **assetId**: `number` + +Defined in: [src/types/asset.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L74) + +The ID of the assets to opt in for / out of + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`assetId`](AssetOptInParams.md#assetid) + +*** + +### ~~atc?~~ + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`atc`](AssetOptInParams.md#atc) + +*** + +### ~~ensureZeroBalance?~~ + +> `optional` **ensureZeroBalance**: `boolean` + +Defined in: [src/types/asset.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L88) + +Whether or not to validate the account has a zero-balance before issuing the opt-out; default = true + +*** + +### ~~fee?~~ + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`fee`](AssetOptInParams.md#fee) + +*** + +### ~~lease?~~ + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/asset.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L80) + +An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`lease`](AssetOptInParams.md#lease) + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`maxFee`](AssetOptInParams.md#maxfee) + +*** + +### ~~maxRoundsToWaitForConfirmation?~~ + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`maxRoundsToWaitForConfirmation`](AssetOptInParams.md#maxroundstowaitforconfirmation) + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/asset.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L78) + +The (optional) transaction note + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`note`](AssetOptInParams.md#note) + +*** + +### ~~populateAppCallResources?~~ + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`populateAppCallResources`](AssetOptInParams.md#populateappcallresources) + +*** + +### ~~skipSending?~~ + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`skipSending`](AssetOptInParams.md#skipsending) + +*** + +### ~~skipWaiting?~~ + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`skipWaiting`](AssetOptInParams.md#skipwaiting) + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`suppressLog`](AssetOptInParams.md#suppresslog) + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/asset.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L76) + +Optional transaction parameters + +#### Inherited from + +[`AssetOptInParams`](AssetOptInParams.md).[`transactionParams`](AssetOptInParams.md#transactionparams) diff --git a/docs/code/types/asset/interfaces/CreateAssetParams.md b/docs/code/types/asset/interfaces/CreateAssetParams.md new file mode 100644 index 00000000..dac8f24b --- /dev/null +++ b/docs/code/types/asset/interfaces/CreateAssetParams.md @@ -0,0 +1,297 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/asset](../README.md) / CreateAssetParams + +# Interface: ~~CreateAssetParams~~ + +Defined in: [src/types/asset.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L7) + +## Deprecated + +Parameters for `createAsset` call. + +## Extends + +- [`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md) + +## Properties + +### ~~atc?~~ + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`atc`](../../transaction/interfaces/SendTransactionParams.md#atc) + +*** + +### ~~clawbackAccount?~~ + +> `optional` **clawbackAccount**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/asset.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L57) + +The optional account that can clawback holdings of this asset. If empty, clawback is not permitted. +If not set at asset creation or subsequently set to empty by the manager the field is permanently empty. + +*** + +### ~~creator~~ + +> **creator**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/asset.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L11) + +The account to create the asset. + +This account automatically is opted in to the asset and holds all units after creation. + +*** + +### ~~decimals~~ + +> **decimals**: `number` + +Defined in: [src/types/asset.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L26) + +The number of digits to use after the decimal point when displaying the asset. +If 0, the asset is not divisible. +If 1, the base unit of the asset is in tenths. +If 2, the base unit of the asset is in hundredths. +If 3, the base unit of the asset is in thousandths, and so on up to 19 decimal places. +This field can only be specified upon asset creation. + +*** + +### ~~fee?~~ + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`fee`](../../transaction/interfaces/SendTransactionParams.md#fee) + +*** + +### ~~freezeAccount?~~ + +> `optional` **freezeAccount**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/asset.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L53) + +The optional account that can be used to freeze holdings of this asset. If empty, freezing is not permitted. +If not set at asset creation or subsequently set to empty by the manager the field is permanently empty. + +*** + +### ~~frozenByDefault?~~ + +> `optional` **frozenByDefault**: `boolean` + +Defined in: [src/types/asset.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L59) + +Whether to freeze holdings for this asset by default. If `true` then for anyone apart from the creator to hold the asset it needs to be unfrozen per account using `freeze`. Defaults to `false`. + +*** + +### ~~lease?~~ + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/asset.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L66) + +An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply + +*** + +### ~~manager?~~ + +> `optional` **manager**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/asset.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L43) + +The optional account that can manage the configuration of the asset and destroy it. +If not set at asset creation or subsequently set to empty by the manager the asset becomes immutable. + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxFee`](../../transaction/interfaces/SendTransactionParams.md#maxfee) + +*** + +### ~~maxRoundsToWaitForConfirmation?~~ + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxRoundsToWaitForConfirmation`](../../transaction/interfaces/SendTransactionParams.md#maxroundstowaitforconfirmation) + +*** + +### ~~metadataHash?~~ + +> `optional` **metadataHash**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/asset.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L39) + +This field is intended to be a 32-byte hash of some metadata that is relevant to your asset and/or asset holders. +The format of this metadata is up to the application. This field can only be specified upon asset creation. + +*** + +### ~~name?~~ + +> `optional` **name**: `string` + +Defined in: [src/types/asset.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L29) + +The optional name of the asset. Max size if 32 bytes. This field can only be specified upon asset creation. + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/asset.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L64) + +The (optional) transaction note + +*** + +### ~~populateAppCallResources?~~ + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`populateAppCallResources`](../../transaction/interfaces/SendTransactionParams.md#populateappcallresources) + +*** + +### ~~reserveAccount?~~ + +> `optional` **reserveAccount**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/asset.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L49) + +The optional account that holds the reserve (non-minted) units of the asset. This address has no specific authority in the protocol itself and is informational. +Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md) rely on this field to hold meaningful data. +It is used in the case where you want to signal to holders of your asset that the non-minted units of the asset reside in an account that is different from the default creator account. +If not set at asset creation or subsequently set to empty by the manager the field is permanently empty. + +*** + +### ~~skipSending?~~ + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipSending`](../../transaction/interfaces/SendTransactionParams.md#skipsending) + +*** + +### ~~skipWaiting?~~ + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipWaiting`](../../transaction/interfaces/SendTransactionParams.md#skipwaiting) + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`suppressLog`](../../transaction/interfaces/SendTransactionParams.md#suppresslog) + +*** + +### ~~total~~ + +> **total**: `number` \| `bigint` + +Defined in: [src/types/asset.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L17) + +The total number of base (decimal) units of the asset to create. +If decimal is, say, 2, then for every 100 `total` there would be 1 whole unit. +This field can only be specified upon asset creation. + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/asset.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L62) + +Optional transaction parameters + +*** + +### ~~unit?~~ + +> `optional` **unit**: `string` + +Defined in: [src/types/asset.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L31) + +The optional name of the unit of this asset. Max size is 8 bytes. This field can only be specified upon asset creation. + +*** + +### ~~url?~~ + +> `optional` **url**: `string` + +Defined in: [src/types/asset.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/asset.ts#L35) + +Specifies an optional URL where more information about the asset can be retrieved. Max size is 96 bytes. +This field can only be specified upon asset creation. diff --git a/docs/code/types/async-event-emitter.spec/README.md b/docs/code/types/async-event-emitter.spec/README.md new file mode 100644 index 00000000..fe69f305 --- /dev/null +++ b/docs/code/types/async-event-emitter.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/async-event-emitter.spec + +# types/async-event-emitter.spec diff --git a/docs/code/types/async-event-emitter/README.md b/docs/code/types/async-event-emitter/README.md new file mode 100644 index 00000000..f520f5b6 --- /dev/null +++ b/docs/code/types/async-event-emitter/README.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/async-event-emitter + +# types/async-event-emitter + +## Classes + +- [AsyncEventEmitter](classes/AsyncEventEmitter.md) + +## Type Aliases + +- [AsyncEventListener](type-aliases/AsyncEventListener.md) diff --git a/docs/code/types/async-event-emitter/classes/AsyncEventEmitter.md b/docs/code/types/async-event-emitter/classes/AsyncEventEmitter.md new file mode 100644 index 00000000..01adf845 --- /dev/null +++ b/docs/code/types/async-event-emitter/classes/AsyncEventEmitter.md @@ -0,0 +1,225 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/async-event-emitter](../README.md) / AsyncEventEmitter + +# Class: AsyncEventEmitter + +Defined in: [src/types/async-event-emitter.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L5) + +## Constructors + +### Constructor + +> **new AsyncEventEmitter**(): `AsyncEventEmitter` + +#### Returns + +`AsyncEventEmitter` + +## Properties + +### off() + +> **off**: (`eventName`, `listener`) => `AsyncEventEmitter` + +Defined in: [src/types/async-event-emitter.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L55) + +#### Parameters + +##### eventName + +`string` | `symbol` + +##### listener + +[`AsyncEventListener`](../type-aliases/AsyncEventListener.md) + +#### Returns + +`AsyncEventEmitter` + +## Methods + +### emitAsync() + +#### Call Signature + +> **emitAsync**\<`K`\>(`eventName`, `event`): `Promise`\<`void`\> + +Defined in: [src/types/async-event-emitter.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L9) + +##### Type Parameters + +###### K + +`K` *extends* [`EventType`](../../lifecycle-events/enumerations/EventType.md) + +##### Parameters + +###### eventName + +`K` + +###### event + +[`EventDataMap`](../../lifecycle-events/type-aliases/EventDataMap.md)\[`K`\] + +##### Returns + +`Promise`\<`void`\> + +#### Call Signature + +> **emitAsync**(`eventName`, `event`): `Promise`\<`void`\> + +Defined in: [src/types/async-event-emitter.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L10) + +##### Parameters + +###### eventName + +`string` | `symbol` + +###### event + +`unknown` + +##### Returns + +`Promise`\<`void`\> + +*** + +### on() + +#### Call Signature + +> **on**\<`K`\>(`eventName`, `listener`): `AsyncEventEmitter` + +Defined in: [src/types/async-event-emitter.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L17) + +##### Type Parameters + +###### K + +`K` *extends* [`EventType`](../../lifecycle-events/enumerations/EventType.md) + +##### Parameters + +###### eventName + +`K` + +###### listener + +[`AsyncEventListener`](../type-aliases/AsyncEventListener.md)\<[`EventDataMap`](../../lifecycle-events/type-aliases/EventDataMap.md)\[`K`\]\> + +##### Returns + +`AsyncEventEmitter` + +#### Call Signature + +> **on**\<`T`\>(`eventName`, `listener`): `AsyncEventEmitter` + +Defined in: [src/types/async-event-emitter.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L18) + +##### Type Parameters + +###### T + +`T` = `unknown` + +##### Parameters + +###### eventName + +`string` | `symbol` + +###### listener + +[`AsyncEventListener`](../type-aliases/AsyncEventListener.md)\<`T`\> + +##### Returns + +`AsyncEventEmitter` + +*** + +### once() + +#### Call Signature + +> **once**\<`K`\>(`eventName`, `listener`): `AsyncEventEmitter` + +Defined in: [src/types/async-event-emitter.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L25) + +##### Type Parameters + +###### K + +`K` *extends* [`EventType`](../../lifecycle-events/enumerations/EventType.md) + +##### Parameters + +###### eventName + +`K` + +###### listener + +[`AsyncEventListener`](../type-aliases/AsyncEventListener.md)\<[`EventDataMap`](../../lifecycle-events/type-aliases/EventDataMap.md)\[`K`\]\> + +##### Returns + +`AsyncEventEmitter` + +#### Call Signature + +> **once**\<`T`\>(`eventName`, `listener`): `AsyncEventEmitter` + +Defined in: [src/types/async-event-emitter.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L26) + +##### Type Parameters + +###### T + +`T` = `unknown` + +##### Parameters + +###### eventName + +`string` | `symbol` + +###### listener + +[`AsyncEventListener`](../type-aliases/AsyncEventListener.md)\<`T`\> + +##### Returns + +`AsyncEventEmitter` + +*** + +### removeListener() + +> **removeListener**(`eventName`, `listener`): `AsyncEventEmitter` + +Defined in: [src/types/async-event-emitter.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L39) + +#### Parameters + +##### eventName + +`string` | `symbol` + +##### listener + +[`AsyncEventListener`](../type-aliases/AsyncEventListener.md) + +#### Returns + +`AsyncEventEmitter` diff --git a/docs/code/types/async-event-emitter/type-aliases/AsyncEventListener.md b/docs/code/types/async-event-emitter/type-aliases/AsyncEventListener.md new file mode 100644 index 00000000..196e5e2d --- /dev/null +++ b/docs/code/types/async-event-emitter/type-aliases/AsyncEventListener.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/async-event-emitter](../README.md) / AsyncEventListener + +# Type Alias: AsyncEventListener()\ + +> **AsyncEventListener**\<`T`\> = (`event`, `eventName`) => `Promise`\<`void`\> \| `void` + +Defined in: [src/types/async-event-emitter.ts:3](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/async-event-emitter.ts#L3) + +## Type Parameters + +### T + +`T` = `unknown` + +## Parameters + +### event + +`T` + +### eventName + +`string` | `symbol` + +## Returns + +`Promise`\<`void`\> \| `void` diff --git a/docs/code/types/client-manager.spec/README.md b/docs/code/types/client-manager.spec/README.md new file mode 100644 index 00000000..f6d416a0 --- /dev/null +++ b/docs/code/types/client-manager.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/client-manager.spec + +# types/client-manager.spec diff --git a/docs/code/types/client-manager/README.md b/docs/code/types/client-manager/README.md new file mode 100644 index 00000000..5393e9c6 --- /dev/null +++ b/docs/code/types/client-manager/README.md @@ -0,0 +1,28 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/client-manager + +# types/client-manager + +## Classes + +- [ClientManager](classes/ClientManager.md) + +## Interfaces + +- [AlgoSdkClients](interfaces/AlgoSdkClients.md) +- [TypedAppClient](interfaces/TypedAppClient.md) +- [TypedAppFactory](interfaces/TypedAppFactory.md) + +## Type Aliases + +- [ClientAppClientByNetworkParams](type-aliases/ClientAppClientByNetworkParams.md) +- [ClientAppClientParams](type-aliases/ClientAppClientParams.md) +- [ClientAppFactoryParams](type-aliases/ClientAppFactoryParams.md) +- [ClientResolveAppClientByCreatorAndNameParams](type-aliases/ClientResolveAppClientByCreatorAndNameParams.md) +- [ClientTypedAppClientByCreatorAndNameParams](type-aliases/ClientTypedAppClientByCreatorAndNameParams.md) +- [ClientTypedAppClientByNetworkParams](type-aliases/ClientTypedAppClientByNetworkParams.md) +- [ClientTypedAppClientParams](type-aliases/ClientTypedAppClientParams.md) +- [ClientTypedAppFactoryParams](type-aliases/ClientTypedAppFactoryParams.md) diff --git a/docs/code/types/client-manager/classes/ClientManager.md b/docs/code/types/client-manager/classes/ClientManager.md new file mode 100644 index 00000000..b6297d82 --- /dev/null +++ b/docs/code/types/client-manager/classes/ClientManager.md @@ -0,0 +1,1370 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / ClientManager + +# Class: ClientManager + +Defined in: [src/types/client-manager.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L48) + +Exposes access to various API clients. + +## Constructors + +### Constructor + +> **new ClientManager**(`clientsOrConfig`, `algorandClient?`): `ClientManager` + +Defined in: [src/types/client-manager.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L74) + +algosdk clients or config for interacting with the official Algorand APIs. + +#### Parameters + +##### clientsOrConfig + +The clients or config to use + +[`AlgoConfig`](../../network-client/interfaces/AlgoConfig.md) | [`AlgoSdkClients`](../interfaces/AlgoSdkClients.md) + +##### algorandClient? + +[`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +#### Returns + +`ClientManager` + +#### Examples + +```typescript +const clientManager = new ClientManager({ algod: algodClient }) +``` + +```typescript +const clientManager = new ClientManager({ algod: algodClient, indexer: indexerClient, kmd: kmdClient }) +``` + +```typescript +const clientManager = new ClientManager({ algodConfig }) +``` + +```typescript +const clientManager = new ClientManager({ algodConfig, indexerConfig, kmdConfig }) +``` + +## Accessors + +### algod + +#### Get Signature + +> **get** **algod**(): `AlgodClient` + +Defined in: [src/types/client-manager.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L93) + +Returns an algosdk Algod API client. + +##### Returns + +`AlgodClient` + +The Algod client + +*** + +### indexer + +#### Get Signature + +> **get** **indexer**(): `IndexerClient` + +Defined in: [src/types/client-manager.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L102) + +Returns an algosdk Indexer API client or throws an error if it's not been provided. + +##### Throws + +Error if no Indexer client is configured + +##### Returns + +`IndexerClient` + +The Indexer client + +*** + +### indexerIfPresent + +#### Get Signature + +> **get** **indexerIfPresent**(): `undefined` \| `IndexerClient` + +Defined in: [src/types/client-manager.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L111) + +Returns an algosdk Indexer API client or `undefined` if it's not been provided. + +##### Returns + +`undefined` \| `IndexerClient` + +The Indexer client or `undefined` + +*** + +### kmd + +#### Get Signature + +> **get** **kmd**(): `KmdClient` + +Defined in: [src/types/client-manager.ts:120](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L120) + +Returns an algosdk KMD API client or throws an error if it's not been provided. + +##### Throws + +Error if no KMD client is configured + +##### Returns + +`KmdClient` + +The KMD client + +## Methods + +### getAppClientByCreatorAndName() + +> **getAppClientByCreatorAndName**(`params`): `Promise`\<[`AppClient`](../../app-client/classes/AppClient.md)\> + +Defined in: [src/types/client-manager.ts:284](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L284) + +Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app. +This method resolves the app ID by looking up the creator address and name +using AlgoKit app deployment semantics (i.e. looking for the app creation transaction note). + +#### Parameters + +##### params + +The parameters to create the app client + +###### appLookupCache? + +[`AppLookup`](../../app-deployer/interfaces/AppLookup.md) + +An optional cached app lookup that matches a name to on-chain details; +either this is needed or indexer is required to be passed in to this `ClientManager` on construction. + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### appSpec + +`string` \| [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) \| [`AppSpec`](../../app-spec/interfaces/AppSpec.md) + +The ARC-56 or ARC-32 application spec as either: + * Parsed JSON ARC-56 `Contract` + * Parsed JSON ARC-32 `AppSpec` + * Raw JSON string (in either ARC-56 or ARC-32 format) + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### creatorAddress + +`string` \| `Address` + +The address of the creator account for the app + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +###### ignoreCache? + +`boolean` + +Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value + +#### Returns + +`Promise`\<[`AppClient`](../../app-client/classes/AppClient.md)\> + +The `AppClient` instance + +#### Example + +```typescript +const appClient = clientManager.getAppClientByCreatorAndName({ + appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}', + // appId resolved by looking for app ID of named app by this creator + creatorAddress: 'CREATORADDRESS', +}) +``` + +*** + +### getAppClientById() + +> **getAppClientById**(`params`): [`AppClient`](../../app-client/classes/AppClient.md) + +Defined in: [src/types/client-manager.ts:307](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L307) + +Returns a new `AppClient` client for managing calls and state for an ARC-32/ARC-56 app. + +#### Parameters + +##### params + +The parameters to create the app client + +###### appId + +`bigint` + +The ID of the app instance this client should make calls against. + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### appSpec + +`string` \| [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) \| [`AppSpec`](../../app-spec/interfaces/AppSpec.md) + +The ARC-56 or ARC-32 application spec as either: + * Parsed JSON ARC-56 `Contract` + * Parsed JSON ARC-32 `AppSpec` + * Raw JSON string (in either ARC-56 or ARC-32 format) + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +#### Returns + +[`AppClient`](../../app-client/classes/AppClient.md) + +The `AppClient` instance + +#### Example + +```typescript +const appClient = clientManager.getAppClientById({ + appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}', + appId: 12345n, +}) +``` + +*** + +### getAppClientByNetwork() + +> **getAppClientByNetwork**(`params`): `Promise`\<[`AppClient`](../../app-client/classes/AppClient.md)\> + +Defined in: [src/types/client-manager.ts:330](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L330) + +Returns a new `AppClient` client for managing calls and state for an ARC-56 app. +This method resolves the app ID for the current network based on +pre-determined network-specific app IDs specified in the ARC-56 app spec. + +If no IDs are in the app spec or the network isn't recognised, an error is thrown. + +#### Parameters + +##### params + +The parameters to create the app client + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### appSpec + +`string` \| [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) \| [`AppSpec`](../../app-spec/interfaces/AppSpec.md) + +The ARC-56 or ARC-32 application spec as either: + * Parsed JSON ARC-56 `Contract` + * Parsed JSON ARC-32 `AppSpec` + * Raw JSON string (in either ARC-56 or ARC-32 format) + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +#### Returns + +`Promise`\<[`AppClient`](../../app-client/classes/AppClient.md)\> + +The `AppClient` instance + +#### Example + +```typescript +const appClient = clientManager.getAppClientByNetwork({ + appSpec: '{/* ARC-56 or ARC-32 compatible JSON *\}', + // appId resolved by using ARC-56 spec to find app ID for current network +}) +``` + +*** + +### getAppFactory() + +> **getAppFactory**(`params`): [`AppFactory`](../../app-factory/classes/AppFactory.md) + +Defined in: [src/types/client-manager.ts:261](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L261) + +Returns a new `AppFactory` client + +#### Parameters + +##### params + +The parameters to create the app factory + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name. + +###### appSpec + +`string` \| [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) \| [`AppSpec`](../../app-spec/interfaces/AppSpec.md) + +The ARC-56 or ARC-32 application spec as either: + * Parsed JSON ARC-56 `Contract` + * Parsed JSON ARC-32 `AppSpec` + * Raw JSON string (in either ARC-56 or ARC-32 format) + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +###### deletable? + +`boolean` + +Whether or not the contract should have deploy-time permanence control set, undefined = ignore. +If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. + +Useful if you want to vend multiple contracts from the same factory without specifying this value +for each call. + +###### deployTimeParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Optional deploy-time TEAL template replacement parameters. +If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. + +Useful if you want to vend multiple contracts from the same factory without specifying this value +for each call. + +###### updatable? + +`boolean` + +Whether or not the contract should have deploy-time immutability control set, undefined = ignore. +If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. + +Useful if you want to vend multiple contracts from the same factory without specifying this value +for each call. + +###### version? + +`string` + +The version of app that is / will be deployed; defaults to 1.0 + +#### Returns + +[`AppFactory`](../../app-factory/classes/AppFactory.md) + +The `AppFactory` instance + +#### Examples + +```typescript +const factory = clientManager.getAppFactory({ + appSpec: '{/* ARC-56 or ARC-32 compatible JSON */}', +}) +``` + +```typescript +const factory = clientManager.getAppFactory({ + appSpec: parsedAppSpec_AppSpec_or_Arc56Contract, + defaultSender: "SENDERADDRESS", + appName: "OverriddenAppName", + version: "2.0.0", + updatable: true, + deletable: false, + deployTimeParams: { ONE: 1, TWO: 'value' } +}) +``` + +*** + +### getTestNetDispenser() + +> **getTestNetDispenser**(`params`): [`TestNetDispenserApiClient`](../../dispenser-client/classes/TestNetDispenserApiClient.md) + +Defined in: [src/types/client-manager.ts:215](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L215) + +Returns a TestNet Dispenser API client. + +Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token. + +#### Parameters + +##### params + +[`TestNetDispenserApiClientParams`](../../dispenser-client/interfaces/TestNetDispenserApiClientParams.md) + +An object containing parameters for the TestNetDispenserApiClient class. + +#### Returns + +[`TestNetDispenserApiClient`](../../dispenser-client/classes/TestNetDispenserApiClient.md) + +An instance of the TestNetDispenserApiClient class. + +#### Example + +```ts +const client = clientManager.getTestNetDispenser( + { + authToken: 'your_auth_token', + requestTimeout: 15, + } +) +``` + +*** + +### getTestNetDispenserFromEnvironment() + +> **getTestNetDispenserFromEnvironment**(`params?`): [`TestNetDispenserApiClient`](../../dispenser-client/classes/TestNetDispenserApiClient.md) + +Defined in: [src/types/client-manager.ts:234](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L234) + +Returns a TestNet Dispenser API client, loading the auth token from `process.env.ALGOKIT_DISPENSER_ACCESS_TOKEN`. + +Refer to [docs](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md) on guidance to obtain an access token. + +#### Parameters + +##### params? + +`Omit`\<[`TestNetDispenserApiClientParams`](../../dispenser-client/interfaces/TestNetDispenserApiClientParams.md), `"authToken"`\> + +An object containing parameters for the TestNetDispenserApiClient class. + +#### Returns + +[`TestNetDispenserApiClient`](../../dispenser-client/classes/TestNetDispenserApiClient.md) + +An instance of the TestNetDispenserApiClient class. + +#### Example + +```ts +const client = clientManager.getTestNetDispenserFromEnvironment( + { + requestTimeout: 15, + } +) +``` + +*** + +### getTypedAppClientByCreatorAndName() + +> **getTypedAppClientByCreatorAndName**\<`TClient`\>(`typedClient`, `params`): `Promise`\<`InstanceType`\<`TClient`\>\> + +Defined in: [src/types/client-manager.ts:358](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L358) + +Returns a new typed client, resolving the app by creator address and name. + +#### Type Parameters + +##### TClient + +`TClient` *extends* [`TypedAppClient`](../interfaces/TypedAppClient.md)\<`InstanceType`\<`TClient`\>\> + +#### Parameters + +##### typedClient + +`TClient` + +The typed client type to use + +##### params + +The params to resolve the app by creator address and name + +###### appLookupCache? + +[`AppLookup`](../../app-deployer/interfaces/AppLookup.md) + +An optional cached app lookup that matches a name to on-chain details; +either this is needed or indexer is required to be passed in to this `ClientManager` on construction. + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### creatorAddress + +`string` \| `Address` + +The address of the creator account for the app + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +###### ignoreCache? + +`boolean` + +Whether or not to ignore the `AppDeployer` lookup cache and force an on-chain lookup, default: use any cached value + +#### Returns + +`Promise`\<`InstanceType`\<`TClient`\>\> + +The typed client instance + +#### Examples + +```typescript +const appClient = clientManager.getTypedAppClientByCreatorAndName(MyContractClient, { + creatorAddress: "CREATORADDRESS", + defaultSender: alice, +}) +``` + +```typescript +const appClient = clientManager.getTypedAppClientByCreatorAndName(MyContractClient, { + creatorAddress: "CREATORADDRESS", + name: "contract-name", + defaultSender: alice, +}) +``` + +*** + +### getTypedAppClientById() + +> **getTypedAppClientById**\<`TClient`\>(`typedClient`, `params`): `InstanceType`\<`TClient`\> + +Defined in: [src/types/client-manager.ts:382](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L382) + +Returns a new typed client, resolving the app by app ID. + +#### Type Parameters + +##### TClient + +`TClient` *extends* [`TypedAppClient`](../interfaces/TypedAppClient.md)\<`InstanceType`\<`TClient`\>\> + +#### Parameters + +##### typedClient + +`TClient` + +The typed client type to use + +##### params + +The params to resolve the app by ID + +###### appId + +`bigint` + +The ID of the app instance this client should make calls against. + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +#### Returns + +`InstanceType`\<`TClient`\> + +The typed client instance + +#### Example + +```typescript +const appClient = clientManager.getTypedAppClientById(MyContractClient, { + appId: 12345n, + defaultSender: alice, +}) +``` + +*** + +### getTypedAppClientByNetwork() + +> **getTypedAppClientByNetwork**\<`TClient`\>(`typedClient`, `params?`): `Promise`\<`InstanceType`\<`TClient`\>\> + +Defined in: [src/types/client-manager.ts:408](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L408) + +Returns a new typed client, resolves the app ID for the current network based on +pre-determined network-specific app IDs specified in the ARC-56 app spec. + +If no IDs are in the app spec or the network isn't recognised, an error is thrown. + +#### Type Parameters + +##### TClient + +`TClient` *extends* [`TypedAppClient`](../interfaces/TypedAppClient.md)\<`InstanceType`\<`TClient`\>\> + +#### Parameters + +##### typedClient + +`TClient` + +The typed client type to use + +##### params? + +The params to resolve the app by network + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name + +###### approvalSourceMap? + +`ProgramSourceMap` + +Optional source map for the approval program + +###### clearSourceMap? + +`ProgramSourceMap` + +Optional source map for the clear state program + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +#### Returns + +`Promise`\<`InstanceType`\<`TClient`\>\> + +The typed client instance + +#### Example + +```typescript +const appClient = clientManager.getTypedAppClientByNetwork(MyContractClient, { + defaultSender: alice, +}) +``` + +*** + +### getTypedAppFactory() + +> **getTypedAppFactory**\<`TClient`\>(`typedFactory`, `params?`): `TClient` + +Defined in: [src/types/client-manager.ts:431](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L431) + +Returns a new typed app factory. + +#### Type Parameters + +##### TClient + +`TClient` + +#### Parameters + +##### typedFactory + +[`TypedAppFactory`](../interfaces/TypedAppFactory.md)\<`TClient`\> + +The typed factory type to use + +##### params? + +The params to resolve the factory by + +###### appName? + +`string` + +Optional override for the app name; used for on-chain metadata and lookups. +Defaults to the ARC-32/ARC-56 app spec name. + +###### defaultSender? + +`string` \| `Address` + +Optional address to use for the account to use as the default sender for calls. + +###### defaultSigner? + +`TransactionSigner` + +Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from `AlgorandClient`). + +###### deletable? + +`boolean` + +Whether or not the contract should have deploy-time permanence control set, undefined = ignore. +If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. + +Useful if you want to vend multiple contracts from the same factory without specifying this value +for each call. + +###### deployTimeParams? + +[`TealTemplateParams`](../../app/interfaces/TealTemplateParams.md) + +Optional deploy-time TEAL template replacement parameters. +If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. + +Useful if you want to vend multiple contracts from the same factory without specifying this value +for each call. + +###### updatable? + +`boolean` + +Whether or not the contract should have deploy-time immutability control set, undefined = ignore. +If specified here will get used in calls to `deploy` and `create` calls unless overridden in those calls. + +Useful if you want to vend multiple contracts from the same factory without specifying this value +for each call. + +###### version? + +`string` + +The version of app that is / will be deployed; defaults to 1.0 + +#### Returns + +`TClient` + +The typed client instance + +#### Example + +```typescript +const appFactory = clientManager.getTypedAppFactory(MyContractClient, { + sender: alice, +}) +``` + +*** + +### isLocalNet() + +> **isLocalNet**(): `Promise`\<`boolean`\> + +Defined in: [src/types/client-manager.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L171) + +Returns true if the current network is LocalNet. + +#### Returns + +`Promise`\<`boolean`\> + +True if the current network is LocalNet. + +#### Example + +```typescript +const isLocalNet = await clientManager.isLocalNet() +``` + +*** + +### isMainNet() + +> **isMainNet**(): `Promise`\<`boolean`\> + +Defined in: [src/types/client-manager.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L195) + +Returns true if the current network is MainNet. + +#### Returns + +`Promise`\<`boolean`\> + +True if the current network is MainNet. + +#### Example + +```typescript +const isMainNet = await clientManager.isMainNet() +``` + +*** + +### isTestNet() + +> **isTestNet**(): `Promise`\<`boolean`\> + +Defined in: [src/types/client-manager.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L183) + +Returns true if the current network is TestNet. + +#### Returns + +`Promise`\<`boolean`\> + +True if the current network is TestNet. + +#### Example + +```typescript +const isTestNet = await clientManager.isTestNet() +``` + +*** + +### network() + +> **network**(): `Promise`\<[`NetworkDetails`](../../network-client/interfaces/NetworkDetails.md)\> + +Defined in: [src/types/client-manager.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L135) + +Get details about the current network. + +#### Returns + +`Promise`\<[`NetworkDetails`](../../network-client/interfaces/NetworkDetails.md)\> + +The current network details + +#### Example + +```typescript +const network = await networkClient.network() +const genesisId = network.genesisId +``` + +*** + +### genesisIdIsLocalNet() + +> `static` **genesisIdIsLocalNet**(`genesisId`): genesisId is "devnet-v1" \| "sandnet-v1" \| "dockernet-v1" + +Defined in: [src/types/client-manager.ts:159](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L159) + +Returns true if the given network genesisId is associated with a LocalNet network. + +#### Parameters + +##### genesisId + +`string` + +The network genesis ID + +#### Returns + +genesisId is "devnet-v1" \| "sandnet-v1" \| "dockernet-v1" + +Whether the given genesis ID is associated with a LocalNet network + +#### Example + +```typescript +const isLocalNet = ClientManager.genesisIdIsLocalNet('testnet-v1.0') +``` + +*** + +### getAlgodClient() + +> `static` **getAlgodClient**(`config`): `AlgodClient` + +Defined in: [src/types/client-manager.ts:590](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L590) + +Returns an algod SDK client that automatically retries on idempotent calls. + +#### Parameters + +##### config + +[`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +The config of the client + +#### Returns + +`AlgodClient` + +The Algod client + +#### Examples + +```typescript + const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('testnet', 'algod')) + await algod.healthCheck().do() +``` + +```typescript + const algod = ClientManager.getAlgodClient(ClientManager.getAlgoNodeConfig('mainnet', 'algod')) + await algod.healthCheck().do() +``` + +```typescript + const algod = ClientManager.getAlgodClient({server: 'http://localhost', port: '4001', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) + await algod.healthCheck().do() +``` + +*** + +### getAlgodClientFromEnvironment() + +> `static` **getAlgodClientFromEnvironment**(): `AlgodClient` + +Defined in: [src/types/client-manager.ts:608](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L608) + +Returns an algod SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment). + +#### Returns + +`AlgodClient` + +The Algod client + +#### Example + +```typescript + // Uses process.env.ALGOD_SERVER, process.env.ALGOD_PORT and process.env.ALGOD_TOKEN + const algod = ClientManager.getAlgodClientFromEnvironment() + await algod.healthCheck().do() + ``` + +*** + +### getAlgodConfigFromEnvironment() + +> `static` **getAlgodConfigFromEnvironment**(): [`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/types/client-manager.ts:492](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L492) + +Retrieve the algod configuration from environment variables (expects to be called from a Node.js environment) + +Expects `process.env.ALGOD_SERVER` to be defined, and you can also specify `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN`. + +#### Returns + +[`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +The Algod client configuration + +#### Throws + +Error if `process.env.ALGOD_SERVER` is not defined + +#### Example + +```typescript +const config = ClientManager.getAlgodConfigFromEnvironment() +``` + +*** + +### getAlgoNodeConfig() + +> `static` **getAlgoNodeConfig**(`network`, `config`): [`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/types/client-manager.ts:545](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L545) + +Returns the Algorand configuration to point to the free tier of the AlgoNode service. + +#### Parameters + +##### network + +Which network to connect to - TestNet or MainNet + +`"testnet"` | `"mainnet"` + +##### config + +Which algod config to return - Algod or Indexer + +`"algod"` | `"indexer"` + +#### Returns + +[`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +The AlgoNode client configuration + +#### Example + +```typescript +const config = ClientManager.getAlgoNodeConfig('testnet', 'algod') +``` + +*** + +### getConfigFromEnvironmentOrLocalNet() + +> `static` **getConfigFromEnvironmentOrLocalNet**(): [`AlgoConfig`](../../network-client/interfaces/AlgoConfig.md) + +Defined in: [src/types/client-manager.ts:456](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L456) + +Retrieve client configurations from environment variables when defined or get defaults (expects to be called from a Node.js environment) + +If both `process.env.INDEXER_SERVER` and `process.env.ALGOD_SERVER` is defined it will use both along with optional `process.env.ALGOD_PORT`, `process.env.ALGOD_TOKEN`, `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`. + +If only `process.env.ALGOD_SERVER` is defined it will use this along with optional `process.env.ALGOD_PORT` and `process.env.ALGOD_TOKEN` and leave indexer as `undefined`. + +If only `process.env.INDEXER_SERVER` is defined it will use the default (LocalNet) configuration for both algod and indexer. + +It will return a KMD configuration that uses `process.env.KMD_PORT` (or port 4002) if `process.env.ALGOD_SERVER` is defined, +otherwise it will use the default LocalNet config unless it detects testnet or mainnet. + +#### Returns + +[`AlgoConfig`](../../network-client/interfaces/AlgoConfig.md) + +The config for algod, indexer and kmd + +#### Example + +```typescript +const config = ClientManager.getConfigFromEnvironmentOrLocalNet() +``` + +*** + +### getDefaultLocalNetConfig() + +> `static` **getDefaultLocalNetConfig**(`configOrPort`): [`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/types/client-manager.ts:561](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L561) + +Returns the Algorand configuration to point to the default LocalNet. + +#### Parameters + +##### configOrPort + +Which algod config to return - algod, kmd, or indexer OR a port number + +`number` | `"algod"` | `"indexer"` | `"kmd"` + +#### Returns + +[`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +The LocalNet client configuration + +#### Example + +```typescript +const config = ClientManager.getDefaultLocalNetConfig('algod') +``` + +*** + +### getIndexerClient() + +> `static` **getIndexerClient**(`config`): `IndexerClient` + +Defined in: [src/types/client-manager.ts:633](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L633) + +Returns an indexer SDK client that automatically retries on idempotent calls + +#### Parameters + +##### config + +[`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +The config of the client + +#### Returns + +`IndexerClient` + +The Indexer client + +#### Examples + +```typescript + const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('testnet', 'indexer')) + await indexer.makeHealthCheck().do() +``` + +```typescript + const indexer = ClientManager.getIndexerClient(ClientManager.getAlgoNodeConfig('mainnet', 'indexer')) + await indexer.makeHealthCheck().do() +``` + +```typescript + const indexer = ClientManager.getIndexerClient({server: 'http://localhost', port: '8980', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) + await indexer.makeHealthCheck().do() +``` + +*** + +### getIndexerClientFromEnvironment() + +> `static` **getIndexerClientFromEnvironment**(): `IndexerClient` + +Defined in: [src/types/client-manager.ts:652](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L652) + +Returns an indexer SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment). + +#### Returns + +`IndexerClient` + +The Indexer client + +#### Example + +```typescript + // Uses process.env.INDEXER_SERVER, process.env.INDEXER_PORT and process.env.INDEXER_TOKEN + const indexer = ClientManager.getIndexerClientFromEnvironment() + await indexer.makeHealthCheck().do() + ``` + +*** + +### getIndexerConfigFromEnvironment() + +> `static` **getIndexerConfigFromEnvironment**(): [`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/types/client-manager.ts:519](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L519) + +Retrieve the indexer configuration from environment variables (expects to be called from a Node.js environment). + +Expects `process.env.INDEXER_SERVER` to be defined, and you can also specify `process.env.INDEXER_PORT` and `process.env.INDEXER_TOKEN`. + +#### Returns + +[`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +The Indexer client configuration + +#### Throws + +Error if `process.env.INDEXER_SERVER` is not defined + +#### Example + +```typescript +const config = ClientManager.getIndexerConfigFromEnvironment() +``` + +*** + +### getKmdClient() + +> `static` **getKmdClient**(`config`): `KmdClient` + +Defined in: [src/types/client-manager.ts:668](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L668) + +Returns a KMD SDK client. + +KMD client allows you to export private keys, which is useful to (for instance) get the default account in a LocalNet network. + +#### Parameters + +##### config + +[`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +The config for the client + +#### Returns + +`KmdClient` + +The KMD client + +#### Example + +```typescript + const kmd = ClientManager.getKmdClient({server: 'http://localhost', port: '4002', token: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'}) +``` + +*** + +### getKmdClientFromEnvironment() + +> `static` **getKmdClientFromEnvironment**(): `KmdClient` + +Defined in: [src/types/client-manager.ts:683](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L683) + +Returns a KMD SDK client that automatically retries on idempotent calls loaded from environment variables (expects to be called from a Node.js environment). + +#### Returns + +`KmdClient` + +The KMD client + +#### Example + +```typescript + // Uses process.env.ALGOD_SERVER, process.env.KMD_PORT (or if not specified: port 4002) and process.env.ALGOD_TOKEN + const kmd = ClientManager.getKmdClientFromEnvironment() + ``` diff --git a/docs/code/types/client-manager/interfaces/AlgoSdkClients.md b/docs/code/types/client-manager/interfaces/AlgoSdkClients.md new file mode 100644 index 00000000..1a2737ee --- /dev/null +++ b/docs/code/types/client-manager/interfaces/AlgoSdkClients.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / AlgoSdkClients + +# Interface: AlgoSdkClients + +Defined in: [src/types/client-manager.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L14) + +Clients from algosdk that interact with the official Algorand APIs + +## Properties + +### algod + +> **algod**: `AlgodClient` + +Defined in: [src/types/client-manager.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L16) + +Algod client, see https://dev.algorand.co/reference/rest-apis/algod/ + +*** + +### indexer? + +> `optional` **indexer**: `IndexerClient` + +Defined in: [src/types/client-manager.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L18) + +Optional indexer client, see https://dev.algorand.co/reference/rest-apis/indexer + +*** + +### kmd? + +> `optional` **kmd**: `KmdClient` + +Defined in: [src/types/client-manager.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L20) + +Optional KMD client, see https://dev.algorand.co/reference/rest-apis/kmd/ diff --git a/docs/code/types/client-manager/interfaces/TypedAppClient.md b/docs/code/types/client-manager/interfaces/TypedAppClient.md new file mode 100644 index 00000000..eafcabd9 --- /dev/null +++ b/docs/code/types/client-manager/interfaces/TypedAppClient.md @@ -0,0 +1,71 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / TypedAppClient + +# Interface: TypedAppClient\ + +Defined in: [src/types/client-manager.ts:693](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L693) + +Interface to identify a typed client that can be used to interact with an application. + +## Type Parameters + +### TClient + +`TClient` + +## Constructors + +### Constructor + +> **new TypedAppClient**(`params`): `TClient` + +Defined in: [src/types/client-manager.ts:694](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L694) + +#### Parameters + +##### params + +`Omit`\<[`AppClientParams`](../../app-client/interfaces/AppClientParams.md), `"appSpec"`\> + +#### Returns + +`TClient` + +## Methods + +### fromCreatorAndName() + +> **fromCreatorAndName**(`params`): `Promise`\<`TClient`\> + +Defined in: [src/types/client-manager.ts:696](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L696) + +#### Parameters + +##### params + +`Omit`\<\{ `algorand`: [`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md); `appLookupCache?`: [`AppLookup`](../../app-deployer/interfaces/AppLookup.md); `appName?`: `string`; `approvalSourceMap?`: `ProgramSourceMap`; `appSpec`: `string` \| [`Arc56Contract`](../../app-arc56/interfaces/Arc56Contract.md) \| [`AppSpec`](../../app-spec/interfaces/AppSpec.md); `clearSourceMap?`: `ProgramSourceMap`; `creatorAddress`: `string` \| `Address`; `defaultSender?`: `string` \| `Address`; `defaultSigner?`: `TransactionSigner`; `ignoreCache?`: `boolean`; \}, `"appSpec"`\> + +#### Returns + +`Promise`\<`TClient`\> + +*** + +### fromNetwork() + +> **fromNetwork**(`params`): `Promise`\<`TClient`\> + +Defined in: [src/types/client-manager.ts:695](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L695) + +#### Parameters + +##### params + +`Omit`\<[`AppClientParams`](../../app-client/interfaces/AppClientParams.md), `"appId"` \| `"appSpec"`\> + +#### Returns + +`Promise`\<`TClient`\> diff --git a/docs/code/types/client-manager/interfaces/TypedAppFactory.md b/docs/code/types/client-manager/interfaces/TypedAppFactory.md new file mode 100644 index 00000000..f263fa4e --- /dev/null +++ b/docs/code/types/client-manager/interfaces/TypedAppFactory.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / TypedAppFactory + +# Interface: TypedAppFactory\ + +Defined in: [src/types/client-manager.ts:702](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L702) + +Interface to identify a typed factory that can be used to create and deploy an application. + +## Type Parameters + +### TClient + +`TClient` + +## Constructors + +### Constructor + +> **new TypedAppFactory**(`params`): `TClient` + +Defined in: [src/types/client-manager.ts:703](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L703) + +#### Parameters + +##### params + +`Omit`\<[`AppFactoryParams`](../../app-factory/interfaces/AppFactoryParams.md), `"appSpec"`\> + +#### Returns + +`TClient` diff --git a/docs/code/types/client-manager/type-aliases/ClientAppClientByNetworkParams.md b/docs/code/types/client-manager/type-aliases/ClientAppClientByNetworkParams.md new file mode 100644 index 00000000..94b39213 --- /dev/null +++ b/docs/code/types/client-manager/type-aliases/ClientAppClientByNetworkParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / ClientAppClientByNetworkParams + +# Type Alias: ClientAppClientByNetworkParams + +> **ClientAppClientByNetworkParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppClientParams`](../../app-client/interfaces/AppClientParams.md), `"algorand"` \| `"appId"`\>\> + +Defined in: [src/types/client-manager.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L33) + +Params to get an app client by network from `ClientManager`. diff --git a/docs/code/types/client-manager/type-aliases/ClientAppClientParams.md b/docs/code/types/client-manager/type-aliases/ClientAppClientParams.md new file mode 100644 index 00000000..7cde62d2 --- /dev/null +++ b/docs/code/types/client-manager/type-aliases/ClientAppClientParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / ClientAppClientParams + +# Type Alias: ClientAppClientParams + +> **ClientAppClientParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppClientParams`](../../app-client/interfaces/AppClientParams.md), `"algorand"`\>\> + +Defined in: [src/types/client-manager.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L30) + +Params to get an app client by ID from `ClientManager`. diff --git a/docs/code/types/client-manager/type-aliases/ClientAppFactoryParams.md b/docs/code/types/client-manager/type-aliases/ClientAppFactoryParams.md new file mode 100644 index 00000000..b41d1127 --- /dev/null +++ b/docs/code/types/client-manager/type-aliases/ClientAppFactoryParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / ClientAppFactoryParams + +# Type Alias: ClientAppFactoryParams + +> **ClientAppFactoryParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppFactoryParams`](../../app-factory/interfaces/AppFactoryParams.md), `"algorand"`\>\> + +Defined in: [src/types/client-manager.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L24) + +Params to get an app factory from `ClientManager`. diff --git a/docs/code/types/client-manager/type-aliases/ClientResolveAppClientByCreatorAndNameParams.md b/docs/code/types/client-manager/type-aliases/ClientResolveAppClientByCreatorAndNameParams.md new file mode 100644 index 00000000..3c8a9f0a --- /dev/null +++ b/docs/code/types/client-manager/type-aliases/ClientResolveAppClientByCreatorAndNameParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / ClientResolveAppClientByCreatorAndNameParams + +# Type Alias: ClientResolveAppClientByCreatorAndNameParams + +> **ClientResolveAppClientByCreatorAndNameParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`ResolveAppClientByCreatorAndName`](../../app-client/type-aliases/ResolveAppClientByCreatorAndName.md), `"algorand"`\>\> + +Defined in: [src/types/client-manager.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L27) + +Params to get an app client by creator address and name from `ClientManager`. diff --git a/docs/code/types/client-manager/type-aliases/ClientTypedAppClientByCreatorAndNameParams.md b/docs/code/types/client-manager/type-aliases/ClientTypedAppClientByCreatorAndNameParams.md new file mode 100644 index 00000000..fa6d3f0a --- /dev/null +++ b/docs/code/types/client-manager/type-aliases/ClientTypedAppClientByCreatorAndNameParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / ClientTypedAppClientByCreatorAndNameParams + +# Type Alias: ClientTypedAppClientByCreatorAndNameParams + +> **ClientTypedAppClientByCreatorAndNameParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`ResolveAppClientByCreatorAndName`](../../app-client/type-aliases/ResolveAppClientByCreatorAndName.md), `"algorand"` \| `"appSpec"`\>\> + +Defined in: [src/types/client-manager.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L36) + +Params to get a typed app client by creator address and name from `ClientManager`. diff --git a/docs/code/types/client-manager/type-aliases/ClientTypedAppClientByNetworkParams.md b/docs/code/types/client-manager/type-aliases/ClientTypedAppClientByNetworkParams.md new file mode 100644 index 00000000..6abf73c2 --- /dev/null +++ b/docs/code/types/client-manager/type-aliases/ClientTypedAppClientByNetworkParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / ClientTypedAppClientByNetworkParams + +# Type Alias: ClientTypedAppClientByNetworkParams + +> **ClientTypedAppClientByNetworkParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppClientParams`](../../app-client/interfaces/AppClientParams.md), `"algorand"` \| `"appSpec"` \| `"appId"`\>\> + +Defined in: [src/types/client-manager.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L42) + +Params to get a typed app client by network from `ClientManager`. diff --git a/docs/code/types/client-manager/type-aliases/ClientTypedAppClientParams.md b/docs/code/types/client-manager/type-aliases/ClientTypedAppClientParams.md new file mode 100644 index 00000000..903fab57 --- /dev/null +++ b/docs/code/types/client-manager/type-aliases/ClientTypedAppClientParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / ClientTypedAppClientParams + +# Type Alias: ClientTypedAppClientParams + +> **ClientTypedAppClientParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppClientParams`](../../app-client/interfaces/AppClientParams.md), `"algorand"` \| `"appSpec"`\>\> + +Defined in: [src/types/client-manager.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L39) + +Params to get a typed app client by ID from `ClientManager`. diff --git a/docs/code/types/client-manager/type-aliases/ClientTypedAppFactoryParams.md b/docs/code/types/client-manager/type-aliases/ClientTypedAppFactoryParams.md new file mode 100644 index 00000000..0b9fdd34 --- /dev/null +++ b/docs/code/types/client-manager/type-aliases/ClientTypedAppFactoryParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/client-manager](../README.md) / ClientTypedAppFactoryParams + +# Type Alias: ClientTypedAppFactoryParams + +> **ClientTypedAppFactoryParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`AppFactoryParams`](../../app-factory/interfaces/AppFactoryParams.md), `"algorand"` \| `"appSpec"`\>\> + +Defined in: [src/types/client-manager.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/client-manager.ts#L45) + +Params to get a typed app factory from `ClientManager`. diff --git a/docs/code/types/composer/README.md b/docs/code/types/composer/README.md new file mode 100644 index 00000000..58040a77 --- /dev/null +++ b/docs/code/types/composer/README.md @@ -0,0 +1,50 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/composer + +# types/composer + +## Classes + +- [TransactionComposer](classes/TransactionComposer.md) + +## Interfaces + +- [BuiltTransactions](interfaces/BuiltTransactions.md) + +## Type Aliases + +- [AppCallMethodCall](type-aliases/AppCallMethodCall.md) +- [AppCallParams](type-aliases/AppCallParams.md) +- [AppCreateMethodCall](type-aliases/AppCreateMethodCall.md) +- [AppCreateParams](type-aliases/AppCreateParams.md) +- [AppDeleteMethodCall](type-aliases/AppDeleteMethodCall.md) +- [AppDeleteParams](type-aliases/AppDeleteParams.md) +- [AppMethodCall](type-aliases/AppMethodCall.md) +- [AppMethodCallParams](type-aliases/AppMethodCallParams.md) +- [AppMethodCallTransactionArgument](type-aliases/AppMethodCallTransactionArgument.md) +- [AppUpdateMethodCall](type-aliases/AppUpdateMethodCall.md) +- [AppUpdateParams](type-aliases/AppUpdateParams.md) +- [AssetConfigParams](type-aliases/AssetConfigParams.md) +- [AssetCreateParams](type-aliases/AssetCreateParams.md) +- [AssetDestroyParams](type-aliases/AssetDestroyParams.md) +- [AssetFreezeParams](type-aliases/AssetFreezeParams.md) +- [AssetOptInParams](type-aliases/AssetOptInParams.md) +- [AssetOptOutParams](type-aliases/AssetOptOutParams.md) +- [AssetTransferParams](type-aliases/AssetTransferParams.md) +- [CommonAppCallParams](type-aliases/CommonAppCallParams.md) +- [CommonTransactionParams](type-aliases/CommonTransactionParams.md) +- [OfflineKeyRegistrationParams](type-aliases/OfflineKeyRegistrationParams.md) +- [OnlineKeyRegistrationParams](type-aliases/OnlineKeyRegistrationParams.md) +- [PaymentParams](type-aliases/PaymentParams.md) +- [RawSimulateOptions](type-aliases/RawSimulateOptions.md) +- [SimulateOptions](type-aliases/SimulateOptions.md) +- [SkipSignaturesSimulateOptions](type-aliases/SkipSignaturesSimulateOptions.md) +- [TransactionComposerParams](type-aliases/TransactionComposerParams.md) +- [Txn](type-aliases/Txn.md) + +## Variables + +- [MAX\_TRANSACTION\_GROUP\_SIZE](variables/MAX_TRANSACTION_GROUP_SIZE.md) diff --git a/docs/code/types/composer/classes/TransactionComposer.md b/docs/code/types/composer/classes/TransactionComposer.md new file mode 100644 index 00000000..20ad8134 --- /dev/null +++ b/docs/code/types/composer/classes/TransactionComposer.md @@ -0,0 +1,1732 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / TransactionComposer + +# Class: TransactionComposer + +Defined in: [src/types/composer.ts:522](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L522) + +TransactionComposer helps you compose and execute transactions as a transaction group. + +## Constructors + +### Constructor + +> **new TransactionComposer**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:559](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L559) + +Create a `TransactionComposer`. + +#### Parameters + +##### params + +[`TransactionComposerParams`](../type-aliases/TransactionComposerParams.md) + +The configuration for this composer + +#### Returns + +`TransactionComposer` + +The `TransactionComposer` instance + +## Methods + +### addAppCall() + +> **addAppCall**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:1046](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1046) + +Add an application call transaction to the transaction group. + +If you want to create or update an app use `addAppCreate` or `addAppUpdate`. + +Note: we recommend using app clients to make it easier to make app calls. + +#### Parameters + +##### params + +[`AppCallParams`](../type-aliases/AppCallParams.md) + +The application call transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAppCall({ sender: 'CREATORADDRESS' }) +``` + +```typescript +composer.addAppCall({ + sender: 'CREATORADDRESS', + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAppCallMethodCall() + +> **addAppCallMethodCall**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:1258](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1258) + +Add a non-create/non-update ABI method application call transaction to the transaction group. + +Note: we recommend using app clients to make it easier to make app calls. + +#### Parameters + +##### params + +[`AppCallMethodCall`](../type-aliases/AppCallMethodCall.md) + +The ABI method application call transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +composer.addAppCallMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +composer.addAppCallMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAppCreate() + +> **addAppCreate**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:925](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L925) + +Add an application create transaction to the transaction group. + +Note: we recommend using app clients to make it easier to make app calls. + +#### Parameters + +##### params + +The application create transaction parameters + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### approvalProgram + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +The program to execute for all OnCompletes other than ClearState as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)). + +###### args? + +`Uint8Array`\<`ArrayBufferLike`\>[] + +Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### clearStateProgram + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +The program to execute for ClearState OnComplete as raw teal that will be compiled (string) or compiled teal (encoded as a byte array (Uint8Array)). + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### extraProgramPages? + +`number` + +Number of extra pages required for the programs. +Defaults to the number needed for the programs in this call if not specified. +This is immutable once the app is created. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`NoOpOC` \| `OptInOC` \| `CloseOutOC` \| `UpdateApplicationOC` \| `DeleteApplicationOC` + +The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### schema? + +\{ `globalByteSlices`: `number`; `globalInts`: `number`; `localByteSlices`: `number`; `localInts`: `number`; \} + +The state schema for the app. This is immutable once the app is created. + +###### schema.globalByteSlices + +`number` + +The number of byte slices saved in global state. + +###### schema.globalInts + +`number` + +The number of integers saved in global state. + +###### schema.localByteSlices + +`number` + +The number of byte slices saved in local state. + +###### schema.localInts + +`number` + +The number of integers saved in local state. + +###### sender + +`string` \| `Address` + +The address of the account sending the transaction. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAppCreate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) +``` + +```typescript +composer.addAppCreate({ + sender: 'CREATORADDRESS', + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + schema: { + globalInts: 1, + globalByteSlices: 2, + localInts: 3, + localByteSlices: 4 + }, + extraProgramPages: 1, + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), + // Signer only needed if you want to provide one, + // generally you'd register it with AlgorandClient + // against the sender and not need to pass it in + signer: transactionSigner, + maxRoundsToWaitForConfirmation: 5, + suppressLog: true, +}) +``` + +*** + +### addAppCreateMethodCall() + +> **addAppCreateMethodCall**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:1106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1106) + +Add an ABI method create application call transaction to the transaction group. + +Note: we recommend using app clients to make it easier to make app calls. + +#### Parameters + +##### params + +[`AppCreateMethodCall`](../type-aliases/AppCreateMethodCall.md) + +The ABI create method application call transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +composer.addAppCreateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +composer.addAppCreateMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + schema: { + globalInts: 1, + globalByteSlices: 2, + localInts: 3, + localByteSlices: 4 + }, + extraProgramPages: 1, + onComplete: algosdk.OnApplicationComplete.OptInOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAppDelete() + +> **addAppDelete**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:1005](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1005) + +Add an application delete transaction to the transaction group. + +Note: we recommend using app clients to make it easier to make app calls. + +#### Parameters + +##### params + +[`AppDeleteParams`](../type-aliases/AppDeleteParams.md) + +The application delete transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAppDelete({ sender: 'CREATORADDRESS' }) +``` + +```typescript +composer.addAppDelete({ + sender: 'CREATORADDRESS', + onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAppDeleteMethodCall() + +> **addAppDeleteMethodCall**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:1208](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1208) + +Add an ABI method delete application call transaction to the transaction group. + +Note: we recommend using app clients to make it easier to make app calls. + +#### Parameters + +##### params + +[`AppDeleteMethodCall`](../type-aliases/AppDeleteMethodCall.md) + +The ABI delete method application call transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +composer.addAppDeleteMethodCall({ sender: 'CREATORADDRESS', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +composer.addAppDeleteMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + onComplete: algosdk.OnApplicationComplete.DeleteApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAppUpdate() + +> **addAppUpdate**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:966](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L966) + +Add an application update transaction to the transaction group. + +Note: we recommend using app clients to make it easier to make app calls. + +#### Parameters + +##### params + +The application update transaction parameters + +###### accountReferences? + +(`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### appId + +`bigint` + +ID of the application; 0 if the application is being created. + +###### appReferences? + +`bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### approvalProgram + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +The program to execute for all OnCompletes other than ClearState as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array)) + +###### args? + +`Uint8Array`\<`ArrayBufferLike`\>[] + +Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). + +###### assetReferences? + +`bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +###### boxReferences? + +([`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md) \| [`BoxReference`](../../app-manager/interfaces/BoxReference.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +###### clearStateProgram + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +The program to execute for ClearState OnComplete as raw teal (string) or compiled teal (base 64 encoded as a byte array (Uint8Array)) + +###### extraFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +###### firstValidRound? + +`bigint` + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +###### lastValidRound? + +`bigint` + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +###### lease? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +###### maxFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +###### note? + +`string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Note to attach to the transaction. Max of 1000 bytes. + +###### onComplete? + +`UpdateApplicationOC` + +The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. + +###### rekeyTo? + +`string` \| `Address` + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +###### sender + +`string` \| `Address` + +The address of the account sending the transaction. + +###### signer? + +`TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +###### staticFee? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +###### validityWindow? + +`number` \| `bigint` + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAppUpdate({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE' }) +``` + +```typescript +composer.addAppUpdate({ + sender: 'CREATORADDRESS', + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAppUpdateMethodCall() + +> **addAppUpdateMethodCall**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:1158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1158) + +Add an ABI method update application call transaction to the transaction group. + +Note: we recommend using app clients to make it easier to make app calls. + +#### Parameters + +##### params + +[`AppUpdateMethodCall`](../type-aliases/AppUpdateMethodCall.md) + +The ABI update method application call transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +composer.addAppUpdateMethodCall({ sender: 'CREATORADDRESS', approvalProgram: 'TEALCODE', clearStateProgram: 'TEALCODE', method: method, args: ["arg1_value"] }) +``` + +```typescript +const method = new ABIMethod({ + name: 'method', + args: [{ name: 'arg1', type: 'string' }], + returns: { type: 'string' }, +}) +composer.addAppUpdateMethodCall({ + sender: 'CREATORADDRESS', + method: method, + args: ["arg1_value"], + approvalProgram: "TEALCODE", + clearStateProgram: "TEALCODE", + onComplete: algosdk.OnApplicationComplete.UpdateApplicationOC, + args: [new Uint8Array(1, 2, 3, 4)] + accountReferences: ["ACCOUNT_1"] + appReferences: [123n, 1234n] + assetReferences: [12345n] + boxReferences: ["box1", {appId: 1234n, name: "box2"}] + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAssetConfig() + +> **addAssetConfig**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:698](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L698) + +Add an asset config transaction to the transaction group. + +#### Parameters + +##### params + +[`AssetConfigParams`](../type-aliases/AssetConfigParams.md) + +The asset config transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAssetConfig({ sender: "MANAGERADDRESS", assetId: 123456n, manager: "MANAGERADDRESS" }) +``` + +```typescript +composer.addAssetConfig({ + sender: 'MANAGERADDRESS', + assetId: 123456n, + manager: 'MANAGERADDRESS', + reserve: 'RESERVEADDRESS', + freeze: 'FREEZEADDRESS', + clawback: 'CLAWBACKADDRESS', + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) + +*** + +### addAssetCreate() + +> **addAssetCreate**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:663](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L663) + +Add an asset create transaction to the transaction group. + +#### Parameters + +##### params + +[`AssetCreateParams`](../type-aliases/AssetCreateParams.md) + +The asset create transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAssetCreate({ sender: "CREATORADDRESS", total: 100n}) +``` + +```typescript +composer.addAssetCreate({ + sender: 'CREATORADDRESS', + total: 100n, + decimals: 2, + assetName: 'asset', + unitName: 'unit', + url: 'url', + metadataHash: 'metadataHash', + defaultFrozen: false, + manager: 'MANAGERADDRESS', + reserve: 'RESERVEADDRESS', + freeze: 'FREEZEADDRESS', + clawback: 'CLAWBACKADDRESS', + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) + +*** + +### addAssetDestroy() + +> **addAssetDestroy**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:764](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L764) + +Add an asset destroy transaction to the transaction group. + +#### Parameters + +##### params + +[`AssetDestroyParams`](../type-aliases/AssetDestroyParams.md) + +The asset destroy transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAssetDestroy({ sender: "MANAGERADDRESS", assetId: 123456n }) +``` + +```typescript +composer.addAssetDestroy({ + sender: 'MANAGERADDRESS', + assetId: 123456n, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAssetFreeze() + +> **addAssetFreeze**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:732](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L732) + +Add an asset freeze transaction to the transaction group. + +#### Parameters + +##### params + +[`AssetFreezeParams`](../type-aliases/AssetFreezeParams.md) + +The asset freeze transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAssetFreeze({ sender: "MANAGERADDRESS", assetId: 123456n, account: "ACCOUNTADDRESS", frozen: true }) +``` + +```typescript +composer.addAssetFreeze({ + sender: 'MANAGERADDRESS', + assetId: 123456n, + account: 'ACCOUNTADDRESS', + frozen: true, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAssetOptIn() + +> **addAssetOptIn**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:833](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L833) + +Add an asset opt-in transaction to the transaction group. + +#### Parameters + +##### params + +[`AssetOptInParams`](../type-aliases/AssetOptInParams.md) + +The asset opt-in transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAssetOptIn({ sender: "SENDERADDRESS", assetId: 123456n }) +``` + +```typescript +composer.addAssetOptIn({ + sender: 'SENDERADDRESS', + assetId: 123456n, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAssetOptOut() + +> **addAssetOptOut**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:871](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L871) + +Add an asset opt-out transaction to the transaction group. + +#### Parameters + +##### params + +[`AssetOptOutParams`](../type-aliases/AssetOptOutParams.md) + +The asset opt-out transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAssetOptOut({ sender: "SENDERADDRESS", assetId: 123456n, ensureZeroBalance: true }) +``` + +```typescript +composer.addAssetOptOut({ sender: "SENDERADDRESS", creator: "CREATORADDRESS", assetId: 123456n, ensureZeroBalance: true }) +``` + +```typescript +composer.addAssetOptOut({ + sender: 'SENDERADDRESS', + assetId: 123456n, + creator: 'CREATORADDRESS', + ensureZeroBalance: true, + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAssetTransfer() + +> **addAssetTransfer**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:801](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L801) + +Add an asset transfer transaction to the transaction group. + +#### Parameters + +##### params + +[`AssetTransferParams`](../type-aliases/AssetTransferParams.md) + +The asset transfer transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addAssetTransfer({ sender: "HOLDERADDRESS", assetId: 123456n, amount: 1n, receiver: "RECEIVERADDRESS" }) +``` + +```typescript +composer.addAssetTransfer({ + sender: 'CLAWBACKADDRESS', + assetId: 123456n, + amount: 1n, + receiver: 'RECEIVERADDRESS', + clawbackTarget: 'HOLDERADDRESS', + // This field needs to be used with caution + closeAssetTo: 'ADDRESSTOCLOSETO' + lease: 'lease', + note: 'note', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addAtc() + +> **addAtc**(`atc`): `TransactionComposer` + +Defined in: [src/types/composer.ts:1356](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1356) + +Add the transactions within an `AtomicTransactionComposer` to the transaction group. + +#### Parameters + +##### atc + +`AtomicTransactionComposer` + +The `AtomicTransactionComposer` to build transactions from and add to the group + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Example + +```typescript +const atc = new AtomicTransactionComposer() + .addPayment({ sender: 'SENDERADDRESS', receiver: 'RECEIVERADDRESS', amount: 1000n }) +composer.addAtc(atc) +``` + +*** + +### addOfflineKeyRegistration() + +> **addOfflineKeyRegistration**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:1339](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1339) + +Add an offline key registration transaction to the transaction group. + +#### Parameters + +##### params + +[`OfflineKeyRegistrationParams`](../type-aliases/OfflineKeyRegistrationParams.md) + +The offline key registration transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addOfflineKeyRegistration({ + sender: 'SENDERADDRESS', +}) +``` + +```typescript +composer.addOfflineKeyRegistration({ + sender: 'SENDERADDRESS', + lease: 'lease', + note: 'note', + // Use this with caution, it's generally better to use algorand.account.rekeyAccount + rekeyTo: 'REKEYTOADDRESS', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addOnlineKeyRegistration() + +> **addOnlineKeyRegistration**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:1304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1304) + +Add an online key registration transaction to the transaction group. + +#### Parameters + +##### params + +[`OnlineKeyRegistrationParams`](../type-aliases/OnlineKeyRegistrationParams.md) + +The online key registration transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addOnlineKeyRegistration({ + sender: 'SENDERADDRESS', + voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), + selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), + stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), + voteFirst: 1n, + voteLast: 1000n, + voteKeyDilution: 1n, +}) +``` + +```typescript +composer.addOnlineKeyRegistration({ + sender: 'SENDERADDRESS', + voteKey: Uint8Array.from(Buffer.from("voteKeyBase64", 'base64')), + selectionKey: Uint8Array.from(Buffer.from("selectionKeyBase64", 'base64')), + stateProofKey: Uint8Array.from(Buffer.from("stateProofKeyBase64", 'base64')), + voteFirst: 1n, + voteLast: 1000n, + voteKeyDilution: 1n, + lease: 'lease', + note: 'note', + // Use this with caution, it's generally better to use algorand.account.rekeyAccount + rekeyTo: 'REKEYTOADDRESS', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) +``` + +*** + +### addPayment() + +> **addPayment**(`params`): `TransactionComposer` + +Defined in: [src/types/composer.ts:622](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L622) + +Add a payment transaction to the transaction group. + +#### Parameters + +##### params + +[`PaymentParams`](../type-aliases/PaymentParams.md) + +The payment transaction parameters + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Examples + +```typescript +composer.addPayment({ + sender: 'SENDERADDRESS', + receiver: 'RECEIVERADDRESS', + amount: (4).algo(), +}) +``` + +```typescript +composer.addPayment({ + amount: (4).algo(), + receiver: 'RECEIVERADDRESS', + sender: 'SENDERADDRESS', + closeRemainderTo: 'CLOSEREMAINDERTOADDRESS', + lease: 'lease', + note: 'note', + // Use this with caution, it's generally better to use algorand.account.rekeyAccount + rekeyTo: 'REKEYTOADDRESS', + // You wouldn't normally set this field + firstValidRound: 1000n, + validityWindow: 10, + extraFee: (1000).microAlgo(), + staticFee: (1000).microAlgo(), + // Max fee doesn't make sense with extraFee AND staticFee + // already specified, but here for completeness + maxFee: (3000).microAlgo(), +}) + +*** + +### addTransaction() + +> **addTransaction**(`transaction`, `signer?`): `TransactionComposer` + +Defined in: [src/types/composer.ts:579](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L579) + +Add a pre-built transaction to the transaction group. + +#### Parameters + +##### transaction + +`Transaction` + +The pre-built transaction + +##### signer? + +`TransactionSigner` + +Optional signer override for the transaction + +#### Returns + +`TransactionComposer` + +The composer so you can chain method calls + +#### Example + +```typescript +composer.addTransaction(txn) +``` + +*** + +### build() + +> **build**(): `Promise`\<\{ `atc`: `AtomicTransactionComposer`; `methodCalls`: `any`; `transactions`: `TransactionWithSigner`[]; \}\> + +Defined in: [src/types/composer.ts:1886](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1886) + +Compose all of the transactions in a single atomic transaction group and an atomic transaction composer. + +You can then use the transactions standalone, or use the composer to execute or simulate the transactions. + +Once this method is called, no further transactions will be able to be added. +You can safely call this method multiple times to get the same result. + +#### Returns + +`Promise`\<\{ `atc`: `AtomicTransactionComposer`; `methodCalls`: `any`; `transactions`: `TransactionWithSigner`[]; \}\> + +The built atomic transaction composer, the transactions and any corresponding method calls + +#### Example + +```typescript +const { atc, transactions, methodCalls } = await composer.build() +``` + +*** + +### buildTransactions() + +> **buildTransactions**(): `Promise`\<[`BuiltTransactions`](../interfaces/BuiltTransactions.md)\> + +Defined in: [src/types/composer.ts:1828](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1828) + +Compose all of the transactions without signers and return the transaction objects directly along with any ABI method calls. + +#### Returns + +`Promise`\<[`BuiltTransactions`](../interfaces/BuiltTransactions.md)\> + +The array of built transactions and any corresponding method calls + +#### Example + +```typescript +const { transactions, methodCalls, signers } = await composer.buildTransactions() +``` + +*** + +### count() + +> **count**(): `Promise`\<`number`\> + +Defined in: [src/types/composer.ts:1869](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1869) + +Get the number of transactions currently added to this composer. + +#### Returns + +`Promise`\<`number`\> + +The number of transactions currently added to this composer + +*** + +### ~~execute()~~ + +> **execute**(`params?`): `Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md)\> + +Defined in: [src/types/composer.ts:1980](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1980) + +#### Parameters + +##### params? + +[`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters to control execution with + +#### Returns + +`Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md)\> + +The execution result + +#### Deprecated + +Use `send` instead. + +Compose the atomic transaction group and send it to the network + +An alias for `composer.send(params)`. + +*** + +### rebuild() + +> **rebuild**(): `Promise`\<\{ `atc`: `AtomicTransactionComposer`; `methodCalls`: `any`; `transactions`: `TransactionWithSigner`[]; \}\> + +Defined in: [src/types/composer.ts:1925](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1925) + +Rebuild the group, discarding any previously built transactions. +This will potentially cause new signers and suggested params to be used if the callbacks return a new value compared to the first build. + +#### Returns + +`Promise`\<\{ `atc`: `AtomicTransactionComposer`; `methodCalls`: `any`; `transactions`: `TransactionWithSigner`[]; \}\> + +The newly built atomic transaction composer and the transactions + +#### Example + +```typescript +const { atc, transactions, methodCalls } = await composer.rebuild() +``` + +*** + +### send() + +> **send**(`params?`): `Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md)\> + +Defined in: [src/types/composer.ts:1939](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1939) + +Compose the atomic transaction group and send it to the network. + +#### Parameters + +##### params? + +[`SendParams`](../../transaction/interfaces/SendParams.md) + +The parameters to control execution with + +#### Returns + +`Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md)\> + +The execution result + +#### Example + +```typescript +const result = await composer.send() +``` + +*** + +### simulate() + +#### Call Signature + +> **simulate**(): `Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md) & `object`\> + +Defined in: [src/types/composer.ts:1992](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L1992) + +Compose the atomic transaction group and simulate sending it to the network + +##### Returns + +`Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md) & `object`\> + +The simulation result + +##### Example + +```typescript +const result = await composer.simulate() +``` + +#### Call Signature + +> **simulate**(`options`): `Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md) & `object`\> + +Defined in: [src/types/composer.ts:2003](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L2003) + +Compose the atomic transaction group and simulate sending it to the network + +##### Parameters + +###### options + +###### allowMoreLogging? + +`boolean` + +###### allowUnnamedResources? + +`boolean` + +###### execTraceConfig? + +`SimulateTraceConfig` + +###### extraOpcodeBudget? + +`number` \| `bigint` + +###### round? + +`number` \| `bigint` + +###### skipSignatures + +`boolean` + +Whether or not to skip signatures for all built transactions and use an empty signer instead. +This will set `fixSigners` and `allowEmptySignatures` when sending the request to the algod API. + +##### Returns + +`Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md) & `object`\> + +The simulation result + +##### Example + +```typescript +const result = await composer.simulate({ + skipSignatures: true, +}) +``` + +#### Call Signature + +> **simulate**(`options`): `Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md) & `object`\> + +Defined in: [src/types/composer.ts:2016](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L2016) + +Compose the atomic transaction group and simulate sending it to the network + +##### Parameters + +###### options + +###### allowEmptySignatures? + +`boolean` + +###### allowMoreLogging? + +`boolean` + +###### allowUnnamedResources? + +`boolean` + +###### execTraceConfig? + +`SimulateTraceConfig` + +###### extraOpcodeBudget? + +`number` \| `bigint` + +###### fixSigners? + +`boolean` + +###### round? + +`number` \| `bigint` + +##### Returns + +`Promise`\<[`SendAtomicTransactionComposerResults`](../../transaction/interfaces/SendAtomicTransactionComposerResults.md) & `object`\> + +The simulation result + +##### Example + +```typescript +const result = await composer.simulate({ + extraOpcodeBudget: 1000, +}) +``` + +*** + +### arc2Note() + +> `static` **arc2Note**(`note`): `Uint8Array` + +Defined in: [src/types/composer.ts:2093](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L2093) + +Create an encoded transaction note that follows the ARC-2 spec. + +https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md + +#### Parameters + +##### note + +[`Arc2TransactionNote`](../../transaction/type-aliases/Arc2TransactionNote.md) + +The ARC-2 transaction note data + +#### Returns + +`Uint8Array` + +The binary encoded transaction note diff --git a/docs/code/types/composer/interfaces/BuiltTransactions.md b/docs/code/types/composer/interfaces/BuiltTransactions.md new file mode 100644 index 00000000..f6a01856 --- /dev/null +++ b/docs/code/types/composer/interfaces/BuiltTransactions.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / BuiltTransactions + +# Interface: BuiltTransactions + +Defined in: [src/types/composer.ts:512](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L512) + +Set of transactions built by `TransactionComposer`. + +## Properties + +### methodCalls + +> **methodCalls**: `Map`\<`number`, `ABIMethod`\> + +Defined in: [src/types/composer.ts:516](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L516) + +Any `ABIMethod` objects associated with any of the transactions in a map keyed by transaction index. + +*** + +### signers + +> **signers**: `Map`\<`number`, `TransactionSigner`\> + +Defined in: [src/types/composer.ts:518](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L518) + +Any `TransactionSigner` objects associated with any of the transactions in a map keyed by transaction index. + +*** + +### transactions + +> **transactions**: `Transaction`[] + +Defined in: [src/types/composer.ts:514](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L514) + +The built transactions diff --git a/docs/code/types/composer/type-aliases/AppCallMethodCall.md b/docs/code/types/composer/type-aliases/AppCallMethodCall.md new file mode 100644 index 00000000..1a1de4a9 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppCallMethodCall.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppCallMethodCall + +# Type Alias: AppCallMethodCall + +> **AppCallMethodCall** = [`AppMethodCall`](AppMethodCall.md)\<[`AppMethodCallParams`](AppMethodCallParams.md)\> + +Defined in: [src/types/composer.ts:426](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L426) + +Parameters to define an ABI method call transaction. diff --git a/docs/code/types/composer/type-aliases/AppCallParams.md b/docs/code/types/composer/type-aliases/AppCallParams.md new file mode 100644 index 00000000..02acecf3 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppCallParams.md @@ -0,0 +1,19 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppCallParams + +# Type Alias: AppCallParams + +> **AppCallParams** = [`CommonAppCallParams`](CommonAppCallParams.md) & `object` + +Defined in: [src/types/composer.ts:402](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L402) + +Parameters to define an application call transaction. + +## Type declaration + +### onComplete? + +> `optional` **onComplete**: `Exclude`\<`algosdk.OnApplicationComplete`, `algosdk.OnApplicationComplete.UpdateApplicationOC`\> diff --git a/docs/code/types/composer/type-aliases/AppCreateMethodCall.md b/docs/code/types/composer/type-aliases/AppCreateMethodCall.md new file mode 100644 index 00000000..c0e419dc --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppCreateMethodCall.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppCreateMethodCall + +# Type Alias: AppCreateMethodCall + +> **AppCreateMethodCall** = [`AppMethodCall`](AppMethodCall.md)\<[`AppCreateParams`](AppCreateParams.md)\> + +Defined in: [src/types/composer.ts:420](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L420) + +Parameters to define an ABI method call create transaction. diff --git a/docs/code/types/composer/type-aliases/AppCreateParams.md b/docs/code/types/composer/type-aliases/AppCreateParams.md new file mode 100644 index 00000000..66fb365b --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppCreateParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppCreateParams + +# Type Alias: AppCreateParams + +> **AppCreateParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`CommonAppCallParams`](CommonAppCallParams.md), `"appId"`\> & `object`\> + +Defined in: [src/types/composer.ts:365](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L365) + +Parameters to define an app create transaction diff --git a/docs/code/types/composer/type-aliases/AppDeleteMethodCall.md b/docs/code/types/composer/type-aliases/AppDeleteMethodCall.md new file mode 100644 index 00000000..488b485c --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppDeleteMethodCall.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppDeleteMethodCall + +# Type Alias: AppDeleteMethodCall + +> **AppDeleteMethodCall** = [`AppMethodCall`](AppMethodCall.md)\<[`AppDeleteParams`](AppDeleteParams.md)\> + +Defined in: [src/types/composer.ts:424](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L424) + +Parameters to define an ABI method call delete transaction. diff --git a/docs/code/types/composer/type-aliases/AppDeleteParams.md b/docs/code/types/composer/type-aliases/AppDeleteParams.md new file mode 100644 index 00000000..6ae4cfb8 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppDeleteParams.md @@ -0,0 +1,19 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppDeleteParams + +# Type Alias: AppDeleteParams + +> **AppDeleteParams** = [`CommonAppCallParams`](CommonAppCallParams.md) & `object` + +Defined in: [src/types/composer.ts:415](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L415) + +Parameters to define an application delete call transaction. + +## Type declaration + +### onComplete? + +> `optional` **onComplete**: `algosdk.OnApplicationComplete.DeleteApplicationOC` diff --git a/docs/code/types/composer/type-aliases/AppMethodCall.md b/docs/code/types/composer/type-aliases/AppMethodCall.md new file mode 100644 index 00000000..603dc69b --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppMethodCall.md @@ -0,0 +1,39 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppMethodCall + +# Type Alias: AppMethodCall\ + +> **AppMethodCall**\<`T`\> = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<`T`, `"args"`\>\> & `object` + +Defined in: [src/types/composer.ts:439](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L439) + +Parameters to define an ABI method call. + +## Type declaration + +### args? + +> `optional` **args**: (`algosdk.ABIValue` \| `TransactionWithSigner` \| `Transaction` \| `Promise`\<`Transaction`\> \| `AppMethodCall`\<[`AppCreateParams`](AppCreateParams.md)\> \| `AppMethodCall`\<[`AppUpdateParams`](AppUpdateParams.md)\> \| `AppMethodCall`\<[`AppMethodCallParams`](AppMethodCallParams.md)\> \| `undefined`)[] + +Arguments to the ABI method, either: +* An ABI value +* A transaction with explicit signer +* A transaction (where the signer will be automatically assigned) +* An unawaited transaction (e.g. from algorand.createTransaction.{transactionType}()) +* Another method call (via method call params object) +* undefined (this represents a placeholder transaction argument that is fulfilled by another method call argument) + +### method + +> **method**: `algosdk.ABIMethod` + +The ABI method to call + +## Type Parameters + +### T + +`T` diff --git a/docs/code/types/composer/type-aliases/AppMethodCallParams.md b/docs/code/types/composer/type-aliases/AppMethodCallParams.md new file mode 100644 index 00000000..f4063d47 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppMethodCallParams.md @@ -0,0 +1,19 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppMethodCallParams + +# Type Alias: AppMethodCallParams + +> **AppMethodCallParams** = [`CommonAppCallParams`](CommonAppCallParams.md) & `object` + +Defined in: [src/types/composer.ts:407](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L407) + +Common parameters to define an ABI method call transaction. + +## Type declaration + +### onComplete? + +> `optional` **onComplete**: `Exclude`\<`algosdk.OnApplicationComplete`, `algosdk.OnApplicationComplete.UpdateApplicationOC` \| `algosdk.OnApplicationComplete.ClearStateOC`\> diff --git a/docs/code/types/composer/type-aliases/AppMethodCallTransactionArgument.md b/docs/code/types/composer/type-aliases/AppMethodCallTransactionArgument.md new file mode 100644 index 00000000..798f6d42 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppMethodCallTransactionArgument.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppMethodCallTransactionArgument + +# Type Alias: AppMethodCallTransactionArgument + +> **AppMethodCallTransactionArgument** = `TransactionWithSigner` \| `Transaction` \| `Promise`\<`Transaction`\> \| [`AppMethodCall`](AppMethodCall.md)\<[`AppCreateParams`](AppCreateParams.md)\> \| [`AppMethodCall`](AppMethodCall.md)\<[`AppUpdateParams`](AppUpdateParams.md)\> \| [`AppMethodCall`](AppMethodCall.md)\<[`AppMethodCallParams`](AppMethodCallParams.md)\> + +Defined in: [src/types/composer.ts:429](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L429) + +Types that can be used to define a transaction argument for an ABI call transaction. diff --git a/docs/code/types/composer/type-aliases/AppUpdateMethodCall.md b/docs/code/types/composer/type-aliases/AppUpdateMethodCall.md new file mode 100644 index 00000000..7c04fec4 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppUpdateMethodCall.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppUpdateMethodCall + +# Type Alias: AppUpdateMethodCall + +> **AppUpdateMethodCall** = [`AppMethodCall`](AppMethodCall.md)\<[`AppUpdateParams`](AppUpdateParams.md)\> + +Defined in: [src/types/composer.ts:422](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L422) + +Parameters to define an ABI method call update transaction. diff --git a/docs/code/types/composer/type-aliases/AppUpdateParams.md b/docs/code/types/composer/type-aliases/AppUpdateParams.md new file mode 100644 index 00000000..2076aeb1 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AppUpdateParams.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AppUpdateParams + +# Type Alias: AppUpdateParams + +> **AppUpdateParams** = [`Expand`](../../expand/type-aliases/Expand.md)\<[`CommonAppCallParams`](CommonAppCallParams.md) & `object`\> + +Defined in: [src/types/composer.ts:391](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L391) + +Parameters to define an app update transaction diff --git a/docs/code/types/composer/type-aliases/AssetConfigParams.md b/docs/code/types/composer/type-aliases/AssetConfigParams.md new file mode 100644 index 00000000..ee9cacb2 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AssetConfigParams.md @@ -0,0 +1,73 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AssetConfigParams + +# Type Alias: AssetConfigParams + +> **AssetConfigParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:218](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L218) + +Parameters to define an asset reconfiguration transaction. + +**Note:** The manager, reserve, freeze, and clawback addresses +are immutably empty if they are not set. If manager is not set then +all fields are immutable from that point forward. + +## Type declaration + +### assetId + +> **assetId**: `bigint` + +ID of the asset to reconfigure + +### clawback? + +> `optional` **clawback**: `string` \| `Address` + +The address of the optional account that can clawback holdings of this asset from any account. + +**This field should be used with caution** as the clawback account has the ability to **unconditionally take assets from any account**. + +If empty, clawback is not permitted. + +If not set (`undefined` or `""`) the field will become permanently empty. + +### freeze? + +> `optional` **freeze**: `string` \| `Address` + +The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account. + +If empty, freezing is not permitted. + +If not set (`undefined` or `""`) the field will become permanently empty. + +### manager + +> **manager**: `string` \| `Address` \| `undefined` + +The address of the optional account that can manage the configuration of the asset and destroy it. + +The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`. + +If not set (`undefined` or `""`) the asset will become permanently immutable. + +### reserve? + +> `optional` **reserve**: `string` \| `Address` + +The address of the optional account that holds the reserve (uncirculated supply) units of the asset. + +This address has no specific authority in the protocol itself and is informational only. + +Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md) +rely on this field to hold meaningful data. + +It can be used in the case where you want to signal to holders of your asset that the uncirculated units +of the asset reside in an account that is different from the default creator account. + +If not set (`undefined` or `""`) the field will become permanently empty. diff --git a/docs/code/types/composer/type-aliases/AssetCreateParams.md b/docs/code/types/composer/type-aliases/AssetCreateParams.md new file mode 100644 index 00000000..4094f646 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AssetCreateParams.md @@ -0,0 +1,144 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AssetCreateParams + +# Type Alias: AssetCreateParams + +> **AssetCreateParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:102](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L102) + +Parameters to define an asset create transaction. + +The account that sends this transaction will automatically be opted in to the asset and will hold all units after creation. + +## Type declaration + +### assetName? + +> `optional` **assetName**: `string` + +The optional name of the asset. + +Max size is 32 bytes. + +This field can only be specified upon asset creation. + +### clawback? + +> `optional` **clawback**: `string` \| `Address` + +The address of the optional account that can clawback holdings of this asset from any account. + +**This field should be used with caution** as the clawback account has the ability to **unconditionally take assets from any account**. + +If empty, clawback is not permitted. + +If not set (`undefined` or `""`) at asset creation or subsequently set to empty by the manager the field is permanently empty. + +### decimals? + +> `optional` **decimals**: `number` + +The amount of decimal places the asset should have. + +If unspecified then the asset will be in whole units (i.e. `0`). + +* If 0, the asset is not divisible; +* If 1, the base unit of the asset is in tenths; +* If 2, the base unit of the asset is in hundredths; +* If 3, the base unit of the asset is in thousandths; +* and so on up to 19 decimal places. + +This field can only be specified upon asset creation. + +### defaultFrozen? + +> `optional` **defaultFrozen**: `boolean` + +Whether the asset is frozen by default for all accounts. +Defaults to `false`. + +If `true` then for anyone apart from the creator to hold the +asset it needs to be unfrozen per account using an asset freeze +transaction from the `freeze` account, which must be set on creation. + +This field can only be specified upon asset creation. + +### freeze? + +> `optional` **freeze**: `string` \| `Address` + +The address of the optional account that can be used to freeze or unfreeze holdings of this asset for any account. + +If empty, freezing is not permitted. + +If not set (`undefined` or `""`) at asset creation or subsequently set to empty by the manager the field is permanently empty. + +### manager? + +> `optional` **manager**: `string` \| `Address` + +The address of the optional account that can manage the configuration of the asset and destroy it. + +The configuration fields it can change are `manager`, `reserve`, `clawback`, and `freeze`. + +If not set (`undefined` or `""`) at asset creation or subsequently set to empty by the `manager` the asset becomes permanently immutable. + +### metadataHash? + +> `optional` **metadataHash**: `string` \| `Uint8Array` + +32-byte hash of some metadata that is relevant to your asset and/or asset holders. + +The format of this metadata is up to the application. + +This field can only be specified upon asset creation. + +### reserve? + +> `optional` **reserve**: `string` \| `Address` + +The address of the optional account that holds the reserve (uncirculated supply) units of the asset. + +This address has no specific authority in the protocol itself and is informational only. + +Some standards like [ARC-19](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0019.md) +rely on this field to hold meaningful data. + +It can be used in the case where you want to signal to holders of your asset that the uncirculated units +of the asset reside in an account that is different from the default creator account. + +If not set (`undefined` or `""`) at asset creation or subsequently set to empty by the manager the field is permanently empty. + +### total + +> **total**: `bigint` + +The total amount of the smallest divisible (decimal) unit to create. + +For example, if `decimals` is, say, 2, then for every 100 `total` there would be 1 whole unit. + +This field can only be specified upon asset creation. + +### unitName? + +> `optional` **unitName**: `string` + +The optional name of the unit of this asset (e.g. ticker name). + +Max size is 8 bytes. + +This field can only be specified upon asset creation. + +### url? + +> `optional` **url**: `string` + +Specifies an optional URL where more information about the asset can be retrieved (e.g. metadata). + +Max size is 96 bytes. + +This field can only be specified upon asset creation. diff --git a/docs/code/types/composer/type-aliases/AssetDestroyParams.md b/docs/code/types/composer/type-aliases/AssetDestroyParams.md new file mode 100644 index 00000000..1d4a14ab --- /dev/null +++ b/docs/code/types/composer/type-aliases/AssetDestroyParams.md @@ -0,0 +1,23 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AssetDestroyParams + +# Type Alias: AssetDestroyParams + +> **AssetDestroyParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L276) + +Parameters to define an asset destroy transaction. + +Created assets can be destroyed only by the asset manager account. All of the assets must be owned by the creator of the asset before the asset can be deleted. + +## Type declaration + +### assetId + +> **assetId**: `bigint` + +ID of the asset to destroy diff --git a/docs/code/types/composer/type-aliases/AssetFreezeParams.md b/docs/code/types/composer/type-aliases/AssetFreezeParams.md new file mode 100644 index 00000000..8037a2ca --- /dev/null +++ b/docs/code/types/composer/type-aliases/AssetFreezeParams.md @@ -0,0 +1,33 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AssetFreezeParams + +# Type Alias: AssetFreezeParams + +> **AssetFreezeParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L263) + +Parameters to define an asset freeze transaction. + +## Type declaration + +### account + +> **account**: `string` \| `Address` + +The address of the account to freeze or unfreeze + +### assetId + +> **assetId**: `bigint` + +The ID of the asset to freeze/unfreeze + +### frozen + +> **frozen**: `boolean` + +Whether the assets in the account should be frozen diff --git a/docs/code/types/composer/type-aliases/AssetOptInParams.md b/docs/code/types/composer/type-aliases/AssetOptInParams.md new file mode 100644 index 00000000..ba749b79 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AssetOptInParams.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AssetOptInParams + +# Type Alias: AssetOptInParams + +> **AssetOptInParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:304](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L304) + +Parameters to define an asset opt-in transaction. + +## Type declaration + +### assetId + +> **assetId**: `bigint` + +ID of the asset that will be opted-in to. diff --git a/docs/code/types/composer/type-aliases/AssetOptOutParams.md b/docs/code/types/composer/type-aliases/AssetOptOutParams.md new file mode 100644 index 00000000..14f8ac98 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AssetOptOutParams.md @@ -0,0 +1,28 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AssetOptOutParams + +# Type Alias: AssetOptOutParams + +> **AssetOptOutParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:310](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L310) + +Parameters to define an asset opt-out transaction. + +## Type declaration + +### assetId + +> **assetId**: `bigint` + +ID of the asset that will be opted-out of. + +### creator + +> **creator**: `string` \| `Address` + +The address of the asset creator account to close the asset + position to (any remaining asset units will be sent to this account). diff --git a/docs/code/types/composer/type-aliases/AssetTransferParams.md b/docs/code/types/composer/type-aliases/AssetTransferParams.md new file mode 100644 index 00000000..a5fce1b7 --- /dev/null +++ b/docs/code/types/composer/type-aliases/AssetTransferParams.md @@ -0,0 +1,51 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / AssetTransferParams + +# Type Alias: AssetTransferParams + +> **AssetTransferParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:282](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L282) + +Parameters to define an asset transfer transaction. + +## Type declaration + +### amount + +> **amount**: `bigint` + +Amount of the asset to transfer (in smallest divisible (decimal) units). + +### assetId + +> **assetId**: `bigint` + +ID of the asset to transfer. + +### clawbackTarget? + +> `optional` **clawbackTarget**: `string` \| `Address` + +Optional address of an account to clawback the asset from. + +Requires the sender to be the clawback account. + +**Warning:** Be careful with this parameter as it can lead to unexpected loss of funds if not used correctly. + +### closeAssetTo? + +> `optional` **closeAssetTo**: `string` \| `Address` + +Optional address of an account to close the asset position to. + +**Warning:** Be careful with this parameter as it can lead to loss of funds if not used correctly. + +### receiver + +> **receiver**: `string` \| `Address` + +The address of the account that will receive the asset unit(s). diff --git a/docs/code/types/composer/type-aliases/CommonAppCallParams.md b/docs/code/types/composer/type-aliases/CommonAppCallParams.md new file mode 100644 index 00000000..507f4816 --- /dev/null +++ b/docs/code/types/composer/type-aliases/CommonAppCallParams.md @@ -0,0 +1,60 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / CommonAppCallParams + +# Type Alias: CommonAppCallParams + +> **CommonAppCallParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:343](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L343) + +Common parameters for defining an application call transaction. + +## Type declaration + +### accountReferences? + +> `optional` **accountReferences**: (`string` \| `Address`)[] + +Any account addresses to add to the [accounts array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +### appId + +> **appId**: `bigint` + +ID of the application; 0 if the application is being created. + +### appReferences? + +> `optional` **appReferences**: `bigint`[] + +The ID of any apps to load to the [foreign apps array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +### args? + +> `optional` **args**: `Uint8Array`[] + +Any [arguments to pass to the smart contract call](/concepts/smart-contracts/languages/teal/#argument-passing). + +### assetReferences? + +> `optional` **assetReferences**: `bigint`[] + +The ID of any assets to load to the [foreign assets array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +### boxReferences? + +> `optional` **boxReferences**: ([`BoxReference`](../../app-manager/interfaces/BoxReference.md) \| [`BoxIdentifier`](../../app-manager/type-aliases/BoxIdentifier.md))[] + +Any boxes to load to the [boxes array](https://dev.algorand.co/concepts/smart-contracts/resource-usage#what-are-reference-arrays). + +Either the name identifier (which will be set against app ID of `0` i.e. + the current app), or a box identifier with the name identifier and app ID. + +### onComplete? + +> `optional` **onComplete**: `algosdk.OnApplicationComplete` + +The [on-complete](https://dev.algorand.co/concepts/smart-contracts/avm#oncomplete) action of the call; defaults to no-op. diff --git a/docs/code/types/composer/type-aliases/CommonTransactionParams.md b/docs/code/types/composer/type-aliases/CommonTransactionParams.md new file mode 100644 index 00000000..b349e5a1 --- /dev/null +++ b/docs/code/types/composer/type-aliases/CommonTransactionParams.md @@ -0,0 +1,133 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / CommonTransactionParams + +# Type Alias: CommonTransactionParams + +> **CommonTransactionParams** = `object` + +Defined in: [src/types/composer.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L45) + +Common parameters for defining a transaction. + +## Properties + +### extraFee? + +> `optional` **extraFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/composer.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L69) + +The fee to pay IN ADDITION to the suggested fee. Useful for manually covering inner transaction fees. + +*** + +### firstValidRound? + +> `optional` **firstValidRound**: `bigint` + +Defined in: [src/types/composer.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L80) + +Set the first round this transaction is valid. +If left undefined, the value from algod will be used. + +We recommend you only set this when you intentionally want this to be some time in the future. + +*** + +### lastValidRound? + +> `optional` **lastValidRound**: `bigint` + +Defined in: [src/types/composer.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L82) + +The last round this transaction is valid. It is recommended to use `validityWindow` instead. + +*** + +### lease? + +> `optional` **lease**: `Uint8Array` \| `string` + +Defined in: [src/types/composer.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L65) + +Prevent multiple transactions with the same lease being included within the validity window. + +A [lease](https://dev.algorand.co/concepts/transactions/leases) + enforces a mutually exclusive transaction (useful to prevent double-posting and other scenarios). + +*** + +### maxFee? + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/composer.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L71) + +Throw an error if the fee for the transaction is more than this amount; prevents overspending on fees during high congestion periods. + +*** + +### note? + +> `optional` **note**: `Uint8Array` \| `string` + +Defined in: [src/types/composer.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L59) + +Note to attach to the transaction. Max of 1000 bytes. + +*** + +### rekeyTo? + +> `optional` **rekeyTo**: `string` \| `Address` + +Defined in: [src/types/composer.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L57) + +Change the signing key of the sender to the given address. + +**Warning:** Please be careful with this parameter and be sure to read the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying). + +*** + +### sender + +> **sender**: `string` \| `Address` + +Defined in: [src/types/composer.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L47) + +The address of the account sending the transaction. + +*** + +### signer? + +> `optional` **signer**: `algosdk.TransactionSigner` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +Defined in: [src/types/composer.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L52) + +The function used to sign transaction(s); if not specified then + an attempt will be made to find a registered signer for the + given `sender` or use a default signer (if configured). + +*** + +### staticFee? + +> `optional` **staticFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/composer.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L67) + +The static transaction fee. In most cases you want to use `extraFee` unless setting the fee to 0 to be covered by another transaction. + +*** + +### validityWindow? + +> `optional` **validityWindow**: `number` \| `bigint` + +Defined in: [src/types/composer.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L73) + +How many rounds the transaction should be valid for, if not specified then the registered default validity window will be used. diff --git a/docs/code/types/composer/type-aliases/OfflineKeyRegistrationParams.md b/docs/code/types/composer/type-aliases/OfflineKeyRegistrationParams.md new file mode 100644 index 00000000..d1082b43 --- /dev/null +++ b/docs/code/types/composer/type-aliases/OfflineKeyRegistrationParams.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / OfflineKeyRegistrationParams + +# Type Alias: OfflineKeyRegistrationParams + +> **OfflineKeyRegistrationParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:337](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L337) + +Parameters to define an offline key registration transaction. + +## Type declaration + +### preventAccountFromEverParticipatingAgain? + +> `optional` **preventAccountFromEverParticipatingAgain**: `boolean` + +Prevent this account from ever participating again. The account will also no longer earn rewards diff --git a/docs/code/types/composer/type-aliases/OnlineKeyRegistrationParams.md b/docs/code/types/composer/type-aliases/OnlineKeyRegistrationParams.md new file mode 100644 index 00000000..db13432b --- /dev/null +++ b/docs/code/types/composer/type-aliases/OnlineKeyRegistrationParams.md @@ -0,0 +1,51 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / OnlineKeyRegistrationParams + +# Type Alias: OnlineKeyRegistrationParams + +> **OnlineKeyRegistrationParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:321](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L321) + +Parameters to define an online key registration transaction. + +## Type declaration + +### selectionKey + +> **selectionKey**: `Uint8Array` + +The VRF public key + +### stateProofKey? + +> `optional` **stateProofKey**: `Uint8Array` + +The 64 byte state proof public key commitment + +### voteFirst + +> **voteFirst**: `bigint` + +The first round that the participation key is valid. Not to be confused with the `firstValid` round of the keyreg transaction + +### voteKey + +> **voteKey**: `Uint8Array` + +The root participation public key + +### voteKeyDilution + +> **voteKeyDilution**: `bigint` + +This is the dilution for the 2-level participation key. It determines the interval (number of rounds) for generating new ephemeral keys + +### voteLast + +> **voteLast**: `bigint` + +The last round that the participation key is valid. Not to be confused with the `lastValid` round of the keyreg transaction diff --git a/docs/code/types/composer/type-aliases/PaymentParams.md b/docs/code/types/composer/type-aliases/PaymentParams.md new file mode 100644 index 00000000..ed431b04 --- /dev/null +++ b/docs/code/types/composer/type-aliases/PaymentParams.md @@ -0,0 +1,35 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / PaymentParams + +# Type Alias: PaymentParams + +> **PaymentParams** = [`CommonTransactionParams`](CommonTransactionParams.md) & `object` + +Defined in: [src/types/composer.ts:86](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L86) + +Parameters to define a payment transaction. + +## Type declaration + +### amount + +> **amount**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Amount to send + +### closeRemainderTo? + +> `optional` **closeRemainderTo**: `string` \| `Address` + +If given, close the sender account and send the remaining balance to this address + +*Warning:* Be careful with this parameter as it can lead to loss of funds if not used correctly. + +### receiver + +> **receiver**: `string` \| `Address` + +The address of the account that will receive the Algo diff --git a/docs/code/types/composer/type-aliases/RawSimulateOptions.md b/docs/code/types/composer/type-aliases/RawSimulateOptions.md new file mode 100644 index 00000000..02b73789 --- /dev/null +++ b/docs/code/types/composer/type-aliases/RawSimulateOptions.md @@ -0,0 +1,14 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / RawSimulateOptions + +# Type Alias: RawSimulateOptions + +> **RawSimulateOptions** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<`ConstructorParameters`\<*typeof* `modelsv2.SimulateRequest`\>\[`0`\], `"txnGroups"`\>\> + +Defined in: [src/types/composer.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L39) + +The raw API options to control a simulate request. +See algod API docs for more information: https://dev.algorand.co/reference/rest-apis/algod/#simulatetransaction diff --git a/docs/code/types/composer/type-aliases/SimulateOptions.md b/docs/code/types/composer/type-aliases/SimulateOptions.md new file mode 100644 index 00000000..0335f8dc --- /dev/null +++ b/docs/code/types/composer/type-aliases/SimulateOptions.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / SimulateOptions + +# Type Alias: SimulateOptions + +> **SimulateOptions** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Partial`\<[`SkipSignaturesSimulateOptions`](SkipSignaturesSimulateOptions.md)\> & [`RawSimulateOptions`](RawSimulateOptions.md)\> + +Defined in: [src/types/composer.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L42) + +All options to control a simulate request diff --git a/docs/code/types/composer/type-aliases/SkipSignaturesSimulateOptions.md b/docs/code/types/composer/type-aliases/SkipSignaturesSimulateOptions.md new file mode 100644 index 00000000..06b7f22d --- /dev/null +++ b/docs/code/types/composer/type-aliases/SkipSignaturesSimulateOptions.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / SkipSignaturesSimulateOptions + +# Type Alias: SkipSignaturesSimulateOptions + +> **SkipSignaturesSimulateOptions** = [`Expand`](../../expand/type-aliases/Expand.md)\<`Omit`\<[`RawSimulateOptions`](RawSimulateOptions.md), `"fixSigners"` \| `"allowEmptySignatures"`\> & `object`\> + +Defined in: [src/types/composer.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L27) + +Options to control a simulate request, that does not require transaction signing diff --git a/docs/code/types/composer/type-aliases/TransactionComposerParams.md b/docs/code/types/composer/type-aliases/TransactionComposerParams.md new file mode 100644 index 00000000..47876aa9 --- /dev/null +++ b/docs/code/types/composer/type-aliases/TransactionComposerParams.md @@ -0,0 +1,80 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / TransactionComposerParams + +# Type Alias: TransactionComposerParams + +> **TransactionComposerParams** = `object` + +Defined in: [src/types/composer.ts:479](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L479) + +Parameters to create an `TransactionComposer`. + +## Properties + +### algod + +> **algod**: `algosdk.Algodv2` + +Defined in: [src/types/composer.ts:481](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L481) + +The algod client to use to get suggestedParams and send the transaction group + +*** + +### appManager? + +> `optional` **appManager**: [`AppManager`](../../app-manager/classes/AppManager.md) + +Defined in: [src/types/composer.ts:494](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L494) + +An existing `AppManager` to use to manage app compilation and cache compilation results. + +If not specified than an ephemeral one will be created. + +*** + +### defaultValidityWindow? + +> `optional` **defaultValidityWindow**: `bigint` + +Defined in: [src/types/composer.ts:489](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L489) + +How many rounds a transaction should be valid for by default; if not specified +then will be 10 rounds (or 1000 rounds if issuing transactions to LocalNet). + +*** + +### getSigner() + +> **getSigner**: (`address`) => `algosdk.TransactionSigner` + +Defined in: [src/types/composer.ts:483](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L483) + +The function used to get the TransactionSigner for a given address + +#### Parameters + +##### address + +`string` | `Address` + +#### Returns + +`algosdk.TransactionSigner` + +*** + +### getSuggestedParams()? + +> `optional` **getSuggestedParams**: () => `Promise`\<`algosdk.SuggestedParams`\> + +Defined in: [src/types/composer.ts:485](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L485) + +The method used to get SuggestedParams for transactions in the group + +#### Returns + +`Promise`\<`algosdk.SuggestedParams`\> diff --git a/docs/code/types/composer/type-aliases/Txn.md b/docs/code/types/composer/type-aliases/Txn.md new file mode 100644 index 00000000..fb7f819d --- /dev/null +++ b/docs/code/types/composer/type-aliases/Txn.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / Txn + +# Type Alias: Txn + +> **Txn** = [`PaymentParams`](PaymentParams.md) & `object` \| [`AssetCreateParams`](AssetCreateParams.md) & `object` \| [`AssetConfigParams`](AssetConfigParams.md) & `object` \| [`AssetFreezeParams`](AssetFreezeParams.md) & `object` \| [`AssetDestroyParams`](AssetDestroyParams.md) & `object` \| [`AssetTransferParams`](AssetTransferParams.md) & `object` \| [`AssetOptInParams`](AssetOptInParams.md) & `object` \| [`AssetOptOutParams`](AssetOptOutParams.md) & `object` \| [`AppCallParams`](AppCallParams.md) \| [`AppCreateParams`](AppCreateParams.md) \| [`AppUpdateParams`](AppUpdateParams.md) & `object` \| [`OnlineKeyRegistrationParams`](OnlineKeyRegistrationParams.md) \| [`OfflineKeyRegistrationParams`](OfflineKeyRegistrationParams.md) & `object` \| `algosdk.TransactionWithSigner` & `object` \| \{ `atc`: `algosdk.AtomicTransactionComposer`; `type`: `"atc"`; \} \| [`AppCallMethodCall`](AppCallMethodCall.md) \| [`AppCreateMethodCall`](AppCreateMethodCall.md) \| [`AppUpdateMethodCall`](AppUpdateMethodCall.md) & `object` + +Defined in: [src/types/composer.ts:463](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L463) diff --git a/docs/code/types/composer/variables/MAX_TRANSACTION_GROUP_SIZE.md b/docs/code/types/composer/variables/MAX_TRANSACTION_GROUP_SIZE.md new file mode 100644 index 00000000..02a09a2a --- /dev/null +++ b/docs/code/types/composer/variables/MAX_TRANSACTION_GROUP_SIZE.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/composer](../README.md) / MAX\_TRANSACTION\_GROUP\_SIZE + +# Variable: MAX\_TRANSACTION\_GROUP\_SIZE + +> `const` **MAX\_TRANSACTION\_GROUP\_SIZE**: `16` = `16` + +Defined in: [src/types/composer.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/composer.ts#L24) diff --git a/docs/code/types/config/README.md b/docs/code/types/config/README.md new file mode 100644 index 00000000..276777aa --- /dev/null +++ b/docs/code/types/config/README.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/config + +# types/config + +## Classes + +- [UpdatableConfig](classes/UpdatableConfig.md) + +## Interfaces + +- [Config](interfaces/Config.md) diff --git a/docs/code/types/config/classes/UpdatableConfig.md b/docs/code/types/config/classes/UpdatableConfig.md new file mode 100644 index 00000000..1c99b936 --- /dev/null +++ b/docs/code/types/config/classes/UpdatableConfig.md @@ -0,0 +1,254 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/config](../README.md) / UpdatableConfig + +# Class: UpdatableConfig + +Defined in: [src/types/config.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L28) + +Updatable AlgoKit config + +## Implements + +- `Readonly`\<[`Config`](../interfaces/Config.md)\> + +## Constructors + +### Constructor + +> **new UpdatableConfig**(): `UpdatableConfig` + +Defined in: [src/types/config.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L90) + +#### Returns + +`UpdatableConfig` + +## Accessors + +### debug + +#### Get Signature + +> **get** **debug**(): `boolean` + +Defined in: [src/types/config.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L39) + +Whether or not debug mode is enabled + +##### Returns + +`boolean` + +#### Implementation of + +`Readonly.debug` + +*** + +### events + +#### Get Signature + +> **get** **events**(): [`AsyncEventEmitter`](../../async-event-emitter/classes/AsyncEventEmitter.md) + +Defined in: [src/types/config.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L59) + +##### Returns + +[`AsyncEventEmitter`](../../async-event-emitter/classes/AsyncEventEmitter.md) + +#### Implementation of + +`Readonly.events` + +*** + +### logger + +#### Get Signature + +> **get** **logger**(): [`Logger`](../../logging/type-aliases/Logger.md) + +Defined in: [src/types/config.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L35) + +Logger + +##### Returns + +[`Logger`](../../logging/type-aliases/Logger.md) + +#### Implementation of + +`Readonly.logger` + +*** + +### maxSearchDepth + +#### Get Signature + +> **get** **maxSearchDepth**(): `number` + +Defined in: [src/types/config.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L55) + +The maximum depth to search for a specific file + +##### Returns + +`number` + +#### Implementation of + +`Readonly.maxSearchDepth` + +*** + +### populateAppCallResources + +#### Get Signature + +> **get** **populateAppCallResources**(): `boolean` + +Defined in: [src/types/config.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L31) + +Whether to enable populateAppCallResources in sendParams by default. +Default value is false. + +##### Returns + +`boolean` + +#### Implementation of + +`Readonly.populateAppCallResources` + +*** + +### projectRoot + +#### Get Signature + +> **get** **projectRoot**(): `null` \| `string` + +Defined in: [src/types/config.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L43) + +The path to the project root directory + +##### Returns + +`null` \| `string` + +#### Implementation of + +`Readonly.projectRoot` + +*** + +### traceAll + +#### Get Signature + +> **get** **traceAll**(): `boolean` + +Defined in: [src/types/config.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L47) + +Indicates whether to trace all operations + +##### Returns + +`boolean` + +#### Implementation of + +`Readonly.traceAll` + +*** + +### traceBufferSizeMb + +#### Get Signature + +> **get** **traceBufferSizeMb**(): `number` + +Defined in: [src/types/config.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L51) + +The size of the trace buffer in megabytes + +##### Returns + +`number` + +#### Implementation of + +`Readonly.traceBufferSizeMb` + +## Methods + +### configure() + +> **configure**(`newConfig`): `void` + +Defined in: [src/types/config.ts:107](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L107) + +Update the AlgoKit configuration with your own configuration settings + +#### Parameters + +##### newConfig + +`Partial`\<[`Config`](../interfaces/Config.md)\> + +Partial or complete config to replace + +#### Returns + +`void` + +*** + +### getLogger() + +> **getLogger**(`returnNullLogger?`): [`Logger`](../../logging/type-aliases/Logger.md) + +Defined in: [src/types/config.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L68) + +Returns the current logger, or the null logger if true is passed in to `returnNullLogger` + +#### Parameters + +##### returnNullLogger? + +`boolean` + +Whether or not to return the null logger + +#### Returns + +[`Logger`](../../logging/type-aliases/Logger.md) + +The requested logger + +*** + +### withDebug() + +> **withDebug**(`lambda`): `void` + +Defined in: [src/types/config.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L80) + +Temporarily run with debug set to true. + +#### Parameters + +##### lambda + +() => `unknown` + +A lambda expression with code to run with debug config set to true + +#### Returns + +`void` diff --git a/docs/code/types/config/interfaces/Config.md b/docs/code/types/config/interfaces/Config.md new file mode 100644 index 00000000..7472d474 --- /dev/null +++ b/docs/code/types/config/interfaces/Config.md @@ -0,0 +1,90 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/config](../README.md) / Config + +# Interface: Config + +Defined in: [src/types/config.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L5) + +The AlgoKit configuration type + +## Properties + +### debug + +> **debug**: `boolean` + +Defined in: [src/types/config.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L9) + +Whether or not debug mode is enabled + +*** + +### events + +> **events**: [`AsyncEventEmitter`](../../async-event-emitter/classes/AsyncEventEmitter.md) + +Defined in: [src/types/config.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L24) + +*** + +### logger + +> **logger**: [`Logger`](../../logging/type-aliases/Logger.md) + +Defined in: [src/types/config.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L7) + +Logger + +*** + +### maxSearchDepth + +> **maxSearchDepth**: `number` + +Defined in: [src/types/config.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L17) + +The maximum depth to search for a specific file + +*** + +### populateAppCallResources + +> **populateAppCallResources**: `boolean` + +Defined in: [src/types/config.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L22) + +Whether to enable populateAppCallResources in sendParams by default. +Default value is false. + +*** + +### projectRoot + +> **projectRoot**: `null` \| `string` + +Defined in: [src/types/config.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L11) + +The path to the project root directory + +*** + +### traceAll + +> **traceAll**: `boolean` + +Defined in: [src/types/config.ts:13](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L13) + +Indicates whether to trace all operations + +*** + +### traceBufferSizeMb + +> **traceBufferSizeMb**: `number` + +Defined in: [src/types/config.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/config.ts#L15) + +The size of the trace buffer in megabytes diff --git a/docs/code/types/debugging/README.md b/docs/code/types/debugging/README.md new file mode 100644 index 00000000..91725b12 --- /dev/null +++ b/docs/code/types/debugging/README.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/debugging + +# types/debugging + +## Interfaces + +- [AVMTracesEventData](interfaces/AVMTracesEventData.md) +- [TealSourceDebugEventData](interfaces/TealSourceDebugEventData.md) +- [TealSourcesDebugEventData](interfaces/TealSourcesDebugEventData.md) + +## Variables + +- [ALGOKIT\_DIR](variables/ALGOKIT_DIR.md) +- [DEFAULT\_MAX\_SEARCH\_DEPTH](variables/DEFAULT_MAX_SEARCH_DEPTH.md) +- [SOURCES\_DIR](variables/SOURCES_DIR.md) +- [TEAL\_FILE\_EXT](variables/TEAL_FILE_EXT.md) +- [TEAL\_SOURCEMAP\_EXT](variables/TEAL_SOURCEMAP_EXT.md) diff --git a/docs/code/types/debugging/interfaces/AVMTracesEventData.md b/docs/code/types/debugging/interfaces/AVMTracesEventData.md new file mode 100644 index 00000000..72908528 --- /dev/null +++ b/docs/code/types/debugging/interfaces/AVMTracesEventData.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/debugging](../README.md) / AVMTracesEventData + +# Interface: AVMTracesEventData + +Defined in: [src/types/debugging.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L46) + +Represents the data for AVM traces debug events emitted whenever a transaction is simulated in debug mode + +## Properties + +### simulateResponse + +> **simulateResponse**: `SimulateResponse` + +Defined in: [src/types/debugging.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L48) + +The simulation response from Algod diff --git a/docs/code/types/debugging/interfaces/TealSourceDebugEventData.md b/docs/code/types/debugging/interfaces/TealSourceDebugEventData.md new file mode 100644 index 00000000..72cc03cf --- /dev/null +++ b/docs/code/types/debugging/interfaces/TealSourceDebugEventData.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/debugging](../README.md) / TealSourceDebugEventData + +# Interface: TealSourceDebugEventData + +Defined in: [src/types/debugging.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L26) + +Represents the data for a single TEAL source + +## Properties + +### appName + +> **appName**: `string` + +Defined in: [src/types/debugging.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L28) + +The name of the application + +*** + +### compiledTeal + +> **compiledTeal**: [`CompiledTeal`](../../app/interfaces/CompiledTeal.md) + +Defined in: [src/types/debugging.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L32) + +The compiled TEAL code + +*** + +### fileName + +> **fileName**: `string` + +Defined in: [src/types/debugging.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L30) + +The name of the file diff --git a/docs/code/types/debugging/interfaces/TealSourcesDebugEventData.md b/docs/code/types/debugging/interfaces/TealSourcesDebugEventData.md new file mode 100644 index 00000000..3cd0d00f --- /dev/null +++ b/docs/code/types/debugging/interfaces/TealSourcesDebugEventData.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/debugging](../README.md) / TealSourcesDebugEventData + +# Interface: TealSourcesDebugEventData + +Defined in: [src/types/debugging.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L38) + +Represents the data for multiple TEAL sources debug events emitted whenever an app is compiled as part of a deploy in debug mode + +## Properties + +### sources + +> **sources**: [`TealSourceDebugEventData`](TealSourceDebugEventData.md)[] + +Defined in: [src/types/debugging.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L40) + +An array of TEAL source debug event data diff --git a/docs/code/types/debugging/variables/ALGOKIT_DIR.md b/docs/code/types/debugging/variables/ALGOKIT_DIR.md new file mode 100644 index 00000000..3ae9bbe9 --- /dev/null +++ b/docs/code/types/debugging/variables/ALGOKIT_DIR.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/debugging](../README.md) / ALGOKIT\_DIR + +# Variable: ALGOKIT\_DIR + +> `const` **ALGOKIT\_DIR**: `".algokit"` = `'.algokit'` + +Defined in: [src/types/debugging.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L9) + +The directory name for AlgoKit project related files diff --git a/docs/code/types/debugging/variables/DEFAULT_MAX_SEARCH_DEPTH.md b/docs/code/types/debugging/variables/DEFAULT_MAX_SEARCH_DEPTH.md new file mode 100644 index 00000000..1db2e1b9 --- /dev/null +++ b/docs/code/types/debugging/variables/DEFAULT_MAX_SEARCH_DEPTH.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/debugging](../README.md) / DEFAULT\_MAX\_SEARCH\_DEPTH + +# Variable: DEFAULT\_MAX\_SEARCH\_DEPTH + +> `const` **DEFAULT\_MAX\_SEARCH\_DEPTH**: `10` = `10` + +Defined in: [src/types/debugging.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L21) + +The default maximum search depth for file operations diff --git a/docs/code/types/debugging/variables/SOURCES_DIR.md b/docs/code/types/debugging/variables/SOURCES_DIR.md new file mode 100644 index 00000000..a8a799d8 --- /dev/null +++ b/docs/code/types/debugging/variables/SOURCES_DIR.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/debugging](../README.md) / SOURCES\_DIR + +# Variable: SOURCES\_DIR + +> `const` **SOURCES\_DIR**: `"sources"` = `'sources'` + +Defined in: [src/types/debugging.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L12) + +The directory name for debug source files diff --git a/docs/code/types/debugging/variables/TEAL_FILE_EXT.md b/docs/code/types/debugging/variables/TEAL_FILE_EXT.md new file mode 100644 index 00000000..de24efc8 --- /dev/null +++ b/docs/code/types/debugging/variables/TEAL_FILE_EXT.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/debugging](../README.md) / TEAL\_FILE\_EXT + +# Variable: TEAL\_FILE\_EXT + +> `const` **TEAL\_FILE\_EXT**: `".teal"` = `'.teal'` + +Defined in: [src/types/debugging.ts:15](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L15) + +The file extension for TEAL files diff --git a/docs/code/types/debugging/variables/TEAL_SOURCEMAP_EXT.md b/docs/code/types/debugging/variables/TEAL_SOURCEMAP_EXT.md new file mode 100644 index 00000000..54095d41 --- /dev/null +++ b/docs/code/types/debugging/variables/TEAL_SOURCEMAP_EXT.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/debugging](../README.md) / TEAL\_SOURCEMAP\_EXT + +# Variable: TEAL\_SOURCEMAP\_EXT + +> `const` **TEAL\_SOURCEMAP\_EXT**: `".teal.map"` = `'.teal.map'` + +Defined in: [src/types/debugging.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/debugging.ts#L18) + +The file extension for TEAL source map files diff --git a/docs/code/types/dispenser-client.spec/README.md b/docs/code/types/dispenser-client.spec/README.md new file mode 100644 index 00000000..c1f3613f --- /dev/null +++ b/docs/code/types/dispenser-client.spec/README.md @@ -0,0 +1,7 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/dispenser-client.spec + +# types/dispenser-client.spec diff --git a/docs/code/types/dispenser-client/README.md b/docs/code/types/dispenser-client/README.md new file mode 100644 index 00000000..a06093ac --- /dev/null +++ b/docs/code/types/dispenser-client/README.md @@ -0,0 +1,17 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/dispenser-client + +# types/dispenser-client + +## Classes + +- [TestNetDispenserApiClient](classes/TestNetDispenserApiClient.md) + +## Interfaces + +- [DispenserFundResponse](interfaces/DispenserFundResponse.md) +- [DispenserLimitResponse](interfaces/DispenserLimitResponse.md) +- [TestNetDispenserApiClientParams](interfaces/TestNetDispenserApiClientParams.md) diff --git a/docs/code/types/dispenser-client/classes/TestNetDispenserApiClient.md b/docs/code/types/dispenser-client/classes/TestNetDispenserApiClient.md new file mode 100644 index 00000000..72ef2178 --- /dev/null +++ b/docs/code/types/dispenser-client/classes/TestNetDispenserApiClient.md @@ -0,0 +1,160 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/dispenser-client](../README.md) / TestNetDispenserApiClient + +# Class: TestNetDispenserApiClient + +Defined in: [src/types/dispenser-client.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L72) + +`TestNetDispenserApiClient` is a class that provides methods to interact with the [Algorand TestNet Dispenser API](https://github.com/algorandfoundation/algokit/blob/main/docs/testnet_api.md). +It allows you to fund an address with Algo, refund a transaction, and get the funding limit for the Algo asset. + +The class requires an authentication token and a request timeout to be initialized. The authentication token can be provided +either directly as a parameter or through an `ALGOKIT_DISPENSER_ACCESS_TOKEN` environment variable. If neither is provided, an error is thrown. + +The request timeout can be provided as a parameter. If not provided, a default value is used. + +## Method + +fund - Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo. + +## Method + +refund - Sends a refund request to the dispenser API for the specified refundTxnId. + +## Method + +limit - Sends a request to the dispenser API to get the funding limit for the Algo asset. + +## Example + +```typescript +const client = new TestNetDispenserApiClient({ authToken: 'your_auth_token', requestTimeout: 30 }); +const fundResponse = await client.fund('your_address', 100); +const limitResponse = await client.getLimit(); +await client.refund('your_transaction_id'); +``` + +## Throws + +If neither the environment variable 'ALGOKIT_DISPENSER_ACCESS_TOKEN' nor the authToken parameter were provided. + +## Constructors + +### Constructor + +> **new TestNetDispenserApiClient**(`params?`): `TestNetDispenserApiClient` + +Defined in: [src/types/dispenser-client.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L76) + +#### Parameters + +##### params? + +[`TestNetDispenserApiClientParams`](../interfaces/TestNetDispenserApiClientParams.md) + +#### Returns + +`TestNetDispenserApiClient` + +## Accessors + +### authToken + +#### Get Signature + +> **get** **authToken**(): `string` + +Defined in: [src/types/dispenser-client.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L92) + +##### Returns + +`string` + +The authentication token used for API requests. + +*** + +### requestTimeout + +#### Get Signature + +> **get** **requestTimeout**(): `number` + +Defined in: [src/types/dispenser-client.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L96) + +##### Returns + +`number` + +The timeout for API requests, in seconds. + +## Methods + +### fund() + +> **fund**(`address`, `amount`): `Promise`\<[`DispenserFundResponse`](../interfaces/DispenserFundResponse.md)\> + +Defined in: [src/types/dispenser-client.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L158) + +Sends a funding request to the dispenser API to fund the specified address with the given amount of Algo. + +#### Parameters + +##### address + +The address to fund. + +`string` | `Address` + +##### amount + +The amount of µAlgo to fund. + +`number` | `bigint` + +#### Returns + +`Promise`\<[`DispenserFundResponse`](../interfaces/DispenserFundResponse.md)\> + +DispenserFundResponse: An object containing the transaction ID and funded amount. + +*** + +### getLimit() + +> **getLimit**(): `Promise`\<[`DispenserLimitResponse`](../interfaces/DispenserLimitResponse.md)\> + +Defined in: [src/types/dispenser-client.ts:188](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L188) + +Sends a request to the dispenser API to get the funding limit for the Algo asset. + +#### Returns + +`Promise`\<[`DispenserLimitResponse`](../interfaces/DispenserLimitResponse.md)\> + +DispenserLimitResponse: An object containing the funding limit amount. + +*** + +### refund() + +> **refund**(`refundTxnId`): `Promise`\<`void`\> + +Defined in: [src/types/dispenser-client.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L179) + +Sends a refund request to the dispenser API for the specified refundTxnId. + +#### Parameters + +##### refundTxnId + +`string` + +The transaction ID to refund. + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/code/types/dispenser-client/interfaces/DispenserFundResponse.md b/docs/code/types/dispenser-client/interfaces/DispenserFundResponse.md new file mode 100644 index 00000000..feb93562 --- /dev/null +++ b/docs/code/types/dispenser-client/interfaces/DispenserFundResponse.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/dispenser-client](../README.md) / DispenserFundResponse + +# Interface: DispenserFundResponse + +Defined in: [src/types/dispenser-client.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L25) + +The TestNet Dispenser API response when funding. + +## Properties + +### amount + +> **amount**: `number` + +Defined in: [src/types/dispenser-client.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L29) + +The number of µAlgo that was funded. + +*** + +### txId + +> **txId**: `string` + +Defined in: [src/types/dispenser-client.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L27) + +The ID of the transaction that was issued to fund the account. diff --git a/docs/code/types/dispenser-client/interfaces/DispenserLimitResponse.md b/docs/code/types/dispenser-client/interfaces/DispenserLimitResponse.md new file mode 100644 index 00000000..c820315b --- /dev/null +++ b/docs/code/types/dispenser-client/interfaces/DispenserLimitResponse.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/dispenser-client](../README.md) / DispenserLimitResponse + +# Interface: DispenserLimitResponse + +Defined in: [src/types/dispenser-client.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L33) + +The TestNet Dispenser API response when getting the current limit. + +## Properties + +### amount + +> **amount**: `number` + +Defined in: [src/types/dispenser-client.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L35) + +The limit, in µAlgo, that you can currently fund. diff --git a/docs/code/types/dispenser-client/interfaces/TestNetDispenserApiClientParams.md b/docs/code/types/dispenser-client/interfaces/TestNetDispenserApiClientParams.md new file mode 100644 index 00000000..c3417284 --- /dev/null +++ b/docs/code/types/dispenser-client/interfaces/TestNetDispenserApiClientParams.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/dispenser-client](../README.md) / TestNetDispenserApiClientParams + +# Interface: TestNetDispenserApiClientParams + +Defined in: [src/types/dispenser-client.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L39) + +The parameters to construct a TestNet Dispenser API client. + +## Properties + +### authToken + +> **authToken**: `string` + +Defined in: [src/types/dispenser-client.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L41) + +The API auth token + +*** + +### requestTimeout? + +> `optional` **requestTimeout**: `number` + +Defined in: [src/types/dispenser-client.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L43) + +The request timeout in seconds diff --git a/docs/code/types/expand/README.md b/docs/code/types/expand/README.md new file mode 100644 index 00000000..886f0f93 --- /dev/null +++ b/docs/code/types/expand/README.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/expand + +# types/expand + +## Type Aliases + +- [Expand](type-aliases/Expand.md) diff --git a/docs/code/types/expand/type-aliases/Expand.md b/docs/code/types/expand/type-aliases/Expand.md new file mode 100644 index 00000000..f943bbc5 --- /dev/null +++ b/docs/code/types/expand/type-aliases/Expand.md @@ -0,0 +1,20 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/expand](../README.md) / Expand + +# Type Alias: Expand\ + +> **Expand**\<`T`\> = `T` *extends* (...`args`) => infer R ? (...`args`) => `Expand`\<`R`\> : `T` *extends* infer O ? `{ [K in keyof O]: O[K] }` : `never` + +Defined in: [src/types/expand.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/expand.ts#L5) + +Expands types for IntelliSense so they are more human readable +See https://stackoverflow.com/a/69288824 + +## Type Parameters + +### T + +`T` diff --git a/docs/code/types/indexer/README.md b/docs/code/types/indexer/README.md new file mode 100644 index 00000000..69e41356 --- /dev/null +++ b/docs/code/types/indexer/README.md @@ -0,0 +1,56 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/indexer + +# types/indexer + +## Enumerations + +- [AccountStatus](enumerations/AccountStatus.md) +- [ApplicationOnComplete](enumerations/ApplicationOnComplete.md) +- [SignatureType](enumerations/SignatureType.md) + +## Interfaces + +- [LookupAssetHoldingsOptions](interfaces/LookupAssetHoldingsOptions.md) + +## Type Aliases + +- [~~AccountLookupResult~~](type-aliases/AccountLookupResult.md) +- [~~AccountParticipation~~](type-aliases/AccountParticipation.md) +- [~~AccountResult~~](type-aliases/AccountResult.md) +- [~~AccountStateDelta~~](type-aliases/AccountStateDelta.md) +- [~~ApplicationCreatedLookupResult~~](type-aliases/ApplicationCreatedLookupResult.md) +- [~~ApplicationLookupResult~~](type-aliases/ApplicationLookupResult.md) +- [~~ApplicationParams~~](type-aliases/ApplicationParams.md) +- [~~ApplicationResult~~](type-aliases/ApplicationResult.md) +- [~~ApplicationTransactionResult~~](type-aliases/ApplicationTransactionResult.md) +- [~~AppLocalState~~](type-aliases/AppLocalState.md) +- [~~AssetBalancesLookupResult~~](type-aliases/AssetBalancesLookupResult.md) +- [~~AssetConfigTransactionResult~~](type-aliases/AssetConfigTransactionResult.md) +- [~~AssetFreezeTransactionResult~~](type-aliases/AssetFreezeTransactionResult.md) +- [~~AssetHolding~~](type-aliases/AssetHolding.md) +- [~~AssetLookupResult~~](type-aliases/AssetLookupResult.md) +- [~~AssetParams~~](type-aliases/AssetParams.md) +- [~~AssetResult~~](type-aliases/AssetResult.md) +- [~~AssetsCreatedLookupResult~~](type-aliases/AssetsCreatedLookupResult.md) +- [~~AssetsLookupResult~~](type-aliases/AssetsLookupResult.md) +- [~~AssetTransferTransactionResult~~](type-aliases/AssetTransferTransactionResult.md) +- [~~EvalDelta~~](type-aliases/EvalDelta.md) +- [~~EvalDeltaKeyValue~~](type-aliases/EvalDeltaKeyValue.md) +- [~~KeyRegistrationTransactionResult~~](type-aliases/KeyRegistrationTransactionResult.md) +- [~~LogicTransactionSignature~~](type-aliases/LogicTransactionSignature.md) +- [~~MerkleArrayProof~~](type-aliases/MerkleArrayProof.md) +- [~~MiniAssetHolding~~](type-aliases/MiniAssetHolding.md) +- [~~MultisigTransactionSignature~~](type-aliases/MultisigTransactionSignature.md) +- [~~MultisigTransactionSubSignature~~](type-aliases/MultisigTransactionSubSignature.md) +- [~~PaymentTransactionResult~~](type-aliases/PaymentTransactionResult.md) +- [~~StateDelta~~](type-aliases/StateDelta.md) +- [~~StateProofTransactionResult~~](type-aliases/StateProofTransactionResult.md) +- [~~StateSchema~~](type-aliases/StateSchema.md) +- [~~TransactionLookupResult~~](type-aliases/TransactionLookupResult.md) +- [~~TransactionResult~~](type-aliases/TransactionResult.md) +- [~~TransactionSearchResults~~](type-aliases/TransactionSearchResults.md) +- [~~TransactionSignature~~](type-aliases/TransactionSignature.md) diff --git a/docs/code/types/indexer/enumerations/AccountStatus.md b/docs/code/types/indexer/enumerations/AccountStatus.md new file mode 100644 index 00000000..d15aa056 --- /dev/null +++ b/docs/code/types/indexer/enumerations/AccountStatus.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AccountStatus + +# Enumeration: AccountStatus + +Defined in: [src/types/indexer.ts:189](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L189) + +Delegation status of the account + +## Enumeration Members + +### NotParticipating + +> **NotParticipating**: `"NotParticipating"` + +Defined in: [src/types/indexer.ts:195](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L195) + +Indicates that the associated account is neither a delegator nor a delegate + +*** + +### Offline + +> **Offline**: `"Offline"` + +Defined in: [src/types/indexer.ts:191](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L191) + +Indicates that the associated account is delegated + +*** + +### Online + +> **Online**: `"Online"` + +Defined in: [src/types/indexer.ts:193](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L193) + +Indicates that the associated account used as part of the delegation pool diff --git a/docs/code/types/indexer/enumerations/ApplicationOnComplete.md b/docs/code/types/indexer/enumerations/ApplicationOnComplete.md new file mode 100644 index 00000000..1a6c11d5 --- /dev/null +++ b/docs/code/types/indexer/enumerations/ApplicationOnComplete.md @@ -0,0 +1,59 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / ApplicationOnComplete + +# Enumeration: ApplicationOnComplete + +Defined in: [src/types/indexer.ts:166](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L166) + +Defines the what additional actions occur with the transaction https://dev.algorand.co/reference/rest-apis/indexer/#oncompletion + +## Enumeration Members + +### clear + +> **clear**: `"clear"` + +Defined in: [src/types/indexer.ts:170](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L170) + +*** + +### closeout + +> **closeout**: `"closeout"` + +Defined in: [src/types/indexer.ts:169](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L169) + +*** + +### delete + +> **delete**: `"delete"` + +Defined in: [src/types/indexer.ts:172](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L172) + +*** + +### noop + +> **noop**: `"noop"` + +Defined in: [src/types/indexer.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L167) + +*** + +### optin + +> **optin**: `"optin"` + +Defined in: [src/types/indexer.ts:168](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L168) + +*** + +### update + +> **update**: `"update"` + +Defined in: [src/types/indexer.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L171) diff --git a/docs/code/types/indexer/enumerations/SignatureType.md b/docs/code/types/indexer/enumerations/SignatureType.md new file mode 100644 index 00000000..746a48fd --- /dev/null +++ b/docs/code/types/indexer/enumerations/SignatureType.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / SignatureType + +# Enumeration: SignatureType + +Defined in: [src/types/indexer.ts:179](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L179) + +Type of signature used by an account + +## Enumeration Members + +### lsig + +> **lsig**: `"lsig"` + +Defined in: [src/types/indexer.ts:185](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L185) + +Logic signature + +*** + +### msig + +> **msig**: `"msig"` + +Defined in: [src/types/indexer.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L183) + +Multisig + +*** + +### sig + +> **sig**: `"sig"` + +Defined in: [src/types/indexer.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L181) + +Normal signature diff --git a/docs/code/types/indexer/interfaces/LookupAssetHoldingsOptions.md b/docs/code/types/indexer/interfaces/LookupAssetHoldingsOptions.md new file mode 100644 index 00000000..1cf4c668 --- /dev/null +++ b/docs/code/types/indexer/interfaces/LookupAssetHoldingsOptions.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / LookupAssetHoldingsOptions + +# Interface: LookupAssetHoldingsOptions + +Defined in: [src/types/indexer.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L23) + +Options when looking up an asset's account holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-idbalances + +## Properties + +### currencyGreaterThan? + +> `optional` **currencyGreaterThan**: `number` \| `bigint` + +Defined in: [src/types/indexer.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L27) + +Results should have a decimal units amount greater than this value. + +*** + +### currencyLessThan? + +> `optional` **currencyLessThan**: `number` \| `bigint` + +Defined in: [src/types/indexer.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L25) + +Results should have a decimal units amount less than this value. + +*** + +### includeAll? + +> `optional` **includeAll**: `boolean` + +Defined in: [src/types/indexer.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L29) + +Include all items including closed accounts and opted-out asset holdings. diff --git a/docs/code/types/indexer/type-aliases/AccountLookupResult.md b/docs/code/types/indexer/type-aliases/AccountLookupResult.md new file mode 100644 index 00000000..f15e6615 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AccountLookupResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AccountLookupResult + +# Type Alias: ~~AccountLookupResult~~ + +> **AccountLookupResult** = `indexerModels.AccountResponse` + +Defined in: [src/types/indexer.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L8) + +## Deprecated + +Use `algosdk.indexerModels.AccountResponse`. Indexer result for an account lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-id diff --git a/docs/code/types/indexer/type-aliases/AccountParticipation.md b/docs/code/types/indexer/type-aliases/AccountParticipation.md new file mode 100644 index 00000000..9b17f81f --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AccountParticipation.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AccountParticipation + +# Type Alias: ~~AccountParticipation~~ + +> **AccountParticipation** = `indexerModels.AccountParticipation` + +Defined in: [src/types/indexer.ts:199](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L199) + +## Deprecated + +Use `algosdk.indexerModels.AccountParticipation`. Indexer AccountParticipation describes the parameters used by this account in consensus protocol. https://dev.algorand.co/reference/rest-apis/indexer#accountparticipation diff --git a/docs/code/types/indexer/type-aliases/AccountResult.md b/docs/code/types/indexer/type-aliases/AccountResult.md new file mode 100644 index 00000000..e5c0faf3 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AccountResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AccountResult + +# Type Alias: ~~AccountResult~~ + +> **AccountResult** = `indexerModels.Account` + +Defined in: [src/types/indexer.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L45) + +## Deprecated + +Use `algosdk.indexerModels.Account`. Indexer Account information at a given round https://dev.algorand.co/reference/rest-apis/indexer#account diff --git a/docs/code/types/indexer/type-aliases/AccountStateDelta.md b/docs/code/types/indexer/type-aliases/AccountStateDelta.md new file mode 100644 index 00000000..8824c0ba --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AccountStateDelta.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AccountStateDelta + +# Type Alias: ~~AccountStateDelta~~ + +> **AccountStateDelta** = `indexerModels.AccountStateDelta` + +Defined in: [src/types/indexer.ts:145](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L145) + +## Deprecated + +Use `algosdk.indexerModels.AccountStateDelta`. diff --git a/docs/code/types/indexer/type-aliases/AppLocalState.md b/docs/code/types/indexer/type-aliases/AppLocalState.md new file mode 100644 index 00000000..b8a83bd9 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AppLocalState.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AppLocalState + +# Type Alias: ~~AppLocalState~~ + +> **AppLocalState** = `indexerModels.ApplicationLocalState` + +Defined in: [src/types/indexer.ts:202](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L202) + +## Deprecated + +Use `algosdk.indexerModels.ApplicationLocalState`. Indexer Stores local state associated with an application. https://dev.algorand.co/reference/rest-apis/indexer#applicationlocalstate diff --git a/docs/code/types/indexer/type-aliases/ApplicationCreatedLookupResult.md b/docs/code/types/indexer/type-aliases/ApplicationCreatedLookupResult.md new file mode 100644 index 00000000..f968c54b --- /dev/null +++ b/docs/code/types/indexer/type-aliases/ApplicationCreatedLookupResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / ApplicationCreatedLookupResult + +# Type Alias: ~~ApplicationCreatedLookupResult~~ + +> **ApplicationCreatedLookupResult** = `indexerModels.ApplicationsResponse` + +Defined in: [src/types/indexer.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L17) + +## Deprecated + +Use `algosdk.indexerModels.ApplicationsResponse`. Indexer result for an account's created applications, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-idcreated-applications diff --git a/docs/code/types/indexer/type-aliases/ApplicationLookupResult.md b/docs/code/types/indexer/type-aliases/ApplicationLookupResult.md new file mode 100644 index 00000000..654f317e --- /dev/null +++ b/docs/code/types/indexer/type-aliases/ApplicationLookupResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / ApplicationLookupResult + +# Type Alias: ~~ApplicationLookupResult~~ + +> **ApplicationLookupResult** = `indexerModels.ApplicationResponse` + +Defined in: [src/types/indexer.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L39) + +## Deprecated + +Use `algosdk.indexerModels.ApplicationResponse`. Indexer result for an application lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2applicationsapplication-id diff --git a/docs/code/types/indexer/type-aliases/ApplicationParams.md b/docs/code/types/indexer/type-aliases/ApplicationParams.md new file mode 100644 index 00000000..8d1dea82 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/ApplicationParams.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / ApplicationParams + +# Type Alias: ~~ApplicationParams~~ + +> **ApplicationParams** = `indexerModels.ApplicationParams` + +Defined in: [src/types/indexer.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L154) + +## Deprecated + +Use `algosdk.indexerModels.ApplicationParams`. Indexer Stores the global information associated with an application https://dev.algorand.co/reference/rest-apis/indexer#applicationparams diff --git a/docs/code/types/indexer/type-aliases/ApplicationResult.md b/docs/code/types/indexer/type-aliases/ApplicationResult.md new file mode 100644 index 00000000..c5312303 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/ApplicationResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / ApplicationResult + +# Type Alias: ~~ApplicationResult~~ + +> **ApplicationResult** = `indexerModels.Application` + +Defined in: [src/types/indexer.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L122) + +## Deprecated + +Use `algosdk.indexerModels.Application`. Indexer result of looking up an application diff --git a/docs/code/types/indexer/type-aliases/ApplicationTransactionResult.md b/docs/code/types/indexer/type-aliases/ApplicationTransactionResult.md new file mode 100644 index 00000000..07c26836 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/ApplicationTransactionResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / ApplicationTransactionResult + +# Type Alias: ~~ApplicationTransactionResult~~ + +> **ApplicationTransactionResult** = `indexerModels.TransactionApplication` + +Defined in: [src/types/indexer.ts:99](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L99) + +## Deprecated + +Use `algosdk.indexerModels.TransactionApplication`. Indexer Fields for an application transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionapplication diff --git a/docs/code/types/indexer/type-aliases/AssetBalancesLookupResult.md b/docs/code/types/indexer/type-aliases/AssetBalancesLookupResult.md new file mode 100644 index 00000000..fdbfce98 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetBalancesLookupResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetBalancesLookupResult + +# Type Alias: ~~AssetBalancesLookupResult~~ + +> **AssetBalancesLookupResult** = `indexerModels.AssetBalancesResponse` + +Defined in: [src/types/indexer.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L33) + +## Deprecated + +Use `algosdk.indexerModels.AssetBalancesResponse`. Indexer result for an asset's account holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-idbalances diff --git a/docs/code/types/indexer/type-aliases/AssetConfigTransactionResult.md b/docs/code/types/indexer/type-aliases/AssetConfigTransactionResult.md new file mode 100644 index 00000000..5ac7b46a --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetConfigTransactionResult.md @@ -0,0 +1,18 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetConfigTransactionResult + +# Type Alias: ~~AssetConfigTransactionResult~~ + +> **AssetConfigTransactionResult** = `indexerModels.TransactionAssetConfig` + +Defined in: [src/types/indexer.ts:106](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L106) + +## Deprecated + +Use `algosdk.indexerModels.TransactionAssetConfig`. Indexer Fields for asset allocation, re-configuration, and destruction. +https://dev.algorand.co/reference/rest-apis/indexer#transactionassetconfig + +A zero value for asset-id indicates asset creation. A zero value for the params indicates asset destruction. diff --git a/docs/code/types/indexer/type-aliases/AssetFreezeTransactionResult.md b/docs/code/types/indexer/type-aliases/AssetFreezeTransactionResult.md new file mode 100644 index 00000000..3f4f4662 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetFreezeTransactionResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetFreezeTransactionResult + +# Type Alias: ~~AssetFreezeTransactionResult~~ + +> **AssetFreezeTransactionResult** = `indexerModels.TransactionAssetFreeze` + +Defined in: [src/types/indexer.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L109) + +## Deprecated + +Use `algosdk.indexerModels.TransactionAssetFreeze`. Indexer Fields for an asset freeze transaction. https://dev.algorand.co/reference/rest-apis/indexer#transactionassetfreeze diff --git a/docs/code/types/indexer/type-aliases/AssetHolding.md b/docs/code/types/indexer/type-aliases/AssetHolding.md new file mode 100644 index 00000000..f18e482e --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetHolding.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetHolding + +# Type Alias: ~~AssetHolding~~ + +> **AssetHolding** = `indexerModels.AssetHolding` + +Defined in: [src/types/indexer.ts:205](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L205) + +## Deprecated + +Use `algosdk.indexerModels.AssetHolding`. Indexer Describes an asset held by an account. https://dev.algorand.co/reference/rest-apis/indexer#assetholding diff --git a/docs/code/types/indexer/type-aliases/AssetLookupResult.md b/docs/code/types/indexer/type-aliases/AssetLookupResult.md new file mode 100644 index 00000000..25d0cea1 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetLookupResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetLookupResult + +# Type Alias: ~~AssetLookupResult~~ + +> **AssetLookupResult** = `indexerModels.AssetResponse` + +Defined in: [src/types/indexer.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L20) + +## Deprecated + +Use `algosdk.indexerModels.AssetResponse`. Indexer result for an asset lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2assetsasset-id diff --git a/docs/code/types/indexer/type-aliases/AssetParams.md b/docs/code/types/indexer/type-aliases/AssetParams.md new file mode 100644 index 00000000..f3fcdd14 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetParams.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetParams + +# Type Alias: ~~AssetParams~~ + +> **AssetParams** = `indexerModels.AssetParams` + +Defined in: [src/types/indexer.ts:176](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L176) + +## Deprecated + +Use `algosdk.indexerModels.AssetParams`. Indexer AssetParams specifies the parameters for an asset. https://dev.algorand.co/reference/rest-apis/indexer#assetparams diff --git a/docs/code/types/indexer/type-aliases/AssetResult.md b/docs/code/types/indexer/type-aliases/AssetResult.md new file mode 100644 index 00000000..31b3fe96 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetResult + +# Type Alias: ~~AssetResult~~ + +> **AssetResult** = `indexerModels.Asset` + +Defined in: [src/types/indexer.ts:118](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L118) + +## Deprecated + +Use `algosdk.indexerModels.Asset`. Indexer Fields to specify both the unique identifier and the parameters for an asset. https://dev.algorand.co/reference/rest-apis/indexer#asset diff --git a/docs/code/types/indexer/type-aliases/AssetTransferTransactionResult.md b/docs/code/types/indexer/type-aliases/AssetTransferTransactionResult.md new file mode 100644 index 00000000..819faa84 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetTransferTransactionResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetTransferTransactionResult + +# Type Alias: ~~AssetTransferTransactionResult~~ + +> **AssetTransferTransactionResult** = `indexerModels.TransactionAssetTransfer` + +Defined in: [src/types/indexer.ts:112](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L112) + +## Deprecated + +Use `algosdk.indexerModels.TransactionAssetTransfer`. Indexer Fields for an asset transfer transaction. https://dev.algorand.co/reference/rest-apis/indexer#transactionassettransfer diff --git a/docs/code/types/indexer/type-aliases/AssetsCreatedLookupResult.md b/docs/code/types/indexer/type-aliases/AssetsCreatedLookupResult.md new file mode 100644 index 00000000..6ac1c1c2 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetsCreatedLookupResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetsCreatedLookupResult + +# Type Alias: ~~AssetsCreatedLookupResult~~ + +> **AssetsCreatedLookupResult** = `indexerModels.AssetsResponse` + +Defined in: [src/types/indexer.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L14) + +## Deprecated + +Use `algosdk.indexerModels.AssetsResponse`. Indexer result for an account's created assets, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-idcreated-assets diff --git a/docs/code/types/indexer/type-aliases/AssetsLookupResult.md b/docs/code/types/indexer/type-aliases/AssetsLookupResult.md new file mode 100644 index 00000000..770255b2 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/AssetsLookupResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / AssetsLookupResult + +# Type Alias: ~~AssetsLookupResult~~ + +> **AssetsLookupResult** = `indexerModels.AssetHoldingsResponse` + +Defined in: [src/types/indexer.ts:11](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L11) + +## Deprecated + +Use `algosdk.indexerModels.AssetHoldingsResponse`. Indexer result for an account's asset holdings, https://dev.algorand.co/reference/rest-apis/indexer#get-v2accountsaccount-idassets diff --git a/docs/code/types/indexer/type-aliases/EvalDelta.md b/docs/code/types/indexer/type-aliases/EvalDelta.md new file mode 100644 index 00000000..d4f25968 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/EvalDelta.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / EvalDelta + +# Type Alias: ~~EvalDelta~~ + +> **EvalDelta** = `indexerModels.EvalDelta` + +Defined in: [src/types/indexer.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L151) + +## Deprecated + +Use `algosdk.indexerModels.EvalDelta`. Indexer Represents a TEAL value delta. https://dev.algorand.co/reference/rest-apis/indexer#evaldelta diff --git a/docs/code/types/indexer/type-aliases/EvalDeltaKeyValue.md b/docs/code/types/indexer/type-aliases/EvalDeltaKeyValue.md new file mode 100644 index 00000000..bdd001fb --- /dev/null +++ b/docs/code/types/indexer/type-aliases/EvalDeltaKeyValue.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / EvalDeltaKeyValue + +# Type Alias: ~~EvalDeltaKeyValue~~ + +> **EvalDeltaKeyValue** = `indexerModels.EvalDeltaKeyValue` + +Defined in: [src/types/indexer.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L142) + +## Deprecated + +Use `algosdk.indexerModels.EvalDeltaKeyValue`. diff --git a/docs/code/types/indexer/type-aliases/KeyRegistrationTransactionResult.md b/docs/code/types/indexer/type-aliases/KeyRegistrationTransactionResult.md new file mode 100644 index 00000000..d9d4aa5b --- /dev/null +++ b/docs/code/types/indexer/type-aliases/KeyRegistrationTransactionResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / KeyRegistrationTransactionResult + +# Type Alias: ~~KeyRegistrationTransactionResult~~ + +> **KeyRegistrationTransactionResult** = `indexerModels.TransactionKeyreg` + +Defined in: [src/types/indexer.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L115) + +## Deprecated + +Use `algosdk.indexerModels.TransactionKeyreg`. Indexer Fields for a `keyreg` transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionkeyreg diff --git a/docs/code/types/indexer/type-aliases/LogicTransactionSignature.md b/docs/code/types/indexer/type-aliases/LogicTransactionSignature.md new file mode 100644 index 00000000..32848f76 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/LogicTransactionSignature.md @@ -0,0 +1,19 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / LogicTransactionSignature + +# Type Alias: ~~LogicTransactionSignature~~ + +> **LogicTransactionSignature** = `indexerModels.TransactionSignatureLogicsig` + +Defined in: [src/types/indexer.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L133) + +## Deprecated + +Use `algosdk.indexerModels.TransactionSignatureLogicsig`. Indexer [lsig] Programatic transaction signature. + +https://dev.algorand.co/reference/rest-apis/indexer#transactionsignaturelogicsig + +https://dev.algorand.co/concepts/smart-contracts/logic-sigs diff --git a/docs/code/types/indexer/type-aliases/MerkleArrayProof.md b/docs/code/types/indexer/type-aliases/MerkleArrayProof.md new file mode 100644 index 00000000..7a6421fc --- /dev/null +++ b/docs/code/types/indexer/type-aliases/MerkleArrayProof.md @@ -0,0 +1,49 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / MerkleArrayProof + +# Type Alias: ~~MerkleArrayProof~~ + +> **MerkleArrayProof** = `indexerModels.MerkleArrayProof` + +Defined in: [src/types/indexer.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L96) + +## Deprecated + +Use `algosdk.indexerModels.MerkleArrayProof`. Indexer Merkle array Proof. + +Proof is used to convince a verifier about membership of leaves: h0,h1...hn +at indexes i0,i1...in on a tree. The verifier has a trusted value of the tree +root hash. + +Path is bounded by MaxNumLeaves since there could be multiple reveals, and +given the distribution of the elt positions and the depth of the tree, +the path length can increase up to 2^MaxTreeDepth / 2 + +Consider two different reveals for the same tree: +``` +. z5 +. z3 z4 +. y z z1 z2 +. q r s t u v w x +. a b c d e f g h i j k l m n o p +. ^ +. hints: [a, r, z, z4] +. len(hints) = 4 +``` +You need a to combine with b to get q, need r to combine with the computed q and get y, and so on. + +The worst case is this: +``` +. z5 +. z3 z4 +. y z z1 z2 +. q r s t u v w x +. a b c d e f g h i j k l m n o p +. ^ ^ ^ ^ ^ ^ ^ ^ +. +. hints: [b, d, e, g, j, l, m, o] +. len(hints) = 2^4/2 +``` diff --git a/docs/code/types/indexer/type-aliases/MiniAssetHolding.md b/docs/code/types/indexer/type-aliases/MiniAssetHolding.md new file mode 100644 index 00000000..e2183bf8 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/MiniAssetHolding.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / MiniAssetHolding + +# Type Alias: ~~MiniAssetHolding~~ + +> **MiniAssetHolding** = `indexerModels.MiniAssetHolding` + +Defined in: [src/types/indexer.ts:208](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L208) + +## Deprecated + +Use `algosdk.indexerModels.MiniAssetHolding`. Indexer Describes an asset holding for an account of a known asset. https://dev.algorand.co/reference/rest-apis/indexer#miniassetholding diff --git a/docs/code/types/indexer/type-aliases/MultisigTransactionSignature.md b/docs/code/types/indexer/type-aliases/MultisigTransactionSignature.md new file mode 100644 index 00000000..d5454600 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/MultisigTransactionSignature.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / MultisigTransactionSignature + +# Type Alias: ~~MultisigTransactionSignature~~ + +> **MultisigTransactionSignature** = `indexerModels.TransactionSignatureMultisig` + +Defined in: [src/types/indexer.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L136) + +## Deprecated + +Use `algosdk.indexerModels.TransactionSignatureMultisig`. Indexer [msig] structure holding multiple subsignatures. https://dev.algorand.co/reference/rest-apis/indexer#transactionsignaturemultisig diff --git a/docs/code/types/indexer/type-aliases/MultisigTransactionSubSignature.md b/docs/code/types/indexer/type-aliases/MultisigTransactionSubSignature.md new file mode 100644 index 00000000..a34de235 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/MultisigTransactionSubSignature.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / MultisigTransactionSubSignature + +# Type Alias: ~~MultisigTransactionSubSignature~~ + +> **MultisigTransactionSubSignature** = `indexerModels.TransactionSignatureMultisigSubsignature` + +Defined in: [src/types/indexer.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L139) + +## Deprecated + +Use `algosdk.indexerModels.TransactionSignatureMultisigSubsignature`. Indexer Sub-signature for a multisig signature https://dev.algorand.co/reference/rest-apis/indexer#transactionsignaturemultisigsubsignature diff --git a/docs/code/types/indexer/type-aliases/PaymentTransactionResult.md b/docs/code/types/indexer/type-aliases/PaymentTransactionResult.md new file mode 100644 index 00000000..59affff8 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/PaymentTransactionResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / PaymentTransactionResult + +# Type Alias: ~~PaymentTransactionResult~~ + +> **PaymentTransactionResult** = `indexerModels.TransactionPayment` + +Defined in: [src/types/indexer.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L48) + +## Deprecated + +Use `algosdk.indexerModels.TransactionPayment`. Indexer Fields for a payment transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionpayment diff --git a/docs/code/types/indexer/type-aliases/StateDelta.md b/docs/code/types/indexer/type-aliases/StateDelta.md new file mode 100644 index 00000000..20f38a0b --- /dev/null +++ b/docs/code/types/indexer/type-aliases/StateDelta.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / StateDelta + +# Type Alias: ~~StateDelta~~ + +> **StateDelta** = [`EvalDeltaKeyValue`](EvalDeltaKeyValue.md)[] + +Defined in: [src/types/indexer.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L148) + +## Deprecated + +Use `algosdk.indexerModels.EvalDeltaKeyValue[]`. diff --git a/docs/code/types/indexer/type-aliases/StateProofTransactionResult.md b/docs/code/types/indexer/type-aliases/StateProofTransactionResult.md new file mode 100644 index 00000000..6da22bdf --- /dev/null +++ b/docs/code/types/indexer/type-aliases/StateProofTransactionResult.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / StateProofTransactionResult + +# Type Alias: ~~StateProofTransactionResult~~ + +> **StateProofTransactionResult** = `indexerModels.TransactionStateProof` + +Defined in: [src/types/indexer.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L58) + +## Deprecated + +Use `algosdk.indexerModels.TransactionStateProof`. Indexer Fields for a state proof transaction https://dev.algorand.co/reference/rest-apis/indexer#transactionstateproof. + +See also https://dev.algorand.co/concepts/protocol/state-proofs/, +https://github.com/algorand/go-algorand/blob/master/data/transactions/stateproof.go, +https://github.com/algorand/go-algorand/blob/master/crypto/stateproof/structs.go, +https://github.com/algorand/go-algorand/blob/master/data/stateproofmsg/message.go, and +https://dev.algorand.co/reference/rest-apis/algod/#stateproof. diff --git a/docs/code/types/indexer/type-aliases/StateSchema.md b/docs/code/types/indexer/type-aliases/StateSchema.md new file mode 100644 index 00000000..4b8023e0 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/StateSchema.md @@ -0,0 +1,20 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / StateSchema + +# Type Alias: ~~StateSchema~~ + +> **StateSchema** = `indexerModels.StateSchema` + +Defined in: [src/types/indexer.ts:163](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L163) + +## Deprecated + +Use `algosdk.indexerModels.StateSchema`. Indexer Represents a [apls] local-state or [apgs] global-state schema. +https://dev.algorand.co/reference/rest-apis/indexer#stateschema + +These schemas determine how much storage may be used in a local-state or global-state for an application. + +The more space used, the larger minimum balance must be maintained in the account holding the data. diff --git a/docs/code/types/indexer/type-aliases/TransactionLookupResult.md b/docs/code/types/indexer/type-aliases/TransactionLookupResult.md new file mode 100644 index 00000000..6c9a61b7 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/TransactionLookupResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / TransactionLookupResult + +# Type Alias: ~~TransactionLookupResult~~ + +> **TransactionLookupResult** = `indexerModels.TransactionResponse` + +Defined in: [src/types/indexer.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L36) + +## Deprecated + +Use `algosdk.indexerModels.TransactionResponse`. Indexer result for a transaction lookup, https://dev.algorand.co/reference/rest-apis/indexer#get-v2transactionstxid diff --git a/docs/code/types/indexer/type-aliases/TransactionResult.md b/docs/code/types/indexer/type-aliases/TransactionResult.md new file mode 100644 index 00000000..c6e4e82f --- /dev/null +++ b/docs/code/types/indexer/type-aliases/TransactionResult.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / TransactionResult + +# Type Alias: ~~TransactionResult~~ + +> **TransactionResult** = `indexerModels.Transaction` + +Defined in: [src/types/indexer.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L42) + +## Deprecated + +Use `algosdk.indexerModels.Transaction`. Indexer result for a transaction, https://dev.algorand.co/reference/rest-apis/indexer#transaction diff --git a/docs/code/types/indexer/type-aliases/TransactionSearchResults.md b/docs/code/types/indexer/type-aliases/TransactionSearchResults.md new file mode 100644 index 00000000..bd18b56e --- /dev/null +++ b/docs/code/types/indexer/type-aliases/TransactionSearchResults.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / TransactionSearchResults + +# Type Alias: ~~TransactionSearchResults~~ + +> **TransactionSearchResults** = `indexerModels.TransactionsResponse` + +Defined in: [src/types/indexer.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L5) + +## Deprecated + +Use `algosdk.indexerModels.TransactionsResponse`. Indexer result for a transaction search, https://dev.algorand.co/reference/rest-apis/indexer#get-v2transactions diff --git a/docs/code/types/indexer/type-aliases/TransactionSignature.md b/docs/code/types/indexer/type-aliases/TransactionSignature.md new file mode 100644 index 00000000..330dfb60 --- /dev/null +++ b/docs/code/types/indexer/type-aliases/TransactionSignature.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/indexer](../README.md) / TransactionSignature + +# Type Alias: ~~TransactionSignature~~ + +> **TransactionSignature** = `indexerModels.TransactionSignature` + +Defined in: [src/types/indexer.ts:125](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/indexer.ts#L125) + +## Deprecated + +Use `algosdk.indexerModels.TransactionSignature`. Indexer Validation signature associated with some data. Only one of the signatures should be provided. https://dev.algorand.co/reference/rest-apis/indexer#transactionsignature diff --git a/docs/code/types/kmd-account-manager/README.md b/docs/code/types/kmd-account-manager/README.md new file mode 100644 index 00000000..15626f26 --- /dev/null +++ b/docs/code/types/kmd-account-manager/README.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/kmd-account-manager + +# types/kmd-account-manager + +## Classes + +- [KmdAccountManager](classes/KmdAccountManager.md) diff --git a/docs/code/types/kmd-account-manager/classes/KmdAccountManager.md b/docs/code/types/kmd-account-manager/classes/KmdAccountManager.md new file mode 100644 index 00000000..79e14b8c --- /dev/null +++ b/docs/code/types/kmd-account-manager/classes/KmdAccountManager.md @@ -0,0 +1,159 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/kmd-account-manager](../README.md) / KmdAccountManager + +# Class: KmdAccountManager + +Defined in: [src/types/kmd-account-manager.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L10) + +Provides abstractions over a [KMD](https://github.com/algorand/go-algorand/blob/master/daemon/kmd/README.md) instance +that makes it easier to get and manage accounts using KMD. + +## Constructors + +### Constructor + +> **new KmdAccountManager**(`clientManager`): `KmdAccountManager` + +Defined in: [src/types/kmd-account-manager.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L18) + +Create a new KMD manager. + +#### Parameters + +##### clientManager + +[`ClientManager`](../../client-manager/classes/ClientManager.md) + +A ClientManager client to use for algod and kmd clients + +#### Returns + +`KmdAccountManager` + +## Methods + +### getLocalNetDispenserAccount() + +> **getLocalNetDispenserAccount**(): `Promise`\<[`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +Defined in: [src/types/kmd-account-manager.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L186) + +Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts). + +#### Returns + +`Promise`\<[`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +The default LocalNet dispenser account + +#### Example + +```typescript +const dispenser = await kmdAccountManager.getLocalNetDispenserAccount() +``` + +*** + +### getOrCreateWalletAccount() + +> **getOrCreateWalletAccount**(`name`, `fundWith?`): `Promise`\<[`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +Defined in: [src/types/kmd-account-manager.ts:135](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L135) + +Gets an account with private key loaded from a KMD wallet of the given name, or alternatively creates one with funds in it via a KMD wallet of the given name. + +This is useful to get idempotent accounts from LocalNet without having to specify the private key (which will change when resetting the LocalNet). + +This significantly speeds up local dev time and improves experience since you can write code that *just works* first go without manual config in a fresh LocalNet. + +If this is used via `mnemonicAccountFromEnvironment`, then you can even use the same code that runs on production without changes for local development! + +#### Parameters + +##### name + +`string` + +The name of the wallet to retrieve / create + +##### fundWith? + +[`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +The number of Algo to fund the account with when it gets created, if not specified then 1000 ALGO will be funded from the dispenser account + +#### Returns + +`Promise`\<[`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +An Algorand account with private key loaded - either one that already existed in the given KMD wallet, or a new one that is funded for you + +#### Example + +```typescript +// Idempotently get (if exists) or create (if it doesn't exist yet) an account by name using KMD +// if creating it then fund it with 2 ALGO from the default dispenser account +const newAccount = await kmdAccountManager.getOrCreateWalletAccount('account1', (2).algo()) +// This will return the same account as above since the name matches +const existingAccount = await kmdAccountManager.getOrCreateWalletAccount('account1') +``` + +*** + +### getWalletAccount() + +> **getWalletAccount**(`walletName`, `predicate?`, `sender?`): `Promise`\<`undefined` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +Defined in: [src/types/kmd-account-manager.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L62) + +Returns an Algorand signing account with private key loaded from the given KMD wallet (identified by name). + +#### Parameters + +##### walletName + +`string` + +The name of the wallet to retrieve an account from + +##### predicate? + +(`account`) => `boolean` + +An optional filter to use to find the account (otherwise it will return a random account from the wallet) + +##### sender? + +The optional sender address to use this signer for (aka a rekeyed account) + +`string` | `Address` + +#### Returns + +`Promise`\<`undefined` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `object`\> + +The signing account (with private key loaded) or undefined if no matching wallet or account was found + +#### Example + +```typescript +const defaultDispenserAccount = await kmdAccountManager.getWalletAccount( + 'unencrypted-default-wallet', + a => a.status !== 'Offline' && a.amount > 1_000_000_000 +) +``` + +*** + +### kmd() + +> **kmd**(): `Promise`\<`KmdClient`\> + +Defined in: [src/types/kmd-account-manager.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/kmd-account-manager.ts#L27) + +#### Returns + +`Promise`\<`KmdClient`\> diff --git a/docs/code/types/lifecycle-events/README.md b/docs/code/types/lifecycle-events/README.md new file mode 100644 index 00000000..977aef3a --- /dev/null +++ b/docs/code/types/lifecycle-events/README.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/lifecycle-events + +# types/lifecycle-events + +## Enumerations + +- [EventType](enumerations/EventType.md) + +## Type Aliases + +- [EventDataMap](type-aliases/EventDataMap.md) diff --git a/docs/code/types/lifecycle-events/enumerations/EventType.md b/docs/code/types/lifecycle-events/enumerations/EventType.md new file mode 100644 index 00000000..70dc9384 --- /dev/null +++ b/docs/code/types/lifecycle-events/enumerations/EventType.md @@ -0,0 +1,25 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/lifecycle-events](../README.md) / EventType + +# Enumeration: EventType + +Defined in: [src/types/lifecycle-events.ts:3](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/lifecycle-events.ts#L3) + +## Enumeration Members + +### AppCompiled + +> **AppCompiled**: `"AppCompiled"` + +Defined in: [src/types/lifecycle-events.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/lifecycle-events.ts#L5) + +*** + +### TxnGroupSimulated + +> **TxnGroupSimulated**: `"TxnGroupSimulated"` + +Defined in: [src/types/lifecycle-events.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/lifecycle-events.ts#L4) diff --git a/docs/code/types/lifecycle-events/type-aliases/EventDataMap.md b/docs/code/types/lifecycle-events/type-aliases/EventDataMap.md new file mode 100644 index 00000000..0485312c --- /dev/null +++ b/docs/code/types/lifecycle-events/type-aliases/EventDataMap.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/lifecycle-events](../README.md) / EventDataMap + +# Type Alias: EventDataMap + +> **EventDataMap** = `object` + +Defined in: [src/types/lifecycle-events.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/lifecycle-events.ts#L8) + +## Indexable + +\[`key`: `string`\]: `unknown` + +## Properties + +### AppCompiled + +> **AppCompiled**: [`TealSourcesDebugEventData`](../../debugging/interfaces/TealSourcesDebugEventData.md) + +Defined in: [src/types/lifecycle-events.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/lifecycle-events.ts#L10) + +*** + +### TxnGroupSimulated + +> **TxnGroupSimulated**: [`AVMTracesEventData`](../../debugging/interfaces/AVMTracesEventData.md) + +Defined in: [src/types/lifecycle-events.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/lifecycle-events.ts#L9) diff --git a/docs/code/types/logging/README.md b/docs/code/types/logging/README.md new file mode 100644 index 00000000..ea74acfc --- /dev/null +++ b/docs/code/types/logging/README.md @@ -0,0 +1,19 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/logging + +# types/logging + +## Type Aliases + +- [Logger](type-aliases/Logger.md) + +## Variables + +- [consoleLogger](variables/consoleLogger.md) +- [infoConsoleLogger](variables/infoConsoleLogger.md) +- [nullLogger](variables/nullLogger.md) +- [verboseConsoleLogger](variables/verboseConsoleLogger.md) +- [warningConsoleLogger](variables/warningConsoleLogger.md) diff --git a/docs/code/types/logging/type-aliases/Logger.md b/docs/code/types/logging/type-aliases/Logger.md new file mode 100644 index 00000000..324da384 --- /dev/null +++ b/docs/code/types/logging/type-aliases/Logger.md @@ -0,0 +1,123 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/logging](../README.md) / Logger + +# Type Alias: Logger + +> **Logger** = `object` + +Defined in: [src/types/logging.ts:5](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L5) + +General purpose logger type, compatible with Winston and others. + +## Methods + +### debug() + +> **debug**(`message`, ...`optionalParams`): `void` + +Defined in: [src/types/logging.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L10) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` + +*** + +### error() + +> **error**(`message`, ...`optionalParams`): `void` + +Defined in: [src/types/logging.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L6) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` + +*** + +### info() + +> **info**(`message`, ...`optionalParams`): `void` + +Defined in: [src/types/logging.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L8) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` + +*** + +### verbose() + +> **verbose**(`message`, ...`optionalParams`): `void` + +Defined in: [src/types/logging.ts:9](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L9) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` + +*** + +### warn() + +> **warn**(`message`, ...`optionalParams`): `void` + +Defined in: [src/types/logging.ts:7](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L7) + +#### Parameters + +##### message + +`string` + +##### optionalParams + +...`unknown`[] + +#### Returns + +`void` diff --git a/docs/code/types/logging/variables/consoleLogger.md b/docs/code/types/logging/variables/consoleLogger.md new file mode 100644 index 00000000..76f3af70 --- /dev/null +++ b/docs/code/types/logging/variables/consoleLogger.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/logging](../README.md) / consoleLogger + +# Variable: consoleLogger + +> `const` **consoleLogger**: [`Logger`](../type-aliases/Logger.md) + +Defined in: [src/types/logging.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L14) + +A logger implementation that writes to console diff --git a/docs/code/types/logging/variables/infoConsoleLogger.md b/docs/code/types/logging/variables/infoConsoleLogger.md new file mode 100644 index 00000000..119db6ef --- /dev/null +++ b/docs/code/types/logging/variables/infoConsoleLogger.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/logging](../README.md) / infoConsoleLogger + +# Variable: infoConsoleLogger + +> `const` **infoConsoleLogger**: [`Logger`](../type-aliases/Logger.md) + +Defined in: [src/types/logging.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L22) diff --git a/docs/code/types/logging/variables/nullLogger.md b/docs/code/types/logging/variables/nullLogger.md new file mode 100644 index 00000000..663a401d --- /dev/null +++ b/docs/code/types/logging/variables/nullLogger.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/logging](../README.md) / nullLogger + +# Variable: nullLogger + +> `const` **nullLogger**: [`Logger`](../type-aliases/Logger.md) + +Defined in: [src/types/logging.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L47) + +A logger implementation that does nothing diff --git a/docs/code/types/logging/variables/verboseConsoleLogger.md b/docs/code/types/logging/variables/verboseConsoleLogger.md new file mode 100644 index 00000000..69f86ac1 --- /dev/null +++ b/docs/code/types/logging/variables/verboseConsoleLogger.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/logging](../README.md) / verboseConsoleLogger + +# Variable: verboseConsoleLogger + +> `const` **verboseConsoleLogger**: [`Logger`](../type-aliases/Logger.md) + +Defined in: [src/types/logging.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L30) diff --git a/docs/code/types/logging/variables/warningConsoleLogger.md b/docs/code/types/logging/variables/warningConsoleLogger.md new file mode 100644 index 00000000..cabd388a --- /dev/null +++ b/docs/code/types/logging/variables/warningConsoleLogger.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/logging](../README.md) / warningConsoleLogger + +# Variable: warningConsoleLogger + +> `const` **warningConsoleLogger**: [`Logger`](../type-aliases/Logger.md) + +Defined in: [src/types/logging.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logging.ts#L38) diff --git a/docs/code/types/logic-error/README.md b/docs/code/types/logic-error/README.md new file mode 100644 index 00000000..dc5cf5b9 --- /dev/null +++ b/docs/code/types/logic-error/README.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/logic-error + +# types/logic-error + +## Classes + +- [LogicError](classes/LogicError.md) + +## Interfaces + +- [LogicErrorDetails](interfaces/LogicErrorDetails.md) diff --git a/docs/code/types/logic-error/classes/LogicError.md b/docs/code/types/logic-error/classes/LogicError.md new file mode 100644 index 00000000..6548aee8 --- /dev/null +++ b/docs/code/types/logic-error/classes/LogicError.md @@ -0,0 +1,229 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/logic-error](../README.md) / LogicError + +# Class: LogicError + +Defined in: [src/types/logic-error.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L20) + +Wraps key functionality around processing logic errors + +## Extends + +- `Error` + +## Constructors + +### Constructor + +> **new LogicError**(`errorDetails`, `program`, `getLineForPc`): `LogicError` + +Defined in: [src/types/logic-error.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L52) + +Create a new logic error object. + +#### Parameters + +##### errorDetails + +[`LogicErrorDetails`](../interfaces/LogicErrorDetails.md) + +The details of the logic error + +##### program + +`string`[] + +The TEAL source code, split by line + +##### getLineForPc + +(`pc`) => `undefined` \| `number` + +The source map of the TEAL source code + +#### Returns + +`LogicError` + +#### Overrides + +`Error.constructor` + +## Properties + +### cause? + +> `optional` **cause**: `unknown` + +Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26 + +#### Inherited from + +`Error.cause` + +*** + +### led + +> **led**: [`LogicErrorDetails`](../interfaces/LogicErrorDetails.md) + +Defined in: [src/types/logic-error.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L40) + +*** + +### lines + +> **lines**: `number` = `5` + +Defined in: [src/types/logic-error.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L42) + +*** + +### message + +> **message**: `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077 + +#### Inherited from + +`Error.message` + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076 + +#### Inherited from + +`Error.name` + +*** + +### program + +> **program**: `string`[] + +Defined in: [src/types/logic-error.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L41) + +*** + +### stack? + +> `optional` **stack**: `string` + +Defined in: [src/types/logic-error.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L44) + +#### Overrides + +`Error.stack` + +*** + +### teal\_line + +> **teal\_line**: `number` = `0` + +Defined in: [src/types/logic-error.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L43) + +*** + +### prepareStackTrace()? + +> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any` + +Defined in: node\_modules/@types/node/globals.d.ts:28 + +Optional override for formatting stack traces + +#### Parameters + +##### err + +`Error` + +##### stackTraces + +`CallSite`[] + +#### Returns + +`any` + +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +`Error.prepareStackTrace` + +*** + +### stackTraceLimit + +> `static` **stackTraceLimit**: `number` + +Defined in: node\_modules/@types/node/globals.d.ts:30 + +#### Inherited from + +`Error.stackTraceLimit` + +## Methods + +### captureStackTrace() + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Defined in: node\_modules/@types/node/globals.d.ts:21 + +Create .stack property on a target object + +#### Parameters + +##### targetObject + +`object` + +##### constructorOpt? + +`Function` + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +*** + +### parseLogicError() + +> `static` **parseLogicError**(`error`): `undefined` \| [`LogicErrorDetails`](../interfaces/LogicErrorDetails.md) + +Defined in: [src/types/logic-error.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L26) + +Takes an error message and parses out the details of any logic errors in there. + +#### Parameters + +##### error + +`any` + +The error message to parse + +#### Returns + +`undefined` \| [`LogicErrorDetails`](../interfaces/LogicErrorDetails.md) + +The logic error details if any, or undefined diff --git a/docs/code/types/logic-error/interfaces/LogicErrorDetails.md b/docs/code/types/logic-error/interfaces/LogicErrorDetails.md new file mode 100644 index 00000000..1d791d62 --- /dev/null +++ b/docs/code/types/logic-error/interfaces/LogicErrorDetails.md @@ -0,0 +1,61 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/logic-error](../README.md) / LogicErrorDetails + +# Interface: LogicErrorDetails + +Defined in: [src/types/logic-error.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L6) + +Details about a smart contract logic error + +## Properties + +### desc + +> **desc**: `string` + +Defined in: [src/types/logic-error.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L14) + +The full error description + +*** + +### msg + +> **msg**: `string` + +Defined in: [src/types/logic-error.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L12) + +The error message + +*** + +### pc + +> **pc**: `number` + +Defined in: [src/types/logic-error.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L10) + +The program counter where the error was + +*** + +### traces + +> **traces**: `Record`\<`string`, `unknown`\>[] + +Defined in: [src/types/logic-error.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L16) + +Any trace information included in the error + +*** + +### txId + +> **txId**: `string` + +Defined in: [src/types/logic-error.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/logic-error.ts#L8) + +The ID of the transaction with the logic error diff --git a/docs/code/types/network-client/README.md b/docs/code/types/network-client/README.md new file mode 100644 index 00000000..f0fc0fc8 --- /dev/null +++ b/docs/code/types/network-client/README.md @@ -0,0 +1,17 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/network-client + +# types/network-client + +## Interfaces + +- [AlgoClientConfig](interfaces/AlgoClientConfig.md) +- [AlgoConfig](interfaces/AlgoConfig.md) +- [NetworkDetails](interfaces/NetworkDetails.md) + +## Functions + +- [genesisIdIsLocalNet](functions/genesisIdIsLocalNet.md) diff --git a/docs/code/types/network-client/functions/genesisIdIsLocalNet.md b/docs/code/types/network-client/functions/genesisIdIsLocalNet.md new file mode 100644 index 00000000..70a9fe2d --- /dev/null +++ b/docs/code/types/network-client/functions/genesisIdIsLocalNet.md @@ -0,0 +1,27 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/network-client](../README.md) / genesisIdIsLocalNet + +# Function: genesisIdIsLocalNet() + +> **genesisIdIsLocalNet**(`genesisId`): genesisId is "devnet-v1" \| "sandnet-v1" \| "dockernet-v1" + +Defined in: [src/types/network-client.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L42) + +Returns true if the given network genesisId is associated with a LocalNet network. + +## Parameters + +### genesisId + +`string` + +The network genesis ID + +## Returns + +genesisId is "devnet-v1" \| "sandnet-v1" \| "dockernet-v1" + +Whether the given genesis ID is associated with a LocalNet network diff --git a/docs/code/types/network-client/interfaces/AlgoClientConfig.md b/docs/code/types/network-client/interfaces/AlgoClientConfig.md new file mode 100644 index 00000000..db7456ae --- /dev/null +++ b/docs/code/types/network-client/interfaces/AlgoClientConfig.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/network-client](../README.md) / AlgoClientConfig + +# Interface: AlgoClientConfig + +Defined in: [src/types/network-client.ts:4](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L4) + +Config for an Algorand SDK client. + +## Properties + +### port? + +> `optional` **port**: `string` \| `number` + +Defined in: [src/types/network-client.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L8) + +The port to use e.g. 4001, 443, etc. + +*** + +### server + +> **server**: `string` + +Defined in: [src/types/network-client.ts:6](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L6) + +Base URL of the server e.g. http://localhost, https://testnet-api.algonode.cloud/, etc. + +*** + +### token? + +> `optional` **token**: `string` \| `TokenHeader` + +Defined in: [src/types/network-client.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L10) + +The token to use for API authentication (or undefined if none needed) - can be a string, or an object with the header key => value diff --git a/docs/code/types/network-client/interfaces/AlgoConfig.md b/docs/code/types/network-client/interfaces/AlgoConfig.md new file mode 100644 index 00000000..f4b1b994 --- /dev/null +++ b/docs/code/types/network-client/interfaces/AlgoConfig.md @@ -0,0 +1,41 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/network-client](../README.md) / AlgoConfig + +# Interface: AlgoConfig + +Defined in: [src/types/network-client.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L14) + +Configuration for algod, indexer and kmd clients. + +## Properties + +### algodConfig + +> **algodConfig**: [`AlgoClientConfig`](AlgoClientConfig.md) + +Defined in: [src/types/network-client.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L16) + +Algod client configuration + +*** + +### indexerConfig? + +> `optional` **indexerConfig**: [`AlgoClientConfig`](AlgoClientConfig.md) + +Defined in: [src/types/network-client.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L18) + +Indexer client configuration + +*** + +### kmdConfig? + +> `optional` **kmdConfig**: [`AlgoClientConfig`](AlgoClientConfig.md) + +Defined in: [src/types/network-client.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L20) + +Kmd configuration diff --git a/docs/code/types/network-client/interfaces/NetworkDetails.md b/docs/code/types/network-client/interfaces/NetworkDetails.md new file mode 100644 index 00000000..76463dc2 --- /dev/null +++ b/docs/code/types/network-client/interfaces/NetworkDetails.md @@ -0,0 +1,61 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/network-client](../README.md) / NetworkDetails + +# Interface: NetworkDetails + +Defined in: [src/types/network-client.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L24) + +Details of the current network. + +## Properties + +### genesisHash + +> **genesisHash**: `string` + +Defined in: [src/types/network-client.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L34) + +The base64 genesis hash of the current network. + +*** + +### genesisId + +> **genesisId**: `string` + +Defined in: [src/types/network-client.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L32) + +The genesis ID of the current network. + +*** + +### isLocalNet + +> **isLocalNet**: `boolean` + +Defined in: [src/types/network-client.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L30) + +Whether or not the network is LocalNet. + +*** + +### isMainNet + +> **isMainNet**: `boolean` + +Defined in: [src/types/network-client.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L28) + +Whether or not the network is MainNet. + +*** + +### isTestNet + +> **isTestNet**: `boolean` + +Defined in: [src/types/network-client.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L26) + +Whether or not the network is TestNet. diff --git a/docs/code/types/testing/README.md b/docs/code/types/testing/README.md new file mode 100644 index 00000000..3f96824a --- /dev/null +++ b/docs/code/types/testing/README.md @@ -0,0 +1,16 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/testing + +# types/testing + +## Interfaces + +- [AlgoKitLogCaptureFixture](interfaces/AlgoKitLogCaptureFixture.md) +- [AlgorandFixture](interfaces/AlgorandFixture.md) +- [AlgorandFixtureConfig](interfaces/AlgorandFixtureConfig.md) +- [AlgorandTestAutomationContext](interfaces/AlgorandTestAutomationContext.md) +- [GetTestAccountParams](interfaces/GetTestAccountParams.md) +- [LogSnapshotConfig](interfaces/LogSnapshotConfig.md) diff --git a/docs/code/types/testing/interfaces/AlgoKitLogCaptureFixture.md b/docs/code/types/testing/interfaces/AlgoKitLogCaptureFixture.md new file mode 100644 index 00000000..18c086b4 --- /dev/null +++ b/docs/code/types/testing/interfaces/AlgoKitLogCaptureFixture.md @@ -0,0 +1,53 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/testing](../README.md) / AlgoKitLogCaptureFixture + +# Interface: AlgoKitLogCaptureFixture + +Defined in: [src/types/testing.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L148) + +## Properties + +### afterEach() + +> **afterEach**: () => `void` + +Defined in: [src/types/testing.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L158) + +Testing framework agnostic handler method to run after each test to reset the logger. + +#### Returns + +`void` + +*** + +### beforeEach() + +> **beforeEach**: () => `void` + +Defined in: [src/types/testing.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L154) + +Testing framework agnostic handler method to run before each test to prepare the `testLogger` for that test. + +#### Returns + +`void` + +## Accessors + +### testLogger + +#### Get Signature + +> **get** **testLogger**(): [`TestLogger`](../../../testing/classes/TestLogger.md) + +Defined in: [src/types/testing.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L150) + +The test logger instance for the current test + +##### Returns + +[`TestLogger`](../../../testing/classes/TestLogger.md) diff --git a/docs/code/interfaces/types_testing.AlgorandFixture.md b/docs/code/types/testing/interfaces/AlgorandFixture.md similarity index 51% rename from docs/code/interfaces/types_testing.AlgorandFixture.md rename to docs/code/types/testing/interfaces/AlgorandFixture.md index 63f94401..f80b678e 100644 --- a/docs/code/interfaces/types_testing.AlgorandFixture.md +++ b/docs/code/types/testing/interfaces/AlgorandFixture.md @@ -1,57 +1,49 @@ -[@algorandfoundation/algokit-utils](../README.md) / [types/testing](../modules/types_testing.md) / AlgorandFixture +[**@algorandfoundation/algokit-utils**](../../../README.md) -# Interface: AlgorandFixture +*** -[types/testing](../modules/types_testing.md).AlgorandFixture +[@algorandfoundation/algokit-utils](../../../README.md) / [types/testing](../README.md) / AlgorandFixture -An Algorand automated testing fixture +# Interface: AlgorandFixture -## Table of contents +Defined in: [src/types/testing.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L66) -### Properties +An Algorand automated testing fixture -- [beforeEach](types_testing.AlgorandFixture.md#beforeeach) -- [newScope](types_testing.AlgorandFixture.md#newscope) +## Properties -### Accessors +### ~~beforeEach()~~ -- [algorand](types_testing.AlgorandFixture.md#algorand) -- [context](types_testing.AlgorandFixture.md#context) +> **beforeEach**: () => `Promise`\<`void`\> -## Properties +Defined in: [src/types/testing.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L90) -### beforeEach +#### Returns -• **beforeEach**: () => `Promise`\<`void`\> +`Promise`\<`void`\> -**`Deprecated`** +#### Deprecated Use newScope instead. Testing framework agnostic handler method to run before each test to prepare the `context` for that test with per test isolation. -#### Type declaration +*** -▸ (): `Promise`\<`void`\> +### newScope() -##### Returns +> **newScope**: () => `Promise`\<`void`\> -`Promise`\<`void`\> - -#### Defined in - -[src/types/testing.ts:90](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L90) - -___ - -### newScope - -• **newScope**: () => `Promise`\<`void`\> +Defined in: [src/types/testing.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L130) Creates a new isolated fixture scope (clean transaction logger, AlgorandClient, testAccount, etc.). You can call this from any testing framework specific hook method to control when you want a new scope. -**`Example`** +#### Returns + +`Promise`\<`void`\> + +#### Examples ```typescript describe('MY MODULE', () => { @@ -66,8 +58,6 @@ describe('MY MODULE', () => { }) ``` -**`Example`** - ```typescript describe('MY MODULE', () => { const fixture = algorandFixture() @@ -85,50 +75,38 @@ describe('MY MODULE', () => { }) ``` -#### Type declaration - -▸ (): `Promise`\<`void`\> - -##### Returns - -`Promise`\<`void`\> - -#### Defined in - -[src/types/testing.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L130) - ## Accessors ### algorand -• `get` **algorand**(): [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md) +#### Get Signature -Retrieve an `AlgorandClient` loaded with the current context, including testAccount and any generated accounts loaded as signers. +> **get** **algorand**(): [`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) -#### Returns +Defined in: [src/types/testing.ts:84](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L84) -[`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md) +Retrieve an `AlgorandClient` loaded with the current context, including testAccount and any generated accounts loaded as signers. -#### Defined in +##### Returns -[src/types/testing.ts:84](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L84) +[`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) -___ +*** ### context -• `get` **context**(): [`AlgorandTestAutomationContext`](types_testing.AlgorandTestAutomationContext.md) +#### Get Signature + +> **get** **context**(): [`AlgorandTestAutomationContext`](AlgorandTestAutomationContext.md) + +Defined in: [src/types/testing.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L79) Retrieve the current context. Useful with destructuring. If you haven't called `newScope` then this will throw an error. -#### Returns - -[`AlgorandTestAutomationContext`](types_testing.AlgorandTestAutomationContext.md) - -**`Example`** +##### Example ```typescript test('My test', () => { @@ -136,6 +114,6 @@ test('My test', () => { }) ``` -#### Defined in +##### Returns -[src/types/testing.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L79) +[`AlgorandTestAutomationContext`](AlgorandTestAutomationContext.md) diff --git a/docs/code/types/testing/interfaces/AlgorandFixtureConfig.md b/docs/code/types/testing/interfaces/AlgorandFixtureConfig.md new file mode 100644 index 00000000..c998bb6e --- /dev/null +++ b/docs/code/types/testing/interfaces/AlgorandFixtureConfig.md @@ -0,0 +1,121 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/testing](../README.md) / AlgorandFixtureConfig + +# Interface: AlgorandFixtureConfig + +Defined in: [src/types/testing.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L52) + +Configuration for creating an Algorand testing fixture. + +## Extends + +- `Partial`\<[`AlgoConfig`](../../network-client/interfaces/AlgoConfig.md)\> + +## Properties + +### accountGetter()? + +> `optional` **accountGetter**: (`algod`, `kmd?`) => `Promise`\<`Account`\> + +Defined in: [src/types/testing.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L62) + +Optional override for how to get an account; this allows you to retrieve accounts from a known or cached list of accounts. + +#### Parameters + +##### algod + +`AlgodClient` + +##### kmd? + +`KmdClient` + +#### Returns + +`Promise`\<`Account`\> + +*** + +### algod? + +> `optional` **algod**: `AlgodClient` + +Defined in: [src/types/testing.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L54) + +An optional algod client, if not specified then it will create one against `algodConfig` (if present) then environment variables defined network (if present) or default LocalNet. + +*** + +### algodConfig? + +> `optional` **algodConfig**: [`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/types/network-client.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L16) + +Algod client configuration + +#### Inherited from + +`Partial.algodConfig` + +*** + +### indexer? + +> `optional` **indexer**: `IndexerClient` + +Defined in: [src/types/testing.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L56) + +An optional indexer client, if not specified then it will create one against `indexerConfig` (if present) then environment variables defined network (if present) or default LocalNet. + +*** + +### indexerConfig? + +> `optional` **indexerConfig**: [`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/types/network-client.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L18) + +Indexer client configuration + +#### Inherited from + +`Partial.indexerConfig` + +*** + +### kmd? + +> `optional` **kmd**: `KmdClient` + +Defined in: [src/types/testing.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L58) + +An optional kmd client, if not specified then it will create one against `kmdConfig` (if present) then environment variables defined network (if present) or default LocalNet. + +*** + +### kmdConfig? + +> `optional` **kmdConfig**: [`AlgoClientConfig`](../../network-client/interfaces/AlgoClientConfig.md) + +Defined in: [src/types/network-client.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/network-client.ts#L20) + +Kmd configuration + +#### Inherited from + +`Partial.kmdConfig` + +*** + +### testAccountFunding? + +> `optional` **testAccountFunding**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/testing.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L60) + +The amount of funds to allocate to the default testing account, if not specified then it will get 10 ALGO. diff --git a/docs/code/types/testing/interfaces/AlgorandTestAutomationContext.md b/docs/code/types/testing/interfaces/AlgorandTestAutomationContext.md new file mode 100644 index 00000000..d160bda6 --- /dev/null +++ b/docs/code/types/testing/interfaces/AlgorandTestAutomationContext.md @@ -0,0 +1,125 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/testing](../README.md) / AlgorandTestAutomationContext + +# Interface: AlgorandTestAutomationContext + +Defined in: [src/types/testing.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L18) + +Test automation context. + +## Properties + +### algod + +> **algod**: `AlgodClient` + +Defined in: [src/types/testing.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L22) + +Algod client instance that will log transactions in `transactionLogger` + +*** + +### algorand + +> **algorand**: [`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +Defined in: [src/types/testing.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L20) + +An AlgorandClient instance loaded with the current context, including testAccount and any generated accounts loaded as signers + +*** + +### generateAccount() + +> **generateAccount**: (`params`) => `Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md)\> + +Defined in: [src/types/testing.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L32) + +Generate and fund an additional ephemerally created account + +#### Parameters + +##### params + +[`GetTestAccountParams`](GetTestAccountParams.md) + +#### Returns + +`Promise`\<`Address` & `Account` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md)\> + +*** + +### indexer + +> **indexer**: `IndexerClient` + +Defined in: [src/types/testing.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L24) + +Indexer client instance + +*** + +### kmd + +> **kmd**: `KmdClient` + +Defined in: [src/types/testing.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L26) + +KMD client instance + +*** + +### testAccount + +> **testAccount**: `Address` & [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) & `Account` + +Defined in: [src/types/testing.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L30) + +Default, funded test account that is ephemerally created + +*** + +### transactionLogger + +> **transactionLogger**: [`TransactionLogger`](../../../testing/classes/TransactionLogger.md) + +Defined in: [src/types/testing.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L28) + +Transaction logger that will log transaction IDs for all transactions issued by `algod` + +*** + +### waitForIndexer() + +> **waitForIndexer**: () => `Promise`\<`void`\> + +Defined in: [src/types/testing.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L34) + +Wait for the indexer to catch up with all transactions logged by `transactionLogger` + +#### Returns + +`Promise`\<`void`\> + +*** + +### waitForIndexerTransaction() + +> **waitForIndexerTransaction**: (`transactionId`) => `Promise`\<`TransactionResponse`\> + +Defined in: [src/types/testing.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L36) + +Wait for the indexer to catch up with the given transaction ID + +#### Parameters + +##### transactionId + +`string` + +#### Returns + +`Promise`\<`TransactionResponse`\> diff --git a/docs/code/types/testing/interfaces/GetTestAccountParams.md b/docs/code/types/testing/interfaces/GetTestAccountParams.md new file mode 100644 index 00000000..56be6b15 --- /dev/null +++ b/docs/code/types/testing/interfaces/GetTestAccountParams.md @@ -0,0 +1,51 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/testing](../README.md) / GetTestAccountParams + +# Interface: GetTestAccountParams + +Defined in: [src/types/testing.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L42) + +Parameters for the `getTestAccount` function. + +## Properties + +### accountGetter()? + +> `optional` **accountGetter**: (`algorand`) => `Promise`\<`Account`\> + +Defined in: [src/types/testing.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L48) + +Optional override for how to get a test account; this allows you to retrieve accounts from a known or cached list of accounts. + +#### Parameters + +##### algorand + +[`AlgorandClient`](../../algorand-client/classes/AlgorandClient.md) + +#### Returns + +`Promise`\<`Account`\> + +*** + +### initialFunds + +> **initialFunds**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/testing.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L44) + +Initial funds to ensure the account has + +*** + +### suppressLog? + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/testing.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L46) + +Whether to suppress the log (which includes a mnemonic) or not (default: do not suppress the log) diff --git a/docs/code/types/testing/interfaces/LogSnapshotConfig.md b/docs/code/types/testing/interfaces/LogSnapshotConfig.md new file mode 100644 index 00000000..6579166b --- /dev/null +++ b/docs/code/types/testing/interfaces/LogSnapshotConfig.md @@ -0,0 +1,63 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/testing](../README.md) / LogSnapshotConfig + +# Interface: LogSnapshotConfig + +Defined in: [src/types/testing.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L137) + +Configuration for preparing 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. + +## Properties + +### accounts? + +> `optional` **accounts**: (`string` \| [`MultisigAccount`](../../account/classes/MultisigAccount.md) \| `Account` \| [`SigningAccount`](../../account/classes/SigningAccount.md) \| `Address` \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) \| `LogicSigAccount`)[] + +Defined in: [src/types/testing.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L141) + +Any accounts/addresses to replace the address for predictably + +*** + +### apps? + +> `optional` **apps**: (`string` \| `number` \| `bigint`)[] + +Defined in: [src/types/testing.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L143) + +Any app IDs to replace predictably + +*** + +### filterPredicate()? + +> `optional` **filterPredicate**: (`log`) => `boolean` + +Defined in: [src/types/testing.ts:145](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L145) + +Optional filter predicate to filter out logs + +#### Parameters + +##### log + +`string` + +#### Returns + +`boolean` + +*** + +### transactions? + +> `optional` **transactions**: (`string` \| `Transaction`)[] + +Defined in: [src/types/testing.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L139) + +Any transaction IDs or transactions to replace the ID for predictably diff --git a/docs/code/types/transaction/README.md b/docs/code/types/transaction/README.md new file mode 100644 index 00000000..71dc14e6 --- /dev/null +++ b/docs/code/types/transaction/README.md @@ -0,0 +1,29 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/transaction + +# types/transaction + +## Interfaces + +- [AdditionalAtomicTransactionComposerContext](interfaces/AdditionalAtomicTransactionComposerContext.md) +- [AtomicTransactionComposerToSend](interfaces/AtomicTransactionComposerToSend.md) +- [ConfirmedTransactionResult](interfaces/ConfirmedTransactionResult.md) +- [ConfirmedTransactionResults](interfaces/ConfirmedTransactionResults.md) +- [SendAtomicTransactionComposerResults](interfaces/SendAtomicTransactionComposerResults.md) +- [SendParams](interfaces/SendParams.md) +- [SendTransactionParams](interfaces/SendTransactionParams.md) +- [SendTransactionResult](interfaces/SendTransactionResult.md) +- [SendTransactionResults](interfaces/SendTransactionResults.md) +- [TransactionGroupToSend](interfaces/TransactionGroupToSend.md) +- [TransactionToSign](interfaces/TransactionToSign.md) + +## Type Aliases + +- [Arc2TransactionNote](type-aliases/Arc2TransactionNote.md) +- [SendSingleTransactionResult](type-aliases/SendSingleTransactionResult.md) +- [SendTransactionFrom](type-aliases/SendTransactionFrom.md) +- [TransactionNote](type-aliases/TransactionNote.md) +- [TransactionNoteData](type-aliases/TransactionNoteData.md) diff --git a/docs/code/types/transaction/interfaces/AdditionalAtomicTransactionComposerContext.md b/docs/code/types/transaction/interfaces/AdditionalAtomicTransactionComposerContext.md new file mode 100644 index 00000000..2aa4ce3e --- /dev/null +++ b/docs/code/types/transaction/interfaces/AdditionalAtomicTransactionComposerContext.md @@ -0,0 +1,29 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / AdditionalAtomicTransactionComposerContext + +# Interface: AdditionalAtomicTransactionComposerContext + +Defined in: [src/types/transaction.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L146) + +Additional context about the `AtomicTransactionComposer`. + +## Properties + +### maxFees + +> **maxFees**: `Map`\<`number`, [`AlgoAmount`](../../amount/classes/AlgoAmount.md)\> + +Defined in: [src/types/transaction.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L148) + +A map of transaction index in the `AtomicTransactionComposer` to the max fee that can be calculated for a transaction in the group + +*** + +### suggestedParams + +> **suggestedParams**: `Pick`\<`SuggestedParams`, `"fee"` \| `"minFee"`\> + +Defined in: [src/types/transaction.ts:151](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L151) diff --git a/docs/code/types/transaction/interfaces/AtomicTransactionComposerToSend.md b/docs/code/types/transaction/interfaces/AtomicTransactionComposerToSend.md new file mode 100644 index 00000000..1cede050 --- /dev/null +++ b/docs/code/types/transaction/interfaces/AtomicTransactionComposerToSend.md @@ -0,0 +1,105 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / AtomicTransactionComposerToSend + +# Interface: AtomicTransactionComposerToSend + +Defined in: [src/types/transaction.ts:155](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L155) + +An `AtomicTransactionComposer` with transactions to send. + +## Extends + +- [`SendParams`](SendParams.md) + +## Properties + +### additionalAtcContext? + +> `optional` **additionalAtcContext**: [`AdditionalAtomicTransactionComposerContext`](AdditionalAtomicTransactionComposerContext.md) + +Defined in: [src/types/transaction.ts:167](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L167) + +Additional `AtomicTransactionComposer` context used when building the transaction group that is sent. +This additional context is used and must be supplied when coverAppCallInnerTransactionFees is set to true. + +*** + +### atc + +> **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L157) + +The `AtomicTransactionComposer` with transactions loaded to send + +*** + +### coverAppCallInnerTransactionFees? + +> `optional` **coverAppCallInnerTransactionFees**: `boolean` + +Defined in: [src/types/transaction.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L142) + +Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee + +#### Inherited from + +[`SendParams`](SendParams.md).[`coverAppCallInnerTransactionFees`](SendParams.md#coverappcallinnertransactionfees) + +*** + +### maxRoundsToWaitForConfirmation? + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L136) + +The number of rounds to wait for confirmation. By default until the latest lastValid has past. + +#### Inherited from + +[`SendParams`](SendParams.md).[`maxRoundsToWaitForConfirmation`](SendParams.md#maxroundstowaitforconfirmation) + +*** + +### populateAppCallResources? + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L140) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. + +#### Inherited from + +[`SendParams`](SendParams.md).[`populateAppCallResources`](SendParams.md#populateappcallresources) + +*** + +### ~~sendParams?~~ + +> `optional` **sendParams**: `Omit`\<[`SendTransactionParams`](SendTransactionParams.md), `"fee"` \| `"maxFee"` \| `"skipSending"` \| `"atc"`\> + +Defined in: [src/types/transaction.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L161) + +#### Deprecated + +- set the parameters at the top level instead +Any parameters to control the semantics of the send to the network + +*** + +### suppressLog? + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L138) + +Whether to suppress log messages from transaction send, default: do not suppress. + +#### Inherited from + +[`SendParams`](SendParams.md).[`suppressLog`](SendParams.md#suppresslog) diff --git a/docs/code/types/transaction/interfaces/ConfirmedTransactionResult.md b/docs/code/types/transaction/interfaces/ConfirmedTransactionResult.md new file mode 100644 index 00000000..cdcc0dcc --- /dev/null +++ b/docs/code/types/transaction/interfaces/ConfirmedTransactionResult.md @@ -0,0 +1,43 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / ConfirmedTransactionResult + +# Interface: ConfirmedTransactionResult + +Defined in: [src/types/transaction.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L85) + +The result of sending and confirming a transaction + +## Extends + +- [`SendTransactionResult`](SendTransactionResult.md) + +## Properties + +### confirmation + +> **confirmation**: `PendingTransactionResponse` + +Defined in: [src/types/transaction.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L87) + +The response from sending and waiting for the transaction + +#### Overrides + +[`SendTransactionResult`](SendTransactionResult.md).[`confirmation`](SendTransactionResult.md#confirmation) + +*** + +### transaction + +> **transaction**: `Transaction` + +Defined in: [src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) + +The transaction + +#### Inherited from + +[`SendTransactionResult`](SendTransactionResult.md).[`transaction`](SendTransactionResult.md#transaction) diff --git a/docs/code/types/transaction/interfaces/ConfirmedTransactionResults.md b/docs/code/types/transaction/interfaces/ConfirmedTransactionResults.md new file mode 100644 index 00000000..960bef48 --- /dev/null +++ b/docs/code/types/transaction/interfaces/ConfirmedTransactionResults.md @@ -0,0 +1,71 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / ConfirmedTransactionResults + +# Interface: ConfirmedTransactionResults + +Defined in: [src/types/transaction.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L91) + +The result of sending and confirming one or more transactions, but where there is a primary transaction of interest + +## Extends + +- [`SendTransactionResult`](SendTransactionResult.md).[`SendTransactionResults`](SendTransactionResults.md) + +## Properties + +### confirmation + +> **confirmation**: `PendingTransactionResponse` + +Defined in: [src/types/transaction.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L93) + +The response from sending and waiting for the primary transaction + +#### Overrides + +[`SendTransactionResult`](SendTransactionResult.md).[`confirmation`](SendTransactionResult.md#confirmation) + +*** + +### confirmations + +> **confirmations**: `PendingTransactionResponse`[] + +Defined in: [src/types/transaction.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L95) + +The response from sending and waiting for the transactions + +#### Overrides + +[`SendTransactionResults`](SendTransactionResults.md).[`confirmations`](SendTransactionResults.md#confirmations) + +*** + +### transaction + +> **transaction**: `Transaction` + +Defined in: [src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) + +The transaction + +#### Inherited from + +[`SendTransactionResult`](SendTransactionResult.md).[`transaction`](SendTransactionResult.md#transaction) + +*** + +### transactions + +> **transactions**: `Transaction`[] + +Defined in: [src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) + +The transactions that have been prepared and/or sent + +#### Inherited from + +[`SendTransactionResults`](SendTransactionResults.md).[`transactions`](SendTransactionResults.md#transactions) diff --git a/docs/code/types/transaction/interfaces/SendAtomicTransactionComposerResults.md b/docs/code/types/transaction/interfaces/SendAtomicTransactionComposerResults.md new file mode 100644 index 00000000..0c6fb4c3 --- /dev/null +++ b/docs/code/types/transaction/interfaces/SendAtomicTransactionComposerResults.md @@ -0,0 +1,74 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / SendAtomicTransactionComposerResults + +# Interface: SendAtomicTransactionComposerResults + +Defined in: [src/types/transaction.ts:71](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L71) + +The result of preparing and/or sending multiple transactions using an `AtomicTransactionComposer` + +## Extends + +- [`SendTransactionResults`](SendTransactionResults.md) + +## Properties + +### confirmations + +> **confirmations**: `PendingTransactionResponse`[] + +Defined in: [src/types/transaction.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L81) + +The responses if the transactions were sent and waited for, +the index of the confirmation will match the index of the underlying transaction + +#### Overrides + +[`SendTransactionResults`](SendTransactionResults.md).[`confirmations`](SendTransactionResults.md#confirmations) + +*** + +### groupId + +> **groupId**: `string` + +Defined in: [src/types/transaction.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L73) + +base64 encoded representation of the group ID of the atomic group + +*** + +### returns? + +> `optional` **returns**: [`ABIReturn`](../../app/type-aliases/ABIReturn.md)[] + +Defined in: [src/types/transaction.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L77) + +If ABI method(s) were called the processed return values + +*** + +### transactions + +> **transactions**: `Transaction`[] + +Defined in: [src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) + +The transactions that have been prepared and/or sent + +#### Inherited from + +[`SendTransactionResults`](SendTransactionResults.md).[`transactions`](SendTransactionResults.md#transactions) + +*** + +### txIds + +> **txIds**: `string`[] + +Defined in: [src/types/transaction.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L75) + +The transaction IDs that have been prepared and/or sent diff --git a/docs/code/types/transaction/interfaces/SendParams.md b/docs/code/types/transaction/interfaces/SendParams.md new file mode 100644 index 00000000..067bd10c --- /dev/null +++ b/docs/code/types/transaction/interfaces/SendParams.md @@ -0,0 +1,55 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / SendParams + +# Interface: SendParams + +Defined in: [src/types/transaction.ts:134](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L134) + +Parameters to configure transaction sending. + +## Extended by + +- [`AtomicTransactionComposerToSend`](AtomicTransactionComposerToSend.md) + +## Properties + +### coverAppCallInnerTransactionFees? + +> `optional` **coverAppCallInnerTransactionFees**: `boolean` + +Defined in: [src/types/transaction.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L142) + +Whether to use simulate to automatically calculate required app call inner transaction fees and cover them in the parent app call transaction fee + +*** + +### maxRoundsToWaitForConfirmation? + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:136](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L136) + +The number of rounds to wait for confirmation. By default until the latest lastValid has past. + +*** + +### populateAppCallResources? + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:140](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L140) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to `Config.populateAppCallResources`. + +*** + +### suppressLog? + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:138](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L138) + +Whether to suppress log messages from transaction send, default: do not suppress. diff --git a/docs/code/types/transaction/interfaces/SendTransactionParams.md b/docs/code/types/transaction/interfaces/SendTransactionParams.md new file mode 100644 index 00000000..6e207e72 --- /dev/null +++ b/docs/code/types/transaction/interfaces/SendTransactionParams.md @@ -0,0 +1,102 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / SendTransactionParams + +# Interface: SendTransactionParams + +Defined in: [src/types/transaction.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L29) + +The sending configuration for a transaction + +## Extended by + +- [`AppCallParams`](../../app/interfaces/AppCallParams.md) +- [`CreateAssetParams`](../../asset/interfaces/CreateAssetParams.md) +- [`AssetOptInParams`](../../asset/interfaces/AssetOptInParams.md) +- [`AlgoTransferParams`](../../transfer/interfaces/AlgoTransferParams.md) +- [`AlgoRekeyParams`](../../transfer/interfaces/AlgoRekeyParams.md) +- [`EnsureFundedParams`](../../transfer/interfaces/EnsureFundedParams.md) +- [`TransferAssetParams`](../../transfer/interfaces/TransferAssetParams.md) + +## Properties + +### atc? + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +*** + +### fee? + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +*** + +### maxFee? + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +*** + +### maxRoundsToWaitForConfirmation? + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +*** + +### populateAppCallResources? + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +*** + +### skipSending? + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +*** + +### skipWaiting? + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +*** + +### suppressLog? + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress diff --git a/docs/code/types/transaction/interfaces/SendTransactionResult.md b/docs/code/types/transaction/interfaces/SendTransactionResult.md new file mode 100644 index 00000000..edb5829d --- /dev/null +++ b/docs/code/types/transaction/interfaces/SendTransactionResult.md @@ -0,0 +1,37 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / SendTransactionResult + +# Interface: SendTransactionResult + +Defined in: [src/types/transaction.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L53) + +The result of sending a transaction + +## Extended by + +- [`AppCallTransactionResultOfType`](../../app/interfaces/AppCallTransactionResultOfType.md) +- [`ConfirmedTransactionResult`](ConfirmedTransactionResult.md) +- [`ConfirmedTransactionResults`](ConfirmedTransactionResults.md) + +## Properties + +### confirmation? + +> `optional` **confirmation**: `PendingTransactionResponse` + +Defined in: [src/types/transaction.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L57) + +The response if the transaction was sent and waited for + +*** + +### transaction + +> **transaction**: `Transaction` + +Defined in: [src/types/transaction.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L55) + +The transaction diff --git a/docs/code/types/transaction/interfaces/SendTransactionResults.md b/docs/code/types/transaction/interfaces/SendTransactionResults.md new file mode 100644 index 00000000..d4351a42 --- /dev/null +++ b/docs/code/types/transaction/interfaces/SendTransactionResults.md @@ -0,0 +1,38 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / SendTransactionResults + +# Interface: SendTransactionResults + +Defined in: [src/types/transaction.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L61) + +The result of preparing and/or sending multiple transactions + +## Extended by + +- [`AppCallTransactionResultOfType`](../../app/interfaces/AppCallTransactionResultOfType.md) +- [`SendAtomicTransactionComposerResults`](SendAtomicTransactionComposerResults.md) +- [`ConfirmedTransactionResults`](ConfirmedTransactionResults.md) + +## Properties + +### confirmations? + +> `optional` **confirmations**: `PendingTransactionResponse`[] + +Defined in: [src/types/transaction.ts:67](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L67) + +The responses if the transactions were sent and waited for, +the index of the confirmation will match the index of the underlying transaction + +*** + +### transactions + +> **transactions**: `Transaction`[] + +Defined in: [src/types/transaction.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L63) + +The transactions that have been prepared and/or sent diff --git a/docs/code/types/transaction/interfaces/TransactionGroupToSend.md b/docs/code/types/transaction/interfaces/TransactionGroupToSend.md new file mode 100644 index 00000000..3e646076 --- /dev/null +++ b/docs/code/types/transaction/interfaces/TransactionGroupToSend.md @@ -0,0 +1,44 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / TransactionGroupToSend + +# Interface: TransactionGroupToSend + +Defined in: [src/types/transaction.ts:121](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L121) + +A group of transactions to send together as an atomic group +https://dev.algorand.co/concepts/transactions/atomic-txn-groups/ + +## Properties + +### sendParams? + +> `optional` **sendParams**: `Omit`\<[`SendTransactionParams`](SendTransactionParams.md), `"fee"` \| `"maxFee"` \| `"skipSending"` \| `"atc"`\> + +Defined in: [src/types/transaction.ts:123](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L123) + +Any parameters to control the semantics of the send to the network + +*** + +### signer? + +> `optional` **signer**: [`SendTransactionFrom`](../type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transaction.ts:130](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L130) + +Optional signer to pass in, required if at least one transaction provided is just the transaction, ignored otherwise + +*** + +### transactions + +> **transactions**: (`Transaction` \| [`TransactionToSign`](TransactionToSign.md) \| `Promise`\<[`SendTransactionResult`](SendTransactionResult.md)\>)[] + +Defined in: [src/types/transaction.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L128) + +The list of transactions to send, which can either be a raw transaction (in which case `signer` is required), + the async result of an AlgoKit utils method that returns a `SendTransactionResult` (saves unwrapping the promise, be sure to pass `skipSending: true`, `signer` is also required) + or the transaction with its signer (`signer` is ignored) diff --git a/docs/code/types/transaction/interfaces/TransactionToSign.md b/docs/code/types/transaction/interfaces/TransactionToSign.md new file mode 100644 index 00000000..a8dcc747 --- /dev/null +++ b/docs/code/types/transaction/interfaces/TransactionToSign.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / TransactionToSign + +# Interface: TransactionToSign + +Defined in: [src/types/transaction.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L111) + +Defines an unsigned transaction that will appear in a group of transactions along with its signing information + +## Properties + +### signer + +> **signer**: [`SendTransactionFrom`](../type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transaction.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L115) + +The account to use to sign the transaction, either an account (with private key loaded) or a logic signature account + +*** + +### transaction + +> **transaction**: `Transaction` + +Defined in: [src/types/transaction.ts:113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L113) + +The unsigned transaction to sign and send diff --git a/docs/code/types/transaction/type-aliases/Arc2TransactionNote.md b/docs/code/types/transaction/type-aliases/Arc2TransactionNote.md new file mode 100644 index 00000000..003ae42f --- /dev/null +++ b/docs/code/types/transaction/type-aliases/Arc2TransactionNote.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / Arc2TransactionNote + +# Type Alias: Arc2TransactionNote + +> **Arc2TransactionNote** = \{ `dAppName`: `string`; `data`: `string`; `format`: `"m"` \| `"b"` \| `"u"`; \} \| \{ `dAppName`: `string`; `data`: [`TransactionNoteData`](TransactionNoteData.md); `format`: `"j"`; \} + +Defined in: [src/types/transaction.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L16) + +ARC-0002 compatible transaction note components https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md diff --git a/docs/code/types/transaction/type-aliases/SendSingleTransactionResult.md b/docs/code/types/transaction/type-aliases/SendSingleTransactionResult.md new file mode 100644 index 00000000..a7cd9275 --- /dev/null +++ b/docs/code/types/transaction/type-aliases/SendSingleTransactionResult.md @@ -0,0 +1,13 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / SendSingleTransactionResult + +# Type Alias: SendSingleTransactionResult + +> **SendSingleTransactionResult** = [`Expand`](../../expand/type-aliases/Expand.md)\<[`SendAtomicTransactionComposerResults`](../interfaces/SendAtomicTransactionComposerResults.md) & [`ConfirmedTransactionResult`](../interfaces/ConfirmedTransactionResult.md)\> + +Defined in: [src/types/transaction.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L50) + +Result from sending a single transaction. diff --git a/docs/code/types/transaction/type-aliases/SendTransactionFrom.md b/docs/code/types/transaction/type-aliases/SendTransactionFrom.md new file mode 100644 index 00000000..2cea3655 --- /dev/null +++ b/docs/code/types/transaction/type-aliases/SendTransactionFrom.md @@ -0,0 +1,21 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / SendTransactionFrom + +# Type Alias: SendTransactionFrom + +> **SendTransactionFrom** = `Account` \| [`SigningAccount`](../../account/classes/SigningAccount.md) \| `LogicSigAccount` \| [`MultisigAccount`](../../account/classes/MultisigAccount.md) \| [`TransactionSignerAccount`](../../account/interfaces/TransactionSignerAccount.md) + +Defined in: [src/types/transaction.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L108) + +Core account abstraction when signing/sending transactions + +This type is used across the entire AlgoKit Utils library and allows you to pass through +many types of accounts, including: +* `Account` - The in-built `algosdk.Account` type for mnemonic accounts +* `SigningAccount` - An AlgoKit Utils class that wraps Account to provide support for rekeyed accounts +* `LogicSigAccount` - The in-built `algosdk.LogicSigAccount` type for logic signatures +* `MultisigAccount` - An AlgoKit Utils class that wraps a multisig account and provides mechanisms to get a multisig account +* `TransactionSignerAccount` - An AlgoKit Utils class that wraps the in-built `algosdk.TransactionSigner` along with the sender address diff --git a/docs/code/types/transaction/type-aliases/TransactionNote.md b/docs/code/types/transaction/type-aliases/TransactionNote.md new file mode 100644 index 00000000..d9855d22 --- /dev/null +++ b/docs/code/types/transaction/type-aliases/TransactionNote.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / TransactionNote + +# Type Alias: TransactionNote + +> **TransactionNote** = `Uint8Array` \| [`TransactionNoteData`](TransactionNoteData.md) \| [`Arc2TransactionNote`](Arc2TransactionNote.md) + +Defined in: [src/types/transaction.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L12) diff --git a/docs/code/types/transaction/type-aliases/TransactionNoteData.md b/docs/code/types/transaction/type-aliases/TransactionNoteData.md new file mode 100644 index 00000000..357d1cdd --- /dev/null +++ b/docs/code/types/transaction/type-aliases/TransactionNoteData.md @@ -0,0 +1,11 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transaction](../README.md) / TransactionNoteData + +# Type Alias: TransactionNoteData + +> **TransactionNoteData** = `string` \| `null` \| `undefined` \| `number` \| `any`[] \| `Record`\<`string`, `any`\> + +Defined in: [src/types/transaction.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L14) diff --git a/docs/code/types/transfer/README.md b/docs/code/types/transfer/README.md new file mode 100644 index 00000000..960a22b6 --- /dev/null +++ b/docs/code/types/transfer/README.md @@ -0,0 +1,15 @@ +[**@algorandfoundation/algokit-utils**](../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../README.md) / types/transfer + +# types/transfer + +## Interfaces + +- [~~AlgoRekeyParams~~](interfaces/AlgoRekeyParams.md) +- [~~AlgoTransferParams~~](interfaces/AlgoTransferParams.md) +- [~~EnsureFundedParams~~](interfaces/EnsureFundedParams.md) +- [~~EnsureFundedReturnType~~](interfaces/EnsureFundedReturnType.md) +- [~~TransferAssetParams~~](interfaces/TransferAssetParams.md) diff --git a/docs/code/types/transfer/interfaces/AlgoRekeyParams.md b/docs/code/types/transfer/interfaces/AlgoRekeyParams.md new file mode 100644 index 00000000..e2ee272c --- /dev/null +++ b/docs/code/types/transfer/interfaces/AlgoRekeyParams.md @@ -0,0 +1,180 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transfer](../README.md) / AlgoRekeyParams + +# Interface: ~~AlgoRekeyParams~~ + +Defined in: [src/types/transfer.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L24) + +## Deprecated + +Parameters for `rekeyAccount` call. + +## Extends + +- [`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md) + +## Properties + +### ~~atc?~~ + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`atc`](../../transaction/interfaces/SendTransactionParams.md#atc) + +*** + +### ~~fee?~~ + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`fee`](../../transaction/interfaces/SendTransactionParams.md#fee) + +*** + +### ~~from~~ + +> **from**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transfer.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L26) + +The account that will be rekeyed + +*** + +### ~~lease?~~ + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/transfer.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L34) + +An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxFee`](../../transaction/interfaces/SendTransactionParams.md#maxfee) + +*** + +### ~~maxRoundsToWaitForConfirmation?~~ + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxRoundsToWaitForConfirmation`](../../transaction/interfaces/SendTransactionParams.md#maxroundstowaitforconfirmation) + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/transfer.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L32) + +The (optional) transaction note + +*** + +### ~~populateAppCallResources?~~ + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`populateAppCallResources`](../../transaction/interfaces/SendTransactionParams.md#populateappcallresources) + +*** + +### ~~rekeyTo~~ + +> **rekeyTo**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transfer.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L28) + +The account / account address that will have the private key that is authorised to transact on behalf of the from account from now on + +*** + +### ~~skipSending?~~ + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipSending`](../../transaction/interfaces/SendTransactionParams.md#skipsending) + +*** + +### ~~skipWaiting?~~ + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipWaiting`](../../transaction/interfaces/SendTransactionParams.md#skipwaiting) + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`suppressLog`](../../transaction/interfaces/SendTransactionParams.md#suppresslog) + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/transfer.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L30) + +Optional transaction parameters diff --git a/docs/code/types/transfer/interfaces/AlgoTransferParams.md b/docs/code/types/transfer/interfaces/AlgoTransferParams.md new file mode 100644 index 00000000..2562f7ee --- /dev/null +++ b/docs/code/types/transfer/interfaces/AlgoTransferParams.md @@ -0,0 +1,190 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transfer](../README.md) / AlgoTransferParams + +# Interface: ~~AlgoTransferParams~~ + +Defined in: [src/types/transfer.ts:8](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L8) + +## Deprecated + +Parameters for `transferAlgos` call. + +## Extends + +- [`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md) + +## Properties + +### ~~amount~~ + +> **amount**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transfer.ts:14](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L14) + +The amount to send + +*** + +### ~~atc?~~ + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`atc`](../../transaction/interfaces/SendTransactionParams.md#atc) + +*** + +### ~~fee?~~ + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`fee`](../../transaction/interfaces/SendTransactionParams.md#fee) + +*** + +### ~~from~~ + +> **from**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transfer.ts:10](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L10) + +The account that will send the Algo + +*** + +### ~~lease?~~ + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/transfer.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L20) + +An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxFee`](../../transaction/interfaces/SendTransactionParams.md#maxfee) + +*** + +### ~~maxRoundsToWaitForConfirmation?~~ + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxRoundsToWaitForConfirmation`](../../transaction/interfaces/SendTransactionParams.md#maxroundstowaitforconfirmation) + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/transfer.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L18) + +The (optional) transaction note + +*** + +### ~~populateAppCallResources?~~ + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`populateAppCallResources`](../../transaction/interfaces/SendTransactionParams.md#populateappcallresources) + +*** + +### ~~skipSending?~~ + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipSending`](../../transaction/interfaces/SendTransactionParams.md#skipsending) + +*** + +### ~~skipWaiting?~~ + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipWaiting`](../../transaction/interfaces/SendTransactionParams.md#skipwaiting) + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`suppressLog`](../../transaction/interfaces/SendTransactionParams.md#suppresslog) + +*** + +### ~~to~~ + +> **to**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transfer.ts:12](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L12) + +The account / account address that will receive the Algo + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/transfer.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L16) + +Optional transaction parameters diff --git a/docs/code/types/transfer/interfaces/EnsureFundedParams.md b/docs/code/types/transfer/interfaces/EnsureFundedParams.md new file mode 100644 index 00000000..5e87cbc3 --- /dev/null +++ b/docs/code/types/transfer/interfaces/EnsureFundedParams.md @@ -0,0 +1,200 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transfer](../README.md) / EnsureFundedParams + +# Interface: ~~EnsureFundedParams~~ + +Defined in: [src/types/transfer.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L38) + +## Deprecated + +Parameters for `ensureFunded` call. + +## Extends + +- [`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md) + +## Properties + +### ~~accountToFund~~ + +> **accountToFund**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transfer.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L40) + +The account to fund + +*** + +### ~~atc?~~ + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`atc`](../../transaction/interfaces/SendTransactionParams.md#atc) + +*** + +### ~~fee?~~ + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`fee`](../../transaction/interfaces/SendTransactionParams.md#fee) + +*** + +### ~~fundingSource?~~ + +> `optional` **fundingSource**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) \| [`TestNetDispenserApiClient`](../../dispenser-client/classes/TestNetDispenserApiClient.md) + +Defined in: [src/types/transfer.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L42) + +The account to use as a funding source, will default to using the dispenser account returned by `algokit.getDispenserAccount` + +*** + +### ~~lease?~~ + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/transfer.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L52) + +An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxFee`](../../transaction/interfaces/SendTransactionParams.md#maxfee) + +*** + +### ~~maxRoundsToWaitForConfirmation?~~ + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxRoundsToWaitForConfirmation`](../../transaction/interfaces/SendTransactionParams.md#maxroundstowaitforconfirmation) + +*** + +### ~~minFundingIncrement?~~ + +> `optional` **minFundingIncrement**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transfer.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L46) + +When issuing a funding amount, the minimum amount to transfer (avoids many small transfers if this gets called often on an active account) + +*** + +### ~~minSpendingBalance~~ + +> **minSpendingBalance**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transfer.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L44) + +The minimum balance of Algo that the account should have available to spend (i.e. on top of minimum balance requirement) + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/transfer.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L50) + +The (optional) transaction note, default: "Funding account to meet minimum requirement" + +*** + +### ~~populateAppCallResources?~~ + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`populateAppCallResources`](../../transaction/interfaces/SendTransactionParams.md#populateappcallresources) + +*** + +### ~~skipSending?~~ + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipSending`](../../transaction/interfaces/SendTransactionParams.md#skipsending) + +*** + +### ~~skipWaiting?~~ + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipWaiting`](../../transaction/interfaces/SendTransactionParams.md#skipwaiting) + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`suppressLog`](../../transaction/interfaces/SendTransactionParams.md#suppresslog) + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/transfer.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L48) + +Optional transaction parameters diff --git a/docs/code/types/transfer/interfaces/EnsureFundedReturnType.md b/docs/code/types/transfer/interfaces/EnsureFundedReturnType.md new file mode 100644 index 00000000..467a3ae5 --- /dev/null +++ b/docs/code/types/transfer/interfaces/EnsureFundedReturnType.md @@ -0,0 +1,31 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transfer](../README.md) / EnsureFundedReturnType + +# Interface: ~~EnsureFundedReturnType~~ + +Defined in: [src/types/transfer.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L76) + +## Deprecated + +## Properties + +### ~~amount~~ + +> **amount**: `number` + +Defined in: [src/types/transfer.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L80) + +The response if the transaction was sent and waited for + +*** + +### ~~transactionId~~ + +> **transactionId**: `string` + +Defined in: [src/types/transfer.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L78) + +The transaction diff --git a/docs/code/types/transfer/interfaces/TransferAssetParams.md b/docs/code/types/transfer/interfaces/TransferAssetParams.md new file mode 100644 index 00000000..5aac4315 --- /dev/null +++ b/docs/code/types/transfer/interfaces/TransferAssetParams.md @@ -0,0 +1,210 @@ +[**@algorandfoundation/algokit-utils**](../../../README.md) + +*** + +[@algorandfoundation/algokit-utils](../../../README.md) / [types/transfer](../README.md) / TransferAssetParams + +# Interface: ~~TransferAssetParams~~ + +Defined in: [src/types/transfer.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L56) + +## Deprecated + +Parameters for `transferAsset` call. + +## Extends + +- [`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md) + +## Properties + +### ~~amount~~ + +> **amount**: `number` \| `bigint` + +Defined in: [src/types/transfer.ts:64](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L64) + +The amount to send as the smallest divisible unit value + +*** + +### ~~assetId~~ + +> **assetId**: `number` + +Defined in: [src/types/transfer.ts:62](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L62) + +The asset id that will be transfered + +*** + +### ~~atc?~~ + +> `optional` **atc**: `AtomicTransactionComposer` + +Defined in: [src/types/transaction.ts:36](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L36) + +An optional `AtomicTransactionComposer` to add the transaction to, if specified then `skipSending: undefined` has the same effect as `skipSending: true` + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`atc`](../../transaction/interfaces/SendTransactionParams.md#atc) + +*** + +### ~~clawbackFrom?~~ + +> `optional` **clawbackFrom**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transfer.ts:68](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L68) + +An address of a target account from which to perform a clawback operation. Please note, in such cases senderAccount must be equal to clawback field on ASA metadata. + +*** + +### ~~fee?~~ + +> `optional` **fee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:40](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L40) + +The flat fee you want to pay, useful for covering extra fees in a transaction group or app call + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`fee`](../../transaction/interfaces/SendTransactionParams.md#fee) + +*** + +### ~~from~~ + +> **from**: [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transfer.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L58) + +The account that will send the asset + +*** + +### ~~lease?~~ + +> `optional` **lease**: `string` \| `Uint8Array`\<`ArrayBufferLike`\> + +Defined in: [src/types/transfer.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L72) + +An (optional) [transaction lease](https://dev.algorand.co/concepts/transactions/leases) to apply + +*** + +### ~~maxFee?~~ + +> `optional` **maxFee**: [`AlgoAmount`](../../amount/classes/AlgoAmount.md) + +Defined in: [src/types/transaction.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L42) + +The maximum fee that you are happy to pay (default: unbounded) - if this is set it's possible the transaction could get rejected during network congestion + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxFee`](../../transaction/interfaces/SendTransactionParams.md#maxfee) + +*** + +### ~~maxRoundsToWaitForConfirmation?~~ + +> `optional` **maxRoundsToWaitForConfirmation**: `number` + +Defined in: [src/types/transaction.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L44) + +The maximum number of rounds to wait for confirmation, only applies if `skipWaiting` is `undefined` or `false`, default: wait up to 5 rounds + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`maxRoundsToWaitForConfirmation`](../../transaction/interfaces/SendTransactionParams.md#maxroundstowaitforconfirmation) + +*** + +### ~~note?~~ + +> `optional` **note**: [`TransactionNote`](../../transaction/type-aliases/TransactionNote.md) + +Defined in: [src/types/transfer.ts:70](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L70) + +The (optional) transaction note + +*** + +### ~~populateAppCallResources?~~ + +> `optional` **populateAppCallResources**: `boolean` + +Defined in: [src/types/transaction.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L46) + +Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group. + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`populateAppCallResources`](../../transaction/interfaces/SendTransactionParams.md#populateappcallresources) + +*** + +### ~~skipSending?~~ + +> `optional` **skipSending**: `boolean` + +Defined in: [src/types/transaction.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L32) + +Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless `atc` specified) +and instead just return the raw transaction, e.g. so you can add it to a group of transactions + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipSending`](../../transaction/interfaces/SendTransactionParams.md#skipsending) + +*** + +### ~~skipWaiting?~~ + +> `optional` **skipWaiting**: `boolean` + +Defined in: [src/types/transaction.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L34) + +Whether to skip waiting for the submitted transaction (only relevant if `skipSending` is `false` or unset) + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`skipWaiting`](../../transaction/interfaces/SendTransactionParams.md#skipwaiting) + +*** + +### ~~suppressLog?~~ + +> `optional` **suppressLog**: `boolean` + +Defined in: [src/types/transaction.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transaction.ts#L38) + +Whether to suppress log messages from transaction send, default: do not suppress + +#### Inherited from + +[`SendTransactionParams`](../../transaction/interfaces/SendTransactionParams.md).[`suppressLog`](../../transaction/interfaces/SendTransactionParams.md#suppresslog) + +*** + +### ~~to~~ + +> **to**: `string` \| [`SendTransactionFrom`](../../transaction/type-aliases/SendTransactionFrom.md) + +Defined in: [src/types/transfer.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L60) + +The account / account address that will receive the asset + +*** + +### ~~transactionParams?~~ + +> `optional` **transactionParams**: `SuggestedParams` + +Defined in: [src/types/transfer.ts:66](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/transfer.ts#L66) + +Optional transaction parameters diff --git a/package-lock.json b/package-lock.json index 0df35525..89224f34 100644 --- a/package-lock.json +++ b/package-lock.json @@ -42,7 +42,7 @@ "tiny-invariant": "^1.3.1", "ts-node": "^10.9.1", "typedoc": "^0.28.3", - "typedoc-plugin-markdown": "^3.17.1", + "typedoc-plugin-markdown": "^4.6.3", "typescript": "^5.4.5", "typescript-eslint": "^8.16.0", "uuid": "^10.0.0", @@ -12355,15 +12355,16 @@ } }, "node_modules/typedoc-plugin-markdown": { - "version": "3.17.1", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.1.tgz", - "integrity": "sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==", + "version": "4.6.3", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.6.3.tgz", + "integrity": "sha512-86oODyM2zajXwLs4Wok2mwVEfCwCnp756QyhLGX2IfsdRYr1DXLCgJgnLndaMUjJD7FBhnLk2okbNE9PdLxYRw==", "dev": true, - "dependencies": { - "handlebars": "^4.7.7" + "license": "MIT", + "engines": { + "node": ">= 18" }, "peerDependencies": { - "typedoc": ">=0.24.0" + "typedoc": "0.28.x" } }, "node_modules/typescript": { diff --git a/package.json b/package.json index e99559bc..dd2530a9 100644 --- a/package.json +++ b/package.json @@ -97,7 +97,7 @@ "tiny-invariant": "^1.3.1", "ts-node": "^10.9.1", "typedoc": "^0.28.3", - "typedoc-plugin-markdown": "^3.17.1", + "typedoc-plugin-markdown": "^4.6.3", "typescript": "^5.4.5", "typescript-eslint": "^8.16.0", "uuid": "^10.0.0", diff --git a/typedoc.json b/typedoc.json index 0fa10010..9109c8aa 100755 --- a/typedoc.json +++ b/typedoc.json @@ -9,6 +9,6 @@ "cleanOutputDir": true, "githubPages": false, "readme": "none", - "entryDocument": "README.md", + "entryFileName": "README.md", "gitRevision": "main" }