opact-sdk v1.2.0

Opact

What is Opact Protocol

OPACT is a privacy layer application on top of multiple different blockchains.

Developers in those blockchains can use OPACT to integrate privacy features in their application

The SDK

The SDK provides abstranctions to implement the opact privacy system.

Guidelines

• Use the present tense ("Add feature" not "Added feature") and the imperative mood ("Move class to..." not "Moves class to...") on commits and use the name issue on pull requests.
• Pull requests must be reviewed before merged.
• Done is better than perfect. Does it work as expected? Ship now, iterate later.
• All contributions must have tests. Remember to verify the Github Actions CI status.
• Every commit is checked using Github Actions.
• If the CI status are not passing, the deploy will not work.

Coding Style

• Typescript: https://github.com/airbnb/javascript

Task Management

• GitHub Issues is used to track all tasks that needed to be done.
• Opact board is used to get a decent look on what's going on wright now.
• Every two weeks all done tasks are put together in a Milestone and the current Sprint is closed.
• Issues Board: https://github.com/orgs/hack-a-chain-software/projects/5

Directory Structure

Here's a brief overview of the SDK structure:

├── .github
│   └── CI              # CI Workflow: validate TS and check all tests 
├── src
│   └── Batch           # The Batch module provides solutions for composing transactions related to withdrawals or deposits.
│   └── Constants       # The Constants module includes essential utilities such as base token definitions, and constants for Merkle tree.
│   └── Encryption      # The Encryption module offers solutions for encryption tasks, including functions for both decryption and encryption.
│   └── Kadena          # The Kadena module: provides solutions for interacting with the Kadena blockchain like: creating deposit and withdrawal transactions
│   └── Keys            # The Keys module offers key derivation solutions to generate wallets compatible with opact protocol
│   └── Merkle-tree     # The Merkle Tree module provides solutions and services for constructing a valid Merkle tree by retrieving each leaf from the indexer
│   └── Proof           # The Proof module provides solutions to assist in generating proofs for the Opact circuit
│   └── Receipts        # The Receipts module: offers solutions for the creation and encryption of receipts
│   └── Storage         # The Storage module provides services for managing cached data, such as persisting wallet login or caching UTXOs
│   └── Utxo            # The UTXO module provides solutions for creating UTXOs essential for utilizing the Opact protocol
├── package.json

Installation

Opact Protocol is powered by Hack-a-chain.

Steps

1) Clone the repository:

$ gh repo clone hack-a-chain-software/kadena-product
$ cd kadena-product

2) Check all packages and copy the .env.example file and edit it with your environment config:

$ cp ./front/.env.example ./front/.env

3) Install frontend dependencies via PNPM

$ pnpm install

3) Run tests

$ pnpm test