@studiowebux/cardano-vault@0.0.1

Built and signed on GitHub Actions

Built and signed on GitHub Actions

About

Objective: This is an experimental project aiming to leverage PGP for creating a simple, secure vault system as part of my learning experience.

Components:

• Database: Postgres Database to store cardano wallets encrypted using PGP Keys.
• Cardano Wallets: To sign transaction seamlessly from the backend. (seamless transaction signing without requiring users to interact with blockchain technology directly)
• PGP Cold Backup Keys: To have a way in case the customer forgot the PIN associated with its PGP key.
• PGP Hot Customer Key: To encrypt cardano wallet at rest.
• PGP Hot Operation Key: Key to encrypt and store the Customer PGP keys at rest.

Installation and Usage

1. Install deno: https://deno.com
2. deno add @studiowebux/cardano-vault
3. See the flow.test.ts test for the proposed flow to use this library.

see __tests__/*.test.ts. To run the tests, you need to copy the .env.example to .env (no need to replace the default information)

Releases and Github Actions

git tag -a X.Y.Z -m "Version X.Y.Z"
git push origin tags/X.Y.Z

Contributing

1. Fork the project
2. Create a Feature Branch
3. Commit your changes
4. Push your changes
5. Create a PR

git checkout -b <feature|fix|release|chore|hotfix>/prefix-name

git fetch origin
git rebase origin/master

git add .
git commit -m "<feat|ci|test|docs|build|chore|style|refactor|perf|BREAKING CHANGE>: commit message"

git push origin <feature|fix|release|chore|hotfix>/prefix-name

git checkout -b release/v1.15.5
git checkout -b feature/abc-123-something-awesome
git checkout -b hotfix/abc-432-something-bad-to-fix

git commit -m "docs: added awesome documentation"
git commit -m "feat: added new feature"
git commit -m "test: added tests"

License

Distributed under the MIT License. See LICENSE for more information.

Contact

• Tommy Gingras @ tommy@studiowebux.com | Studio Webux

| | Webux Lab |