/froglin

Collect and trade location-based game built on Aztec's Zero-Knowledge blockchain

Primary LanguageTypeScriptMIT LicenseMIT

cover_image

Introduction

Welcome to froglin, a mysterious universe hiding treasures and friends within!

Froglins are strange creatures which can be found all around us. They exist solely in cryptography terms, and you can befriend them through the use of Zero-Knowledge Proofs.

This repo is the Froglin game source code.


Contents



Setup

This project is based on a Linux development environment.
The setup instructions are equivalent for macOS.
If you're using Windows, you'll need to install WSL first.

In support of the development process, the following prerequisites are used:


Clone repository

git clone https://github.com/ZeroK-Labs/froglin

Install all dependencies (prerequistites and packages)

sudo chmod +x scripts/prerequisites/setup.sh

scripts/prerequisites/setup.sh

After the script completes successfully run

bun dev

to start webpack, a tailwindcss watcher for changes to CSS style files, and the aztec-sandbox.


Available Tasks


Install dependencies (packages only)

bun i

Report outdated packages

bun packages:report

Update all packages to their latest (fixed) versions

bun packages:update

Build contracts typescript and JSON ABIs

bun aztec:build

In-memory typescript project transpilation (for error checking)

typescript:compile

Start aztec-sandbox only

bun aztec:start

Start webpack server

bun webpack:start

Start everything concurrently

bun dev

Run tests

bun test



Project Organization

configuration


scripts

  • push_staging.sh - replaces the remote staging branch with the contents and history of the branch currently checked out

  • update.sh - updates all packages in package.json to their latest versions



  • tests - Bun tests

    • prep - env loader for all tests



Contributing

Get in touch with the owners via Noir Discord to be added as a collaborator.

Use the hashtag froglin.