https://github.com/algorandfoundation/algokit-utils-ts
https://github.com/algorandfoundation/algokit-utils-ts
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/algorandfoundation/algokit-utils-ts
- Owner: algorandfoundation
- License: mit
- Created: 2022-12-09T09:17:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T03:43:15.000Z (11 months ago)
- Last Synced: 2024-05-22T10:41:03.463Z (11 months ago)
- Language: TypeScript
- Size: 2.07 MB
- Stars: 16
- Watchers: 4
- Forks: 5
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-algorand - algokit-utils-ts - Algorand AlgoKit Utils for TypeScript. (Core Resources / AlgoKit)
README
# AlgoKit TypeScript Utilities
A set of core Algorand utilities written in TypeScript and released via npm that make it easier to build solutions on Algorand. This project is part of [AlgoKit](https://github.com/algorandfoundation/algokit-cli).
The goal of this library is to provide intuitive, productive utility functions that make it easier, quicker and safer to build applications on Algorand. Largely these functions wrap the underlying Algorand SDK, but provide a higher level interface with sensible defaults and capabilities for common tasks.
Note: If you prefer Python there's an equivalent [Python utility library](https://github.com/algorandfoundation/algokit-utils-py).
[Install](#install) | [Documentation](./docs/README.md)
## Install
Before installing, you'll need to decide on the version you want to target. Version 7 and 8 have the same feature set, however v7 leverages algosdk@>=2.9.0<3.0, whereas v8 leverages algosdk@>=3.0.0. Your project and it's dependencies will help you decide which version to target.
Once you've decided on the target version, this library can be installed from NPM using your favourite npm client, e.g.:
To target algosdk@2 and use version 7 of AlgoKit Utils, run the below:
```
npm install algosdk@^2.9.0 @algorandfoundation/algokit-utils@^7.0.0
```
To target algosdk@3 and use the latest version of AlgoKit Utils, run the below:
```
npm install algosdk@^3.0.0 @algorandfoundation/algokit-utils
```
Now you can import the library:
```typescript
import { AlgorandClient, Config } from '@algorandfoundation/algokit-utils'
```
See [usage](./docs/README.md#usage) for more details.
## Migration
Whilst we aim to minimise breaking changes, there are situations where they are required.
JSDoc deprecations should guide you through most migration paths inside your IDE, however the migration guides will provide more detailed information should you need it.
If you're targetting v7, please refer to the [v7 migration guide](./docs/v7-migration.md).
If you're targetting v8, please refer to the [v8 migration guide](./docs/v8-migration.md).
## Guiding principles
This library follows the [Guiding Principles of AlgoKit](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md#guiding-principles).
## Contributing
This is an open source project managed by the Algorand Foundation. See the [AlgoKit contributing page](https://github.com/algorandfoundation/algokit-cli/blob/main/CONTRIBUTING.md) to learn about making improvements.
To successfully run the tests in this repository you need to be running LocalNet via [AlgoKit](https://github.com/algorandfoundation/algokit-cli) and also have package dependencies and `.env.template` copied to `.env` (both of which `algokit bootstrap all` can do for you):
```
algokit bootstrap all
algokit localnet start
```
To run tests you can use VS Code, or:
```
npm run test
```