Skip to content

bwmx/algo-scarf

Repository files navigation

Algo Scarf

Description

A general smart contract and utility library for Algorand TypesScript (puya-ts). Designed to provide a set of extendable contracts with consistent, predictable behaviors and generic utility libraries to reduce boilerplate code.

This project has been generated using AlgoKit. See below for default getting started instructions.

Installation

You can install the package directly from GitHub, expect frequent breaking changes during development. This library should not be used in production.

npm install --save-dev algo-scarf

Documentation

Read full documentation here

Local Development and Testing

Clone the repo:

git clone https://github.com/bwmx/algo-scarf

Install dependencies:

npm install

Start AlgoKit localnet:

algokit localnet start

Run tests:

npm run test

Contributing

Feel free to make a pull request. I will try to implement useful functionality when possible but any contributions to the projectare greatly appreciated.

Credits

Some other libraries and projects that provide references and inspired this one:

  1. OpenZeppelin contracts
  2. Folks Finance Python Library
  3. Solady

About

Algorand TypeScript library for smart contract development. Work in progress!

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •