Albus CLI
Command-line interface (CLI) v.0.0.1 for interacting with Albus program endpoints.
Usage
pnpm cli [option(s)] [command]-V, --version: outputs the current version number
-c, --cluster <CLUSTER>: sets a Solana cluster (mainnet-beta, testnet or devnet; default: devnet)
-k, --keypair <PATH_TO_KEYPAIR>: sets a file path or URL to a keypair (default: ~/.config/solana/id.json)
-1, --log-level <LOGGING_LEVEL>: sets sets a logging level (info, error, or warn; default: info)
-h, --help: displays information about the command
Default Values
Default values can be set or changed in an .env file via the following environmental variables:
CLI_SOLANA_CLUSTER=[value]CLI_SOLANA_KEYPAIR=[value]CLI_LOG_LEVEL=[value]
Usage Example
Running
admin sp add:
Running
admin sp addwith-hto view arguments:
Commands
Identity
Create an identity and store it as NFT. It identifies the NFT holder as the Albus holder and stores its state:
Verifiable Credentials (VC)
Show all VCs:
Issue a VC and store it as NFT. The VC is encrypted with the NFT holder's pubkey:
Proof Generation
Generate a ZK proof based on a corresponding circuit, and store it as NFT:
Generate a ZK proof for a specific proof request, and store it as NFT:
Verification
Verify a ZK proof:
Verify a proof request, and change the status to "verified" or "rejected" depending on the output:
Circuit Management
Register a new circuit:
Web3 Protocol Management
Register a Web3 protocol:
Remove a Web3 protocol:
Show Web3 protocol info:
Show all Web3 protocols with optional filters:
Proof Request Management
Create a proof request:
Delete a proof request:
Show a proof request based on its program derived address (PDA):
Find and show a proof request based on a Web3 protocol's PDA, circuit NFT's mint address, and/or proof request owner's address:
Show all proof requests with optional filters by service provider's PDA, circuit NFT's mint address, and/or ZKP NFT's mint address:
Last updated