Credential schema module (cs)
Generated from veranad --help of version v0.10.6 by scripts/gen-cli-reference.sh. Every transaction below executes on behalf of a corporation and is signed by an authorized operator; see the message catalog for the signer model and the surface that normally sends each message.
veranad tx cs
archive
Set the archive status of a credential schema. Use true to archive, false to unarchive
Usage:
veranad tx cs archive [id] [archive] [flags]
Flags:
-a, --account-number uint The account number of the signing account (offline mode only)
--aux Generate aux signer data instead of sending a tx
-b, --broadcast-mode string Transaction broadcasting mode (sync|async) (default "sync")
--chain-id string The network chain ID
--corporation account address or key name
--dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
--fee-granter string Fee granter grants fees for the transaction
--fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer
--fees string Fees to pay along with transaction; eg: 10uatom
--from string Name or address of private key with which to sign
--gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000)
--gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1)
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-h, --help help for archive
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--ledger Use a connected Ledger device
--node string <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
--note string Note to add a description to the transaction (previously --memo)
--offline Offline mode (does not allow any online functionality)
-o, --output string Output format (text|json) (default "json")
-s, --sequence uint The sequence number of the signing account (offline mode only)
--sign-mode string Choose sign mode (direct|amino-json|direct-aux|textual), this is an advanced feature
--timeout-duration duration TimeoutDuration is the duration the transaction will be considered valid in the mempool. The transaction's unordered nonce will be set to the time of transaction creation + the duration value passed. If the transaction is still in the mempool, and the block time has passed the time of submission + TimeoutDuration, the transaction will be rejected.
--timeout-height uint DEPRECATED: Please use --timeout-duration instead. Set a block timeout height to prevent the tx from being committed past a certain height
--tip string Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator
--unordered Enable unordered transaction delivery; must be used in conjunction with --timeout-duration
-y, --yes Skip tx broadcasting prompt confirmation
create-credential-schema
Create a new credential schema with the specified parameters. The JSON schema supports placeholder replacement:
- VPR_CREDENTIAL_SCHEMA_ID: Replaced with the generated schema ID
- VPR_CHAIN_ID: Replaced with the current chain ID
Required Parameters:
- ecosystem-id: Ecosystem ID (must be controlled by authority)
- json-schema: Path to JSON schema file or inline JSON string
- issuer-mode: Issuer onboarding mode (1=OPEN, 2=ECOSYSTEM_ONBOARDING_PROCESS, 3=GRANTOR_ONBOARDING_PROCESS)
- verifier-mode: Verifier onboarding mode (same options as issuer-mode)
- holder-onboarding-mode: Holder onboarding mode (1=ISSUER_ONBOARDING_PROCESS, 2=PERMISSIONLESS)
- pricing-asset-type: Asset type for business fees (1=TU, 2=COIN, 3=FIAT)
- pricing-asset: Asset identifier ("tu" for TU, denom for COIN, ISO-4217 code for FIAT)
- digest-algorithm: Algorithm for credential digest (sha384, sha512)
Required Flags (default to 0 days, 0 means never expires):
- --issuer-grantor-validation-validity-period: Validation period for issuer grantors (days, default: 0)
- --verifier-grantor-validation-validity-period: Validation period for verifier grantors (days, default: 0)
- --issuer-validation-validity-period: Validation period for issuers (days, default: 0)
- --verifier-validation-validity-period: Validation period for verifiers (days, default: 0)
- --holder-validation-validity-period: Validation period for holders (days, default: 0)
Example:
$ veranad tx cs create-credential-schema 1 schema.json 2 2 1 1 tu sha384 --issuer-grantor-validation-validity-period 365 --verifier-grantor-validation-validity-period 365
$ veranad tx cs create-credential-schema 1 schema.json 2 2 2 2 uvna sha384
Usage:
veranad tx cs create-credential-schema [ecosystem-id] [json-schema] [issuer-mode] [verifier-mode] [holder-onboarding-mode] [pricing-asset-type] [pricing-asset] [digest-algorithm] [flags]
Flags:
-a, --account-number uint The account number of the signing account (offline mode only)
--aux Generate aux signer data instead of sending a tx
-b, --broadcast-mode string Transaction broadcasting mode (sync|async) (default "sync")
--chain-id string The network chain ID
--corporation account address or key name
--dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
--fee-granter string Fee granter grants fees for the transaction
--fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer
--fees string Fees to pay along with transaction; eg: 10uatom
--from string Name or address of private key with which to sign
--gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000)
--gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1)
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-h, --help help for create-credential-schema
--holder-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for holders in days (default: 0)
--issuer-grantor-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for issuer grantors in days (default: 0)
--issuer-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for issuers in days (default: 0)
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--ledger Use a connected Ledger device
--node string <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
--note string Note to add a description to the transaction (previously --memo)
--offline Offline mode (does not allow any online functionality)
-o, --output string Output format (text|json) (default "json")
-s, --sequence uint The sequence number of the signing account (offline mode only)
--sign-mode string Choose sign mode (direct|amino-json|direct-aux|textual), this is an advanced feature
--timeout-duration duration TimeoutDuration is the duration the transaction will be considered valid in the mempool. The transaction's unordered nonce will be set to the time of transaction creation + the duration value passed. If the transaction is still in the mempool, and the block time has passed the time of submission + TimeoutDuration, the transaction will be rejected.
--timeout-height uint DEPRECATED: Please use --timeout-duration instead. Set a block timeout height to prevent the tx from being committed past a certain height
--tip string Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator
--unordered Enable unordered transaction delivery; must be used in conjunction with --timeout-duration
--verifier-grantor-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for verifier grantors in days (default: 0)
--verifier-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for verifiers in days (default: 0)
-y, --yes Skip tx broadcasting prompt confirmation
update
Update the validity periods of an existing credential schema.
Required Flags (default to 0 days, 0 means never expires):
- --issuer-grantor-validation-validity-period: Validation period for issuer grantors (days, default: 0)
- --verifier-grantor-validation-validity-period: Validation period for verifier grantors (days, default: 0)
- --issuer-validation-validity-period: Validation period for issuers (days, default: 0)
- --verifier-validation-validity-period: Validation period for verifiers (days, default: 0)
- --holder-validation-validity-period: Validation period for holders (days, default: 0)
Example:
$ veranad tx cs update 1 --issuer-validation-validity-period 365 --verifier-validation-validity-period 180
Usage:
veranad tx cs update [id] [flags]
Flags:
-a, --account-number uint The account number of the signing account (offline mode only)
--aux Generate aux signer data instead of sending a tx
-b, --broadcast-mode string Transaction broadcasting mode (sync|async) (default "sync")
--chain-id string The network chain ID
--corporation account address or key name
--dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
--fee-granter string Fee granter grants fees for the transaction
--fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer
--fees string Fees to pay along with transaction; eg: 10uatom
--from string Name or address of private key with which to sign
--gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000)
--gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1)
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-h, --help help for update
--holder-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for holders in days (default: 0)
--issuer-grantor-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for issuer grantors in days (default: 0)
--issuer-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for issuers in days (default: 0)
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--ledger Use a connected Ledger device
--node string <host>:<port> to CometBFT rpc interface for this chain (default "tcp://localhost:26657")
--note string Note to add a description to the transaction (previously --memo)
--offline Offline mode (does not allow any online functionality)
-o, --output string Output format (text|json) (default "json")
-s, --sequence uint The sequence number of the signing account (offline mode only)
--sign-mode string Choose sign mode (direct|amino-json|direct-aux|textual), this is an advanced feature
--timeout-duration duration TimeoutDuration is the duration the transaction will be considered valid in the mempool. The transaction's unordered nonce will be set to the time of transaction creation + the duration value passed. If the transaction is still in the mempool, and the block time has passed the time of submission + TimeoutDuration, the transaction will be rejected.
--timeout-height uint DEPRECATED: Please use --timeout-duration instead. Set a block timeout height to prevent the tx from being committed past a certain height
--tip string Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator
--unordered Enable unordered transaction delivery; must be used in conjunction with --timeout-duration
--verifier-grantor-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for verifier grantors in days (default: 0)
--verifier-validation-validity-period verana.cs.v1.OptionalUInt32 (json) Validation period for verifiers in days (default: 0)
-y, --yes Skip tx broadcasting prompt confirmation
veranad query cs
get-schema
Get a credential schema by its ID.
Example:
$ veranad query cs get 1
Usage:
veranad query cs get-schema [id] [flags]
Flags:
--grpc-addr string the gRPC endpoint to use for this chain
--grpc-insecure allow gRPC over insecure channels, if not the server must use TLS
--height int Use a specific height to query state at (this can error if the node is pruning state)
-h, --help help for get-schema
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--no-indent Do not indent JSON output
--node string <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
-o, --output string Output format (text|json) (default "text")
list-schemas
List credential schemas with optional filters.
Example:
$ veranad query cs list-schemas
$ veranad query cs list-schemas --ecosystem_id 1 --modified_after 2024-01-01T00:00:00Z --response_max_size 100
Usage:
veranad query cs list-schemas [flags]
Flags:
--ecosystem_id uint Filter by ecosystem ID
--grpc-addr string the gRPC endpoint to use for this chain
--grpc-insecure allow gRPC over insecure channels, if not the server must use TLS
--height int Use a specific height to query state at (this can error if the node is pruning state)
-h, --help help for list-schemas
--holder-onboarding-mode HolderOnboardingMode (unspecified | issuer-onboarding-process | permissionless) (default unspecified)
--issuer-onboarding-mode IssuerOnboardingMode (unspecified | open | ecosystem-onboarding-process | grantor-onboarding-process) (default unspecified)
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--modified_after timestamp (RFC 3339) Show schemas modified after this datetime (RFC3339 format)
--no-indent Do not indent JSON output
--node string <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
--only-active
-o, --output string Output format (text|json) (default "text")
--response_max_size uint32 Maximum number of results (1-1024, default 64)
--verifier-onboarding-mode VerifierOnboardingMode (unspecified | open | ecosystem-onboarding-process | grantor-onboarding-process) (default unspecified)
params
Shows the parameters of the module
Usage:
veranad query cs params [flags]
Flags:
--grpc-addr string the gRPC endpoint to use for this chain
--grpc-insecure allow gRPC over insecure channels, if not the server must use TLS
--height int Use a specific height to query state at (this can error if the node is pruning state)
-h, --help help for params
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--no-indent Do not indent JSON output
--node string <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
-o, --output string Output format (text|json) (default "text")
render-json-schema
Render the JSON schema definition for a credential schema.
Response will be in application/schema+json format.
Example:
$ veranad query cs schema 1
Usage:
veranad query cs render-json-schema [id] [flags]
Flags:
--grpc-addr string the gRPC endpoint to use for this chain
--grpc-insecure allow gRPC over insecure channels, if not the server must use TLS
--height int Use a specific height to query state at (this can error if the node is pruning state)
-h, --help help for render-json-schema
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "os")
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--no-indent Do not indent JSON output
--node string <host>:<port> to CometBFT RPC interface for this chain (default "tcp://localhost:26657")
-o, --output string Output format (text|json) (default "text")