kalypso-cli
kalypso-cli is a prompt based command line tool to interact with components in kalypso. You can refer this section to build it from source code.
Common Operation done using CLI
| Name | Description |
|---|---|
| Register | Register a new operator on Kalypso Marketplace |
| Join Marketplace | Join a new marketplace on Kalypso. Operator must have 'Register'ed before joining the market |
| Request To Leave Marketplace | Request Kalypso To Leave Marketplace. If there are no requests, the operator will automatically exit. Otherwise, the operator will have to call 'Leave Marketplace' later |
| Leave Marketplace | Leave Marketplace |
| Create Marketplace | Create a new marketplace in Kalypso |
| Compute PCRs | Compute PCRs of a given enclave from its attestation server/attestation utility |
| Read Attestation | Read the attestation of the enclave from its attestation server |
| Non-Confidential Market PCRS | Get PCRs for non-confidential market |
| Claim Rewards | Claim accumulated rewards |
| Native Stake | Stake Your Own Tokens |
| Create Proof Request (non confidential market) | Create a proof request for a non-confidential market |
| Create Proof Request (confidential market) | Create a proof request for a confidential market. Private Inputs in this market are shared with TEE directly and ensured that they don't go on-chain |
| Discard Request | Discard your own request using Request ID |
| Whitelist Prover Image | Whitelist Prover Image/PCRs for a market |
| Whitelist IVS Image | Whitelist IVS Image/PCRs for a market |
| Update Encryption Key | Update Encryption Key for confidential markets |
| Add IVS Key | Adds IVS Enclave key and registers respective keys with the market |
| Read Proof Bytes | Read Proof Bytes using Kalypso data indexer |
| Read Stake Data | Read Stake Data across Native and Symbiotic Staking modules |
| Request Symbiotic Stake | Request delegation from Symbiotic |
| Set Kalypso Delegatee Address | Set Symbiotic Delegate Address |
| Load Generator Config | Load config in confidential generator. (Only works in testnet right now) |
| Start Enclave Program | Starts a program inside enclave |
| Stop Enclave Program | Stop a program inside enclave |
| Test Enclave Connection | Test Enclave Connection |
| Benchmark Prover | Get Benchmark results of prover |
| Symbiotic Operator Register | Register Operator on Symbiotic Network |
| Update Market Metadata | Update the Market Related data. It reads info from marketmeta.json and updates in the marketplace. Operation can be only performed by admin |
| Update Generator Metadata | Update the generator info in the registry. It reads info from generatormeta.json and updates in the generator registry. Operation can be performed only by relevant operator |
| Check Symbiotic Registration Info | Checks whether the operator is registered on Symbiotic |
| Check Symbiotic Optin Info | Checks whether operator has opted into vaults and networks |
| Read Rewards Info | Read accumulated rewards |
| Read Native Staking Pending Withdrawals | Reads Native Staking pending withdrawals |
| Request Native Stake Withdrawal | Create a withdrawal request on Native Staking Module |
| Process Withdrawal Requests | Complete Withdrawal Request. Withdraws amount present in all withdrawal requests |
| Start Matching Engine | Starts the Matching Engine Enclave |
| Stop Matching Engine | Stops the Matching Engine Enclave |
| Load Matching Engine Config | Securely load the matching engine config into matching engine |
| Set Matching Engine Image | Set matching engine image. (Only by address that has UPDATER role) |
| Verify Matching Engine Keys | Verify Matching Engine Keys. (Only by address that has UPDATER role) |
| Verify Remote Attestation | Verify Remote Attestation Locally against given PCRS |
| Check Role Management | Check role managements in different contracts |
Common terms used in CLI
| Field | Prompt | Secret | Env Var |
|---|---|---|---|
| address_to_check_role_for | Enter address to check role for | false | CHECK_ROLE_FOR |
| private_key | Enter your private key | true | PRIVATE_KEY |
| rpc_url | Enter RPC URL | false | RPC_URL |
| chain_id | Enter Chain ID | false | CHAIN_ID |
| market_id | Enter Market ID | false | MARKET_ID |
| generator_registry | Enter Generator Registry Contract Address | false | GENERATOR_REGISTRY_ADDRESS |
| proof_marketplace | Enter Proof Marketplace Contract Address | false | PROOF_MARKETPLACE_ADDRESS |
| symbiotic_staking | Enter Symbiotic Staking Contract Address | false | SYMBIOTIC_STAKING_ADDRESS |
| symbiotic_staking_reward | Enter Symbiotic Staking Reward Contract Address | false | SYMBIOTIC_STAKING_REWARD_ADDRESS |
| entity_registry | Enter Entity Key Registry Contract Address | false | ENTITY_KEY_REGISTRY_ADDRESS |
| reward_address | Enter Reward Address | false | REWARD_ADDRESS |
| declared_compute | Enter compute you wish to provide | false | DECLARED_COMPUTE |
| compute_per_request | Enter compute your machine requires per request | false | COMPUTE_PER_REQUEST |
| proof_generation_cost | Enter proof generation cost per request | false | PROOF_GENERATION_COST |
| proposed_time | Enter Maximum Time in which you can submit the proof | false | PROPOSED_TIME |
| staking_token | Enter the staking token address | false | STAKING_TOKEN |
| payment_token | Enter the payment token address | false | PAYMENT_TOKEN |
| enclave_image_id | Enter the enclave pcrs pcrs | false | ENCLAVE_IMAGE_ID |
| prover_image_id | Enter the prover image pcrs | false | PROVER_IMAGE_PCRS |
| verification_image_id | Enter the input_verification image pcrs | false | IVS_IMAGE_PCRS |
| matching_engine_image_id | Enter the matching_engine image pcrs | false | MATCHING_ENGINE_IMAGE_PCRS |
| verifier_wrapper | Enter Proof Verifier Contract Address (refer to Kalypso Standard Wrapper Contract) | false | VERIFIER_WRAPPER_ADDRESS |
| attestation_server_url | Enter Attestation Server URL | false | ATTESTATION_UTILITY_URL |
| attestation_verifier_url | Enter Attestation VERIFIER URL | false | ATTESTATION_VERIFIER_URL |
| staking_amount | Enter the amount to stake (or) withdraw | false | STAKING_AMOUNT |
| native_staking | Enter Native Staking Contract Address | false | NATIVE_STAKING_ADDRESS |
| staking_manager | Enter Staking Manager Contract Address | false | STAKING_MANAGER_ADDRESS |
| operator_address | Enter Operator Address on Kalypso | false | OPERATOR_ADDRESS |
| max_proof_generation_cost | Enter Maximum number of payments token to pay | false | MAX_PROOF_GENERATION_COST |
| max_proof_generation_time | Enter Maximum Proof Generation Time you can wait for proof to be generated | false | MAX_PROOF_GENERATION_TIME |
| inputs | Enter public inputs in hex string. Don't share any secret information in this prompt | false | INPUTS |
| private_inputs | Enter private inputs in hex string | true | PRIVATE_INPUTS |
| ask_id | Enter BID ID/ Request ID | false | BID_ID |
| enclave_client_url | Enter enclave client URL | false | ENCLAVE_CLIENT_URL |
| display_name | Enter Display Name | false | DISPLAY_NAME |
| display_description | A brief description of the generator | false | DESCRIPTION |
| website | Website | false | WEBSITE |
| false | |||
| symbiotic_rpc_url | RPC URL of the chain on which symbiotic exists | false | SYMBIOTIC_RPC_URL |
| symbiotic_chain_id | Chain Id of the chain on which symbiotic exists | false | SYMBIOTIC_CHAIN_ID |
| vault_opt_in_service | Address of the symbiotic vault opt in contract | false | VAULT_OPT_IN_SERVICE |
| middleware_service | Address of the middleware contract | false | MIDDLEWARE_SERVICE |
| network_opt_in_service | Address of the symbiotic network opt in contract | false | NETWORK_OPT_IN_SERVICE |
| vault_address | Address of the vault to opt in | false | VAULT_ADDRESS |
| network_address | Address of the network to opt in | false | NETWORK_ADDRESS |
| indexer_url | Enter the URL or kalypso indexer | false | INDEXER_URL |
| generator_client_url | Generator Client URL | false | GENERATOR_CLIENT_URL |
| gas_key | Enter gas key. This key will be used to spend gas on chain | true | GAS_KEY |
| start_block | Enter Start from which the operations should start | false | START_BLOCK |
| attestation_verifier | Enter Attestation Verifier Contract Address | false | ATTESTATION_VERIFIER_ADDRESS |
| internal_prover_port | Internal Port number on which proving server is running. It depends on market to market | false | INTERNAL_PROVER_PORT |
| input_verification_url | Enter input verification enclave URL. This url helps prover determine whether given inputs are valid using IVS service | false | INPUT_VERIFICATION_URL |
| prover_program_name | name of the program to start in the enclave | false | PROVER_PROGRAM_NAME |
| benchmark_url | Enter url of the server that does benchmarking and returns benchmark result | false | BENCHMARK_URL |
| symbiotic_operator_registry | Enter Symbiotic Operator Registry | false | SYMBIOTIC_OPERATOR_REGISTRY |
| operator_commission | Enter operator-commission. [0 (0%)- 1000000000000000000 (100%)] | false | OPERATOR_COMMISSION |
| matching_engine_client_url | Enter matching engine client url | false | MATCHING_ENGINE_CLIENT_URL |
| matching_engine_attestation_utility | Enter matching engine attestation utility URL | false | MATCHING_ENGINE_ATTESTATION_UTILITY_URL |
warning
In the "Secret" column, true indicates that the field contains sensitive information