Core Framework Encryption Service + Proxy server - with a Cryptonote twist
Find a file
google-labs-jules[bot] 21d1c4fb5e docs: Enhance README and add future improvements log
This commit enhances the `README.md` file with more detailed information about the project, including a usage example and a development philosophy section. It also adds a new file, `.ideas/future_improvements.md`, to log out-of-scope ideas for future development.
2025-10-30 23:12:44 +00:00
.dataset Switching machines, ffmpeg + readable byte stream 2022-01-24 07:43:24 +00:00
.github docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
.ideas docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
.run Switching machines, ffmpeg + readable byte stream 2022-01-24 07:43:24 +00:00
chachapoly docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
lthn docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
vault docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
.gitignore docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
crypt.go docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
crypt_test.go docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
DISCLAIMER.md 42 2022-01-23 21:49:14 +00:00
go.mod docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
go.work docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00
LICENCE Create LICENCE 2022-01-23 13:07:49 +00:00
README.md docs: Enhance README and add future improvements log 2025-10-30 23:12:44 +00:00

Enchantrix

Enchantrix is a modern encryption library for the Web3 era, designed to provide a secure and easy-to-use framework for handling sensitive data. It will feature Poly-ChaCha stream proxying and a custom .trix file format for encrypted data.

Getting Started

To get started with Enchantrix, you'll need to have Go installed. You can then run the tests using the following command:

go test ./...

Development Philosophy

This project follows a strict Test-Driven Development (TDD) methodology. All new functionality must be accompanied by a comprehensive suite of tests. We also leverage AI tools to accelerate development and ensure code quality.

Usage

Here's a quick example of how to use the ChaCha20-Poly1305 encryption:

package main

import (
	"fmt"
	"log"

	"github.com/Snider/Enchantrix/chachapoly"
)

func main() {
	key := make([]byte, 32)
	for i := range key {
		key[i] = 1
	}

	plaintext := []byte("Hello, world!")
	ciphertext, err := chachapoly.Encrypt(plaintext, key)
	if err != nil {
		log.Fatalf("Failed to encrypt: %v", err)
	}

	decrypted, err := chachapoly.Decrypt(ciphertext, key)
	if err != nil {
		log.Fatalf("Failed to decrypt: %v", err)
	}

	fmt.Printf("Decrypted message: %s\n", decrypted)
}

Contributing

We welcome contributions! Please feel free to submit a pull request or open an issue.