README
¶
Galactica Guardian CLI
The Galactica Guardian CLI is a powerful command-line interface designed for guardians in the Galactica blockchain ecosystem. Guardians play a pivotal role in verifying and managing user data on the blockchain. The CLI provides essential tools for tasks such as certificate issuance, revocation, renewal, and more.
Installation
To install the Galactica Guardian CLI, run the following command:
go install github.com/galactica-corp/guardians-sdk/cmd/galactica-guardian@latest
Ensure that your Go environment is properly configured before running the installation command.
Usage
Once installed, you can use the Galactica Guardian CLI to perform various tasks. The CLI provides several commands to
manage certificates, interact with the blockchain, and handle key operations. Each command supports the --help flag
for detailed information and usage guidelines.
The CLI requires the Merkle Proof Service for issuing and revoking Zero Knowledge Certificates. Ensure that this service is running and accessible to perform these operations.
Commands Overview
generateEdDSAKeyPair: Generate EdDSA key pairs for managing zero knowledge certificates.createZKCert: Create a Zero Knowledge Certificate (ZKCert) for on-chain verification.issueZKCert: Issue a ZKCert to the Galactica blockchain registry.revokeZKCert: Revoke a ZKCert from the Galactica blockchain registry.renewZKCert: Renew a ZKCert with an updated expiration date.encryptZKCert: Encrypt a ZKCert with a holder's encryption key.printEdDSAPublicKey: Print EdDSA public key for a given private key.
License
This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the LICENSE file for details.
Happy guarding in the Galactica ecosystem!
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
pkg
|
|
|
contracts
Package contracts provides a set of abstractions and utilities for interacting with Ethereum smart contracts, specifically the ones that are required for type-safe blockchain interaction in this SDK.
|
Package contracts provides a set of abstractions and utilities for interacting with Ethereum smart contracts, specifically the ones that are required for type-safe blockchain interaction in this SDK. |
|
encryption
Package encryption provides functionalities for secure message encryption using the NaCl (Networking and Cryptography library) authenticated encryption scheme.
|
Package encryption provides functionalities for secure message encryption using the NaCl (Networking and Cryptography library) authenticated encryption scheme. |
|
keymanagement
Package keymanagement provides utilities for managing cryptographic keys, specifically focusing on EdDSA (Poseidon hash over BN128 elliptic curve signature scheme) keys derived from Ethereum private keys.
|
Package keymanagement provides utilities for managing cryptographic keys, specifically focusing on EdDSA (Poseidon hash over BN128 elliptic curve signature scheme) keys derived from Ethereum private keys. |
|
merkle
Package merkle provides functionality for creating and manipulating Merkle trees, with a focus on efficient and secure verification of data integrity.
|
Package merkle provides functionality for creating and manipulating Merkle trees, with a focus on efficient and secure verification of data integrity. |
|
zkcertificate
Package zkcertificate provides a comprehensive framework for managing zero-knowledge certificates.
|
Package zkcertificate provides a comprehensive framework for managing zero-knowledge certificates. |