oasisprotocol/Oasis ROFL

A framework that enables offchain computation with private data and verifiable results

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
cli_versionOasis CLI version to install. Options: - "auto" (default): Read version from rofl.yaml tooling.version field - "latest": Use the latest release from GitHub - Specific version (e.g., "0.18.0"): Use exact version noauto
check_updatesRun 'oasis rofl upgrade' to check for artifact updates (runtime, compose, etc). If updates are found and create_update_pr is true, a PR will be created. nofalse
create_update_prCreate a pull request if rofl.yaml changes are detected after running upgrade. Requires check_updates: true and GITHUB_TOKEN with write permissions. nofalse
configGlobal CLI config file to useno
deploymentDeployment name (defaults to default)no
encryptedEncrypt transaction call data (requires online mode)nofalse
fee_denomOverride fee denomination (defaults to native)no
forceForce deploymentnofalse
formatTransaction output format, one of [json, cbor] (defaults to json)no
gas_limitGas limit to useno
gas_priceGas price to useno
machineMachine nameno
networkNetwork to usenomainnet
no_containerDo not use the containerized buildernofalse
no_update_manifestDo not update the manifestnofalse
update_manifestAllow updating rofl.yaml with new enclave IDs after build (skips verification). WARNING: For testing only. Production deployments should commit enclave IDs to source control and use the default verify behavior. nofalse
nonceExplicitly set transaction nonceno
offerOffer nameno
offlineDo not perform any operations requiring network accessnofalse
only_validateValidate without buildingnofalse
outputOutput bundle filenameno
output_fileOutput transaction into specified file instead of broadcastingno
providerProvider nameno
replace_machineRent a new machine if the provided one expirednofalse
show_offersShow all provider offers and quitnofalse
termTerm to pay for in advance [hour, month, year]no
term_countNumber of terms to pay for in advanceno
unsignedDo not sign transactionnofalse
verboseVerbose outputnofalse
verifyVerify build against manifest and on-chain statenofalse
wallet_accountOasis CLI account to use for wallet operations (defaults to test:alice for offline/unsigned mode)notest:alice
wallet_algorithmCryptographic algorithm to use for wallet , one of [ed25519-adr8, ed25519-raw, secp256k1-bip44, secp256k1-raw, sr25519-adr8, sr25519-raw]no
wallet_importRun wallet import before build (true/false)nofalse
wallet_numberKey number to use in the key derivation scheme for wallet importno
wallet_secretSecret for wallet import. Format depends on wallet_algorithm: - Mnemonic algorithms (ed25519-adr8, secp256k1-bip44, sr25519-adr8): BIP-39 phrase - Raw algorithms (ed25519-raw, secp256k1-raw, sr25519-raw): Private key hex no
wipe_storageWhether to wipe machine storagenofalse
working_directoryDirectory to run all ROFL commands inno
skip_buildSkip the ROFL build stepnofalse
skip_updateSkip the ROFL update stepnofalse
skip_deploySkip the ROFL deploy stepnofalse
update_output_fileOutput file for update transaction (instead of broadcasting)no
deploy_output_fileOutput file for deploy transaction (instead of broadcasting)no
safe_addressSafe multisig contract addressno
safe_proposer_keyPrivate key for Safe transaction proposerno
safe_rpc_urlRPC URL for the chain where Safe is deployed (auto-detected from network if not specified)no
safe_service_urlSafe transaction service URL (auto-detected from network if not specified)no
safe_chain_idChain ID for Safe transactions (auto-detected from network if not specified)no
safe_dry_runDry run mode for Safe proposal. Runs all steps (CBOR parsing, subcall generation, transaction creation, signing) but does NOT submit to the Safe service. Useful for testing the Safe integration without actually proposing. nofalse
namedescription
build_outputPath to the built ROFL ORC bundle
update_filePath to the generated update transaction file
deploy_filePath to the generated deploy transaction file
safe_tx_hashHash of the proposed Safe transaction
update_pr_urlURL of the created pull request (when check_updates and create_update_pr are enabled)
updates_availableWhether updates are available for rofl.yaml ('true' or 'false')