From 875d9c9923857d47999bda9988babb4e556f1d29 Mon Sep 17 00:00:00 2001 From: Joe Polny Date: Wed, 24 Jan 2024 17:01:28 -0500 Subject: [PATCH] don't track docs/api --- docusaurus/.gitignore | 2 + docusaurus/docs/api/_category_.yml | 1 - docusaurus/docs/api/classes/Account.md | 343 --- docusaurus/docs/api/classes/Address.md | 263 -- docusaurus/docs/api/classes/Application.md | 188 -- docusaurus/docs/api/classes/Asset.md | 177 -- docusaurus/docs/api/classes/Contract.md | 304 --- docusaurus/docs/api/classes/EventLogger.md | 53 - docusaurus/docs/api/classes/LogicSig.md | 139 - docusaurus/docs/api/classes/PendingGroup.md | 318 --- docusaurus/docs/api/classes/_category_.yml | 2 - docusaurus/docs/api/classes/abi.md | 30 - docusaurus/docs/api/classes/allow.md | 97 - .../docs/api/classes/nonABIRouterFallback.md | 57 - docusaurus/docs/api/enums/OnCompletion.md | 67 - docusaurus/docs/api/enums/TransactionType.md | 77 - docusaurus/docs/api/enums/_category_.yml | 2 - docusaurus/docs/api/index.md | 90 - .../interfaces/AppOnChainTransactionParams.md | 231 -- docusaurus/docs/api/interfaces/AppParams.md | 201 -- .../docs/api/interfaces/AssetConfigParams.md | 119 - .../docs/api/interfaces/AssetCreateParams.md | 179 -- .../docs/api/interfaces/AssetFreezeParams.md | 99 - .../api/interfaces/AssetTransferParams.md | 119 - .../CommonOnChainTransactionParams.md | 91 - .../api/interfaces/CommonTransactionParams.md | 67 - .../docs/api/interfaces/KeyRegParams.md | 129 - .../docs/api/interfaces/MethodCallParams.md | 281 --- .../docs/api/interfaces/OnlineKeyRegParams.md | 129 - .../docs/api/interfaces/PaymentParams.md | 99 - docusaurus/docs/api/interfaces/_category_.yml | 2 - docusaurus/docs/api/modules.md | 2225 ----------------- 32 files changed, 2 insertions(+), 6179 deletions(-) delete mode 100644 docusaurus/docs/api/_category_.yml delete mode 100644 docusaurus/docs/api/classes/Account.md delete mode 100644 docusaurus/docs/api/classes/Address.md delete mode 100644 docusaurus/docs/api/classes/Application.md delete mode 100644 docusaurus/docs/api/classes/Asset.md delete mode 100644 docusaurus/docs/api/classes/Contract.md delete mode 100644 docusaurus/docs/api/classes/EventLogger.md delete mode 100644 docusaurus/docs/api/classes/LogicSig.md delete mode 100644 docusaurus/docs/api/classes/PendingGroup.md delete mode 100644 docusaurus/docs/api/classes/_category_.yml delete mode 100644 docusaurus/docs/api/classes/abi.md delete mode 100644 docusaurus/docs/api/classes/allow.md delete mode 100644 docusaurus/docs/api/classes/nonABIRouterFallback.md delete mode 100644 docusaurus/docs/api/enums/OnCompletion.md delete mode 100644 docusaurus/docs/api/enums/TransactionType.md delete mode 100644 docusaurus/docs/api/enums/_category_.yml delete mode 100644 docusaurus/docs/api/index.md delete mode 100644 docusaurus/docs/api/interfaces/AppOnChainTransactionParams.md delete mode 100644 docusaurus/docs/api/interfaces/AppParams.md delete mode 100644 docusaurus/docs/api/interfaces/AssetConfigParams.md delete mode 100644 docusaurus/docs/api/interfaces/AssetCreateParams.md delete mode 100644 docusaurus/docs/api/interfaces/AssetFreezeParams.md delete mode 100644 docusaurus/docs/api/interfaces/AssetTransferParams.md delete mode 100644 docusaurus/docs/api/interfaces/CommonOnChainTransactionParams.md delete mode 100644 docusaurus/docs/api/interfaces/CommonTransactionParams.md delete mode 100644 docusaurus/docs/api/interfaces/KeyRegParams.md delete mode 100644 docusaurus/docs/api/interfaces/MethodCallParams.md delete mode 100644 docusaurus/docs/api/interfaces/OnlineKeyRegParams.md delete mode 100644 docusaurus/docs/api/interfaces/PaymentParams.md delete mode 100644 docusaurus/docs/api/interfaces/_category_.yml delete mode 100644 docusaurus/docs/api/modules.md diff --git a/docusaurus/.gitignore b/docusaurus/.gitignore index 54b985d02..bc13bf7d2 100644 --- a/docusaurus/.gitignore +++ b/docusaurus/.gitignore @@ -20,3 +20,5 @@ yarn-debug.log* yarn-error.log* !*.js + +docs/api/ \ No newline at end of file diff --git a/docusaurus/docs/api/_category_.yml b/docusaurus/docs/api/_category_.yml deleted file mode 100644 index 24a460261..000000000 --- a/docusaurus/docs/api/_category_.yml +++ /dev/null @@ -1 +0,0 @@ -label: "API" \ No newline at end of file diff --git a/docusaurus/docs/api/classes/Account.md b/docusaurus/docs/api/classes/Account.md deleted file mode 100644 index 7f0d88054..000000000 --- a/docusaurus/docs/api/classes/Account.md +++ /dev/null @@ -1,343 +0,0 @@ ---- -id: "Account" -title: "Class: Account" -sidebar_label: "Account" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`Address`](Address.md) - - ↳ **`Account`** - -## Constructors - -### constructor - -• **new Account**(): [`Account`](Account.md) - -#### Returns - -[`Account`](Account.md) - -#### Inherited from - -[Address](Address.md).[constructor](Address.md#constructor) - -## Properties - -### authAddr - -• `Readonly` **authAddr**: [`Address`](Address.md) - -#### Inherited from - -[Address](Address.md).[authAddr](Address.md#authaddr) - -#### Defined in - -[types/global.d.ts:397](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L397) - -___ - -### balance - -• `Readonly` **balance**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[balance](Address.md#balance) - -#### Defined in - -[types/global.d.ts:388](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L388) - -___ - -### hasBalance - -• `Readonly` **hasBalance**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[hasBalance](Address.md#hasbalance) - -#### Defined in - -[types/global.d.ts:390](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L390) - -___ - -### minBalance - -• `Readonly` **minBalance**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[minBalance](Address.md#minbalance) - -#### Defined in - -[types/global.d.ts:392](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L392) - -___ - -### totalAppsCreated - -• `Readonly` **totalAppsCreated**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[totalAppsCreated](Address.md#totalappscreated) - -#### Defined in - -[types/global.d.ts:405](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L405) - -___ - -### totalAppsOptedIn - -• `Readonly` **totalAppsOptedIn**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[totalAppsOptedIn](Address.md#totalappsoptedin) - -#### Defined in - -[types/global.d.ts:407](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L407) - -___ - -### totalAssets - -• `Readonly` **totalAssets**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[totalAssets](Address.md#totalassets) - -#### Defined in - -[types/global.d.ts:394](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L394) - -___ - -### totalAssetsCreated - -• `Readonly` **totalAssetsCreated**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[totalAssetsCreated](Address.md#totalassetscreated) - -#### Defined in - -[types/global.d.ts:409](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L409) - -___ - -### totalBoxBytes - -• `Readonly` **totalBoxBytes**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[totalBoxBytes](Address.md#totalboxbytes) - -#### Defined in - -[types/global.d.ts:413](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L413) - -___ - -### totalBoxes - -• `Readonly` **totalBoxes**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[totalBoxes](Address.md#totalboxes) - -#### Defined in - -[types/global.d.ts:411](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L411) - -___ - -### totalExtraAppPages - -• `Readonly` **totalExtraAppPages**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[totalExtraAppPages](Address.md#totalextraapppages) - -#### Defined in - -[types/global.d.ts:403](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L403) - -___ - -### totalNumByteSlice - -• `Readonly` **totalNumByteSlice**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[totalNumByteSlice](Address.md#totalnumbyteslice) - -#### Defined in - -[types/global.d.ts:401](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L401) - -___ - -### totalNumUint - -• `Readonly` **totalNumUint**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[totalNumUint](Address.md#totalnumuint) - -#### Defined in - -[types/global.d.ts:399](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L399) - -___ - -### zeroAddress - -▪ `Static` `Readonly` **zeroAddress**: [`Address`](Address.md) - -#### Inherited from - -[Address](Address.md).[zeroAddress](Address.md#zeroaddress) - -#### Defined in - -[types/global.d.ts:386](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L386) - -## Methods - -### assetBalance - -▸ **assetBalance**(`asa`): [`uint64`](../modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `asa` | [`Asset`](Asset.md) | - -#### Returns - -[`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[assetBalance](Address.md#assetbalance) - -#### Defined in - -[types/global.d.ts:415](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L415) - -___ - -### assetFrozen - -▸ **assetFrozen**(`asa`): [`uint64`](../modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `asa` | [`Asset`](Asset.md) | - -#### Returns - -[`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[assetFrozen](Address.md#assetfrozen) - -#### Defined in - -[types/global.d.ts:419](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L419) - -___ - -### hasAsset - -▸ **hasAsset**(`asa`): [`uint64`](../modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `asa` | [`Asset`](Asset.md) | - -#### Returns - -[`uint64`](../modules.md#uint64) - -#### Inherited from - -[Address](Address.md).[hasAsset](Address.md#hasasset) - -#### Defined in - -[types/global.d.ts:417](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L417) - -___ - -### isOptedInToApp - -▸ **isOptedInToApp**(`app`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `app` | [`Application`](Application.md) | - -#### Returns - -`boolean` - -#### Inherited from - -[Address](Address.md).[isOptedInToApp](Address.md#isoptedintoapp) - -#### Defined in - -[types/global.d.ts:421](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L421) - -___ - -### fromBytes - -▸ **fromBytes**(`addr`): [`Address`](Address.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addr` | [`BytesLike`](../modules.md#byteslike) | - -#### Returns - -[`Address`](Address.md) - -#### Inherited from - -[Address](Address.md).[fromBytes](Address.md#frombytes) - -#### Defined in - -[types/global.d.ts:384](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L384) diff --git a/docusaurus/docs/api/classes/Address.md b/docusaurus/docs/api/classes/Address.md deleted file mode 100644 index 687719806..000000000 --- a/docusaurus/docs/api/classes/Address.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -id: "Address" -title: "Class: Address" -sidebar_label: "Address" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`Address`** - - ↳ [`Account`](Account.md) - -## Constructors - -### constructor - -• **new Address**(): [`Address`](Address.md) - -#### Returns - -[`Address`](Address.md) - -## Properties - -### authAddr - -• `Readonly` **authAddr**: [`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:397](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L397) - -___ - -### balance - -• `Readonly` **balance**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:388](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L388) - -___ - -### hasBalance - -• `Readonly` **hasBalance**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:390](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L390) - -___ - -### minBalance - -• `Readonly` **minBalance**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:392](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L392) - -___ - -### totalAppsCreated - -• `Readonly` **totalAppsCreated**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:405](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L405) - -___ - -### totalAppsOptedIn - -• `Readonly` **totalAppsOptedIn**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:407](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L407) - -___ - -### totalAssets - -• `Readonly` **totalAssets**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:394](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L394) - -___ - -### totalAssetsCreated - -• `Readonly` **totalAssetsCreated**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:409](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L409) - -___ - -### totalBoxBytes - -• `Readonly` **totalBoxBytes**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:413](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L413) - -___ - -### totalBoxes - -• `Readonly` **totalBoxes**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:411](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L411) - -___ - -### totalExtraAppPages - -• `Readonly` **totalExtraAppPages**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:403](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L403) - -___ - -### totalNumByteSlice - -• `Readonly` **totalNumByteSlice**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:401](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L401) - -___ - -### totalNumUint - -• `Readonly` **totalNumUint**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:399](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L399) - -___ - -### zeroAddress - -▪ `Static` `Readonly` **zeroAddress**: [`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:386](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L386) - -## Methods - -### assetBalance - -▸ **assetBalance**(`asa`): [`uint64`](../modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `asa` | [`Asset`](Asset.md) | - -#### Returns - -[`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:415](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L415) - -___ - -### assetFrozen - -▸ **assetFrozen**(`asa`): [`uint64`](../modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `asa` | [`Asset`](Asset.md) | - -#### Returns - -[`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:419](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L419) - -___ - -### hasAsset - -▸ **hasAsset**(`asa`): [`uint64`](../modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `asa` | [`Asset`](Asset.md) | - -#### Returns - -[`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:417](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L417) - -___ - -### isOptedInToApp - -▸ **isOptedInToApp**(`app`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `app` | [`Application`](Application.md) | - -#### Returns - -`boolean` - -#### Defined in - -[types/global.d.ts:421](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L421) - -___ - -### fromBytes - -▸ **fromBytes**(`addr`): [`Address`](Address.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `addr` | [`BytesLike`](../modules.md#byteslike) | - -#### Returns - -[`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:384](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L384) diff --git a/docusaurus/docs/api/classes/Application.md b/docusaurus/docs/api/classes/Application.md deleted file mode 100644 index 0dd0bfe4b..000000000 --- a/docusaurus/docs/api/classes/Application.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -id: "Application" -title: "Class: Application" -sidebar_label: "Application" -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new Application**(): [`Application`](Application.md) - -#### Returns - -[`Application`](Application.md) - -## Properties - -### address - -• `Readonly` **address**: [`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:451](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L451) - -___ - -### approvalProgram - -• `Readonly` **approvalProgram**: [`bytes`](../modules.md#bytes) - -#### Defined in - -[types/global.d.ts:435](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L435) - -___ - -### clearStateProgram - -• `Readonly` **clearStateProgram**: [`bytes`](../modules.md#bytes) - -#### Defined in - -[types/global.d.ts:437](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L437) - -___ - -### creator - -• `Readonly` **creator**: [`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:449](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L449) - -___ - -### extraProgramPages - -• `Readonly` **extraProgramPages**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:447](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L447) - -___ - -### globalNumByteSlice - -• `Readonly` **globalNumByteSlice**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:441](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L441) - -___ - -### globalNumUint - -• `Readonly` **globalNumUint**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:439](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L439) - -___ - -### id - -• `Readonly` **id**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:431](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L431) - -___ - -### localNumByteSlice - -• `Readonly` **localNumByteSlice**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:445](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L445) - -___ - -### localNumUint - -• `Readonly` **localNumUint**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:443](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L443) - -___ - -### zeroIndex - -▪ `Static` `Readonly` **zeroIndex**: [`Application`](Application.md) - -#### Defined in - -[types/global.d.ts:433](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L433) - -## Methods - -### globalState - -▸ **globalState**(`key`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | [`BytesLike`](../modules.md#byteslike) | - -#### Returns - -`unknown` - -#### Defined in - -[types/global.d.ts:453](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L453) - -___ - -### localState - -▸ **localState**(`account`, `key`): `unknown` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`Address`](Address.md) | -| `key` | [`BytesLike`](../modules.md#byteslike) | - -#### Returns - -`unknown` - -#### Defined in - -[types/global.d.ts:455](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L455) - -___ - -### fromID - -▸ **fromID**(`appID`): [`Application`](Application.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `appID` | [`uint64`](../modules.md#uint64) | - -#### Returns - -[`Application`](Application.md) - -#### Defined in - -[types/global.d.ts:429](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L429) diff --git a/docusaurus/docs/api/classes/Asset.md b/docusaurus/docs/api/classes/Asset.md deleted file mode 100644 index d00949b11..000000000 --- a/docusaurus/docs/api/classes/Asset.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -id: "Asset" -title: "Class: Asset" -sidebar_label: "Asset" -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new Asset**(): [`Asset`](Asset.md) - -#### Returns - -[`Asset`](Asset.md) - -## Properties - -### clawback - -• `Readonly` **clawback**: [`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:378](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L378) - -___ - -### creator - -• `Readonly` **creator**: [`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:380](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L380) - -___ - -### decimals - -• `Readonly` **decimals**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:360](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L360) - -___ - -### defaultFrozen - -• `Readonly` **defaultFrozen**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:362](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L362) - -___ - -### freeze - -• `Readonly` **freeze**: [`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:376](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L376) - -___ - -### id - -• `Readonly` **id**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:356](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L356) - -___ - -### manager - -• `Readonly` **manager**: [`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:372](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L372) - -___ - -### metadataHash - -• `Readonly` **metadataHash**: `string` - -#### Defined in - -[types/global.d.ts:370](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L370) - -___ - -### name - -• `Readonly` **name**: `string` - -#### Defined in - -[types/global.d.ts:364](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L364) - -___ - -### reserve - -• `Readonly` **reserve**: [`Address`](Address.md) - -#### Defined in - -[types/global.d.ts:374](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L374) - -___ - -### total - -• `Readonly` **total**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:358](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L358) - -___ - -### unitName - -• `Readonly` **unitName**: `string` - -#### Defined in - -[types/global.d.ts:366](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L366) - -___ - -### url - -• `Readonly` **url**: `string` - -#### Defined in - -[types/global.d.ts:368](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L368) - -___ - -### zeroIndex - -▪ `Static` `Readonly` **zeroIndex**: [`Asset`](Asset.md) - -#### Defined in - -[types/global.d.ts:354](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L354) - -## Methods - -### fromID - -▸ **fromID**(`index`): [`Asset`](Asset.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `index` | [`uint64`](../modules.md#uint64) | - -#### Returns - -[`Asset`](Asset.md) - -#### Defined in - -[types/global.d.ts:352](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L352) diff --git a/docusaurus/docs/api/classes/Contract.md b/docusaurus/docs/api/classes/Contract.md deleted file mode 100644 index af1dc66b3..000000000 --- a/docusaurus/docs/api/classes/Contract.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -id: "Contract" -title: "Class: Contract" -sidebar_label: "Contract" -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new Contract**(): [`Contract`](Contract.md) - -#### Returns - -[`Contract`](Contract.md) - -## Properties - -### app - -• **app**: [`Application`](Application.md) - -#### Defined in - -[src/lib/contract.ts:77](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L77) - -___ - -### itxn - -• **itxn**: `ItxnParams` - -#### Defined in - -[src/lib/contract.ts:71](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L71) - -___ - -### pendingGroup - -• **pendingGroup**: [`PendingGroup`](PendingGroup.md) - -#### Defined in - -[src/lib/contract.ts:79](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L79) - -___ - -### programVersion - -• **programVersion**: `number` = `9` - -The program version to use in the generated TEAL. This is the number used in the "#pragma version" directive - -#### Defined in - -[src/lib/contract.ts:69](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L69) - -___ - -### txn - -• **txn**: [`ThisTxnParams`](../modules.md#thistxnparams) - -#### Defined in - -[src/lib/contract.ts:73](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L73) - -___ - -### txnGroup - -• **txnGroup**: [`Txn`](../modules.md#txn)[] - -#### Defined in - -[src/lib/contract.ts:75](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L75) - -___ - -### approvalProgram - -▪ `Static` **approvalProgram**: () => [`bytes`](../modules.md#bytes) - -#### Type declaration - -▸ (): [`bytes`](../modules.md#bytes) - -##### Returns - -[`bytes`](../modules.md#bytes) - -#### Defined in - -[src/lib/contract.ts:53](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L53) - -___ - -### clearProgram - -▪ `Static` **clearProgram**: () => [`bytes`](../modules.md#bytes) - -#### Type declaration - -▸ (): [`bytes`](../modules.md#bytes) - -##### Returns - -[`bytes`](../modules.md#bytes) - -#### Defined in - -[src/lib/contract.ts:55](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L55) - -___ - -### extend - -▪ `Static` **extend**: \(...`types`: `T`) => `Polytype.ClusteredConstructor`\<`T`\> - -Create a contract class that inherits from the given contracts. Inheritance is in order of arguments. - -#### Type declaration - -▸ \<`T`\>(`...types`): `Polytype.ClusteredConstructor`\<`T`\> - -Create a contract class that inherits from the given contracts. Inheritance is in order of arguments. - -##### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`SuperConstructor`, ...SuperConstructor[]] | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...types` | `T` | - -##### Returns - -`Polytype.ClusteredConstructor`\<`T`\> - -#### Defined in - -[src/lib/contract.ts:51](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L51) - -___ - -### schema - -▪ `Static` **schema**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `global` | \{ `numByteSlice`: `number` ; `numUint`: `number` } | -| `global.numByteSlice` | `number` | -| `global.numUint` | `number` | -| `local` | \{ `numByteSlice`: `number` ; `numUint`: `number` } | -| `local.numByteSlice` | `number` | -| `local.numUint` | `number` | - -#### Defined in - -[src/lib/contract.ts:57](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L57) - -## Methods - -### clearState - -▸ **clearState**(): `void` - -The method called when an account clears their local state. The default ClearState -method does nothing. ClearState will always allow a user to delete their local state, -reagrdless of logic. - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:129](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L129) - -___ - -### closeOutOfApplication - -▸ **closeOutOfApplication**(`...args`): `void` - -The method called when an account closes out their local state. The default close-out method -will always throw an error - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:120](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L120) - -___ - -### createApplication - -▸ **createApplication**(`...args`): `void` - -The method called when creating the application. The default create method will -allow the contract to be created via a bare NoOp appcall and throw an error if called -with any arguments. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:86](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L86) - -___ - -### deleteApplication - -▸ **deleteApplication**(`...args`): `void` - -The method called when attempting to delete the application. The default delete method will -always throw an error - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:104](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L104) - -___ - -### optInToApplication - -▸ **optInToApplication**(`...args`): `void` - -The method called when an account opts-in to the application. The default opt-in method will -always throw an error - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:112](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L112) - -___ - -### updateApplication - -▸ **updateApplication**(`...args`): `void` - -The method called when attempting to update the application. The default update method will -always throw an error - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:96](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L96) diff --git a/docusaurus/docs/api/classes/EventLogger.md b/docusaurus/docs/api/classes/EventLogger.md deleted file mode 100644 index e6fa65ef8..000000000 --- a/docusaurus/docs/api/classes/EventLogger.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: "EventLogger" -title: "Class: EventLogger" -sidebar_label: "EventLogger" -sidebar_position: 0 -custom_edit_url: null ---- - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `ArgumentTypes` | extends `Object` | - -## Constructors - -### constructor - -• **new EventLogger**\<`ArgumentTypes`\>(): [`EventLogger`](EventLogger.md)\<`ArgumentTypes`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `ArgumentTypes` | extends `Object` | - -#### Returns - -[`EventLogger`](EventLogger.md)\<`ArgumentTypes`\> - -#### Defined in - -[types/global.d.ts:459](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L459) - -## Methods - -### log - -▸ **log**(`args`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `args` | `ArgumentTypes` | - -#### Returns - -`void` - -#### Defined in - -[types/global.d.ts:461](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L461) diff --git a/docusaurus/docs/api/classes/LogicSig.md b/docusaurus/docs/api/classes/LogicSig.md deleted file mode 100644 index b6f0b99b5..000000000 --- a/docusaurus/docs/api/classes/LogicSig.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -id: "LogicSig" -title: "Class: LogicSig" -sidebar_label: "LogicSig" -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new LogicSig**(): [`LogicSig`](LogicSig.md) - -#### Returns - -[`LogicSig`](LogicSig.md) - -## Properties - -### programVersion - -• **programVersion**: `number` = `9` - -The program version to use in the generated TEAL. This is the number used in the "#pragma version" directive - -#### Defined in - -[src/lib/lsig.ts:24](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/lsig.ts#L24) - -___ - -### txn - -• **txn**: [`Txn`](../modules.md#txn) - -#### Defined in - -[src/lib/lsig.ts:19](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/lsig.ts#L19) - -___ - -### txnGroup - -• **txnGroup**: [`Txn`](../modules.md#txn)[] - -#### Defined in - -[src/lib/lsig.ts:21](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/lsig.ts#L21) - -___ - -### address - -▪ `Static` **address**: () => [`Address`](Address.md) - -#### Type declaration - -▸ (): [`Address`](Address.md) - -##### Returns - -[`Address`](Address.md) - -#### Defined in - -[src/lib/lsig.ts:15](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/lsig.ts#L15) - -___ - -### extend - -▪ `Static` **extend**: \(...`types`: `T`) => `Polytype.ClusteredConstructor`\<`T`\> - -Create a contract class that inherits from the given contracts. Inheritance is in order of arguments. - -#### Type declaration - -▸ \<`T`\>(`...types`): `Polytype.ClusteredConstructor`\<`T`\> - -Create a contract class that inherits from the given contracts. Inheritance is in order of arguments. - -##### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`SuperConstructor`, ...SuperConstructor[]] | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...types` | `T` | - -##### Returns - -`Polytype.ClusteredConstructor`\<`T`\> - -#### Defined in - -[src/lib/lsig.ts:13](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/lsig.ts#L13) - -___ - -### program - -▪ `Static` **program**: () => [`bytes`](../modules.md#bytes) - -#### Type declaration - -▸ (): [`bytes`](../modules.md#bytes) - -##### Returns - -[`bytes`](../modules.md#bytes) - -#### Defined in - -[src/lib/lsig.ts:17](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/lsig.ts#L17) - -## Methods - -### logic - -▸ **logic**(`...args`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `any`[] | - -#### Returns - -`void` - -#### Defined in - -[src/lib/lsig.ts:26](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/lsig.ts#L26) diff --git a/docusaurus/docs/api/classes/PendingGroup.md b/docusaurus/docs/api/classes/PendingGroup.md deleted file mode 100644 index b56e44d34..000000000 --- a/docusaurus/docs/api/classes/PendingGroup.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -id: "PendingGroup" -title: "Class: PendingGroup" -sidebar_label: "PendingGroup" -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new PendingGroup**(): [`PendingGroup`](PendingGroup.md) - -#### Returns - -[`PendingGroup`](PendingGroup.md) - -## Methods - -### addAppCall - -▸ **addAppCall**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.accounts?` | [`Address`](Address.md)[] | -| `params.applicationArgs?` | [`bytes`](../modules.md#bytes)[] | -| `params.applicationID?` | [`Application`](Application.md) | -| `params.applications?` | [`Application`](Application.md)[] | -| `params.approvalProgram?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.assets?` | [`Asset`](Asset.md)[] | -| `params.clearStateProgram?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.extraProgramPages?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.globalNumByteSlice?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.globalNumUint?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.localNumByteSlice?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.localNumUint?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.onCompletion?` | [`NoOp`](../enums/OnCompletion.md#noop) \| [`OptIn`](../enums/OnCompletion.md#optin) \| [`CloseOut`](../enums/OnCompletion.md#closeout) \| [`ClearState`](../enums/OnCompletion.md#clearstate) \| [`UpdateApplication`](../enums/OnCompletion.md#updateapplication) \| [`DeleteApplication`](../enums/OnCompletion.md#deleteapplication) | -| `params.rekeyTo?` | [`Address`](Address.md) | -| `params.sender?` | [`Address`](Address.md) | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:24](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L24) - -___ - -### addAssetConfig - -▸ **addAssetConfig**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.configAsset` | [`Asset`](Asset.md) | -| `params.configAssetClawback?` | [`Address`](Address.md) | -| `params.configAssetFreeze?` | [`Address`](Address.md) | -| `params.configAssetManager?` | [`Address`](Address.md) | -| `params.configAssetReserve?` | [`Address`](Address.md) | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](Address.md) | -| `params.sender?` | [`Address`](Address.md) | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:34](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L34) - -___ - -### addAssetCreation - -▸ **addAssetCreation**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.configAssetClawback?` | [`Address`](Address.md) | -| `params.configAssetDecimals?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.configAssetDefaultFrozen?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.configAssetFreeze?` | [`Address`](Address.md) | -| `params.configAssetManager?` | [`Address`](Address.md) | -| `params.configAssetMetadataHash?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.configAssetName?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.configAssetReserve?` | [`Address`](Address.md) | -| `params.configAssetTotal` | [`uint64`](../modules.md#uint64) | -| `params.configAssetURL?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.configAssetUnitName?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](Address.md) | -| `params.sender?` | [`Address`](Address.md) | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:28](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L28) - -___ - -### addAssetFreeze - -▸ **addAssetFreeze**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.freezeAsset` | [`Asset`](Asset.md) | -| `params.freezeAssetAccount` | [`Address`](Address.md) | -| `params.freezeAssetFrozen` | `boolean` | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](Address.md) | -| `params.sender?` | [`Address`](Address.md) | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:36](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L36) - -___ - -### addAssetTransfer - -▸ **addAssetTransfer**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.assetAmount` | [`uint64`](../modules.md#uint64) | -| `params.assetCloseTo?` | [`Address`](Address.md) | -| `params.assetReceiver` | [`Address`](Address.md) | -| `params.assetSender?` | [`Address`](Address.md) | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](Address.md) | -| `params.sender?` | [`Address`](Address.md) | -| `params.xferAsset` | [`Asset`](Asset.md) | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:26](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L26) - -___ - -### addMethodCall - -▸ **addMethodCall**\<`ArgsType`, `ReturnType`\>(`params`): `void` - -Adds ABI method to the pending transaction group. The two type arguments in combination with the -name argument are used to form the the method signature to ensure typesafety. - -#### Type parameters - -| Name | Description | -| :------ | :------ | -| `ArgsType` | A tuple type corresponding to the types of the method arguments | -| `ReturnType` | The return type of the method | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters of the method call | -| `params.accounts?` | [`Address`](Address.md)[] | - | -| `params.applicationArgs?` | [`bytes`](../modules.md#bytes)[] | - | -| `params.applicationID?` | [`Application`](Application.md) | - | -| `params.applications?` | [`Application`](Application.md)[] | - | -| `params.approvalProgram?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | - | -| `params.assets?` | [`Asset`](Asset.md)[] | - | -| `params.clearStateProgram?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | - | -| `params.extraProgramPages?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.globalNumByteSlice?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.globalNumUint?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.localNumByteSlice?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.localNumUint?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.methodArgs?` | `ArgsType` | ABI method arguments | -| `params.name` | `string` | Name of the ABI method | -| `params.note?` | `string` | - | -| `params.onCompletion?` | [`NoOp`](../enums/OnCompletion.md#noop) \| [`OptIn`](../enums/OnCompletion.md#optin) \| [`CloseOut`](../enums/OnCompletion.md#closeout) \| [`ClearState`](../enums/OnCompletion.md#clearstate) \| [`UpdateApplication`](../enums/OnCompletion.md#updateapplication) \| [`DeleteApplication`](../enums/OnCompletion.md#deleteapplication) | - | -| `params.rekeyTo?` | [`Address`](Address.md) | - | -| `params.sender?` | [`Address`](Address.md) | - | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:20](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L20) - -___ - -### addOfflineKeyRegistration - -▸ **addOfflineKeyRegistration**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](Address.md) | -| `params.sender?` | [`Address`](Address.md) | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:32](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L32) - -___ - -### addOnlineKeyRegistration - -▸ **addOnlineKeyRegistration**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](Address.md) | -| `params.selectionPK` | [`bytes`](../modules.md#bytes) | -| `params.sender?` | [`Address`](Address.md) | -| `params.stateProofPK` | [`bytes`](../modules.md#bytes) | -| `params.voteFirst` | [`uint64`](../modules.md#uint64) | -| `params.voteKeyDilution` | [`uint64`](../modules.md#uint64) | -| `params.voteLast` | [`uint64`](../modules.md#uint64) | -| `params.votePK` | [`bytes`](../modules.md#bytes) | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:30](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L30) - -___ - -### addPayment - -▸ **addPayment**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.amount?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.closeRemainderTo?` | [`Address`](Address.md) | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.receiver?` | [`Address`](Address.md) | -| `params.rekeyTo?` | [`Address`](Address.md) | -| `params.sender?` | [`Address`](Address.md) | - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:22](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L22) - -___ - -### submit - -▸ **submit**(): `void` - -#### Returns - -`void` - -#### Defined in - -[src/lib/contract.ts:38](https://github.com/algorandfoundation/tealscript/blob/d1eab388/src/lib/contract.ts#L38) diff --git a/docusaurus/docs/api/classes/_category_.yml b/docusaurus/docs/api/classes/_category_.yml deleted file mode 100644 index 55c7980a4..000000000 --- a/docusaurus/docs/api/classes/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Classes" -position: 3 \ No newline at end of file diff --git a/docusaurus/docs/api/classes/abi.md b/docusaurus/docs/api/classes/abi.md deleted file mode 100644 index 5128af477..000000000 --- a/docusaurus/docs/api/classes/abi.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: "abi" -title: "Class: abi" -sidebar_label: "abi" -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new abi**(): [`abi`](abi.md) - -#### Returns - -[`abi`](abi.md) - -## Properties - -### readonly - -▪ `Static` **readonly**: [`decorator`](../modules.md#decorator) - -Signifies this method doesn't write any state to the chain, thus it can be -called via simulate to avoid fees - -#### Defined in - -[types/global.d.ts:1027](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1027) diff --git a/docusaurus/docs/api/classes/allow.md b/docusaurus/docs/api/classes/allow.md deleted file mode 100644 index 39bfa8b7d..000000000 --- a/docusaurus/docs/api/classes/allow.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -id: "allow" -title: "Class: allow" -sidebar_label: "allow" -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new allow**(): [`allow`](allow.md) - -#### Returns - -[`allow`](allow.md) - -## Methods - -### bareCall - -▸ **bareCall**(`onComplete`): [`decorator`](../modules.md#decorator) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onComplete` | ``"NoOp"`` \| ``"OptIn"`` \| ``"CloseOut"`` \| ``"ClearState"`` \| ``"UpdateApplication"`` \| ``"DeleteApplication"`` | - -#### Returns - -[`decorator`](../modules.md#decorator) - -#### Defined in - -[types/global.d.ts:1005](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1005) - -___ - -### bareCreate - -▸ **bareCreate**(`onComplete?`): [`decorator`](../modules.md#decorator) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `onComplete` | ``"NoOp"`` \| ``"OptIn"`` \| ``"CloseOut"`` \| ``"ClearState"`` \| ``"UpdateApplication"`` \| ``"DeleteApplication"`` | `'NoOp'` | - -#### Returns - -[`decorator`](../modules.md#decorator) - -#### Defined in - -[types/global.d.ts:1009](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1009) - -___ - -### call - -▸ **call**(`onComplete`): [`decorator`](../modules.md#decorator) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onComplete` | ``"NoOp"`` \| ``"OptIn"`` \| ``"CloseOut"`` \| ``"ClearState"`` \| ``"UpdateApplication"`` \| ``"DeleteApplication"`` | - -#### Returns - -[`decorator`](../modules.md#decorator) - -#### Defined in - -[types/global.d.ts:997](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L997) - -___ - -### create - -▸ **create**(`onComplete?`): [`decorator`](../modules.md#decorator) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `onComplete` | ``"NoOp"`` \| ``"OptIn"`` \| ``"CloseOut"`` \| ``"ClearState"`` \| ``"UpdateApplication"`` \| ``"DeleteApplication"`` | `'NoOp'` | - -#### Returns - -[`decorator`](../modules.md#decorator) - -#### Defined in - -[types/global.d.ts:1001](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1001) diff --git a/docusaurus/docs/api/classes/nonABIRouterFallback.md b/docusaurus/docs/api/classes/nonABIRouterFallback.md deleted file mode 100644 index b270ee868..000000000 --- a/docusaurus/docs/api/classes/nonABIRouterFallback.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: "nonABIRouterFallback" -title: "Class: nonABIRouterFallback" -sidebar_label: "nonABIRouterFallback" -sidebar_position: 0 -custom_edit_url: null ---- - -## Constructors - -### constructor - -• **new nonABIRouterFallback**(): [`nonABIRouterFallback`](nonABIRouterFallback.md) - -#### Returns - -[`nonABIRouterFallback`](nonABIRouterFallback.md) - -## Methods - -### call - -▸ **call**(`onComplete`): [`decorator`](../modules.md#decorator) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `onComplete` | ``"NoOp"`` \| ``"OptIn"`` \| ``"CloseOut"`` \| ``"ClearState"`` \| ``"UpdateApplication"`` \| ``"DeleteApplication"`` | - -#### Returns - -[`decorator`](../modules.md#decorator) - -#### Defined in - -[types/global.d.ts:1015](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1015) - -___ - -### create - -▸ **create**(`onComplete?`): [`decorator`](../modules.md#decorator) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `onComplete` | ``"NoOp"`` \| ``"OptIn"`` \| ``"CloseOut"`` \| ``"ClearState"`` \| ``"UpdateApplication"`` \| ``"DeleteApplication"`` | `'NoOp'` | - -#### Returns - -[`decorator`](../modules.md#decorator) - -#### Defined in - -[types/global.d.ts:1019](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1019) diff --git a/docusaurus/docs/api/enums/OnCompletion.md b/docusaurus/docs/api/enums/OnCompletion.md deleted file mode 100644 index e6cf6a75c..000000000 --- a/docusaurus/docs/api/enums/OnCompletion.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: "OnCompletion" -title: "Enumeration: OnCompletion" -sidebar_label: "OnCompletion" -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### ClearState - -• **ClearState** = ``3`` - -#### Defined in - -[types/global.d.ts:585](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L585) - -___ - -### CloseOut - -• **CloseOut** = ``2`` - -#### Defined in - -[types/global.d.ts:584](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L584) - -___ - -### DeleteApplication - -• **DeleteApplication** = ``5`` - -#### Defined in - -[types/global.d.ts:587](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L587) - -___ - -### NoOp - -• **NoOp** = ``0`` - -#### Defined in - -[types/global.d.ts:582](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L582) - -___ - -### OptIn - -• **OptIn** = ``1`` - -#### Defined in - -[types/global.d.ts:583](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L583) - -___ - -### UpdateApplication - -• **UpdateApplication** = ``4`` - -#### Defined in - -[types/global.d.ts:586](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L586) diff --git a/docusaurus/docs/api/enums/TransactionType.md b/docusaurus/docs/api/enums/TransactionType.md deleted file mode 100644 index 31c52819a..000000000 --- a/docusaurus/docs/api/enums/TransactionType.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -id: "TransactionType" -title: "Enumeration: TransactionType" -sidebar_label: "TransactionType" -sidebar_position: 0 -custom_edit_url: null ---- - -## Enumeration Members - -### ApplicationCall - -• **ApplicationCall** = `number` - -#### Defined in - -[types/global.d.ts:1043](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1043) - -___ - -### AssetConfig - -• **AssetConfig** = `number` - -#### Defined in - -[types/global.d.ts:1040](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1040) - -___ - -### AssetFreeze - -• **AssetFreeze** = `number` - -#### Defined in - -[types/global.d.ts:1042](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1042) - -___ - -### AssetTransfer - -• **AssetTransfer** = `number` - -#### Defined in - -[types/global.d.ts:1041](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1041) - -___ - -### KeyRegistration - -• **KeyRegistration** = `number` - -#### Defined in - -[types/global.d.ts:1039](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1039) - -___ - -### Payment - -• **Payment** = `number` - -#### Defined in - -[types/global.d.ts:1038](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1038) - -___ - -### Unknown - -• **Unknown** = `number` - -#### Defined in - -[types/global.d.ts:1037](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1037) diff --git a/docusaurus/docs/api/enums/_category_.yml b/docusaurus/docs/api/enums/_category_.yml deleted file mode 100644 index 1687a9e03..000000000 --- a/docusaurus/docs/api/enums/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Enumerations" -position: 2 \ No newline at end of file diff --git a/docusaurus/docs/api/index.md b/docusaurus/docs/api/index.md deleted file mode 100644 index 050b4d985..000000000 --- a/docusaurus/docs/api/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: "index" -title: "@algorandfoundation/tealscript" -sidebar_label: "Readme" -sidebar_position: 0 -custom_edit_url: null ---- - -# TEALScript - -TEALScript is a subset of TypeScript that can be compiled into TEAL. The goal is to enable developers to write Algorand Smart Contracts using native TypeScript syntax. Since TEALScript uses native TypeScript syntax, IDE support works out of the box for any IDE that supports TypeScript. - -## Status - -TEALScript is a work in progress and not production-ready. The current version is `0.x.x`. This means there will be frequent changes being made, including breaking changes, without incrementing the MAJOR version number. - -## Documentation - -The documentation for the latest release can be viewed at [tealscript.algo.xyz](https://tealscript.algo.xyz) and can be generated locally with `yarn docs` - -## Example Contract - -The artifacts for this contract can be seen in [examples/calculator/artifacts](https://github.com/algorandfoundation/TEALScript/tree/dev/examples/calculator/artifacts). Note that the TypeDoc comment is used when generating [the ABI JSON](https://github.com/algorandfoundation/TEALScript/tree/dev/examples/calculator/artifacts/Calculator.abi.json) - -```ts -import { Contract } from '../../src/lib/index'; - -class Calculator extends Contract { - /** - * Calculates the sum of two numbers - * - * @param a - * @param b - * @returns The sum of a and b - */ - private getSum(a: number, b: number): number { - return a + b; - } - - /** - * Calculates the difference between two numbers - * - * @param a - * @param b - * @returns The difference between a and b. - */ - private getDifference(a: number, b: number): number { - return a >= b ? a - b : b - a; - } - - /** - * A method that takes two numbers and does either addition or subtraction - * - * @param a The first number - * @param b The second number - * @param operation The operation to perform. Can be either 'sum' or 'difference' - * - * @returns The result of the operation - */ - doMath(a: number, b: number, operation: string): number { - let result: number; - - if (operation === 'sum') { - result = this.getSum(a, b); - } else if (operation === 'difference') { - result = this.getDifference(a, b); - } else throw Error('Invalid operation'); - - return result; - } -} -``` - -## Differences from TypeScript - -While TEALScript is a subset of TypeScript, it does function differently in some cases. - -### Types Affect Behavior - -In TypeScript, using types, `as` expressions, or type arguments don't affect the compiled JS. In TEALScript, however, types fundamentally change the compiled TEAL. - -For example, the literal expression `1` results in `int 1` in TEAL, but `1 as uint8` results in `byte 0x01`. This also means that arithmetic is done differently on these numbers and they have different overflow protections. - -### Numbers Can Be Bigger - -In TypeScript, numeric literals with absolute values equal to 2^53 or greater are too large to be represented accurately as integers. In TEALScript, however, numeric literals can be much larger (up to 2^512) if properly type casted as `uint512`. - -### Types May Be Required - -All JavaScript is valid TypeScript, but that is not the case with TEALScript. In certain cases, types are required and the compiler will throw an error if they are missing. For example, types are always required when defining a method or when defining an array. diff --git a/docusaurus/docs/api/interfaces/AppOnChainTransactionParams.md b/docusaurus/docs/api/interfaces/AppOnChainTransactionParams.md deleted file mode 100644 index e67c0fcaa..000000000 --- a/docusaurus/docs/api/interfaces/AppOnChainTransactionParams.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -id: "AppOnChainTransactionParams" -title: "Interface: AppOnChainTransactionParams" -sidebar_label: "AppOnChainTransactionParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonOnChainTransactionParams`](CommonOnChainTransactionParams.md) - - ↳ **`AppOnChainTransactionParams`** - -## Properties - -### applicationID - -• **applicationID**: [`Application`](../classes/Application.md) - -#### Defined in - -[types/global.d.ts:527](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L527) - -___ - -### createdApplicationID - -• **createdApplicationID**: [`Application`](../classes/Application.md) - -#### Defined in - -[types/global.d.ts:525](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L525) - -___ - -### createdAssetID - -• **createdAssetID**: [`Asset`](../classes/Asset.md) - -#### Defined in - -[types/global.d.ts:524](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L524) - -___ - -### fee - -• **fee**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[CommonOnChainTransactionParams](CommonOnChainTransactionParams.md).[fee](CommonOnChainTransactionParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### groupIndex - -• **groupIndex**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -[CommonOnChainTransactionParams](CommonOnChainTransactionParams.md).[groupIndex](CommonOnChainTransactionParams.md#groupindex) - -#### Defined in - -[types/global.d.ts:519](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L519) - -___ - -### lastLog - -• **lastLog**: [`bytes`](../modules.md#bytes) - -#### Defined in - -[types/global.d.ts:526](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L526) - -___ - -### loadScratch - -• **loadScratch**: (`slot`: [`uint64`](../modules.md#uint64)) => `unknown` - -#### Type declaration - -▸ (`slot`): `unknown` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `slot` | [`uint64`](../modules.md#uint64) | - -##### Returns - -`unknown` - -#### Defined in - -[types/global.d.ts:535](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L535) - -___ - -### note - -• **note**: `string` - -#### Inherited from - -[CommonOnChainTransactionParams](CommonOnChainTransactionParams.md).[note](CommonOnChainTransactionParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### numAccounts - -• **numAccounts**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:529](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L529) - -___ - -### numAppArgs - -• **numAppArgs**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:528](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L528) - -___ - -### numApplicatons - -• **numApplicatons**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:531](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L531) - -___ - -### numApprovalProgrammPages - -• **numApprovalProgrammPages**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:533](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L533) - -___ - -### numAssets - -• **numAssets**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:530](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L530) - -___ - -### numClearStateProgramPages - -• **numClearStateProgramPages**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:534](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L534) - -___ - -### numLogs - -• **numLogs**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:532](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L532) - -___ - -### rekeyTo - -• **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonOnChainTransactionParams](CommonOnChainTransactionParams.md).[rekeyTo](CommonOnChainTransactionParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonOnChainTransactionParams](CommonOnChainTransactionParams.md).[sender](CommonOnChainTransactionParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) - -___ - -### txID - -• **txID**: `string` - -#### Inherited from - -[CommonOnChainTransactionParams](CommonOnChainTransactionParams.md).[txID](CommonOnChainTransactionParams.md#txid) - -#### Defined in - -[types/global.d.ts:520](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L520) diff --git a/docusaurus/docs/api/interfaces/AppParams.md b/docusaurus/docs/api/interfaces/AppParams.md deleted file mode 100644 index 5fb61f970..000000000 --- a/docusaurus/docs/api/interfaces/AppParams.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -id: "AppParams" -title: "Interface: AppParams" -sidebar_label: "AppParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionParams`](CommonTransactionParams.md) - - ↳ **`AppParams`** - - ↳↳ [`MethodCallParams`](MethodCallParams.md) - -## Properties - -### accounts - -• `Optional` **accounts**: [`Address`](../classes/Address.md)[] - -#### Defined in - -[types/global.d.ts:593](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L593) - -___ - -### applicationArgs - -• `Optional` **applicationArgs**: [`bytes`](../modules.md#bytes)[] - -#### Defined in - -[types/global.d.ts:595](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L595) - -___ - -### applicationID - -• `Optional` **applicationID**: [`Application`](../classes/Application.md) - -#### Defined in - -[types/global.d.ts:591](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L591) - -___ - -### applications - -• `Optional` **applications**: [`Application`](../classes/Application.md)[] - -#### Defined in - -[types/global.d.ts:597](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L597) - -___ - -### approvalProgram - -• `Optional` **approvalProgram**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Defined in - -[types/global.d.ts:594](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L594) - -___ - -### assets - -• `Optional` **assets**: [`Asset`](../classes/Asset.md)[] - -#### Defined in - -[types/global.d.ts:598](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L598) - -___ - -### clearStateProgram - -• `Optional` **clearStateProgram**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Defined in - -[types/global.d.ts:596](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L596) - -___ - -### extraProgramPages - -• `Optional` **extraProgramPages**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:603](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L603) - -___ - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[fee](CommonTransactionParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### globalNumByteSlice - -• `Optional` **globalNumByteSlice**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:599](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L599) - -___ - -### globalNumUint - -• `Optional` **globalNumUint**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:600](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L600) - -___ - -### localNumByteSlice - -• `Optional` **localNumByteSlice**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:601](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L601) - -___ - -### localNumUint - -• `Optional` **localNumUint**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:602](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L602) - -___ - -### note - -• `Optional` **note**: `string` - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[note](CommonTransactionParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### onCompletion - -• `Optional` **onCompletion**: [`NoOp`](../enums/OnCompletion.md#noop) \| [`OptIn`](../enums/OnCompletion.md#optin) \| [`CloseOut`](../enums/OnCompletion.md#closeout) \| [`ClearState`](../enums/OnCompletion.md#clearstate) \| [`UpdateApplication`](../enums/OnCompletion.md#updateapplication) \| [`DeleteApplication`](../enums/OnCompletion.md#deleteapplication) - -#### Defined in - -[types/global.d.ts:592](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L592) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[rekeyTo](CommonTransactionParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[sender](CommonTransactionParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) diff --git a/docusaurus/docs/api/interfaces/AssetConfigParams.md b/docusaurus/docs/api/interfaces/AssetConfigParams.md deleted file mode 100644 index 4d4760380..000000000 --- a/docusaurus/docs/api/interfaces/AssetConfigParams.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -id: "AssetConfigParams" -title: "Interface: AssetConfigParams" -sidebar_label: "AssetConfigParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionParams`](CommonTransactionParams.md) - - ↳ **`AssetConfigParams`** - -## Properties - -### configAsset - -• **configAsset**: [`Asset`](../classes/Asset.md) - -#### Defined in - -[types/global.d.ts:547](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L547) - -___ - -### configAssetClawback - -• `Optional` **configAssetClawback**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:551](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L551) - -___ - -### configAssetFreeze - -• `Optional` **configAssetFreeze**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:550](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L550) - -___ - -### configAssetManager - -• `Optional` **configAssetManager**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:548](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L548) - -___ - -### configAssetReserve - -• `Optional` **configAssetReserve**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:549](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L549) - -___ - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[fee](CommonTransactionParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### note - -• `Optional` **note**: `string` - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[note](CommonTransactionParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[rekeyTo](CommonTransactionParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[sender](CommonTransactionParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) diff --git a/docusaurus/docs/api/interfaces/AssetCreateParams.md b/docusaurus/docs/api/interfaces/AssetCreateParams.md deleted file mode 100644 index f8aadedce..000000000 --- a/docusaurus/docs/api/interfaces/AssetCreateParams.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -id: "AssetCreateParams" -title: "Interface: AssetCreateParams" -sidebar_label: "AssetCreateParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionParams`](CommonTransactionParams.md) - - ↳ **`AssetCreateParams`** - -## Properties - -### configAssetClawback - -• `Optional` **configAssetClawback**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:562](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L562) - -___ - -### configAssetDecimals - -• `Optional` **configAssetDecimals**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:558](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L558) - -___ - -### configAssetDefaultFrozen - -• `Optional` **configAssetDefaultFrozen**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:563](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L563) - -___ - -### configAssetFreeze - -• `Optional` **configAssetFreeze**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:561](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L561) - -___ - -### configAssetManager - -• `Optional` **configAssetManager**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:559](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L559) - -___ - -### configAssetMetadataHash - -• `Optional` **configAssetMetadataHash**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Defined in - -[types/global.d.ts:565](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L565) - -___ - -### configAssetName - -• `Optional` **configAssetName**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Defined in - -[types/global.d.ts:555](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L555) - -___ - -### configAssetReserve - -• `Optional` **configAssetReserve**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:560](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L560) - -___ - -### configAssetTotal - -• **configAssetTotal**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:557](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L557) - -___ - -### configAssetURL - -• `Optional` **configAssetURL**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Defined in - -[types/global.d.ts:564](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L564) - -___ - -### configAssetUnitName - -• `Optional` **configAssetUnitName**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Defined in - -[types/global.d.ts:556](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L556) - -___ - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[fee](CommonTransactionParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### note - -• `Optional` **note**: `string` - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[note](CommonTransactionParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[rekeyTo](CommonTransactionParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[sender](CommonTransactionParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) diff --git a/docusaurus/docs/api/interfaces/AssetFreezeParams.md b/docusaurus/docs/api/interfaces/AssetFreezeParams.md deleted file mode 100644 index 9ec98d45a..000000000 --- a/docusaurus/docs/api/interfaces/AssetFreezeParams.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -id: "AssetFreezeParams" -title: "Interface: AssetFreezeParams" -sidebar_label: "AssetFreezeParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionParams`](CommonTransactionParams.md) - - ↳ **`AssetFreezeParams`** - -## Properties - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[fee](CommonTransactionParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### freezeAsset - -• **freezeAsset**: [`Asset`](../classes/Asset.md) - -#### Defined in - -[types/global.d.ts:569](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L569) - -___ - -### freezeAssetAccount - -• **freezeAssetAccount**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:570](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L570) - -___ - -### freezeAssetFrozen - -• **freezeAssetFrozen**: `boolean` - -#### Defined in - -[types/global.d.ts:571](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L571) - -___ - -### note - -• `Optional` **note**: `string` - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[note](CommonTransactionParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[rekeyTo](CommonTransactionParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[sender](CommonTransactionParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) diff --git a/docusaurus/docs/api/interfaces/AssetTransferParams.md b/docusaurus/docs/api/interfaces/AssetTransferParams.md deleted file mode 100644 index 5c269d0c3..000000000 --- a/docusaurus/docs/api/interfaces/AssetTransferParams.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -id: "AssetTransferParams" -title: "Interface: AssetTransferParams" -sidebar_label: "AssetTransferParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionParams`](CommonTransactionParams.md) - - ↳ **`AssetTransferParams`** - -## Properties - -### assetAmount - -• **assetAmount**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:540](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L540) - -___ - -### assetCloseTo - -• `Optional` **assetCloseTo**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:543](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L543) - -___ - -### assetReceiver - -• **assetReceiver**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:542](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L542) - -___ - -### assetSender - -• `Optional` **assetSender**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:541](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L541) - -___ - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[fee](CommonTransactionParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### note - -• `Optional` **note**: `string` - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[note](CommonTransactionParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[rekeyTo](CommonTransactionParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[sender](CommonTransactionParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) - -___ - -### xferAsset - -• **xferAsset**: [`Asset`](../classes/Asset.md) - -#### Defined in - -[types/global.d.ts:539](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L539) diff --git a/docusaurus/docs/api/interfaces/CommonOnChainTransactionParams.md b/docusaurus/docs/api/interfaces/CommonOnChainTransactionParams.md deleted file mode 100644 index 34371084f..000000000 --- a/docusaurus/docs/api/interfaces/CommonOnChainTransactionParams.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -id: "CommonOnChainTransactionParams" -title: "Interface: CommonOnChainTransactionParams" -sidebar_label: "CommonOnChainTransactionParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- `Required`\<[`CommonTransactionParams`](CommonTransactionParams.md)\> - - ↳ **`CommonOnChainTransactionParams`** - - ↳↳ [`AppOnChainTransactionParams`](AppOnChainTransactionParams.md) - -## Properties - -### fee - -• **fee**: [`uint64`](../modules.md#uint64) - -#### Inherited from - -Required.fee - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### groupIndex - -• **groupIndex**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:519](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L519) - -___ - -### note - -• **note**: `string` - -#### Inherited from - -Required.note - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### rekeyTo - -• **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -Required.rekeyTo - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -Required.sender - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) - -___ - -### txID - -• **txID**: `string` - -#### Defined in - -[types/global.d.ts:520](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L520) diff --git a/docusaurus/docs/api/interfaces/CommonTransactionParams.md b/docusaurus/docs/api/interfaces/CommonTransactionParams.md deleted file mode 100644 index e373a53a4..000000000 --- a/docusaurus/docs/api/interfaces/CommonTransactionParams.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: "CommonTransactionParams" -title: "Interface: CommonTransactionParams" -sidebar_label: "CommonTransactionParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- **`CommonTransactionParams`** - - ↳ [`AssetTransferParams`](AssetTransferParams.md) - - ↳ [`AssetConfigParams`](AssetConfigParams.md) - - ↳ [`AssetCreateParams`](AssetCreateParams.md) - - ↳ [`AssetFreezeParams`](AssetFreezeParams.md) - - ↳ [`PaymentParams`](PaymentParams.md) - - ↳ [`AppParams`](AppParams.md) - - ↳ [`KeyRegParams`](KeyRegParams.md) - - ↳ [`OnlineKeyRegParams`](OnlineKeyRegParams.md) - -## Properties - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### note - -• `Optional` **note**: `string` - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) diff --git a/docusaurus/docs/api/interfaces/KeyRegParams.md b/docusaurus/docs/api/interfaces/KeyRegParams.md deleted file mode 100644 index f8d3c13fb..000000000 --- a/docusaurus/docs/api/interfaces/KeyRegParams.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -id: "KeyRegParams" -title: "Interface: KeyRegParams" -sidebar_label: "KeyRegParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionParams`](CommonTransactionParams.md) - - ↳ **`KeyRegParams`** - -## Properties - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[fee](CommonTransactionParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### note - -• `Optional` **note**: `string` - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[note](CommonTransactionParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[rekeyTo](CommonTransactionParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### selectionPK - -• `Optional` **selectionPK**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Defined in - -[types/global.d.ts:608](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L608) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[sender](CommonTransactionParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) - -___ - -### stateProofPk - -• `Optional` **stateProofPk**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Defined in - -[types/global.d.ts:609](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L609) - -___ - -### voteFirst - -• `Optional` **voteFirst**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:610](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L610) - -___ - -### voteKeyDilution - -• `Optional` **voteKeyDilution**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:612](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L612) - -___ - -### voteLast - -• `Optional` **voteLast**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:611](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L611) - -___ - -### votePk - -• `Optional` **votePk**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Defined in - -[types/global.d.ts:607](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L607) diff --git a/docusaurus/docs/api/interfaces/MethodCallParams.md b/docusaurus/docs/api/interfaces/MethodCallParams.md deleted file mode 100644 index 5b848d5b8..000000000 --- a/docusaurus/docs/api/interfaces/MethodCallParams.md +++ /dev/null @@ -1,281 +0,0 @@ ---- -id: "MethodCallParams" -title: "Interface: MethodCallParams" -sidebar_label: "MethodCallParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Type parameters - -| Name | -| :------ | -| `ArgsType` | - -## Hierarchy - -- [`AppParams`](AppParams.md) - - ↳ **`MethodCallParams`** - -## Properties - -### accounts - -• `Optional` **accounts**: [`Address`](../classes/Address.md)[] - -#### Inherited from - -[AppParams](AppParams.md).[accounts](AppParams.md#accounts) - -#### Defined in - -[types/global.d.ts:593](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L593) - -___ - -### applicationArgs - -• `Optional` **applicationArgs**: [`bytes`](../modules.md#bytes)[] - -#### Inherited from - -[AppParams](AppParams.md).[applicationArgs](AppParams.md#applicationargs) - -#### Defined in - -[types/global.d.ts:595](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L595) - -___ - -### applicationID - -• `Optional` **applicationID**: [`Application`](../classes/Application.md) - -#### Inherited from - -[AppParams](AppParams.md).[applicationID](AppParams.md#applicationid) - -#### Defined in - -[types/global.d.ts:591](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L591) - -___ - -### applications - -• `Optional` **applications**: [`Application`](../classes/Application.md)[] - -#### Inherited from - -[AppParams](AppParams.md).[applications](AppParams.md#applications) - -#### Defined in - -[types/global.d.ts:597](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L597) - -___ - -### approvalProgram - -• `Optional` **approvalProgram**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Inherited from - -[AppParams](AppParams.md).[approvalProgram](AppParams.md#approvalprogram) - -#### Defined in - -[types/global.d.ts:594](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L594) - -___ - -### assets - -• `Optional` **assets**: [`Asset`](../classes/Asset.md)[] - -#### Inherited from - -[AppParams](AppParams.md).[assets](AppParams.md#assets) - -#### Defined in - -[types/global.d.ts:598](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L598) - -___ - -### clearStateProgram - -• `Optional` **clearStateProgram**: `string` \| `string` & \{ `__brand?`: ``"bytes"`` } - -#### Inherited from - -[AppParams](AppParams.md).[clearStateProgram](AppParams.md#clearstateprogram) - -#### Defined in - -[types/global.d.ts:596](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L596) - -___ - -### extraProgramPages - -• `Optional` **extraProgramPages**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[AppParams](AppParams.md).[extraProgramPages](AppParams.md#extraprogrampages) - -#### Defined in - -[types/global.d.ts:603](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L603) - -___ - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[AppParams](AppParams.md).[fee](AppParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### globalNumByteSlice - -• `Optional` **globalNumByteSlice**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[AppParams](AppParams.md).[globalNumByteSlice](AppParams.md#globalnumbyteslice) - -#### Defined in - -[types/global.d.ts:599](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L599) - -___ - -### globalNumUint - -• `Optional` **globalNumUint**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[AppParams](AppParams.md).[globalNumUint](AppParams.md#globalnumuint) - -#### Defined in - -[types/global.d.ts:600](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L600) - -___ - -### localNumByteSlice - -• `Optional` **localNumByteSlice**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[AppParams](AppParams.md).[localNumByteSlice](AppParams.md#localnumbyteslice) - -#### Defined in - -[types/global.d.ts:601](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L601) - -___ - -### localNumUint - -• `Optional` **localNumUint**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[AppParams](AppParams.md).[localNumUint](AppParams.md#localnumuint) - -#### Defined in - -[types/global.d.ts:602](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L602) - -___ - -### methodArgs - -• `Optional` **methodArgs**: `ArgsType` - -ABI method arguments - -#### Defined in - -[types/global.d.ts:633](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L633) - -___ - -### name - -• **name**: `string` - -Name of the ABI method - -#### Defined in - -[types/global.d.ts:635](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L635) - -___ - -### note - -• `Optional` **note**: `string` - -#### Inherited from - -[AppParams](AppParams.md).[note](AppParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### onCompletion - -• `Optional` **onCompletion**: [`NoOp`](../enums/OnCompletion.md#noop) \| [`OptIn`](../enums/OnCompletion.md#optin) \| [`CloseOut`](../enums/OnCompletion.md#closeout) \| [`ClearState`](../enums/OnCompletion.md#clearstate) \| [`UpdateApplication`](../enums/OnCompletion.md#updateapplication) \| [`DeleteApplication`](../enums/OnCompletion.md#deleteapplication) - -#### Inherited from - -[AppParams](AppParams.md).[onCompletion](AppParams.md#oncompletion) - -#### Defined in - -[types/global.d.ts:592](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L592) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[AppParams](AppParams.md).[rekeyTo](AppParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[AppParams](AppParams.md).[sender](AppParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) diff --git a/docusaurus/docs/api/interfaces/OnlineKeyRegParams.md b/docusaurus/docs/api/interfaces/OnlineKeyRegParams.md deleted file mode 100644 index 8dcd6d1b4..000000000 --- a/docusaurus/docs/api/interfaces/OnlineKeyRegParams.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -id: "OnlineKeyRegParams" -title: "Interface: OnlineKeyRegParams" -sidebar_label: "OnlineKeyRegParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionParams`](CommonTransactionParams.md) - - ↳ **`OnlineKeyRegParams`** - -## Properties - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[fee](CommonTransactionParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### note - -• `Optional` **note**: `string` - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[note](CommonTransactionParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[rekeyTo](CommonTransactionParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### selectionPK - -• **selectionPK**: [`bytes`](../modules.md#bytes) - -#### Defined in - -[types/global.d.ts:617](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L617) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[sender](CommonTransactionParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) - -___ - -### stateProofPK - -• **stateProofPK**: [`bytes`](../modules.md#bytes) - -#### Defined in - -[types/global.d.ts:618](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L618) - -___ - -### voteFirst - -• **voteFirst**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:619](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L619) - -___ - -### voteKeyDilution - -• **voteKeyDilution**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:621](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L621) - -___ - -### voteLast - -• **voteLast**: [`uint64`](../modules.md#uint64) - -#### Defined in - -[types/global.d.ts:620](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L620) - -___ - -### votePK - -• **votePK**: [`bytes`](../modules.md#bytes) - -#### Defined in - -[types/global.d.ts:616](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L616) diff --git a/docusaurus/docs/api/interfaces/PaymentParams.md b/docusaurus/docs/api/interfaces/PaymentParams.md deleted file mode 100644 index f69829ed8..000000000 --- a/docusaurus/docs/api/interfaces/PaymentParams.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -id: "PaymentParams" -title: "Interface: PaymentParams" -sidebar_label: "PaymentParams" -sidebar_position: 0 -custom_edit_url: null ---- - -## Hierarchy - -- [`CommonTransactionParams`](CommonTransactionParams.md) - - ↳ **`PaymentParams`** - -## Properties - -### amount - -• `Optional` **amount**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Defined in - -[types/global.d.ts:575](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L575) - -___ - -### closeRemainderTo - -• `Optional` **closeRemainderTo**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:577](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L577) - -___ - -### fee - -• `Optional` **fee**: `number` \| `number` & \{ `__brand?`: ``"uint64"`` } - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[fee](CommonTransactionParams.md#fee) - -#### Defined in - -[types/global.d.ts:512](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L512) - -___ - -### note - -• `Optional` **note**: `string` - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[note](CommonTransactionParams.md#note) - -#### Defined in - -[types/global.d.ts:515](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L515) - -___ - -### receiver - -• `Optional` **receiver**: [`Address`](../classes/Address.md) - -#### Defined in - -[types/global.d.ts:576](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L576) - -___ - -### rekeyTo - -• `Optional` **rekeyTo**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[rekeyTo](CommonTransactionParams.md#rekeyto) - -#### Defined in - -[types/global.d.ts:514](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L514) - -___ - -### sender - -• `Optional` **sender**: [`Address`](../classes/Address.md) - -#### Inherited from - -[CommonTransactionParams](CommonTransactionParams.md).[sender](CommonTransactionParams.md#sender) - -#### Defined in - -[types/global.d.ts:513](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L513) diff --git a/docusaurus/docs/api/interfaces/_category_.yml b/docusaurus/docs/api/interfaces/_category_.yml deleted file mode 100644 index 43bec88cf..000000000 --- a/docusaurus/docs/api/interfaces/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Interfaces" -position: 4 \ No newline at end of file diff --git a/docusaurus/docs/api/modules.md b/docusaurus/docs/api/modules.md deleted file mode 100644 index 19ce2ff01..000000000 --- a/docusaurus/docs/api/modules.md +++ /dev/null @@ -1,2225 +0,0 @@ ---- -id: "modules" -title: "@algorandfoundation/tealscript" -sidebar_label: "Table of Contents" -sidebar_position: 0.5 -hide_table_of_contents: true -custom_edit_url: null ---- - -## Enumerations - -- [OnCompletion](enums/OnCompletion.md) -- [TransactionType](enums/TransactionType.md) - -## Classes - -- [Account](classes/Account.md) -- [Address](classes/Address.md) -- [Application](classes/Application.md) -- [Asset](classes/Asset.md) -- [Contract](classes/Contract.md) -- [EventLogger](classes/EventLogger.md) -- [LogicSig](classes/LogicSig.md) -- [PendingGroup](classes/PendingGroup.md) -- [abi](classes/abi.md) -- [allow](classes/allow.md) -- [nonABIRouterFallback](classes/nonABIRouterFallback.md) - -## Interfaces - -- [AppOnChainTransactionParams](interfaces/AppOnChainTransactionParams.md) -- [AppParams](interfaces/AppParams.md) -- [AssetConfigParams](interfaces/AssetConfigParams.md) -- [AssetCreateParams](interfaces/AssetCreateParams.md) -- [AssetFreezeParams](interfaces/AssetFreezeParams.md) -- [AssetTransferParams](interfaces/AssetTransferParams.md) -- [CommonOnChainTransactionParams](interfaces/CommonOnChainTransactionParams.md) -- [CommonTransactionParams](interfaces/CommonTransactionParams.md) -- [KeyRegParams](interfaces/KeyRegParams.md) -- [MethodCallParams](interfaces/MethodCallParams.md) -- [OnlineKeyRegParams](interfaces/OnlineKeyRegParams.md) -- [PaymentParams](interfaces/PaymentParams.md) - -## Type Aliases - -### AppCallTxn - -Ƭ **AppCallTxn**: [`AppOnChainTransactionParams`](interfaces/AppOnChainTransactionParams.md) & `Required`\<[`AppParams`](interfaces/AppParams.md)\> - -#### Defined in - -[types/global.d.ts:626](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L626) - -___ - -### AppCallTxnVerificationFields - -Ƭ **AppCallTxnVerificationFields**: [`CommonTxnVerificationFields`](modules.md#commontxnverificationfields) & \{ `applicationID?`: [`Application`](classes/Application.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `approvalProgram?`: [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `approvalProgramPages?`: [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `clearStateProgram?`: [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `clearStateProgramPages?`: [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `extraProgramPages?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `globalNumByteSlice?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `globalNumUint?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `lastLog?`: [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `localNumByteSlice?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `localNumUint?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `numAccounts?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `numAppArgs?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `numApplications?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `numApprovalProgramPages?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `numAssets?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `numClearStateProgramPages?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `numLogs?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `onCompletion?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) } - -#### Defined in - -[types/global.d.ts:314](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L314) - -___ - -### AssetConfigTxn - -Ƭ **AssetConfigTxn**: `Required`\<[`AssetConfigParams`](interfaces/AssetConfigParams.md)\> - -#### Defined in - -[types/global.d.ts:628](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L628) - -___ - -### AssetConfigTxnVerificationFields - -Ƭ **AssetConfigTxnVerificationFields**: [`CommonTxnVerificationFields`](modules.md#commontxnverificationfields) & \{ `configAsset?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetClawback?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetDecimals?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetDefaultFrozen?`: `boolean` \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetFreeze?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetManager?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetMetadataHash?`: [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetName?`: [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetReserve?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetTotal?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetURL?`: [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `configAssetUnitName?`: [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `freezeAsset?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `freezeAssetAccount?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `freezeAssetFrozen?`: `boolean` \| [`TxnVerificationTests`](modules.md#txnverificationtests) } - -#### Defined in - -[types/global.d.ts:296](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L296) - -___ - -### AssetFreezeTxn - -Ƭ **AssetFreezeTxn**: `Required`\<[`AssetFreezeParams`](interfaces/AssetFreezeParams.md)\> - -#### Defined in - -[types/global.d.ts:629](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L629) - -___ - -### AssetTransferTxn - -Ƭ **AssetTransferTxn**: `Required`\<[`AssetTransferParams`](interfaces/AssetTransferParams.md)\> - -#### Defined in - -[types/global.d.ts:625](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L625) - -___ - -### AssetTransferTxnVerificationFields - -Ƭ **AssetTransferTxnVerificationFields**: [`CommonTxnVerificationFields`](modules.md#commontxnverificationfields) & \{ `assetAmount?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `assetCloseTo?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `assetReceiver?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `assetSender?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `xferAsset?`: [`Asset`](classes/Asset.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) } - -#### Defined in - -[types/global.d.ts:288](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L288) - -___ - -### BoxValue - -Ƭ **BoxValue**\<`ValueType`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `ValueType` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `delete` | () => `void` | -| `exists` | `boolean` | -| `size` | [`uint64`](modules.md#uint64) | -| `value` | `ValueType` | -| `create` | (`size`: [`uint64`](modules.md#uint64)) => `void` | -| `extract` | (`offset`: [`uint64`](modules.md#uint64), `length`: [`uint64`](modules.md#uint64)) => [`bytes`](modules.md#bytes) | -| `replace` | (`offset`: [`uint64`](modules.md#uint64), `value`: [`bytes`](modules.md#bytes)) => `void` | - -#### Defined in - -[types/global.d.ts:464](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L464) - -___ - -### Brand - -Ƭ **Brand**\<`K`, `T`\>: `K` \| `K` & \{ `__brand?`: `T` } - -#### Type parameters - -| Name | -| :------ | -| `K` | -| `T` | - -#### Defined in - -[types/global.d.ts:241](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L241) - -___ - -### BytesLike - -Ƭ **BytesLike**: [`bytes`](modules.md#bytes) \| [`Address`](classes/Address.md) \| `string` - -#### Defined in - -[types/global.d.ts:426](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L426) - -___ - -### CommonTxnVerificationFields - -Ƭ **CommonTxnVerificationFields**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `fee?` | [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) | -| `firstValid?` | [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) | -| `firstValidTime?` | [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) | -| `groupIndex?` | [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) | -| `lastValid?` | [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) | -| `lease?` | [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> \| [`TxnVerificationTests`](modules.md#txnverificationtests) | -| `note?` | [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) | -| `rekeyTo?` | [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) | -| `sender?` | [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) | -| `txID?` | [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> \| [`TxnVerificationTests`](modules.md#txnverificationtests) | - -#### Defined in - -[types/global.d.ts:260](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L260) - -___ - -### Expand - -Ƭ **Expand**\<`T`\>: `T` extends (...`args`: infer A) => infer R ? (...`args`: [`Expand`](modules.md#expand)\<`A`\>) => [`Expand`](modules.md#expand)\<`R`\> : `T` extends infer O ? \{ [K in keyof O]: O[K] } : `never` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Defined in - -[types/global.d.ts:6](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L6) - -___ - -### GlobalStateValue - -Ƭ **GlobalStateValue**\<`ValueType`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `ValueType` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `delete` | () => `void` | -| `exists` | `boolean` | -| `value` | `ValueType` | - -#### Defined in - -[types/global.d.ts:482](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L482) - -___ - -### InnerAppCall - -Ƭ **InnerAppCall**: [`AppParams`](interfaces/AppParams.md) - -#### Defined in - -[types/global.d.ts:678](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L678) - -___ - -### InnerAssetConfig - -Ƭ **InnerAssetConfig**: [`AssetConfigParams`](interfaces/AssetConfigParams.md) - -#### Defined in - -[types/global.d.ts:680](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L680) - -___ - -### InnerAssetCreation - -Ƭ **InnerAssetCreation**: [`AssetCreateParams`](interfaces/AssetCreateParams.md) - -#### Defined in - -[types/global.d.ts:681](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L681) - -___ - -### InnerAssetFreeze - -Ƭ **InnerAssetFreeze**: [`AssetFreezeParams`](interfaces/AssetFreezeParams.md) - -#### Defined in - -[types/global.d.ts:682](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L682) - -___ - -### InnerAssetTransfer - -Ƭ **InnerAssetTransfer**: [`AssetTransferParams`](interfaces/AssetTransferParams.md) - -#### Defined in - -[types/global.d.ts:679](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L679) - -___ - -### InnerMethodCall - -Ƭ **InnerMethodCall**\<`ArgsType`, `ReturnType`\>: [`MethodCallParams`](interfaces/MethodCallParams.md)\<`ArgsType`\> - -#### Type parameters - -| Name | -| :------ | -| `ArgsType` | -| `ReturnType` | - -#### Defined in - -[types/global.d.ts:685](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L685) - -___ - -### InnerOfflineKeyRegistration - -Ƭ **InnerOfflineKeyRegistration**: [`CommonTransactionParams`](interfaces/CommonTransactionParams.md) - -#### Defined in - -[types/global.d.ts:684](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L684) - -___ - -### InnerOnlineKeyRegistration - -Ƭ **InnerOnlineKeyRegistration**: [`OnlineKeyRegParams`](interfaces/OnlineKeyRegParams.md) - -#### Defined in - -[types/global.d.ts:683](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L683) - -___ - -### InnerPayment - -Ƭ **InnerPayment**: [`PaymentParams`](interfaces/PaymentParams.md) - -#### Defined in - -[types/global.d.ts:677](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L677) - -___ - -### IntLike - -Ƭ **IntLike**: [`uint64`](modules.md#uint64) \| [`Asset`](classes/Asset.md) \| [`Application`](classes/Application.md) \| `boolean` \| `number` - -#### Defined in - -[types/global.d.ts:509](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L509) - -___ - -### KeyRegTxn - -Ƭ **KeyRegTxn**: `Required`\<[`KeyRegParams`](interfaces/KeyRegParams.md)\> - -#### Defined in - -[types/global.d.ts:627](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L627) - -___ - -### KeyRegTxnVerificationFields - -Ƭ **KeyRegTxnVerificationFields**: [`CommonTxnVerificationFields`](modules.md#commontxnverificationfields) & \{ `nonparticipation?`: `boolean` \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `selectionPK?`: [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `voteFirst?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `voteKeyDilution?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `voteLast?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `votePK?`: [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> \| [`TxnVerificationTests`](modules.md#txnverificationtests) } - -#### Defined in - -[types/global.d.ts:279](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L279) - -___ - -### LocalStateValue - -Ƭ **LocalStateValue**\<`ValueType`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `ValueType` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `delete` | () => `void` | -| `exists` | `boolean` | -| `value` | `ValueType` | - -#### Defined in - -[types/global.d.ts:495](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L495) - -___ - -### PayTxn - -Ƭ **PayTxn**: `Required`\<[`PaymentParams`](interfaces/PaymentParams.md)\> - -#### Defined in - -[types/global.d.ts:624](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L624) - -___ - -### PayTxnVerificationFields - -Ƭ **PayTxnVerificationFields**: [`CommonTxnVerificationFields`](modules.md#commontxnverificationfields) & \{ `amount?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `closeRemainderTo?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `receiver?`: [`Address`](classes/Address.md) \| [`TxnVerificationTests`](modules.md#txnverificationtests) } - -#### Defined in - -[types/global.d.ts:273](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L273) - -___ - -### ScratchValue - -Ƭ **ScratchValue**\<`ValueType`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `ValueType` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `value` | `ValueType` | - -#### Defined in - -[types/global.d.ts:1054](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1054) - -___ - -### StaticArray - -Ƭ **StaticArray**\<`T`, `N`\>: [`Brand`](modules.md#brand)\<`T` extends [`byte`](modules.md#byte) ? `string` : `N` extends ``0`` ? `never`[] : `T` extends `boolean` ? (`boolean`)[] : `T`[], `T`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`BytesLike`](modules.md#byteslike) \| [`IntLike`](modules.md#intlike) \| [`StaticArray`](modules.md#staticarray) | -| `N` | extends `number` | - -#### Defined in - -[types/global.d.ts:1030](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1030) - -___ - -### ThisTxnParams - -Ƭ **ThisTxnParams**: [`AppOnChainTransactionParams`](interfaces/AppOnChainTransactionParams.md) & [`AppParams`](interfaces/AppParams.md) - -#### Defined in - -[types/global.d.ts:638](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L638) - -___ - -### Txn - -Ƭ **Txn**: [`PayTxn`](modules.md#paytxn) & [`AssetTransferTxn`](modules.md#assettransfertxn) & [`AppCallTxn`](modules.md#appcalltxn) & [`KeyRegTxn`](modules.md#keyregtxn) & [`AssetConfigTxn`](modules.md#assetconfigtxn) & [`AssetFreezeTxn`](modules.md#assetfreezetxn) & \{ `typeEnum`: [`TransactionType`](enums/TransactionType.md) } - -#### Defined in - -[types/global.d.ts:640](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L640) - -___ - -### TxnVerificationFields - -Ƭ **TxnVerificationFields**: [`PayTxnVerificationFields`](modules.md#paytxnverificationfields) & [`KeyRegTxnVerificationFields`](modules.md#keyregtxnverificationfields) & [`AssetTransferTxnVerificationFields`](modules.md#assettransfertxnverificationfields) & [`AssetConfigTxnVerificationFields`](modules.md#assetconfigtxnverificationfields) & [`AppCallTxnVerificationFields`](modules.md#appcalltxnverificationfields) & \{ `type?`: [`BytesLike`](modules.md#byteslike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) ; `typeEnum?`: [`IntLike`](modules.md#intlike) \| [`TxnVerificationTests`](modules.md#txnverificationtests) } - -#### Defined in - -[types/global.d.ts:342](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L342) - -___ - -### TxnVerificationTests - -Ƭ **TxnVerificationTests**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `greaterThan?` | [`IntLike`](modules.md#intlike) | -| `greaterThanEqualTo?` | [`IntLike`](modules.md#intlike) | -| `includedIn?` | ([`IntLike`](modules.md#intlike) \| [`BytesLike`](modules.md#byteslike))[] | -| `lessThan?` | [`IntLike`](modules.md#intlike) | -| `lessThanEqualTo?` | [`IntLike`](modules.md#intlike) | -| `not?` | [`IntLike`](modules.md#intlike) \| [`BytesLike`](modules.md#byteslike) | -| `notIncludedIn?` | ([`IntLike`](modules.md#intlike) \| [`BytesLike`](modules.md#byteslike))[] | - -#### Defined in - -[types/global.d.ts:250](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L250) - -___ - -### byte - -Ƭ **byte**: [`Brand`](modules.md#brand)\<`string`, ``"byte"``\> - -#### Defined in - -[types/global.d.ts:247](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L247) - -___ - -### bytes - -Ƭ **bytes**: [`Brand`](modules.md#brand)\<`string`, ``"bytes"``\> - -#### Defined in - -[types/global.d.ts:248](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L248) - -___ - -### decorator - -Ƭ **decorator**: (`target`: `Object`, `key`: `string` \| `symbol`, `descriptor`: `PropertyDescriptor`) => `PropertyDescriptor` - -#### Type declaration - -▸ (`target`, `key`, `descriptor`): `PropertyDescriptor` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `target` | `Object` | -| `key` | `string` \| `symbol` | -| `descriptor` | `PropertyDescriptor` | - -##### Returns - -`PropertyDescriptor` - -#### Defined in - -[types/global.d.ts:994](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L994) - -___ - -### precisions - -Ƭ **precisions**: ``1`` \| ``2`` \| ``3`` \| ``4`` \| ``5`` \| ``6`` \| ``7`` \| ``8`` \| ``9`` \| ``10`` \| ``11`` \| ``12`` \| ``13`` \| ``14`` \| ``15`` \| ``16`` \| ``17`` \| ``18`` \| ``19`` \| ``20`` \| ``21`` \| ``22`` \| ``23`` \| ``24`` \| ``25`` \| ``26`` \| ``27`` \| ``28`` \| ``29`` \| ``30`` \| ``31`` \| ``32`` \| ``33`` \| ``34`` \| ``35`` \| ``36`` \| ``37`` \| ``38`` \| ``39`` \| ``40`` \| ``41`` \| ``42`` \| ``43`` \| ``44`` \| ``45`` \| ``46`` \| ``47`` \| ``48`` \| ``49`` \| ``50`` \| ``51`` \| ``52`` \| ``53`` \| ``54`` \| ``55`` \| ``56`` \| ``57`` \| ``58`` \| ``59`` \| ``60`` \| ``61`` \| ``62`` \| ``63`` \| ``64`` \| ``65`` \| ``66`` \| ``67`` \| ``68`` \| ``69`` \| ``70`` \| ``71`` \| ``72`` \| ``73`` \| ``74`` \| ``75`` \| ``76`` \| ``77`` \| ``78`` \| ``79`` \| ``80`` \| ``81`` \| ``82`` \| ``83`` \| ``84`` \| ``85`` \| ``86`` \| ``87`` \| ``88`` \| ``89`` \| ``90`` \| ``91`` \| ``92`` \| ``93`` \| ``94`` \| ``95`` \| ``96`` \| ``97`` \| ``98`` \| ``99`` \| ``100`` \| ``101`` \| ``102`` \| ``103`` \| ``104`` \| ``105`` \| ``106`` \| ``107`` \| ``108`` \| ``109`` \| ``110`` \| ``111`` \| ``112`` \| ``113`` \| ``114`` \| ``115`` \| ``116`` \| ``117`` \| ``118`` \| ``119`` \| ``120`` \| ``121`` \| ``122`` \| ``123`` \| ``124`` \| ``125`` \| ``126`` \| ``127`` \| ``128`` \| ``129`` \| ``130`` \| ``131`` \| ``132`` \| ``133`` \| ``134`` \| ``135`` \| ``136`` \| ``137`` \| ``138`` \| ``139`` \| ``140`` \| ``141`` \| ``142`` \| ``143`` \| ``144`` \| ``145`` \| ``146`` \| ``147`` \| ``148`` \| ``149`` \| ``150`` \| ``151`` \| ``152`` \| ``153`` \| ``154`` \| ``155`` \| ``156`` \| ``157`` \| ``158`` \| ``159`` \| ``160`` - -#### Defined in - -[types/global.d.ts:78](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L78) - -___ - -### ufixed - -Ƭ **ufixed**\<`N`, `M`\>: [`Brand`](modules.md#brand)\<`number`, \`ufixed$\{N}x$\{M}\`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends [`widths`](modules.md#widths) | -| `M` | extends [`precisions`](modules.md#precisions) | - -#### Defined in - -[types/global.d.ts:245](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L245) - -___ - -### uint - -Ƭ **uint**\<`N`\>: [`Brand`](modules.md#brand)\<`number`, \`uint$\{N}\`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `N` | extends [`widths`](modules.md#widths) | - -#### Defined in - -[types/global.d.ts:243](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L243) - -___ - -### uint64 - -Ƭ **uint64**: [`uint`](modules.md#uint)\<``64``\> \| `number` - -#### Defined in - -[types/global.d.ts:244](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L244) - -___ - -### widths - -Ƭ **widths**: ``8`` \| ``16`` \| ``24`` \| ``32`` \| ``40`` \| ``48`` \| ``56`` \| ``64`` \| ``72`` \| ``80`` \| ``88`` \| ``96`` \| ``104`` \| ``112`` \| ``120`` \| ``128`` \| ``136`` \| ``144`` \| ``152`` \| ``160`` \| ``168`` \| ``176`` \| ``184`` \| ``192`` \| ``200`` \| ``208`` \| ``216`` \| ``224`` \| ``232`` \| ``240`` \| ``248`` \| ``256`` \| ``264`` \| ``272`` \| ``280`` \| ``288`` \| ``296`` \| ``304`` \| ``312`` \| ``320`` \| ``328`` \| ``336`` \| ``344`` \| ``352`` \| ``360`` \| ``368`` \| ``376`` \| ``384`` \| ``392`` \| ``400`` \| ``408`` \| ``416`` \| ``424`` \| ``432`` \| ``440`` \| ``448`` \| ``456`` \| ``464`` \| ``472`` \| ``480`` \| ``488`` \| ``496`` \| ``504`` \| ``512`` - -#### Defined in - -[types/global.d.ts:12](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L12) - -## Variables - -### globals - -• `Const` **globals**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `callerApplicationAddress` | [`Address`](classes/Address.md) | -| `callerApplicationID` | [`Application`](classes/Application.md) | -| `creatorAddress` | [`Address`](classes/Address.md) | -| `currentApplicationAddress` | [`Address`](classes/Address.md) | -| `currentApplicationID` | [`Application`](classes/Application.md) | -| `groupID` | [`bytes`](modules.md#bytes) | -| `groupSize` | [`uint64`](modules.md#uint64) | -| `latestTimestamp` | [`uint64`](modules.md#uint64) | -| `logicSigVersion` | [`uint64`](modules.md#uint64) | -| `maxTxnLife` | [`uint64`](modules.md#uint64) | -| `minBalance` | [`uint64`](modules.md#uint64) | -| `minTxnFee` | [`uint64`](modules.md#uint64) | -| `opcodeBudget` | [`uint64`](modules.md#uint64) | -| `round` | [`uint64`](modules.md#uint64) | -| `zeroAddress` | [`Address`](classes/Address.md) | - -#### Defined in - -[types/global.d.ts:647](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L647) - -## Functions - -### BoxKey - -▸ **BoxKey**\<`ValueType`\>(`options?`): [`BoxValue`](modules.md#boxvalue)\<`ValueType`\> - -#### Type parameters - -| Name | -| :------ | -| `ValueType` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Object` | -| `options.dynamicSize?` | `boolean` | -| `options.key?` | `string` | - -#### Returns - -[`BoxValue`](modules.md#boxvalue)\<`ValueType`\> - -#### Defined in - -[types/global.d.ts:474](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L474) - -___ - -### BoxMap - -▸ **BoxMap**\<`KeyType`, `ValueType`\>(`options?`): (`key`: `KeyType`) => [`BoxValue`](modules.md#boxvalue)\<`ValueType`\> - -#### Type parameters - -| Name | -| :------ | -| `KeyType` | -| `ValueType` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Object` | -| `options.allowPotentialCollisions?` | `boolean` | -| `options.dynamicSize?` | `boolean` | -| `options.prefix?` | `string` | - -#### Returns - -`fn` - -▸ (`key`): [`BoxValue`](modules.md#boxvalue)\<`ValueType`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `KeyType` | - -##### Returns - -[`BoxValue`](modules.md#boxvalue)\<`ValueType`\> - -#### Defined in - -[types/global.d.ts:476](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L476) - -___ - -### GlobalStateKey - -▸ **GlobalStateKey**\<`ValueType`\>(`options?`): [`GlobalStateValue`](modules.md#globalstatevalue)\<`ValueType`\> - -#### Type parameters - -| Name | -| :------ | -| `ValueType` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Object` | -| `options.key?` | `string` | - -#### Returns - -[`GlobalStateValue`](modules.md#globalstatevalue)\<`ValueType`\> - -#### Defined in - -[types/global.d.ts:488](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L488) - -___ - -### GlobalStateMap - -▸ **GlobalStateMap**\<`KeyType`, `ValueType`\>(`options`): (`key`: `KeyType`) => [`GlobalStateValue`](modules.md#globalstatevalue)\<`ValueType`\> - -#### Type parameters - -| Name | -| :------ | -| `KeyType` | -| `ValueType` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Object` | -| `options.allowPotentialCollisions?` | `boolean` | -| `options.maxKeys` | `number` | -| `options.prefix?` | `string` | - -#### Returns - -`fn` - -▸ (`key`): [`GlobalStateValue`](modules.md#globalstatevalue)\<`ValueType`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `KeyType` | - -##### Returns - -[`GlobalStateValue`](modules.md#globalstatevalue)\<`ValueType`\> - -#### Defined in - -[types/global.d.ts:489](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L489) - -___ - -### LocalStateKey - -▸ **LocalStateKey**\<`ValueType`\>(`options?`): (`account`: [`Address`](classes/Address.md)) => [`LocalStateValue`](modules.md#localstatevalue)\<`ValueType`\> - -#### Type parameters - -| Name | -| :------ | -| `ValueType` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options?` | `Object` | -| `options.key?` | `string` | - -#### Returns - -`fn` - -▸ (`account`): [`LocalStateValue`](modules.md#localstatevalue)\<`ValueType`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`Address`](classes/Address.md) | - -##### Returns - -[`LocalStateValue`](modules.md#localstatevalue)\<`ValueType`\> - -#### Defined in - -[types/global.d.ts:501](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L501) - -___ - -### LocalStateMap - -▸ **LocalStateMap**\<`KeyType`, `ValueType`\>(`options`): (`account`: [`Address`](classes/Address.md), `key`: `KeyType`) => [`LocalStateValue`](modules.md#localstatevalue)\<`ValueType`\> - -#### Type parameters - -| Name | -| :------ | -| `KeyType` | -| `ValueType` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Object` | -| `options.allowPotentialCollisions?` | `boolean` | -| `options.maxKeys` | `number` | -| `options.prefix?` | `string` | - -#### Returns - -`fn` - -▸ (`account`, `key`): [`LocalStateValue`](modules.md#localstatevalue)\<`ValueType`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `account` | [`Address`](classes/Address.md) | -| `key` | `KeyType` | - -##### Returns - -[`LocalStateValue`](modules.md#localstatevalue)\<`ValueType`\> - -#### Defined in - -[types/global.d.ts:503](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L503) - -___ - -### ScratchSlot - -▸ **ScratchSlot**\<`ValueType`\>(`slot`): [`ScratchValue`](modules.md#scratchvalue)\<`ValueType`\> - -#### Type parameters - -| Name | -| :------ | -| `ValueType` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `slot` | `number` | - -#### Returns - -[`ScratchValue`](modules.md#scratchvalue)\<`ValueType`\> - -#### Defined in - -[types/global.d.ts:1058](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1058) - -___ - -### TemplateVar - -▸ **TemplateVar**\<`TmplType`\>(`name?`): `TmplType` - -#### Type parameters - -| Name | -| :------ | -| `TmplType` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name?` | `string` | - -#### Returns - -`TmplType` - -#### Defined in - -[types/global.d.ts:1046](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1046) - -___ - -### addr - -▸ **addr**(`address`): [`Address`](classes/Address.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `address` | `string` | - -#### Returns - -[`Address`](classes/Address.md) - -#### Defined in - -[types/global.d.ts:666](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L666) - -___ - -### assert - -▸ **assert**(`...conditions`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...conditions` | [`IntLike`](modules.md#intlike)[] | - -#### Returns - -`void` - -**`Throws`** - -if one of the given conditions is 0 or false - -#### Defined in - -[types/global.d.ts:750](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L750) - -___ - -### bsqrt - -▸ **bsqrt**(`arg0`): [`uint`](modules.md#uint)\<[`widths`](modules.md#widths)\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `arg0` | [`uint`](modules.md#uint)\<[`widths`](modules.md#widths)\> | - -#### Returns - -[`uint`](modules.md#uint)\<[`widths`](modules.md#widths)\> - -square root of the given uintN - -#### Defined in - -[types/global.d.ts:856](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L856) - -___ - -### btobigint - -▸ **btobigint**(`input`): `number` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -`number` - -bytes interpreted as a number - -#### Defined in - -[types/global.d.ts:941](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L941) - -___ - -### btoi - -▸ **btoi**(`data`): [`uint64`](modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -[`uint64`](modules.md#uint64) - -the input data converted to [uint64](modules.md#uint64) - -**`Throws`** - -if the input data is longer than 8 bytes - -#### Defined in - -[types/global.d.ts:716](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L716) - -___ - -### bzero - -▸ **bzero**\<`T`\>(`size?`): `T` - -Returns zero bytes of the given size. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | [`bytes`](modules.md#bytes) | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `size?` | `number` \| `boolean` \| [`Application`](classes/Application.md) \| `number` & \{ `__brand?`: ``"uint64"`` } \| [`Asset`](classes/Asset.md) | the number of zero bytes to return. If not given, returns the size of the type given the type argument | - -#### Returns - -`T` - -#### Defined in - -[types/global.d.ts:927](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L927) - -___ - -### castBytes - -▸ **castBytes**\<`T`\>(`input`): `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -`T` - -#### Defined in - -[types/global.d.ts:1048](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1048) - -___ - -### clone - -▸ **clone**\<`T`\>(`input`): `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `T` | - -#### Returns - -`T` - -#### Defined in - -[types/global.d.ts:1052](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1052) - -___ - -### concat - -▸ **concat**(`a`, `b`): [`bytes`](modules.md#bytes) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `a` | [`BytesLike`](modules.md#byteslike) | -| `b` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -[`bytes`](modules.md#bytes) - -The concatenation of two [bytes](modules.md#bytes) - -#### Defined in - -[types/global.d.ts:753](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L753) - -___ - -### divw - -▸ **divw**(`dividendHigh`, `dividendLow`, `divisor`): [`uint64`](modules.md#uint64) - -Combines two uint64 into one uint128 and then divides it by another uint64 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `dividendHigh` | [`IntLike`](modules.md#intlike) | high bits of the dividend | -| `dividendLow` | [`IntLike`](modules.md#intlike) | low bits of the dividend | -| `divisor` | [`IntLike`](modules.md#intlike) | divisor | - -#### Returns - -[`uint64`](modules.md#uint64) - -#### Defined in - -[types/global.d.ts:865](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L865) - -___ - -### ecdsa\_pk\_decompress - -▸ **ecdsa_pk_decompress**(`curve`, `pubKey`): [[`uint`](modules.md#uint)\<``256``\>, [`uint`](modules.md#uint)\<``256``\>] - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `curve` | ``"Secp256k1"`` \| ``"Secp256r1"`` | The curve being used | -| `pubKey` | [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``33``\> | The public key to decompress | - -#### Returns - -[[`uint`](modules.md#uint)\<``256``\>, [`uint`](modules.md#uint)\<``256``\>] - -The X and Y components of the decompressed public key - -#### Defined in - -[types/global.d.ts:897](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L897) - -___ - -### ecdsa\_pk\_recover - -▸ **ecdsa_pk_recover**(`curve`, `data`, `recoveryID`, `sSignatureComponent`, `rSignatureComponent`): [[`uint`](modules.md#uint)\<``256``\>, [`uint`](modules.md#uint)\<``256``\>] - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `curve` | ``"Secp256k1"`` \| ``"Secp256r1"`` | The curve being used | -| `data` | [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> | The data that was signed | -| `recoveryID` | [`uint64`](modules.md#uint64) | The recovery ID | -| `sSignatureComponent` | [`uint`](modules.md#uint)\<``256``\> | The s component of the lower-S signature | -| `rSignatureComponent` | [`uint`](modules.md#uint)\<``256``\> | The r component of the lower-S signature | - -#### Returns - -[[`uint`](modules.md#uint)\<``256``\>, [`uint`](modules.md#uint)\<``256``\>] - -The X and Y components of the recovered public key - -#### Defined in - -[types/global.d.ts:912](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L912) - -___ - -### ecdsa\_verify - -▸ **ecdsa_verify**(`curve`, `data`, `sSignatureComponent`, `rSignatureComponent`, `xPubkeyComponent`, `yPubkeyComponent`): `boolean` - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `curve` | ``"Secp256k1"`` \| ``"Secp256r1"`` | The curve being used | -| `data` | [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> | The data that was signed | -| `sSignatureComponent` | [`uint`](modules.md#uint)\<``256``\> | The s component of the lower-S signature | -| `rSignatureComponent` | [`uint`](modules.md#uint)\<``256``\> | The r component of the lower-S signature | -| `xPubkeyComponent` | [`uint`](modules.md#uint)\<``256``\> | The x component of the public key | -| `yPubkeyComponent` | [`uint`](modules.md#uint)\<``256``\> | The y component of the public key | - -#### Returns - -`boolean` - -true if the signature is valid, false otherwise - -#### Defined in - -[types/global.d.ts:881](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L881) - -___ - -### ed25519verify - -▸ **ed25519verify**(`data`, `signature`, `pubkey`): `boolean` - -Verify the signature of ("ProgData" || program_hash || data) against the pubkey. -The program_hash is the hash of the program source code - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | Data be verified | -| `signature` | [`BytesLike`](modules.md#byteslike) | The signature to verify | -| `pubkey` | [`BytesLike`](modules.md#byteslike) | The public key to verify the signature with | - -#### Returns - -`boolean` - -true if the signature is valid, false otherwise - -#### Defined in - -[types/global.d.ts:744](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L744) - -___ - -### ed25519verify\_bare - -▸ **ed25519verify_bare**(`message`, `signature`, `publicKey`): [`uint64`](modules.md#uint64) - -Verifies the given signature against the given public key and message - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `message` | [`BytesLike`](modules.md#byteslike) | message to verify | -| `signature` | [`BytesLike`](modules.md#byteslike) | signature to verify | -| `publicKey` | [`BytesLike`](modules.md#byteslike) | public key to verify the signature with | - -#### Returns - -[`uint64`](modules.md#uint64) - -true if the signature is valid, false otherwise - -#### Defined in - -[types/global.d.ts:850](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L850) - -___ - -### extract3 - -▸ **extract3**(`data`, `start`, `length`): [`bytes`](modules.md#bytes) - -Extracts a subtstring of the given length starting at the given index - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | bytes to extract from | -| `start` | [`IntLike`](modules.md#intlike) | byte index to start extracting from | -| `length` | [`IntLike`](modules.md#intlike) | number of bytes to extract | - -#### Returns - -[`bytes`](modules.md#bytes) - -extracted bytes - -#### Defined in - -[types/global.d.ts:798](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L798) - -___ - -### extract\_uint16 - -▸ **extract_uint16**(`data`, `byteIndex`): [`uint64`](modules.md#uint64) - -Extracts 2 bytes from the given data starting at the given index and converts them to uint16 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | bytes to extract from | -| `byteIndex` | [`IntLike`](modules.md#intlike) | - | - -#### Returns - -[`uint64`](modules.md#uint64) - -uint16 as uint64 - -#### Defined in - -[types/global.d.ts:808](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L808) - -___ - -### extract\_uint32 - -▸ **extract_uint32**(`data`, `byteIndex`): [`uint64`](modules.md#uint64) - -Extracts 4 bytes from the given data starting at the given index and converts them to uint32 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | bytes to extract from | -| `byteIndex` | [`IntLike`](modules.md#intlike) | - | - -#### Returns - -[`uint64`](modules.md#uint64) - -uint32 as uint64 - -#### Defined in - -[types/global.d.ts:818](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L818) - -___ - -### extract\_uint64 - -▸ **extract_uint64**(`data`, `byteIndex`): [`uint64`](modules.md#uint64) - -Extracts 8 bytes from the given data starting at the given index and converts them to uint64 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | bytes to extract from | -| `byteIndex` | [`IntLike`](modules.md#intlike) | - | - -#### Returns - -[`uint64`](modules.md#uint64) - -uint64 - -#### Defined in - -[types/global.d.ts:828](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L828) - -___ - -### getbit - -▸ **getbit**(`data`, `bitIndex`): `boolean` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | -| `bitIndex` | [`IntLike`](modules.md#intlike) | - -#### Returns - -`boolean` - -The value of the bit at the given index - -#### Defined in - -[types/global.d.ts:766](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L766) - -___ - -### getbyte - -▸ **getbyte**(`data`, `byteIndex`): [`uint64`](modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | -| `byteIndex` | [`IntLike`](modules.md#intlike) | - -#### Returns - -[`uint64`](modules.md#uint64) - -The value of the byte at the given index - -#### Defined in - -[types/global.d.ts:778](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L778) - -___ - -### hex - -▸ **hex**(`input`): [`bytes`](modules.md#bytes) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `string` | - -#### Returns - -[`bytes`](modules.md#bytes) - -hex input decoded to bytes - -#### Defined in - -[types/global.d.ts:938](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L938) - -___ - -### itob - -▸ **itob**(`int`): [`bytes`](modules.md#bytes) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `int` | [`IntLike`](modules.md#intlike) | - -#### Returns - -[`bytes`](modules.md#bytes) - -[uint64](modules.md#uint64) converted to [bytes](modules.md#bytes) - -#### Defined in - -[types/global.d.ts:719](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L719) - -___ - -### keccak256 - -▸ **keccak256**(`data`): [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -[`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> - -the keccak256 hash of the given data - -#### Defined in - -[types/global.d.ts:728](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L728) - -___ - -### len - -▸ **len**(`data`): [`uint64`](modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -[`uint64`](modules.md#uint64) - -the length of the data - -#### Defined in - -[types/global.d.ts:747](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L747) - -___ - -### log - -▸ **log**(`content`): `void` - -Logs data to the chain. Logs only persist if the app call is successful - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `content` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -`void` - -#### Defined in - -[types/global.d.ts:722](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L722) - -___ - -### method - -▸ **method**(`signature`): [`bytes`](modules.md#bytes) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `signature` | `string` | - -#### Returns - -[`bytes`](modules.md#bytes) - -#### Defined in - -[types/global.d.ts:665](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L665) - -___ - -### rawBytes - -▸ **rawBytes**(`input`): [`bytes`](modules.md#bytes) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `input` | `any` | - -#### Returns - -[`bytes`](modules.md#bytes) - -#### Defined in - -[types/global.d.ts:1050](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L1050) - -___ - -### replace3 - -▸ **replace3**(`data`, `byteIndex`, `newData`): [`bytes`](modules.md#bytes) - -Replace bytes in the given data starting at the given index - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | data containing the bytes that should be replaced | -| `byteIndex` | [`IntLike`](modules.md#intlike) | index of the first byte to replace | -| `newData` | [`BytesLike`](modules.md#byteslike) | bytes to replace with | - -#### Returns - -[`bytes`](modules.md#bytes) - -updated data - -#### Defined in - -[types/global.d.ts:839](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L839) - -___ - -### sendAppCall - -▸ **sendAppCall**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.accounts?` | [`Address`](classes/Address.md)[] | -| `params.applicationArgs?` | [`bytes`](modules.md#bytes)[] | -| `params.applicationID?` | [`Application`](classes/Application.md) | -| `params.applications?` | [`Application`](classes/Application.md)[] | -| `params.approvalProgram?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.assets?` | [`Asset`](classes/Asset.md)[] | -| `params.clearStateProgram?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.extraProgramPages?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.globalNumByteSlice?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.globalNumUint?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.localNumByteSlice?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.localNumUint?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.onCompletion?` | [`NoOp`](enums/OnCompletion.md#noop) \| [`OptIn`](enums/OnCompletion.md#optin) \| [`CloseOut`](enums/OnCompletion.md#closeout) \| [`ClearState`](enums/OnCompletion.md#clearstate) \| [`UpdateApplication`](enums/OnCompletion.md#updateapplication) \| [`DeleteApplication`](enums/OnCompletion.md#deleteapplication) | -| `params.rekeyTo?` | [`Address`](classes/Address.md) | -| `params.sender?` | [`Address`](classes/Address.md) | - -#### Returns - -`void` - -#### Defined in - -[types/global.d.ts:669](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L669) - -___ - -### sendAssetConfig - -▸ **sendAssetConfig**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.configAsset` | [`Asset`](classes/Asset.md) | -| `params.configAssetClawback?` | [`Address`](classes/Address.md) | -| `params.configAssetFreeze?` | [`Address`](classes/Address.md) | -| `params.configAssetManager?` | [`Address`](classes/Address.md) | -| `params.configAssetReserve?` | [`Address`](classes/Address.md) | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](classes/Address.md) | -| `params.sender?` | [`Address`](classes/Address.md) | - -#### Returns - -`void` - -#### Defined in - -[types/global.d.ts:674](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L674) - -___ - -### sendAssetCreation - -▸ **sendAssetCreation**(`params`): [`Asset`](classes/Asset.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.configAssetClawback?` | [`Address`](classes/Address.md) | -| `params.configAssetDecimals?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.configAssetDefaultFrozen?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.configAssetFreeze?` | [`Address`](classes/Address.md) | -| `params.configAssetManager?` | [`Address`](classes/Address.md) | -| `params.configAssetMetadataHash?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.configAssetName?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.configAssetReserve?` | [`Address`](classes/Address.md) | -| `params.configAssetTotal` | [`uint64`](modules.md#uint64) | -| `params.configAssetURL?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.configAssetUnitName?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](classes/Address.md) | -| `params.sender?` | [`Address`](classes/Address.md) | - -#### Returns - -[`Asset`](classes/Asset.md) - -#### Defined in - -[types/global.d.ts:671](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L671) - -___ - -### sendAssetFreeze - -▸ **sendAssetFreeze**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.freezeAsset` | [`Asset`](classes/Asset.md) | -| `params.freezeAssetAccount` | [`Address`](classes/Address.md) | -| `params.freezeAssetFrozen` | `boolean` | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](classes/Address.md) | -| `params.sender?` | [`Address`](classes/Address.md) | - -#### Returns - -`void` - -#### Defined in - -[types/global.d.ts:675](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L675) - -___ - -### sendAssetTransfer - -▸ **sendAssetTransfer**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.assetAmount` | [`uint64`](modules.md#uint64) | -| `params.assetCloseTo?` | [`Address`](classes/Address.md) | -| `params.assetReceiver` | [`Address`](classes/Address.md) | -| `params.assetSender?` | [`Address`](classes/Address.md) | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](classes/Address.md) | -| `params.sender?` | [`Address`](classes/Address.md) | -| `params.xferAsset` | [`Asset`](classes/Asset.md) | - -#### Returns - -`void` - -#### Defined in - -[types/global.d.ts:670](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L670) - -___ - -### sendMethodCall - -▸ **sendMethodCall**\<`ArgsType`, `ReturnType`\>(`params`): `ReturnType` - -Sends ABI method call. The two type arguments in combination with the -name argument are used to form the the method signature to ensure typesafety. - -#### Type parameters - -| Name | Description | -| :------ | :------ | -| `ArgsType` | A tuple type corresponding to the types of the method arguments | -| `ReturnType` | The return type of the method | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `params` | `Object` | The parameters of the method call | -| `params.accounts?` | [`Address`](classes/Address.md)[] | - | -| `params.applicationArgs?` | [`bytes`](modules.md#bytes)[] | - | -| `params.applicationID?` | [`Application`](classes/Application.md) | - | -| `params.applications?` | [`Application`](classes/Application.md)[] | - | -| `params.approvalProgram?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | - | -| `params.assets?` | [`Asset`](classes/Asset.md)[] | - | -| `params.clearStateProgram?` | `string` \| `string` & \{ `__brand?`: ``"bytes"`` } | - | -| `params.extraProgramPages?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.globalNumByteSlice?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.globalNumUint?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.localNumByteSlice?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.localNumUint?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | - | -| `params.methodArgs?` | `ArgsType` | ABI method arguments | -| `params.name` | `string` | Name of the ABI method | -| `params.note?` | `string` | - | -| `params.onCompletion?` | [`NoOp`](enums/OnCompletion.md#noop) \| [`OptIn`](enums/OnCompletion.md#optin) \| [`CloseOut`](enums/OnCompletion.md#closeout) \| [`ClearState`](enums/OnCompletion.md#clearstate) \| [`UpdateApplication`](enums/OnCompletion.md#updateapplication) \| [`DeleteApplication`](enums/OnCompletion.md#deleteapplication) | - | -| `params.rekeyTo?` | [`Address`](classes/Address.md) | - | -| `params.sender?` | [`Address`](classes/Address.md) | - | - -#### Returns - -`ReturnType` - -The return value of the method call - -**`Example`** - -Calling a method and getting the return value -```ts -// call createNFT(string,string)uint64 -const createdAsset = sendMethodCall<[string, string], Asset>({ - applicationID: factoryApp, - name: 'createNFT', - methodArgs: ['My NFT', 'MNFT'], -}); -``` - -#### Defined in - -[types/global.d.ts:710](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L710) - -___ - -### sendOfflineKeyRegistration - -▸ **sendOfflineKeyRegistration**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](classes/Address.md) | -| `params.sender?` | [`Address`](classes/Address.md) | - -#### Returns - -`void` - -#### Defined in - -[types/global.d.ts:673](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L673) - -___ - -### sendOnlineKeyRegistration - -▸ **sendOnlineKeyRegistration**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.rekeyTo?` | [`Address`](classes/Address.md) | -| `params.selectionPK` | [`bytes`](modules.md#bytes) | -| `params.sender?` | [`Address`](classes/Address.md) | -| `params.stateProofPK` | [`bytes`](modules.md#bytes) | -| `params.voteFirst` | [`uint64`](modules.md#uint64) | -| `params.voteKeyDilution` | [`uint64`](modules.md#uint64) | -| `params.voteLast` | [`uint64`](modules.md#uint64) | -| `params.votePK` | [`bytes`](modules.md#bytes) | - -#### Returns - -`void` - -#### Defined in - -[types/global.d.ts:672](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L672) - -___ - -### sendPayment - -▸ **sendPayment**(`params`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `params` | `Object` | -| `params.amount?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.closeRemainderTo?` | [`Address`](classes/Address.md) | -| `params.fee?` | `number` \| `number` & \{ `__brand?`: ``"uint64"`` } | -| `params.note?` | `string` | -| `params.receiver?` | [`Address`](classes/Address.md) | -| `params.rekeyTo?` | [`Address`](classes/Address.md) | -| `params.sender?` | [`Address`](classes/Address.md) | - -#### Returns - -`void` - -#### Defined in - -[types/global.d.ts:668](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L668) - -___ - -### setbit - -▸ **setbit**(`data`, `bitIndex`, `value`): [`bytes`](modules.md#bytes) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | The input data to update | -| `bitIndex` | [`IntLike`](modules.md#intlike) | The index of the bit to update | -| `value` | [`IntLike`](modules.md#intlike) | The value to set the bit to | - -#### Returns - -[`bytes`](modules.md#bytes) - -The updated data - -#### Defined in - -[types/global.d.ts:775](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L775) - -___ - -### setbyte - -▸ **setbyte**(`data`, `byteIndex`, `value`): [`bytes`](modules.md#bytes) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | The input data to update | -| `byteIndex` | [`IntLike`](modules.md#intlike) | The index of the byte to update | -| `value` | [`IntLike`](modules.md#intlike) | The value to set the byte to | - -#### Returns - -[`bytes`](modules.md#bytes) - -The updated data - -#### Defined in - -[types/global.d.ts:787](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L787) - -___ - -### sha256 - -▸ **sha256**(`data`): [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -[`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> - -the sha256 hash of the given data - -#### Defined in - -[types/global.d.ts:725](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L725) - -___ - -### sha3\_256 - -▸ **sha3_256**(`data`): [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -[`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> - -sha3_256 hash of the given data - -#### Defined in - -[types/global.d.ts:868](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L868) - -___ - -### sha512\_256 - -▸ **sha512_256**(`data`): [`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | - -#### Returns - -[`StaticArray`](modules.md#staticarray)\<[`byte`](modules.md#byte), ``32``\> - -the sha512_256 hash of the given data - -#### Defined in - -[types/global.d.ts:731](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L731) - -___ - -### sqrt - -▸ **sqrt**(`n`): [`uint64`](modules.md#uint64) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `n` | [`IntLike`](modules.md#intlike) | - -#### Returns - -[`uint64`](modules.md#uint64) - -square root of the given uint64 - -#### Defined in - -[types/global.d.ts:853](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L853) - -___ - -### substring3 - -▸ **substring3**(`data`, `start`, `end`): [`bytes`](modules.md#bytes) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `data` | [`BytesLike`](modules.md#byteslike) | The input data from which bytes are extracted | -| `start` | [`IntLike`](modules.md#intlike) | The start index of the bytes to extract | -| `end` | [`IntLike`](modules.md#intlike) | The end index of the bytes to extract (not inclusive) | - -#### Returns - -[`bytes`](modules.md#bytes) - -Extracted bytes - -#### Defined in - -[types/global.d.ts:763](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L763) - -___ - -### verifyAppCallTxn - -▸ **verifyAppCallTxn**(`txn`, `params`): `any` - -Verifies the fields of an app call transaction against the given parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `txn` | [`ThisTxnParams`](modules.md#thistxnparams) \| [`AppCallTxn`](modules.md#appcalltxn) \| [`Txn`](modules.md#txn) | the transaction to verify | -| `params` | [`AppCallTxnVerificationFields`](modules.md#appcalltxnverificationfields) | the transaction fields to verify in the given transaction | - -#### Returns - -`any` - -#### Defined in - -[types/global.d.ts:984](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L984) - -___ - -### verifyAssetConfigTxn - -▸ **verifyAssetConfigTxn**(`txn`, `params`): `any` - -Verifies the fields of an asset config transaction against the given parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `txn` | `Required`\<[`AssetConfigParams`](interfaces/AssetConfigParams.md)\> \| [`Txn`](modules.md#txn) | the transaction to verify | -| `params` | [`AssetConfigTxnVerificationFields`](modules.md#assetconfigtxnverificationfields) | the transaction fields to verify in the given transaction | - -#### Returns - -`any` - -#### Defined in - -[types/global.d.ts:968](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L968) - -___ - -### verifyAssetTransferTxn - -▸ **verifyAssetTransferTxn**(`txn`, `params`): `any` - -Verifies the fields of an asset transfer transaction against the given parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `txn` | [`AssetTransferParams`](interfaces/AssetTransferParams.md) \| [`Txn`](modules.md#txn) | the transaction to verify | -| `params` | [`AssetTransferTxnVerificationFields`](modules.md#assettransfertxnverificationfields) | the transaction fields to verify in the given transaction | - -#### Returns - -`any` - -#### Defined in - -[types/global.d.ts:976](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L976) - -___ - -### verifyKeyRegTxn - -▸ **verifyKeyRegTxn**(`txn`, `params`): `any` - -Verifies the fields of a key reg transaction against the given parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `txn` | `Required`\<[`KeyRegParams`](interfaces/KeyRegParams.md)\> \| [`Txn`](modules.md#txn) | the transaction to verify | -| `params` | [`KeyRegTxnVerificationFields`](modules.md#keyregtxnverificationfields) | the transaction fields to verify in the given transaction | - -#### Returns - -`any` - -#### Defined in - -[types/global.d.ts:992](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L992) - -___ - -### verifyPayTxn - -▸ **verifyPayTxn**(`txn`, `params`): `any` - -Verifies the fields of a pay transaction against the given parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `txn` | `Required`\<[`PaymentParams`](interfaces/PaymentParams.md)\> \| [`Txn`](modules.md#txn) | the transaction to verify | -| `params` | [`PayTxnVerificationFields`](modules.md#paytxnverificationfields) | the transaction fields to verify in the given transaction | - -#### Returns - -`any` - -#### Defined in - -[types/global.d.ts:960](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L960) - -___ - -### verifyTxn - -▸ **verifyTxn**(`txn`, `params`): `any` - -Verifies the fields of a transaction against the given parameters. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `txn` | [`AssetTransferParams`](interfaces/AssetTransferParams.md) \| [`AssetFreezeParams`](interfaces/AssetFreezeParams.md) \| [`ThisTxnParams`](modules.md#thistxnparams) \| `Required`\<[`PaymentParams`](interfaces/PaymentParams.md)\> \| [`AppCallTxn`](modules.md#appcalltxn) \| `Required`\<[`KeyRegParams`](interfaces/KeyRegParams.md)\> \| `Required`\<[`AssetConfigParams`](interfaces/AssetConfigParams.md)\> \| [`Txn`](modules.md#txn) | the transaction to verify | -| `params` | [`TxnVerificationFields`](modules.md#txnverificationfields) | the transaction fields to verify in the given transaction | - -#### Returns - -`any` - -#### Defined in - -[types/global.d.ts:949](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L949) - -___ - -### wideRatio - -▸ **wideRatio**(`numeratorFactors`, `denominatorFactors`): [`uint64`](modules.md#uint64) - -Use this method if all inputs to the expression are uint64s, -the output fits in a uint64, and all intermediate values fit in a uint128. -Otherwise uintN division should be used. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `numeratorFactors` | [`uint64`](modules.md#uint64)[] | -| `denominatorFactors` | [`uint64`](modules.md#uint64)[] | - -#### Returns - -[`uint64`](modules.md#uint64) - -product of numerators divided by product of denominator - -#### Defined in - -[types/global.d.ts:935](https://github.com/algorandfoundation/tealscript/blob/d1eab388/types/global.d.ts#L935)