https://github.com/algorandfoundation/puya-ts
https://github.com/algorandfoundation/puya-ts
algokit lib
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/algorandfoundation/puya-ts
- Owner: algorandfoundation
- License: mit
- Created: 2024-05-27T08:29:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-26T04:05:02.000Z (4 months ago)
- Last Synced: 2026-02-26T08:04:57.103Z (4 months ago)
- Topics: algokit, lib
- Language: TypeScript
- Homepage: https://algorandfoundation.github.io/puya-ts/
- Size: 37.2 MB
- Stars: 16
- Watchers: 8
- Forks: 5
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-algorand - puya-ts - An official TypeScript to TEAL compiler frontend, leveraging the core puya compiler, allows you to write code to execute on the Algorand Virtual Machine (AVM) with TypeScript syntax. (Core Resources / AlgoKit)
README
# Algorand TypeScript
Algorand TypeScript is a partial implementation of the TypeScript programming language that runs on the Algorand Virtual Machine (AVM). It includes a statically typed framework for development of Algorand smart contracts and logic signatures, with TypeScript interfaces to underlying AVM functionality that works with standard TypeScript tooling.
It maintains the syntax and semantics of TypeScript such that a developer who knows TypeScript can make safe assumptions
about the behaviour of the compiled code when running on the AVM. Algorand TypeScript is also executable TypeScript that can be run
and debugged on a Node.js virtual machine with transpilation to EcmaScript and run from automated tests.
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.
## Documentation
- [Language Guide](https://algorandfoundation.github.io/puya-ts/language-guide/)
- [API Reference](https://algorandfoundation.github.io/puya-ts/api/)
- [CLI Guide](https://algorandfoundation.github.io/puya-ts/cli/)
- [Migration Guides](https://algorandfoundation.github.io/puya-ts/migration-guides/)
- [Release Notes](https://github.com/algorandfoundation/puya-ts/releases)
- [Contribution Guide](CONTRIBUTING.md)
For developing the documentation site locally, see the [docs README](docs/README.md).