Skip to content

Commit efe8fe1

Browse files
committed
fix: borken docs links
1 parent 5b2f65a commit efe8fe1

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

docs/algots.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ and debugged on a Node.js virtual machine with transpilation to EcmaScript and r
88

99
Algorand TypeScript is compiled for execution on the AVM by PuyaTs, a TypeScript frontend for the [Puya](https://github.com/algorandfoundation/puya) optimising compiler that ensures the resulting AVM bytecode execution semantics that match the given TypeScript code. PuyaTs produces output that is directly compatible with AlgoKit typed clients to make deployment and calling easy.
1010

11-
[Documentation](https://github.com/algorandfoundation/puya/blob/main/README.md)
11+
[Documentation](https://github.com/algorandfoundation/puya-ts/blob/main/README.md)

docs/examples.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
Below is a showcase of various examples of unit testing real and sample Algorand Python smart contracts using `algorand-typescript-testing`.
44

5-
| Contract Name | Test File | Key Features Demonstrated | Test versions of Algorand TypeScript Abstractions used |
6-
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
7-
| Auction | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/auction/contract.algo.ts) | - Use of TestExecutionContext<br>- Mocking of global state and transaction fields<br>- Testing of ARC4 contract methods<br>- Emulation of asset creation and transfers<br>- Verification of inner transactions | - **arc4.Contract**<br>- **Global**<br>- **Txn**<br>- **Asset**<br>- **Account**<br>- **LocalState** |
8-
| Proof of Attendance | [contract.algo.ts](https://github.com/algorandfoundation/algorand-python-testing/blob/main/examples/proof-of-attendance/contract.algo.ts) | - Creation and management of dummy assets<br>- Testing of box storage operations<br>- Verification of inner transactions for asset transfers<br>- Use of any\_\* methods for generating test data | - **arc4.Contract**<br>- **Box**<br>- **BoxMap**<br>- **Asset**<br>- **Account**<br>- **op** |
9-
| Simple Voting | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/simple-voting/contract.algo.ts) | - Testing of global and local state operations<br>- Verification of transaction group operations<br>- Mocking of payment transactions | - **BaseContract**<br>- **GlobalState**<br>- **LocalState**<br>- **Txn**<br>- **op.GTxn** |
10-
| ZK Whitelist | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/zk-whitelist/contract.algo.ts) | - Testing of zero-knowledge proof verification<br>- Mocking of external application calls<br>- Use of ARC4 types and methods | - **arc4.Contract**<br>- **arc4 types**<br>- **LocalState**<br>- **Global**<br>- **Txn** |
11-
| HTLC LogicSig | [signature.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/htlc-logicsig/signature.algo.ts) | - Testing of LogicSig contracts<br>- Verification of time-based conditions<br>- Mocking of transaction parameters | - **logicsig**<br>- **Account**<br>- **Txn**<br>- **Global**<br>- **op** |
12-
| Marketplace | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/marketplace/contract.algo.ts) | - Testing of complex marketplace operations<br>- Use of BoxMap for listings<br>- Testing of asset transfers and payments | - **arc4.Contract**<br>- **BoxMap**<br>- **Asset**<br>- **arc4 types**<br>- **Global**<br>- **Txn** |
13-
| Scratch Storage | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/scratch-storage/contract.algo.ts) | - Testing of scratch space usage<br>- Verification of scratch slot values | - **arc4.Contract**<br>- **Contract**<br>- **op** |
5+
| Contract Name | Test File | Key Features Demonstrated | Test versions of Algorand TypeScript Abstractions used |
6+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
7+
| Auction | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/auction/contract.algo.ts) | - Use of TestExecutionContext<br>- Mocking of global state and transaction fields<br>- Testing of ARC4 contract methods<br>- Emulation of asset creation and transfers<br>- Verification of inner transactions | - **arc4.Contract**<br>- **Global**<br>- **Txn**<br>- **Asset**<br>- **Account**<br>- **LocalState** |
8+
| Proof of Attendance | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/proof-of-attendance/contract.algo.ts) | - Creation and management of dummy assets<br>- Testing of box storage operations<br>- Verification of inner transactions for asset transfers<br>- Use of any\_\* methods for generating test data | - **arc4.Contract**<br>- **Box**<br>- **BoxMap**<br>- **Asset**<br>- **Account**<br>- **op** |
9+
| Simple Voting | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/simple-voting/contract.algo.ts) | - Testing of global and local state operations<br>- Verification of transaction group operations<br>- Mocking of payment transactions | - **BaseContract**<br>- **GlobalState**<br>- **LocalState**<br>- **Txn**<br>- **op.GTxn** |
10+
| ZK Whitelist | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/zk-whitelist/contract.algo.ts) | - Testing of zero-knowledge proof verification<br>- Mocking of external application calls<br>- Use of ARC4 types and methods | - **arc4.Contract**<br>- **arc4 types**<br>- **LocalState**<br>- **Global**<br>- **Txn** |
11+
| HTLC LogicSig | [signature.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/htlc-logicsig/signature.algo.ts) | - Testing of LogicSig contracts<br>- Verification of time-based conditions<br>- Mocking of transaction parameters | - **logicsig**<br>- **Account**<br>- **Txn**<br>- **Global**<br>- **op** |
12+
| Marketplace | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/marketplace/contract.algo.ts) | - Testing of complex marketplace operations<br>- Use of BoxMap for listings<br>- Testing of asset transfers and payments | - **arc4.Contract**<br>- **BoxMap**<br>- **Asset**<br>- **arc4 types**<br>- **Global**<br>- **Txn** |
13+
| Scratch Storage | [contract.algo.ts](https://github.com/algorandfoundation/algorand-typescript-testing/blob/main/examples/scratch-storage/contract.algo.ts) | - Testing of scratch space usage<br>- Verification of scratch slot values | - **arc4.Contract**<br>- **Contract**<br>- **op** |

readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,9 @@ To dig deeper into the capabilities of `algorand-typescript-testing`, continue w
198198

199199
#### Contents
200200

201-
- [Testing Guide](./docs/testing-guide/index)
202-
- [Examples](./docs/examples)
203-
- [Coverage](./docs/coverage)
204-
- [FQA](./docs/faq)
205-
- [API Reference](./docs/api)
206-
- [Algorand TypeScript](./docs/algots)
201+
- [Testing Guide](./docs/testing-guide/index.md)
202+
- [Examples](./docs/examples.md)
203+
- [Coverage](./docs/coverage.md)
204+
- [FQA](./docs/faq.md)
205+
- [API Reference](./docs/api.md)
206+
- [Algorand TypeScript](./docs/algots.md)

0 commit comments

Comments
 (0)