mirror of
https://github.com/sonr-io/sonr.git
synced 2026-08-03 01:41:44 +00:00
Prad Nukala
@@ -0,0 +1,191 @@
|
||||
---
|
||||
title: "Migrating from Centralized to Decentralized Authentication"
|
||||
description: "A comprehensive guide to migrating from centralized 8787 endpoints to decentralized OIDC authentication with WebAuthn"
|
||||
sidebarTitle: "Decentralized Authentication"
|
||||
icon: "key"
|
||||
---
|
||||
|
||||
# Migrating from Centralized to Decentralized Authentication
|
||||
|
||||
## Overview
|
||||
|
||||
Sonr is transitioning from a centralized authentication model using 8787 endpoints to a fully decentralized, privacy-preserving authentication system leveraging OpenID Connect (OIDC), Self-Issued OpenID Provider (SIOP), and WebAuthn technologies.
|
||||
|
||||
### Key Improvements
|
||||
|
||||
- **Decentralization**: Move from centralized identity management to self-sovereign identity
|
||||
- **WebAuthn Integration**: Hardware-backed, phishing-resistance authentication
|
||||
- **Gasless Onboarding**: Zero-cost user registration and transactions
|
||||
- **Automatic Vault Creation**: Seamless user experience with instant identity setup
|
||||
- **Enhanced Privacy**: DID-based authentication with verifiable presentations
|
||||
|
||||
## Architecture Comparison
|
||||
|
||||
### Old Architecture: Centralized 8787 Endpoints
|
||||
|
||||
- Centralized authentication server
|
||||
- Fixed credential storage
|
||||
- Limited authentication methods
|
||||
- Higher security risks
|
||||
|
||||
### New Architecture: Decentralized OIDC Provider
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A[User Device] --> B{WebAuthn Registration}
|
||||
B --> |Credential Generation| C[Blockchain Bridge]
|
||||
C --> |Broadcast Credential| D[Sonr Blockchain]
|
||||
D --> |Create DID| E[User's Decentralized Identity]
|
||||
E --> |SIOP Flow| F[OIDC Provider]
|
||||
F --> |Verifiable Presentation| G[Service Provider]
|
||||
```
|
||||
|
||||
## Migration Steps
|
||||
|
||||
### 1. Prerequisites
|
||||
|
||||
- Go 1.24.1+
|
||||
- Cosmos SDK v0.50.14
|
||||
- WebAuthn-compatible browser/device
|
||||
- Updated Sonr SDK
|
||||
|
||||
### 2. Configuration Changes
|
||||
|
||||
#### Environment Variables
|
||||
|
||||
<CodeGroup>
|
||||
```bash title="Old Configuration"
|
||||
# Centralized auth endpoints
|
||||
AUTH_ENDPOINT=https://8787.sonr.io/auth
|
||||
AUTH_CLIENT_ID=legacy-client-id
|
||||
```
|
||||
|
||||
```bash title="New Configuration"
|
||||
# Decentralized OIDC configuration
|
||||
OIDC_PROVIDER_URL=https://oidc.sonr.network
|
||||
WEBAUTHN_ORIGIN=https://your-app.com
|
||||
DID_RESOLVER_URL=https://did.sonr.network
|
||||
```
|
||||
|
||||
</CodeGroup>
|
||||
|
||||
### 3. Endpoint Migration
|
||||
|
||||
| Old Endpoint | New Endpoint | Changes |
|
||||
| ---------------- | -------------------- | ----------------------- |
|
||||
| `/auth/login` | `/oidc/authorize` | OIDC authorization flow |
|
||||
| `/auth/register` | `/webauthn/register` | WebAuthn registration |
|
||||
| `/auth/token` | `/oidc/token` | Token issuance via SIOP |
|
||||
|
||||
### 4. API Changes
|
||||
|
||||
#### Request Format
|
||||
|
||||
<CodeGroup>
|
||||
```json title="Legacy Request"
|
||||
{
|
||||
"username": "user@example.com",
|
||||
"password": "legacy-password"
|
||||
}
|
||||
```
|
||||
|
||||
```json title="New WebAuthn Request"
|
||||
{
|
||||
"challenge": "base64-encoded-challenge",
|
||||
"attestation": {
|
||||
"type": "public-key",
|
||||
"id": "credential-id",
|
||||
"rawId": "base64-encoded-raw-credential",
|
||||
"response": {
|
||||
"clientDataJSON": "...",
|
||||
"attestationObject": "..."
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</CodeGroup>
|
||||
|
||||
### 5. WebAuthn Integration
|
||||
|
||||
#### Registration Flow
|
||||
|
||||
1. Generate registration challenge
|
||||
2. Create WebAuthn credential
|
||||
3. Broadcast credential to blockchain
|
||||
4. Automatically create user vault
|
||||
5. Issue decentralized identifier (DID)
|
||||
|
||||
#### Code Example
|
||||
|
||||
```go title="WebAuthn Registration Handler"
|
||||
func (s *Server) HandleWebAuthnRegistration(w http.ResponseWriter, r *http.Request) {
|
||||
// 1. Validate WebAuthn attestation
|
||||
credential, err := s.webAuthnService.VerifyRegistration(attestationData)
|
||||
|
||||
// 2. Broadcast to blockchain
|
||||
didDoc, err := s.blockchainBridge.CreateDID(credential)
|
||||
|
||||
// 3. Create user vault
|
||||
vault, err := s.vaultService.CreateVault(didDoc)
|
||||
|
||||
// 4. Issue OIDC token
|
||||
token := s.oidcService.IssueToken(didDoc)
|
||||
}
|
||||
```
|
||||
|
||||
### 6. SIOP (Self-Issued OpenID Provider)
|
||||
|
||||
#### Key Concepts
|
||||
|
||||
- Verifiable Presentations
|
||||
- Decentralized Identifiers (DIDs)
|
||||
- User-controlled authentication
|
||||
|
||||
### 7. Error Handling
|
||||
|
||||
#### Migration Errors
|
||||
|
||||
| Error Code | Description | Mitigation |
|
||||
| ------------------------ | ---------------------- | -------------------- |
|
||||
| `AUTH_LEGACY_DEPRECATED` | Legacy auth method | Upgrade client |
|
||||
| `WEBAUTHN_UNSUPPORTED` | Device incompatibility | Use alternative auth |
|
||||
| `DID_RESOLUTION_FAILED` | Identity verification | Retry registration |
|
||||
|
||||
### 8. Testing Migration
|
||||
|
||||
```bash
|
||||
# Validate WebAuthn registration
|
||||
sonr webauthn test-registration
|
||||
|
||||
# Verify OIDC provider
|
||||
sonr oidc validate-provider
|
||||
|
||||
# Check DID resolution
|
||||
sonr did resolve did:sonr:example
|
||||
```
|
||||
|
||||
### 9. Breaking Changes
|
||||
|
||||
- Legacy password authentication removed
|
||||
- Token format changed to JWT with DID claims
|
||||
- New client libraries required
|
||||
- WebAuthn mandatory for registration
|
||||
|
||||
## Rollback Procedure
|
||||
|
||||
If issues arise:
|
||||
|
||||
1. Maintain legacy user mappings
|
||||
2. Provide fallback authentication
|
||||
3. Gradual, opt-in migration
|
||||
|
||||
## Conclusion
|
||||
|
||||
This migration represents a significant leap in authentication security and user privacy. By adopting WebAuthn, SIOP, and blockchain-backed identities, we're creating a more robust, user-controlled authentication ecosystem.
|
||||
|
||||
## Support
|
||||
|
||||
- [Sonr Developer Docs](/docs)
|
||||
- [WebAuthn Specification](https://www.w3.org/TR/webauthn-2/)
|
||||
- [OIDC Community](https://openid.net/developers/specs/)
|
||||
@@ -0,0 +1,129 @@
|
||||
---
|
||||
title: "DID Generation and Management"
|
||||
description: "Learn how to generate and manage Decentralized Identifiers (DIDs) using advanced crypto interfaces"
|
||||
sidebarTitle: "Identity Generation"
|
||||
icon: "signature"
|
||||
---
|
||||
|
||||
# DID Generation Patterns
|
||||
|
||||
The Sonr project provides a robust and flexible DID (Decentralized Identifier) generation system supporting multiple key types and cryptographic methods.
|
||||
|
||||
## Supported Key Types
|
||||
|
||||
The `didkey.go` interface supports the following key types:
|
||||
|
||||
- RSA Public Keys
|
||||
- Ed25519 Public Keys
|
||||
- Secp256k1 Public Keys
|
||||
|
||||
## Basic DID Generation
|
||||
|
||||
### Creating a DID from a Public Key
|
||||
|
||||
```go
|
||||
import (
|
||||
"github.com/libp2p/go-libp2p/core/crypto"
|
||||
"github.com/sonr-io/sonr/crypto/keys"
|
||||
)
|
||||
|
||||
// Generate a new key pair
|
||||
privateKey, publicKey, err := crypto.GenerateKeyPair(crypto.Ed25519, -1)
|
||||
|
||||
// Create a DID
|
||||
did, err := keys.NewDID(publicKey)
|
||||
```
|
||||
|
||||
### Parsing an Existing DID
|
||||
|
||||
```go
|
||||
// Parse a DID string
|
||||
did, err := keys.Parse("did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGTsyDFWYviJr4")
|
||||
```
|
||||
|
||||
## Advanced DID Operations
|
||||
|
||||
### Address Derivation
|
||||
|
||||
```go
|
||||
// Get a blockchain-compatible address from a DID
|
||||
address, err := did.Address()
|
||||
```
|
||||
|
||||
### Compressed Public Key Retrieval
|
||||
|
||||
```go
|
||||
// Get a compressed public key (for Secp256k1)
|
||||
compressedPubKey, err := did.CompressedPubKey()
|
||||
```
|
||||
|
||||
## MPC Enclave DID Generation
|
||||
|
||||
For MPC (Multi-Party Computation) enclaves, use a specialized method:
|
||||
|
||||
```go
|
||||
// Create a DID from MPC enclave public key bytes
|
||||
did, err := keys.NewFromMPCPubKey(enclavePublicKeyBytes)
|
||||
```
|
||||
|
||||
## DID Validation
|
||||
|
||||
```go
|
||||
// Validate a DID format
|
||||
err := keys.ValidateFormat("did:key:example123")
|
||||
```
|
||||
|
||||
## Multicodec Support
|
||||
|
||||
The library supports various multicodec prefixes for different key types:
|
||||
|
||||
- RSA: `0x1205`
|
||||
- Ed25519: `0xed`
|
||||
- Secp256k1: `0xe7`
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- Always generate keys using cryptographically secure methods
|
||||
- Validate DIDs before using them in critical operations
|
||||
- Use the appropriate key type for your security requirements
|
||||
|
||||
## Example: Complete DID Workflow
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/libp2p/go-libp2p/core/crypto"
|
||||
"github.com/sonr-io/sonr/crypto/keys"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// Generate a new key pair
|
||||
privateKey, publicKey, err := crypto.GenerateKeyPair(crypto.Ed25519, -1)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
// Create a DID
|
||||
did, err := keys.NewDID(publicKey)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
// Get the DID string
|
||||
didString := did.String()
|
||||
fmt.Println("Generated DID:", didString)
|
||||
|
||||
// Derive blockchain address
|
||||
address, err := did.Address()
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
fmt.Println("Blockchain Address:", address)
|
||||
}
|
||||
```
|
||||
|
||||
## Compatibility and Interoperability
|
||||
|
||||
The Sonr DID implementation follows the W3C DID specification, ensuring broad compatibility with other decentralized identity systems.
|
||||
@@ -0,0 +1,155 @@
|
||||
---
|
||||
title: "DWN Plugin Architecture"
|
||||
description: "Deep dive into the Decentralized Web Node (DWN) plugin system and integration"
|
||||
sidebarTitle: "WASM Architecture"
|
||||
icon: "puzzle"
|
||||
---
|
||||
|
||||
# DWN Plugin Architecture
|
||||
|
||||
The Sonr project implements a flexible and secure plugin system for Decentralized Web Nodes (DWN), enabling modular and extensible functionality.
|
||||
|
||||
## Overview
|
||||
|
||||
The plugin architecture is designed to:
|
||||
|
||||
- Support dynamic loading of WebAssembly (WASM) plugins
|
||||
- Provide a standardized interface for plugin interactions
|
||||
- Enable secure, isolated execution of plugins
|
||||
|
||||
## Core Components
|
||||
|
||||
### Plugin Manager
|
||||
|
||||
The `PluginManager` manages plugin lifecycle and interactions:
|
||||
|
||||
```go
|
||||
type PluginManager struct {
|
||||
plugins map[string]Plugin
|
||||
actors map[string]Actor
|
||||
}
|
||||
|
||||
type Plugin interface {
|
||||
Initialize(config map[string]any) error
|
||||
Execute(method string, payload []byte) ([]byte, error)
|
||||
Close() error
|
||||
}
|
||||
```
|
||||
|
||||
### Plugin Configuration
|
||||
|
||||
Plugins are configured through a structured configuration:
|
||||
|
||||
```go
|
||||
type PluginConfig struct {
|
||||
ID string // Unique plugin identifier
|
||||
Type string // Plugin type (e.g., "motor", "crypto")
|
||||
Path string // WASM module path
|
||||
Environment map[string]any // Plugin-specific environment variables
|
||||
}
|
||||
```
|
||||
|
||||
## Loading and Initializing Plugins
|
||||
|
||||
### Basic Plugin Loading
|
||||
|
||||
```go
|
||||
func (pm *PluginManager) LoadPlugin(config PluginConfig) error {
|
||||
// Load WASM module
|
||||
module, err := extism.Load(config.Path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Initialize plugin
|
||||
plugin := &WASMPlugin{
|
||||
module: module,
|
||||
config: config,
|
||||
}
|
||||
|
||||
// Store in plugin registry
|
||||
pm.plugins[config.ID] = plugin
|
||||
}
|
||||
```
|
||||
|
||||
### Actor-Based Plugin Management
|
||||
|
||||
```go
|
||||
func (pm *PluginManager) CreateActor(pluginID string) (*Actor, error) {
|
||||
plugin, exists := pm.plugins[pluginID]
|
||||
if !exists {
|
||||
return nil, errors.New("plugin not found")
|
||||
}
|
||||
|
||||
actor := NewActor(plugin)
|
||||
pm.actors[actor.ID] = actor
|
||||
|
||||
return actor, nil
|
||||
}
|
||||
```
|
||||
|
||||
## Plugin Execution Workflow
|
||||
|
||||
1. Plugin is loaded from WASM module
|
||||
2. Configuration is applied
|
||||
3. Plugin is initialized
|
||||
4. Specific methods can be invoked through a standardized interface
|
||||
|
||||
### Example Plugin Execution
|
||||
|
||||
```go
|
||||
func ExecutePluginMethod(pluginID, method string, payload []byte) ([]byte, error) {
|
||||
plugin := pluginManager.plugins[pluginID]
|
||||
return plugin.Execute(method, payload)
|
||||
}
|
||||
```
|
||||
|
||||
## Configuration and Environment
|
||||
|
||||
### Plugin Environment Variables
|
||||
|
||||
```json
|
||||
{
|
||||
"motor_plugin": {
|
||||
"enclave_config": { ... },
|
||||
"chain_id": "sonr-testnet-1",
|
||||
"log_level": "debug"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Error Handling and Logging
|
||||
|
||||
```go
|
||||
type PluginError struct {
|
||||
Code string
|
||||
Message string
|
||||
Details map[string]any
|
||||
}
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- WASM plugins run in an isolated sandbox
|
||||
- Limited access to system resources
|
||||
- Runtime restrictions prevent malicious behavior
|
||||
- Cryptographic verification of plugin modules
|
||||
|
||||
## Plugin Types
|
||||
|
||||
1. **Crypto Plugins**: Cryptographic operations
|
||||
2. **Motor Plugins**: MPC and token management
|
||||
3. **DID Plugins**: Decentralized Identity operations
|
||||
4. **Custom Plugins**: Application-specific extensions
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Keep plugins small and focused
|
||||
- Use standardized interfaces
|
||||
- Implement comprehensive error handling
|
||||
- Validate all plugin inputs
|
||||
- Monitor plugin performance
|
||||
|
||||
## Advanced Configuration
|
||||
|
||||
For advanced plugin configuration and deployment, refer to the [PDK Configuration Guide](/blockchain/modules/dwn/configuration).
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Delegated Proof of Stake (DPoS)
|
||||
description: A decentralized, secure, and efficient consensus mechanism.
|
||||
---
|
||||
|
||||
Sonr leverages a Delegated Proof of Stake (DPoS) mechanism to optimize network security and user participation. DPoS imposes an opportunity cost for malicious behavior through slashing, but it also presents challenges that must be addressed for a sustainable design.
|
||||
|
||||
## Challenges in Staking Mechanisms
|
||||
|
||||
- **Token Value**: The token must have intrinsic value to incentivize staking.
|
||||
- **Wealth Concentration**: Staking can give an outsized advantage to wealthy users.
|
||||
- **Coordination Problems**: Staking mechanisms can be gamed by coordinated actors.
|
||||
|
||||
## Sonr's Approach to DPoS
|
||||
|
||||
We have designed our staking mechanism to address these challenges and create a sustainable and equitable system:
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Low Barrier to Entry">
|
||||
The upfront capital required to stake is designed to not significantly
|
||||
discourage participation.
|
||||
</Card>
|
||||
<Card title="Slashing for Malice">
|
||||
If a stakeholder group makes decisions that materially harm the network,
|
||||
their stake is slashed.
|
||||
</Card>
|
||||
<Card title="Incentivizing Positive Growth">
|
||||
Stakeholders can make decisions that positively impact the future network
|
||||
health and token price, promoting long-term growth.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Network Architecture
|
||||
description: A detailed look at Sonr's three-tier system design.
|
||||
---
|
||||
|
||||
Our incorporation of embedded light nodes signifies a strategic move towards enhancing network robustness and efficiency. These nodes operate with a reduced resource footprint, ensuring a widespread and seamless network distribution. They form the bedrock of the infrastructure, interfacing directly with a series of validators. These validators are pivotal in maintaining the integrity and trustworthiness of the network, each playing an instrumental role in processing transactions and securing the network's protocol.
|
||||
|
||||
## Blockchain Services
|
||||
|
||||
Blockchain Services are instrumental in ensuring seamless interoperability and data exchange across the network.
|
||||
|
||||
<CardGroup>
|
||||
<Card title="IBC Relayer">
|
||||
The IBC Relayer stands at the forefront of inter-blockchain communication,
|
||||
enabling different blockchain protocols to transfer and share information
|
||||
effectively.
|
||||
</Card>
|
||||
<Card title="IPFS/Libp2p Routing">
|
||||
IPFS/Libp2p Routing underpins the decentralized routing of information,
|
||||
ensuring resilient and scalable data distribution across the network.
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Interoperability Protocols
|
||||
|
||||
The overarching network architecture is designed with interoperability at its core, integrating protocols such as Matrix and Pinecone to facilitate communication and data exchange across disparate systems.
|
||||
|
||||
- **Matrix Protocol**: A new paradigm in secure, decentralized communication.
|
||||
- **Pinecone Routing**: A novel approach to establishing network pathways, enhancing the efficiency and reliability of data transmission.
|
||||
@@ -0,0 +1,238 @@
|
||||
---
|
||||
title: "WebAuthn Integration"
|
||||
description: "Comprehensive guide to Sonr's WebAuthn/FIDO2 implementation for passwordless authentication"
|
||||
icon: "key"
|
||||
sidebarTitle: "WebAuthn Integration"
|
||||
---
|
||||
|
||||
<Note>
|
||||
This documentation covers the WebAuthn implementation in the Sonr blockchain,
|
||||
providing a secure, passwordless authentication mechanism through
|
||||
W3C-compliant WebAuthn protocols.
|
||||
</Note>
|
||||
|
||||
## Overview
|
||||
|
||||
Sonr's WebAuthn implementation enables gasless onboarding and secure transaction authorization without requiring users to hold tokens initially. This document provides a comprehensive guide to understanding and using our WebAuthn client.
|
||||
|
||||
## Architecture
|
||||
|
||||
<Frame>
|
||||
<img
|
||||
src="https://cdn.sonr.io/diagrams/passkey-jwt.png"
|
||||
alt="WebAuthn Architecture Diagram"
|
||||
/>
|
||||
</Frame>
|
||||
|
||||
The WebAuthn implementation is structured across three primary layers:
|
||||
|
||||
1. **Client Layer** (`client/auth/webauthn.go`)
|
||||
|
||||
- WebAuthnClient interface
|
||||
- Registration and Authentication flows
|
||||
- DID integration
|
||||
|
||||
2. **Internal WebAuthn Package** (`internal/webauthn/`)
|
||||
|
||||
- COSE key parsing
|
||||
- CBOR encoding/decoding
|
||||
- Attestation verification
|
||||
- Signature verification (ES256/RS256)
|
||||
|
||||
3. **DID Module Layer** (`x/did/keeper/`)
|
||||
- WebAuthn controller verifier
|
||||
- Credential storage in DID documents
|
||||
- Challenge generation and validation
|
||||
|
||||
## API Reference
|
||||
|
||||
### WebAuthnClient Interface
|
||||
|
||||
<CodeGroup>
|
||||
```go
|
||||
type WebAuthnClient interface {
|
||||
// Registration Operations
|
||||
BeginRegistration(ctx context.Context, opts *RegistrationOptions) (*RegistrationChallenge, error)
|
||||
CompleteRegistration(ctx context.Context, challenge *RegistrationChallenge, response *AuthenticatorAttestationResponse) (*WebAuthnCredential, error)
|
||||
|
||||
// Authentication Operations
|
||||
BeginAuthentication(ctx context.Context, opts *AuthenticationOptions) (*AuthenticationChallenge, error)
|
||||
CompleteAuthentication(ctx context.Context, challenge *AuthenticationChallenge, response *AuthenticatorAssertionResponse, credentialID string) (*AuthenticationResult, error)
|
||||
|
||||
// Credential Management Methods...
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### Registration Flow
|
||||
|
||||
<CodeGroup>
|
||||
```go Registration Example
|
||||
func registerWebAuthn() error {
|
||||
client := auth.NewWebAuthnClient()
|
||||
ctx := context.Background()
|
||||
|
||||
// Begin registration
|
||||
regOpts := &auth.RegistrationOptions{
|
||||
UserID: "user123",
|
||||
Username: "alice@example.com",
|
||||
DisplayName: "Alice Smith",
|
||||
UserVerification: "preferred",
|
||||
}
|
||||
|
||||
challenge, err := client.BeginRegistration(ctx, regOpts)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Complete registration
|
||||
response := &auth.AuthenticatorAttestationResponse{
|
||||
ClientDataJSON: clientDataJSON,
|
||||
AttestationObject: attestationObject,
|
||||
}
|
||||
|
||||
credential, err := client.CompleteRegistration(ctx, challenge, response)
|
||||
return err
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
### Authentication Flow
|
||||
|
||||
<CodeGroup>
|
||||
```go Authentication Example
|
||||
func authenticateWebAuthn(credentialID string) error {
|
||||
client := auth.NewWebAuthnClient()
|
||||
ctx := context.Background()
|
||||
|
||||
// Begin authentication
|
||||
authOpts := &auth.AuthenticationOptions{
|
||||
UserVerification: "required",
|
||||
AllowedCredentials: []*auth.CredentialDescriptor{
|
||||
{
|
||||
Type: "public-key",
|
||||
ID: []byte(credentialID),
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
challenge, err := client.BeginAuthentication(ctx, authOpts)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Complete authentication
|
||||
response := &auth.AuthenticatorAssertionResponse{
|
||||
ClientDataJSON: clientDataJSON,
|
||||
AuthenticatorData: authenticatorData,
|
||||
Signature: signature,
|
||||
UserHandle: userHandle,
|
||||
}
|
||||
|
||||
result, err := client.CompleteAuthentication(ctx, challenge, response, credentialID)
|
||||
return err
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## Security Considerations
|
||||
|
||||
### Supported Algorithms
|
||||
|
||||
<Tabs>
|
||||
<Tab title="ES256">ECDSA with P-256 curve and SHA-256</Tab>
|
||||
<Tab title="RS256">RSASSA-PKCS1-v1_5 with SHA-256</Tab>
|
||||
</Tabs>
|
||||
|
||||
### Attestation Formats
|
||||
|
||||
<Callout type="info">
|
||||
1. **none**: No attestation (development/testing) 2. **packed**:
|
||||
Self-attestation or certificate chain 3. **fido-u2f**: Legacy U2F
|
||||
authenticators 4. **android-safetynet**: Android device attestation
|
||||
</Callout>
|
||||
|
||||
### Security Features
|
||||
|
||||
- **Challenge uniqueness**: Each challenge is unique and time-bound
|
||||
- **Origin validation**: Ensures requests come from trusted origins
|
||||
- **User verification**: Requires biometric or PIN when configured
|
||||
- **Counter tracking**: Detects cloned credentials
|
||||
- **Credential isolation**: Each DID has separate credential namespace
|
||||
|
||||
## Configuration
|
||||
|
||||
### Chain Parameters
|
||||
|
||||
<CodeGroup>
|
||||
```json Configuration Example
|
||||
{
|
||||
"webauthn": {
|
||||
"rp_id": "sonr.io",
|
||||
"rp_name": "Sonr Network",
|
||||
"timeout": 60000,
|
||||
"user_verification": "preferred",
|
||||
"attestation": "none",
|
||||
"allowed_origins": [
|
||||
"https://sonr.io",
|
||||
"https://app.sonr.io"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
<Accordion title="Common WebAuthn Issues">
|
||||
- **"Invalid attestation format"**: Ensure authenticator supports the
|
||||
configured format - **"Challenge mismatch"**: Verify challenge hasn't expired
|
||||
- **"Origin validation failed"**: Check allowed origins list - **"User
|
||||
verification required"**: Ensure authenticator supports verification
|
||||
</Accordion>
|
||||
|
||||
## Contributing
|
||||
|
||||
### Development Setup
|
||||
|
||||
<CodeGroup>
|
||||
```bash Setup Commands
|
||||
# Clone repository
|
||||
git clone https://github.com/sonr-io/sonr.git
|
||||
|
||||
# Install dependencies
|
||||
|
||||
make install
|
||||
|
||||
# Run WebAuthn tests
|
||||
|
||||
make test-webauthn
|
||||
|
||||
```
|
||||
</CodeGroup>
|
||||
|
||||
## References
|
||||
|
||||
<Card
|
||||
title="WebAuthn Specifications"
|
||||
icon="link"
|
||||
href="https://www.w3.org/TR/webauthn/"
|
||||
>
|
||||
Official W3C WebAuthn Specification
|
||||
</Card>
|
||||
|
||||
<Card
|
||||
title="FIDO2 CTAP"
|
||||
icon="lock"
|
||||
href="https://fidoalliance.org/specs/fido-v2.0/"
|
||||
>
|
||||
FIDO2 Client to Authenticator Protocol
|
||||
</Card>
|
||||
|
||||
## License
|
||||
|
||||
Copyright 2024 Sonr Inc. Licensed under the Apache License, Version 2.0.
|
||||
```
|
||||
|
||||
@@ -0,0 +1,132 @@
|
||||
---
|
||||
title: snrd
|
||||
description: The Sonr blockchain daemon (server) command
|
||||
---
|
||||
|
||||
# snrd
|
||||
|
||||
The main command for running and interacting with the Sonr blockchain node.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `auth` | User authentication with Passkeys |
|
||||
| `comet` | CometBFT subcommands |
|
||||
| `config` | Utilities for managing application configuration |
|
||||
| `debug` | Tool for helping with debugging your application |
|
||||
| `export` | Export state to JSON |
|
||||
| `genesis` | Application's genesis-related subcommands |
|
||||
| `gov` | Governance utilities |
|
||||
| `help` | Help about any command |
|
||||
| `index-eth-tx` | Index historical eth txs |
|
||||
| `init` | Initialize private validator, p2p, genesis, and application configuration files |
|
||||
| `keys` | Manage your application's keys |
|
||||
| `prune` | Prune app history states by keeping the recent heights and deleting old heights |
|
||||
| `query` | Querying subcommands |
|
||||
| `rollback` | Rollback Cosmos SDK and CometBFT state by one height |
|
||||
| `snapshots` | Manage local snapshots |
|
||||
| `start` | Run the full node |
|
||||
| `status` | Query remote node for status |
|
||||
| `tx` | Transactions subcommands |
|
||||
| `version` | Print the application binary version information |
|
||||
| `wallet` | Wallet operations |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction (e.g., 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g., 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="boolean">
|
||||
Help for snrd
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="~/.sonr">
|
||||
Directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="boolean">
|
||||
Disable colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="boolean">
|
||||
Print out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Start a node
|
||||
|
||||
```shell
|
||||
snrd start
|
||||
```
|
||||
|
||||
### Query node status
|
||||
|
||||
```shell
|
||||
snrd status
|
||||
```
|
||||
|
||||
### Initialize a new node
|
||||
|
||||
```shell
|
||||
snrd init my-node --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
### Get help for any command
|
||||
|
||||
```shell
|
||||
snrd [command] --help
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd auth](./snrd_auth.mdx) - User authentication with Passkeys
|
||||
- [snrd genesis](./snrd_genesis.mdx) - Genesis-related subcommands
|
||||
- [snrd init](./snrd_init.mdx) - Initialize node configuration
|
||||
- [snrd keys](./snrd_keys.mdx) - Manage application keys
|
||||
- [snrd query](./snrd_query.mdx) - Query blockchain state
|
||||
- [snrd tx](./snrd_tx.mdx) - Submit transactions
|
||||
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: snrd auth
|
||||
description: User authentication with Passkeys
|
||||
---
|
||||
|
||||
# snrd auth
|
||||
|
||||
Manage user authentication using WebAuthn/Passkey technology for decentralized identity.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd auth [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `login` | Login with WebAuthn authentication |
|
||||
| `register` | Register a new identity using WebAuthn |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="boolean">
|
||||
Help for auth
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction (e.g., 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
Adjustment factor to be multiplied against the estimate returned by the tx simulation
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g., 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="~/.sonr">
|
||||
Directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="boolean">
|
||||
Disable colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
Tendermint RPC interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="boolean">
|
||||
Print out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Register a new identity
|
||||
|
||||
```shell
|
||||
snrd auth register --username alice
|
||||
```
|
||||
|
||||
### Login with existing identity
|
||||
|
||||
```shell
|
||||
snrd auth login --username alice
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd auth register](./snrd_auth_register.mdx) - Register a new identity using WebAuthn
|
||||
- [snrd auth login](./snrd_auth_login.mdx) - Login with WebAuthn authentication
|
||||
@@ -0,0 +1,117 @@
|
||||
---
|
||||
title: snrd auth register
|
||||
description: Register a new decentralized identity using WebAuthn/Passkey authentication
|
||||
---
|
||||
|
||||
# snrd auth register
|
||||
|
||||
Register a new decentralized identity using WebAuthn/Passkey authentication.
|
||||
|
||||
This command will:
|
||||
1. Start a local auth server
|
||||
2. Open your browser for WebAuthn credential creation
|
||||
3. Create a DID document with your WebAuthn credential
|
||||
4. Auto-create a DWN vault for data storage
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd auth register [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="username" type="string" required>
|
||||
Username for the new identity
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="auto-vault" type="boolean" default="true">
|
||||
Automatically create vault for DID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="webauthn" type="boolean" default="true">
|
||||
Use WebAuthn for registration
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="boolean">
|
||||
Help for register
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction (e.g., 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
Adjustment factor to be multiplied against the estimate returned by the tx simulation
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g., 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="~/.sonr">
|
||||
Directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="boolean">
|
||||
Disable colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
Tendermint RPC interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="boolean">
|
||||
Print out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic registration
|
||||
|
||||
```shell
|
||||
snrd auth register --username alice
|
||||
```
|
||||
|
||||
### Registration without auto vault creation
|
||||
|
||||
```shell
|
||||
snrd auth register --username alice --auto-vault=false
|
||||
```
|
||||
|
||||
### Registration with custom chain ID
|
||||
|
||||
```shell
|
||||
snrd auth register --username alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd auth](./snrd_auth.mdx) - User authentication with Passkeys
|
||||
- [snrd auth login](./snrd_auth_login.mdx) - Login with WebAuthn authentication
|
||||
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: snrd genesis
|
||||
description: Application's genesis-related subcommands
|
||||
---
|
||||
|
||||
# snrd genesis
|
||||
|
||||
Application's genesis-related subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd genesis [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd genesis [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `add-genesis-account` | Add a genesis account to genesis.json |
|
||||
| `collect-gentxs` | Collect genesis txs and output a genesis.json file |
|
||||
| `gentx` | Generate a genesis tx carrying a self delegation |
|
||||
| `migrate` | Migrate genesis to a specified target version |
|
||||
| `validate` | Validates the genesis file at the default location or at the location passed as an arg |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for genesis
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd genesis
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,122 @@
|
||||
---
|
||||
title: snrd genesis add-genesis-account
|
||||
description: Add a genesis account to genesis.json. The provided account must specify
|
||||
---
|
||||
|
||||
# snrd genesis add-genesis-account
|
||||
|
||||
Add a genesis account to genesis.json. The provided account must specify
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd genesis add-genesis-account [address_or_key_name] [coin][,[coin]] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="append" type="string">
|
||||
the coins to an account already in the genesis.json file
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="grpc-addr" type="string">
|
||||
the gRPC endpoint to use for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="grpc-insecure" type="string">
|
||||
gRPC over insecure channels, if not the server must use TLS
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="height" type="integer">
|
||||
Use a specific height to query state at (this can error if the node is pruning state)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for add-genesis-account
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|kwallet|pass|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="module-name" type="string">
|
||||
module account name
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to CometBFT RPC interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="vesting-amount" type="string">
|
||||
amount of coins for vesting accounts
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="vesting-end-time" type="integer">
|
||||
schedule end time (unix epoch) for vesting accounts
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="vesting-start-time" type="integer">
|
||||
schedule start time (unix epoch) for vesting accounts
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Add account with initial coins
|
||||
|
||||
```shell
|
||||
snrd genesis add-genesis-account alice 1000000snr
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd genesis](./snrd_genesis.mdx) - Parent command
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: snrd genesis collect-gentxs
|
||||
description: Collect genesis txs and output a genesis.json file
|
||||
---
|
||||
|
||||
# snrd genesis collect-gentxs
|
||||
|
||||
Collect genesis txs and output a genesis.json file. This command iterates over all genesis transactions in the gentx directory and merges them into the genesis.json file.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd genesis collect-gentxs [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="gentx-dir" type="string">
|
||||
Override default "gentx" directory from which collect and execute genesis transactions; default [--home]/config/gentx/
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="boolean">
|
||||
Help for collect-gentxs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="~/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction (e.g., 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g., 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="boolean">
|
||||
Disable colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="boolean">
|
||||
Print out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Collect genesis transactions
|
||||
|
||||
```shell
|
||||
snrd genesis collect-gentxs
|
||||
```
|
||||
|
||||
### Collect from custom directory
|
||||
|
||||
```shell
|
||||
snrd genesis collect-gentxs --gentx-dir ./custom-gentx/
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd genesis](./snrd_genesis.mdx) - Genesis-related subcommands
|
||||
- [snrd genesis gentx](./snrd_genesis_gentx.mdx) - Generate a genesis tx carrying a self delegation
|
||||
- [snrd genesis add-genesis-account](./snrd_genesis_add-genesis-account.mdx) - Add a genesis account to genesis.json
|
||||
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: snrd genesis export
|
||||
description: Application's genesis-related subcommands
|
||||
---
|
||||
|
||||
# snrd genesis export
|
||||
|
||||
Application's genesis-related subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd genesis [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd genesis [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `add-genesis-account` | Add a genesis account to genesis.json |
|
||||
| `collect-gentxs` | Collect genesis txs and output a genesis.json file |
|
||||
| `gentx` | Generate a genesis tx carrying a self delegation |
|
||||
| `migrate` | Migrate genesis to a specified target version |
|
||||
| `validate` | Validates the genesis file at the default location or at the location passed as an arg |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for genesis
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd genesis export
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd genesis](./snrd_genesis.mdx) - Parent command
|
||||
@@ -0,0 +1,210 @@
|
||||
---
|
||||
title: snrd genesis gentx
|
||||
description: Generate a genesis transaction that creates a validator with a self-delegation,
|
||||
---
|
||||
|
||||
# snrd genesis gentx
|
||||
|
||||
Generate a genesis transaction that creates a validator with a self-delegation,
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd genesis gentx [key_name] [amount] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="account-number" type="string">
|
||||
The account number of the signing account (offline mode only)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="amount" type="string">
|
||||
Amount of coins to bond
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="aux" type="string">
|
||||
aux signer data instead of sending a tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="commission-max-change-rate" type="string">
|
||||
The maximum commission change rate percentage (per day)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="commission-max-rate" type="string">
|
||||
The maximum commission rate percentage
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="commission-rate" type="string">
|
||||
The initial commission rate percentage
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="details" type="string">
|
||||
The validator's (optional) details
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="dry-run" type="string">
|
||||
the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fee-granter" type="string">
|
||||
Fee granter grants fees for the transaction
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fee-payer" type="string">
|
||||
Fee payer pays fees for the transaction instead of deducting from the signer
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10uatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas" type="string" default="200000">
|
||||
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".
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="generate-only" type="string">
|
||||
an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for gentx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="identity" type="string">
|
||||
The (optional) identity signature (ex. UPort or Keybase)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="ip" type="string" default="192.168.1.203">
|
||||
The node's public P2P IP
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|kwallet|pass|test|memory)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="ledger" type="string">
|
||||
a connected Ledger device
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="min-self-delegation" type="string">
|
||||
The minimum self delegation required on the validator
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="moniker" type="string">
|
||||
The validator's (optional) moniker
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to CometBFT rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node-id" type="string">
|
||||
The node's NodeID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="note" type="string">
|
||||
Note to add a description to the transaction (previously --memo)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="offline" type="string">
|
||||
mode (does not allow any online functionality)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output-document" type="string">
|
||||
Write the genesis transaction JSON document to the given file instead of the default location
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="p2p-port" type="string" default="26656">
|
||||
The node's public P2P port
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="pubkey" type="string">
|
||||
The validator's Protobuf JSON encoded public key
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="security-contact" type="string">
|
||||
The validator's (optional) security contact email
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="sequence" type="string">
|
||||
The sequence number of the signing account (offline mode only)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="sign-mode" type="string">
|
||||
Choose sign mode (direct|amino-json|direct-aux|textual), this is an advanced feature
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="timeout-height" type="string">
|
||||
Set a block timeout height to prevent the tx from being committed past a certain height
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="tip" type="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
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="website" type="string">
|
||||
The validator's (optional) website
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="yes" type="string">
|
||||
tx broadcasting prompt confirmation
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Generate genesis transaction
|
||||
|
||||
```shell
|
||||
snrd genesis gentx alice 1000000snr --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd genesis](./snrd_genesis.mdx) - Parent command
|
||||
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: snrd genesis init
|
||||
description: Application's genesis-related subcommands
|
||||
---
|
||||
|
||||
# snrd genesis init
|
||||
|
||||
Application's genesis-related subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd genesis [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd genesis [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `add-genesis-account` | Add a genesis account to genesis.json |
|
||||
| `collect-gentxs` | Collect genesis txs and output a genesis.json file |
|
||||
| `gentx` | Generate a genesis tx carrying a self delegation |
|
||||
| `migrate` | Migrate genesis to a specified target version |
|
||||
| `validate` | Validates the genesis file at the default location or at the location passed as an arg |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for genesis
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd genesis init
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd genesis](./snrd_genesis.mdx) - Parent command
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: snrd genesis migrate
|
||||
description: Migrate the source genesis into the target version and print to STDOUT
|
||||
---
|
||||
|
||||
# snrd genesis migrate
|
||||
|
||||
Migrate the source genesis into the target version and print to STDOUT
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd genesis migrate [target-version] [genesis-file] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Override chain_id with this flag
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="genesis-time" type="string">
|
||||
Override genesis_time with this flag
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for migrate
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output-document" type="string">
|
||||
Exported state is written to the given file instead of STDOUT
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd genesis migrate
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd genesis](./snrd_genesis.mdx) - Parent command
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: snrd genesis validate
|
||||
description: Validates the genesis file at the default location or at the location passed as an arg
|
||||
---
|
||||
|
||||
# snrd genesis validate
|
||||
|
||||
Validates the genesis file at the default location or at the location passed as an arg
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd genesis validate [file] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for validate
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd genesis validate
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd genesis](./snrd_genesis.mdx) - Parent command
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: snrd help
|
||||
description: Help provides help for any command in the application.
|
||||
---
|
||||
|
||||
# snrd help
|
||||
|
||||
Help provides help for any command in the application.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd help [command] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for help
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd help
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
title: snrd init
|
||||
description: Initialize validators's and node's configuration files.
|
||||
---
|
||||
|
||||
# snrd init
|
||||
|
||||
Initialize validators's and node's configuration files.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd init [moniker] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
genesis file chain-id, if left blank will be randomly created
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="default-denom" type="string">
|
||||
genesis file default denomination, if left blank default value is 'stake'
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for init
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
node's home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="initial-height" type="integer" default="1">
|
||||
specify the initial block height at genesis
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="overwrite" type="string">
|
||||
the genesis.json file
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="recover" type="string">
|
||||
seed phrase to recover existing key instead of creating
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd init
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: snrd keys
|
||||
description: Keyring management commands. These keys may be in any format supported by the
|
||||
---
|
||||
|
||||
# snrd keys
|
||||
|
||||
Keyring management commands. These keys may be in any format supported by the
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd keys [command]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for keys
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd keys
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,158 @@
|
||||
---
|
||||
title: snrd keys add
|
||||
description: Derive a new private key and encrypt to disk.
|
||||
---
|
||||
|
||||
# snrd keys add
|
||||
|
||||
Derive a new private key and encrypt to disk.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd keys add <name> [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="account" type="integer">
|
||||
Account number for HD derivation (less than equal 2147483647)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="coin-type" type="integer" default="60">
|
||||
coin type number for HD derivation
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="dry-run" type="string">
|
||||
action, but don't add key to local keystore
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="hd-path" type="string">
|
||||
Manual HD Path derivation (overrides BIP44 config)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for add
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="index" type="integer">
|
||||
Address index number for HD derivation (less than equal 2147483647)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="interactive" type="string">
|
||||
prompt user for BIP39 passphrase and mnemonic
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="key-type" type="string" default="eth_secp256k1">
|
||||
Key signing algorithm to generate keys for
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="ledger" type="string">
|
||||
a local reference to a private key on a Ledger device
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="multisig" type="string">
|
||||
List of key names stored in keyring to construct a public legacy multisig key
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="multisig-threshold" type="integer" default="1">
|
||||
K out of N required signatures. For use in conjunction with --multisig
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="no-backup" type="string">
|
||||
print out seed phrase (if others are watching the terminal)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="nosort" type="string">
|
||||
passed to --multisig are taken in the order they're supplied
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="pubkey" type="string">
|
||||
Parse a public key in JSON format and saves key info to <name> file.
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="pubkey-base64" type="string">
|
||||
Parse a public key in base64 format and saves key info.
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="recover" type="string">
|
||||
seed phrase to recover existing key instead of creating
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="source" type="string">
|
||||
Import mnemonic from a file (only usable when recover or interactive is passed)
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Add new key
|
||||
|
||||
```shell
|
||||
snrd keys add alice
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd keys](./snrd_keys.mdx) - Parent command
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
title: snrd keys delete
|
||||
description: Delete keys from the Keybase backend.
|
||||
---
|
||||
|
||||
# snrd keys delete
|
||||
|
||||
Delete keys from the Keybase backend.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd keys delete <name>... [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="force" type="string">
|
||||
the key unconditionally without asking for the passphrase. Deprecated.
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for delete
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="yes" type="string">
|
||||
confirmation prompt when deleting offline or ledger key references
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd keys delete
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd keys](./snrd_keys.mdx) - Parent command
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
title: snrd keys export
|
||||
description: Export a private key from the local keyring in ASCII-armored encrypted format.
|
||||
---
|
||||
|
||||
# snrd keys export
|
||||
|
||||
Export a private key from the local keyring in ASCII-armored encrypted format.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd keys export <name> [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for export
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="unarmored-hex" type="string">
|
||||
unarmored hex privkey. Requires --unsafe.
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="unsafe" type="string">
|
||||
unsafe operations. This flag must be switched on along with all unsafe operation-specific options.
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd keys export
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd keys](./snrd_keys.mdx) - Parent command
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: snrd keys import
|
||||
description: Import a ASCII armored private key into the local keybase.
|
||||
---
|
||||
|
||||
# snrd keys import
|
||||
|
||||
Import a ASCII armored private key into the local keybase.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd keys import <name> <keyfile> [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for import
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd keys import
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd keys](./snrd_keys.mdx) - Parent command
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: snrd keys list
|
||||
description: Return a list of all public keys stored by this key manager
|
||||
---
|
||||
|
||||
# snrd keys list
|
||||
|
||||
Return a list of all public keys stored by this key manager
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd keys list [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for list
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="list-names" type="string">
|
||||
names only
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### List all keys
|
||||
|
||||
```shell
|
||||
snrd keys list
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd keys](./snrd_keys.mdx) - Parent command
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: snrd keys migrate
|
||||
description: Migrate keys from Amino to Protocol Buffers records.
|
||||
---
|
||||
|
||||
# snrd keys migrate
|
||||
|
||||
Migrate keys from Amino to Protocol Buffers records.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd keys migrate [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for migrate
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd keys migrate
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd keys](./snrd_keys.mdx) - Parent command
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: snrd keys parse
|
||||
description: Convert and print to stdout key addresses and fingerprints from
|
||||
---
|
||||
|
||||
# snrd keys parse
|
||||
|
||||
Convert and print to stdout key addresses and fingerprints from
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd keys parse <hex-or-bech32-address> [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for parse
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd keys parse
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd keys](./snrd_keys.mdx) - Parent command
|
||||
@@ -0,0 +1,114 @@
|
||||
---
|
||||
title: snrd keys show
|
||||
description: Display keys details. If multiple names or addresses are provided,
|
||||
---
|
||||
|
||||
# snrd keys show
|
||||
|
||||
Display keys details. If multiple names or addresses are provided,
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd keys show [name_or_address [name_or_address...]] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="address" type="string">
|
||||
the address only (cannot be used with --output)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="bech" type="string" default="acc">
|
||||
The Bech32 prefix encoding for a key (acc|val|cons)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="device" type="string">
|
||||
the address in a ledger device (cannot be used with --pubkey)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for show
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="multisig-threshold" type="integer" default="1">
|
||||
K out of N required signatures
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="pubkey" type="string">
|
||||
the public key only (cannot be used with --output)
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend (os|file|test)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-dir" type="string">
|
||||
The client Keyring directory; if omitted, the default 'home' directory will be used
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd keys show
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd keys](./snrd_keys.mdx) - Parent command
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: snrd migrate
|
||||
description: unknown command "migrate" for "snrd"
|
||||
---
|
||||
|
||||
# snrd migrate
|
||||
|
||||
unknown command "migrate" for "snrd"
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd migrate
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: snrd node
|
||||
description: unknown command "node" for "snrd"
|
||||
---
|
||||
|
||||
# snrd node
|
||||
|
||||
unknown command "node" for "snrd"
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd node
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: snrd prune
|
||||
description: Prune app history states by keeping the recent heights and deleting old heights.
|
||||
---
|
||||
|
||||
# snrd prune
|
||||
|
||||
Prune app history states by keeping the recent heights and deleting old heights.
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd prune [pruning-method] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="app-db-backend" type="string">
|
||||
The type of database for application and snapshots databases
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for prune
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="pruning-interval" type="string">
|
||||
Height interval at which pruned heights are removed from disk (ignored if pruning is not 'custom'),
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="pruning-keep-recent" type="string">
|
||||
Number of recent heights to keep on disk (ignored if pruning is not 'custom')
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd prune
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,131 @@
|
||||
---
|
||||
title: snrd query
|
||||
description: Querying subcommands
|
||||
---
|
||||
|
||||
# snrd query
|
||||
|
||||
Querying subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `auth` | Querying commands for the auth module |
|
||||
| `authz` | Querying commands for the authz module |
|
||||
| `bank` | Querying commands for the bank module |
|
||||
| `block-results` | Query for a committed block's results by height |
|
||||
| `blocks` | Query for paginated blocks that match a set of events |
|
||||
| `circuit` | Querying commands for the circuit module |
|
||||
| `comet-validator-set` | Get the full CometBFT validator set at given height |
|
||||
| `consensus` | Querying commands for the consensus module |
|
||||
| `dex` | Querying commands for the dex module |
|
||||
| `did` | Querying commands for the did module |
|
||||
| `distribution` | Querying commands for the distribution module |
|
||||
| `dwn` | Querying commands for the dwn module |
|
||||
| `erc20` | Querying commands for the erc20 module |
|
||||
| `evidence` | Querying commands for the evidence module |
|
||||
| `evm` | Querying commands for the evm module |
|
||||
| `feegrant` | Querying commands for the feegrant module |
|
||||
| `feemarket` | Querying commands for the fee market module |
|
||||
| `gov` | Querying commands for the gov module |
|
||||
| `group` | Querying commands for the group module |
|
||||
| `ibc` | Querying commands for the IBC module |
|
||||
| `ibc-fee` | IBC relayer incentivization query subcommands |
|
||||
| `ibc-transfer` | IBC fungible token transfer query subcommands |
|
||||
| `ibc-wasm` | IBC wasm manager module query subcommands |
|
||||
| `interchain-accounts` | IBC interchain accounts query subcommands |
|
||||
| `mint` | Querying commands for the mint module |
|
||||
| `nft` | Querying commands for the nft module |
|
||||
| `params` | Querying commands for the params module |
|
||||
| `ratelimit` | Querying commands for the ratelimit module |
|
||||
| `slashing` | Querying commands for the slashing module |
|
||||
| `staking` | Querying commands for the staking module |
|
||||
| `svc` | Querying commands for the svc module |
|
||||
| `tokenfactory` | Querying commands for the tokenfactory module |
|
||||
| `tx` | Query for a transaction by hash, "addr/seq" combination or comma-separated signatures in a committed block |
|
||||
| `txs` | Query for paginated transactions that match a set of events |
|
||||
| `upgrade` | Querying commands for the upgrade module |
|
||||
| `wait-tx` | Wait for a transaction to be included in a block |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for query
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,131 @@
|
||||
---
|
||||
title: snrd query account
|
||||
description: Querying subcommands
|
||||
---
|
||||
|
||||
# snrd query account
|
||||
|
||||
Querying subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `auth` | Querying commands for the auth module |
|
||||
| `authz` | Querying commands for the authz module |
|
||||
| `bank` | Querying commands for the bank module |
|
||||
| `block-results` | Query for a committed block's results by height |
|
||||
| `blocks` | Query for paginated blocks that match a set of events |
|
||||
| `circuit` | Querying commands for the circuit module |
|
||||
| `comet-validator-set` | Get the full CometBFT validator set at given height |
|
||||
| `consensus` | Querying commands for the consensus module |
|
||||
| `dex` | Querying commands for the dex module |
|
||||
| `did` | Querying commands for the did module |
|
||||
| `distribution` | Querying commands for the distribution module |
|
||||
| `dwn` | Querying commands for the dwn module |
|
||||
| `erc20` | Querying commands for the erc20 module |
|
||||
| `evidence` | Querying commands for the evidence module |
|
||||
| `evm` | Querying commands for the evm module |
|
||||
| `feegrant` | Querying commands for the feegrant module |
|
||||
| `feemarket` | Querying commands for the fee market module |
|
||||
| `gov` | Querying commands for the gov module |
|
||||
| `group` | Querying commands for the group module |
|
||||
| `ibc` | Querying commands for the IBC module |
|
||||
| `ibc-fee` | IBC relayer incentivization query subcommands |
|
||||
| `ibc-transfer` | IBC fungible token transfer query subcommands |
|
||||
| `ibc-wasm` | IBC wasm manager module query subcommands |
|
||||
| `interchain-accounts` | IBC interchain accounts query subcommands |
|
||||
| `mint` | Querying commands for the mint module |
|
||||
| `nft` | Querying commands for the nft module |
|
||||
| `params` | Querying commands for the params module |
|
||||
| `ratelimit` | Querying commands for the ratelimit module |
|
||||
| `slashing` | Querying commands for the slashing module |
|
||||
| `staking` | Querying commands for the staking module |
|
||||
| `svc` | Querying commands for the svc module |
|
||||
| `tokenfactory` | Querying commands for the tokenfactory module |
|
||||
| `tx` | Query for a transaction by hash, "addr/seq" combination or comma-separated signatures in a committed block |
|
||||
| `txs` | Query for paginated transactions that match a set of events |
|
||||
| `upgrade` | Querying commands for the upgrade module |
|
||||
| `wait-tx` | Wait for a transaction to be included in a block |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for query
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query account
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,131 @@
|
||||
---
|
||||
title: snrd query accounts
|
||||
description: Querying subcommands
|
||||
---
|
||||
|
||||
# snrd query accounts
|
||||
|
||||
Querying subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `auth` | Querying commands for the auth module |
|
||||
| `authz` | Querying commands for the authz module |
|
||||
| `bank` | Querying commands for the bank module |
|
||||
| `block-results` | Query for a committed block's results by height |
|
||||
| `blocks` | Query for paginated blocks that match a set of events |
|
||||
| `circuit` | Querying commands for the circuit module |
|
||||
| `comet-validator-set` | Get the full CometBFT validator set at given height |
|
||||
| `consensus` | Querying commands for the consensus module |
|
||||
| `dex` | Querying commands for the dex module |
|
||||
| `did` | Querying commands for the did module |
|
||||
| `distribution` | Querying commands for the distribution module |
|
||||
| `dwn` | Querying commands for the dwn module |
|
||||
| `erc20` | Querying commands for the erc20 module |
|
||||
| `evidence` | Querying commands for the evidence module |
|
||||
| `evm` | Querying commands for the evm module |
|
||||
| `feegrant` | Querying commands for the feegrant module |
|
||||
| `feemarket` | Querying commands for the fee market module |
|
||||
| `gov` | Querying commands for the gov module |
|
||||
| `group` | Querying commands for the group module |
|
||||
| `ibc` | Querying commands for the IBC module |
|
||||
| `ibc-fee` | IBC relayer incentivization query subcommands |
|
||||
| `ibc-transfer` | IBC fungible token transfer query subcommands |
|
||||
| `ibc-wasm` | IBC wasm manager module query subcommands |
|
||||
| `interchain-accounts` | IBC interchain accounts query subcommands |
|
||||
| `mint` | Querying commands for the mint module |
|
||||
| `nft` | Querying commands for the nft module |
|
||||
| `params` | Querying commands for the params module |
|
||||
| `ratelimit` | Querying commands for the ratelimit module |
|
||||
| `slashing` | Querying commands for the slashing module |
|
||||
| `staking` | Querying commands for the staking module |
|
||||
| `svc` | Querying commands for the svc module |
|
||||
| `tokenfactory` | Querying commands for the tokenfactory module |
|
||||
| `tx` | Query for a transaction by hash, "addr/seq" combination or comma-separated signatures in a committed block |
|
||||
| `txs` | Query for paginated transactions that match a set of events |
|
||||
| `upgrade` | Querying commands for the upgrade module |
|
||||
| `wait-tx` | Wait for a transaction to be included in a block |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for query
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query accounts
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,105 @@
|
||||
---
|
||||
title: snrd query auth
|
||||
description: Querying commands for the auth module
|
||||
---
|
||||
|
||||
# snrd query auth
|
||||
|
||||
Querying commands for the auth module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query auth [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query auth [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `account` | Query account by address |
|
||||
| `account-info` | Query account info which is common to all account types. |
|
||||
| `accounts` | Query all the accounts |
|
||||
| `address-by-acc-num` | Query account address by account number |
|
||||
| `address-bytes-to-string` | Transform an address bytes to string |
|
||||
| `address-string-to-bytes` | Transform an address string to bytes |
|
||||
| `bech32-prefix` | Query the chain bech32 prefix (if applicable) |
|
||||
| `module-account` | Query module account info by module name |
|
||||
| `module-accounts` | Query all module accounts |
|
||||
| `params` | Query the current auth parameters |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for auth
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query auth
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,107 @@
|
||||
---
|
||||
title: snrd query bank
|
||||
description: Querying commands for the bank module
|
||||
---
|
||||
|
||||
# snrd query bank
|
||||
|
||||
Querying commands for the bank module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query bank [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query bank [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `balance` | Query an account balance by address and denom |
|
||||
| `balances` | Query for account balances by address |
|
||||
| `denom-metadata` | Query the client metadata of a given coin denomination |
|
||||
| `denom-metadata-by-query-string` | Execute the DenomMetadataByQueryString RPC method |
|
||||
| `denom-owners` | Query for all account addresses that own a particular token denomination. |
|
||||
| `denoms-metadata` | Query the client metadata for all registered coin denominations |
|
||||
| `params` | Query the current bank parameters |
|
||||
| `send-enabled` | Query for send enabled entries |
|
||||
| `spendable-balance` | Query the spendable balance of a single denom for a single account. |
|
||||
| `spendable-balances` | Query for account spendable balances by address |
|
||||
| `total-supply` | Query the total supply of coins of the chain |
|
||||
| `total-supply-of` | Query the supply of a single coin denom |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for bank
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query bank
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
title: snrd query consensus
|
||||
description: Querying commands for the consensus module
|
||||
---
|
||||
|
||||
# snrd query consensus
|
||||
|
||||
Querying commands for the consensus module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query consensus [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query consensus [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `comet` | Querying commands for the cosmos.base.tendermint.v1beta1.Service service |
|
||||
| `params` | Query the current consensus parameters |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for consensus
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query consensus
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,131 @@
|
||||
---
|
||||
title: snrd query delegation
|
||||
description: Querying subcommands
|
||||
---
|
||||
|
||||
# snrd query delegation
|
||||
|
||||
Querying subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `auth` | Querying commands for the auth module |
|
||||
| `authz` | Querying commands for the authz module |
|
||||
| `bank` | Querying commands for the bank module |
|
||||
| `block-results` | Query for a committed block's results by height |
|
||||
| `blocks` | Query for paginated blocks that match a set of events |
|
||||
| `circuit` | Querying commands for the circuit module |
|
||||
| `comet-validator-set` | Get the full CometBFT validator set at given height |
|
||||
| `consensus` | Querying commands for the consensus module |
|
||||
| `dex` | Querying commands for the dex module |
|
||||
| `did` | Querying commands for the did module |
|
||||
| `distribution` | Querying commands for the distribution module |
|
||||
| `dwn` | Querying commands for the dwn module |
|
||||
| `erc20` | Querying commands for the erc20 module |
|
||||
| `evidence` | Querying commands for the evidence module |
|
||||
| `evm` | Querying commands for the evm module |
|
||||
| `feegrant` | Querying commands for the feegrant module |
|
||||
| `feemarket` | Querying commands for the fee market module |
|
||||
| `gov` | Querying commands for the gov module |
|
||||
| `group` | Querying commands for the group module |
|
||||
| `ibc` | Querying commands for the IBC module |
|
||||
| `ibc-fee` | IBC relayer incentivization query subcommands |
|
||||
| `ibc-transfer` | IBC fungible token transfer query subcommands |
|
||||
| `ibc-wasm` | IBC wasm manager module query subcommands |
|
||||
| `interchain-accounts` | IBC interchain accounts query subcommands |
|
||||
| `mint` | Querying commands for the mint module |
|
||||
| `nft` | Querying commands for the nft module |
|
||||
| `params` | Querying commands for the params module |
|
||||
| `ratelimit` | Querying commands for the ratelimit module |
|
||||
| `slashing` | Querying commands for the slashing module |
|
||||
| `staking` | Querying commands for the staking module |
|
||||
| `svc` | Querying commands for the svc module |
|
||||
| `tokenfactory` | Querying commands for the tokenfactory module |
|
||||
| `tx` | Query for a transaction by hash, "addr/seq" combination or comma-separated signatures in a committed block |
|
||||
| `txs` | Query for paginated transactions that match a set of events |
|
||||
| `upgrade` | Querying commands for the upgrade module |
|
||||
| `wait-tx` | Wait for a transaction to be included in a block |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for query
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query delegation
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,105 @@
|
||||
---
|
||||
title: snrd query did
|
||||
description: Querying commands for the did module
|
||||
---
|
||||
|
||||
# snrd query did
|
||||
|
||||
Querying commands for the did module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query did [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query did [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `credential` | Get a W3C verifiable credential |
|
||||
| `credentials` | List all W3C verifiable credentials |
|
||||
| `credentials-by-did` | Get all credentials (verifiable and WebAuthn) associated with a DID |
|
||||
| `document` | Get a W3C DID document by DID |
|
||||
| `documents` | List all W3C DID documents |
|
||||
| `documents-by-controller` | Get W3C DID documents by controller |
|
||||
| `params` | Query the current consensus parameters |
|
||||
| `resolve` | Resolve a DID to its document |
|
||||
| `service` | Get a service endpoint from a DID document |
|
||||
| `verification-method` | Get a verification method from a DID document |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for did
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query did
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,105 @@
|
||||
---
|
||||
title: snrd query distribution
|
||||
description: Querying commands for the distribution module
|
||||
---
|
||||
|
||||
# snrd query distribution
|
||||
|
||||
Querying commands for the distribution module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query distribution [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query distribution [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `commission` | Query distribution validator commission |
|
||||
| `community-pool` | Query the amount of coins in the community pool |
|
||||
| `delegator-validators` | Execute the DelegatorValidators RPC method |
|
||||
| `delegator-withdraw-address` | Execute the DelegatorWithdrawAddress RPC method |
|
||||
| `params` | Query the current distribution parameters. |
|
||||
| `rewards` | Query all distribution delegator rewards |
|
||||
| `rewards-by-validator` | Query all distribution delegator from a particular validator |
|
||||
| `slashes` | Query distribution validator slashes |
|
||||
| `validator-distribution-info` | Query validator distribution info |
|
||||
| `validator-outstanding-rewards` | Query distribution outstanding (un-withdrawn) rewards for a validator and all their delegations |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for distribution
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query distribution
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,108 @@
|
||||
---
|
||||
title: snrd query dwn
|
||||
description: Querying commands for the dwn module
|
||||
---
|
||||
|
||||
# snrd query dwn
|
||||
|
||||
Querying commands for the dwn module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query dwn [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query dwn [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `cid` | Execute the CID RPC method |
|
||||
| `encrypted-record` | Execute the EncryptedRecord RPC method |
|
||||
| `encryption-status` | Execute the EncryptionStatus RPC method |
|
||||
| `ipfs` | Execute the IPFS RPC method |
|
||||
| `params` | Query the current consensus parameters |
|
||||
| `permissions` | Query DWN permissions for a target |
|
||||
| `protocol` | Query a specific DWN protocol |
|
||||
| `protocols` | Query DWN protocols for a target |
|
||||
| `record` | Query a specific DWN record |
|
||||
| `records` | Query DWN records for a target |
|
||||
| `vault` | Query a specific vault |
|
||||
| `vaults` | Query vaults by owner |
|
||||
| `vrf-contributions` | Execute the VRFContributions RPC method |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for dwn
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query dwn
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: snrd query feegrant
|
||||
description: Querying commands for the feegrant module
|
||||
---
|
||||
|
||||
# snrd query feegrant
|
||||
|
||||
Querying commands for the feegrant module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query feegrant [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query feegrant [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `grant` | Query details of a single grant |
|
||||
| `grants-by-grantee` | Query all grants of a grantee |
|
||||
| `grants-by-granter` | Query all grants by a granter |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for feegrant
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query feegrant
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,104 @@
|
||||
---
|
||||
title: snrd query gov
|
||||
description: Querying commands for the gov module
|
||||
---
|
||||
|
||||
# snrd query gov
|
||||
|
||||
Querying commands for the gov module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query gov [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query gov [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `constitution` | Query the current chain constitution |
|
||||
| `deposit` | Query details of a deposit |
|
||||
| `deposits` | Query deposits on a proposal |
|
||||
| `params` | Query the parameters of the governance process |
|
||||
| `proposal` | Query details of a single proposal |
|
||||
| `proposals` | Query proposals with optional filters |
|
||||
| `tally` | Query the tally of a proposal vote |
|
||||
| `vote` | Query details of a single vote |
|
||||
| `votes` | Query votes of a single proposal |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for gov
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query gov
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: snrd query slashing
|
||||
description: Querying commands for the slashing module
|
||||
---
|
||||
|
||||
# snrd query slashing
|
||||
|
||||
Querying commands for the slashing module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query slashing [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query slashing [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `params` | Query the current slashing parameters |
|
||||
| `signing-info` | Query a validator's signing information |
|
||||
| `signing-infos` | Query signing information of all validators |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for slashing
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query slashing
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,109 @@
|
||||
---
|
||||
title: snrd query staking
|
||||
description: Querying commands for the staking module
|
||||
---
|
||||
|
||||
# snrd query staking
|
||||
|
||||
Querying commands for the staking module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query staking [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query staking [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `delegation` | Query a delegation based on address and validator address |
|
||||
| `delegations` | Query all delegations made by one delegator |
|
||||
| `delegations-to` | Query all delegations made to one validator |
|
||||
| `delegator-validator` | Query validator info for given delegator validator pair |
|
||||
| `delegator-validators` | Query all validators info for given delegator address |
|
||||
| `historical-info` | Query historical info at given height |
|
||||
| `params` | Query the current staking parameters information |
|
||||
| `pool` | Query the current staking pool values |
|
||||
| `redelegation` | Query a redelegation record based on delegator and a source and destination validator address |
|
||||
| `unbonding-delegation` | Query an unbonding-delegation record based on delegator and validator address |
|
||||
| `unbonding-delegations` | Query all unbonding-delegations records for one delegator |
|
||||
| `unbonding-delegations-from` | Query all unbonding delegatations from a validator |
|
||||
| `validator` | Query a validator |
|
||||
| `validators` | Query for all validators |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for staking
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query staking
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: snrd query svc
|
||||
description: Querying commands for the svc module
|
||||
---
|
||||
|
||||
# snrd query svc
|
||||
|
||||
Querying commands for the svc module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query svc [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query svc [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `domain-verification` | Query domain verification status |
|
||||
| `params` | Query the current consensus parameters |
|
||||
| `service` | Query service information by ID |
|
||||
| `services-by-domain` | Query services bound to a specific domain |
|
||||
| `services-by-owner` | Query all services owned by an address |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for svc
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query svc
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,131 @@
|
||||
---
|
||||
title: snrd query tendermint
|
||||
description: Querying subcommands
|
||||
---
|
||||
|
||||
# snrd query tendermint
|
||||
|
||||
Querying subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd query [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `auth` | Querying commands for the auth module |
|
||||
| `authz` | Querying commands for the authz module |
|
||||
| `bank` | Querying commands for the bank module |
|
||||
| `block-results` | Query for a committed block's results by height |
|
||||
| `blocks` | Query for paginated blocks that match a set of events |
|
||||
| `circuit` | Querying commands for the circuit module |
|
||||
| `comet-validator-set` | Get the full CometBFT validator set at given height |
|
||||
| `consensus` | Querying commands for the consensus module |
|
||||
| `dex` | Querying commands for the dex module |
|
||||
| `did` | Querying commands for the did module |
|
||||
| `distribution` | Querying commands for the distribution module |
|
||||
| `dwn` | Querying commands for the dwn module |
|
||||
| `erc20` | Querying commands for the erc20 module |
|
||||
| `evidence` | Querying commands for the evidence module |
|
||||
| `evm` | Querying commands for the evm module |
|
||||
| `feegrant` | Querying commands for the feegrant module |
|
||||
| `feemarket` | Querying commands for the fee market module |
|
||||
| `gov` | Querying commands for the gov module |
|
||||
| `group` | Querying commands for the group module |
|
||||
| `ibc` | Querying commands for the IBC module |
|
||||
| `ibc-fee` | IBC relayer incentivization query subcommands |
|
||||
| `ibc-transfer` | IBC fungible token transfer query subcommands |
|
||||
| `ibc-wasm` | IBC wasm manager module query subcommands |
|
||||
| `interchain-accounts` | IBC interchain accounts query subcommands |
|
||||
| `mint` | Querying commands for the mint module |
|
||||
| `nft` | Querying commands for the nft module |
|
||||
| `params` | Querying commands for the params module |
|
||||
| `ratelimit` | Querying commands for the ratelimit module |
|
||||
| `slashing` | Querying commands for the slashing module |
|
||||
| `staking` | Querying commands for the staking module |
|
||||
| `svc` | Querying commands for the svc module |
|
||||
| `tokenfactory` | Querying commands for the tokenfactory module |
|
||||
| `tx` | Query for a transaction by hash, "addr/seq" combination or comma-separated signatures in a committed block |
|
||||
| `txs` | Query for paginated transactions that match a set of events |
|
||||
| `upgrade` | Querying commands for the upgrade module |
|
||||
| `wait-tx` | Wait for a transaction to be included in a block |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for query
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query tendermint
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,106 @@
|
||||
---
|
||||
title: snrd query tx
|
||||
description: Query for a transaction by hash or address/sequence combination
|
||||
---
|
||||
|
||||
# snrd query tx
|
||||
|
||||
Example:
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd query tx --type=[hash|acc_seq|signature] [hash|acc_seq|signature] [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="grpc-addr" type="string">
|
||||
the gRPC endpoint to use for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="grpc-insecure" type="string">
|
||||
gRPC over insecure channels, if not the server must use TLS
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="height" type="integer">
|
||||
Use a specific height to query state at (this can error if the node is pruning state)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to CometBFT RPC interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="type" type="string" default="hash">
|
||||
The type to be used when querying tx, can be one of "hash", "acc_seq", "signature"
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic query
|
||||
|
||||
```shell
|
||||
snrd query tx
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd query](./snrd_query.mdx) - Parent command
|
||||
@@ -0,0 +1,90 @@
|
||||
---
|
||||
title: snrd rollback
|
||||
description: A state rollback is performed to recover from an incorrect application state transition,
|
||||
---
|
||||
|
||||
# snrd rollback
|
||||
|
||||
A state rollback is performed to recover from an incorrect application state transition,
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd rollback [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="hard" type="string">
|
||||
last block as well as state
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for rollback
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
The application home directory
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd rollback
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,90 @@
|
||||
---
|
||||
title: snrd status
|
||||
description: Query remote node for status
|
||||
---
|
||||
|
||||
# snrd status
|
||||
|
||||
Query remote node for status
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd status [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for status
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
Node to connect to
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="json">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd status
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: snrd tendermint
|
||||
description: CometBFT subcommands
|
||||
---
|
||||
|
||||
# snrd tendermint
|
||||
|
||||
CometBFT subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd comet [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `bootstrap-state` | Bootstrap CometBFT state at an arbitrary block height using a light client |
|
||||
| `reset-state` | Remove all the data and WAL |
|
||||
| `show-address` | Shows this node's CometBFT validator consensus address |
|
||||
| `show-node-id` | Show this node's ID |
|
||||
| `show-validator` | Show this node's CometBFT validator info |
|
||||
| `unsafe-reset-all` | (unsafe) Remove all the data and WAL, reset this node's validator to genesis state |
|
||||
| `version` | Print CometBFT libraries' version |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for comet
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd tendermint
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,135 @@
|
||||
---
|
||||
title: snrd tx
|
||||
description: Transactions subcommands
|
||||
---
|
||||
|
||||
# snrd tx
|
||||
|
||||
Transactions subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `auth` | Transactions commands for the auth module |
|
||||
| `authz` | Authorization transactions subcommands |
|
||||
| `bank` | Bank transaction subcommands |
|
||||
| `broadcast` | Broadcast transactions generated offline |
|
||||
| `circuit` | Transactions commands for the circuit module |
|
||||
| `consensus` | Transactions commands for the consensus module |
|
||||
| `crisis` | Transactions commands for the crisis module |
|
||||
| `decode` | Decode a binary encoded transaction string |
|
||||
| `dex` | dex transactions subcommands |
|
||||
| `did` | Transactions commands for the did module |
|
||||
| `distribution` | Distribution transactions subcommands |
|
||||
| `dwn` | Transactions commands for the dwn module |
|
||||
| `encode` | Encode transactions generated offline |
|
||||
| `erc20` | erc20 subcommands |
|
||||
| `evidence` | Evidence transaction subcommands |
|
||||
| `evm` | evm subcommands |
|
||||
| `feegrant` | Feegrant transactions sub-commands |
|
||||
| `feemarket` | Transactions commands for the feemarket module |
|
||||
| `gov` | Governance transactions subcommands |
|
||||
| `group` | Group transaction subcommands |
|
||||
| `ibc` | IBC transaction subcommands |
|
||||
| `ibc-fee` | IBC relayer incentivization transaction subcommands |
|
||||
| `ibc-transfer` | IBC fungible token transfer transaction subcommands |
|
||||
| `ibc-wasm` | IBC wasm manager module transaction subcommands |
|
||||
| `interchain-accounts` | IBC interchain accounts transaction subcommands |
|
||||
| `mint` | Transactions commands for the mint module |
|
||||
| `multi-sign` | Generate multisig signatures for transactions generated offline |
|
||||
| `multisign-batch` | Assemble multisig transactions in batch from batch signatures |
|
||||
| `nft` | Transactions commands for the nft module |
|
||||
| `ratelimit` | Transactions commands for the ratelimit module |
|
||||
| `sign` | Sign a transaction generated offline |
|
||||
| `sign-batch` | Sign transaction batch files |
|
||||
| `simulate` | Simulate the gas usage of a transaction |
|
||||
| `slashing` | Transactions commands for the slashing module |
|
||||
| `staking` | Staking transaction subcommands |
|
||||
| `svc` | Transactions commands for the svc module |
|
||||
| `tokenfactory` | tokenfactory transactions subcommands |
|
||||
| `upgrade` | Upgrade transaction subcommands |
|
||||
| `validate-signatures` | validate transactions signatures |
|
||||
| `vesting` | Vesting transaction subcommands |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for tx
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
title: snrd tx bank
|
||||
description: Bank transaction subcommands
|
||||
---
|
||||
|
||||
# snrd tx bank
|
||||
|
||||
Bank transaction subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx bank [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx bank [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `multi-send` | Send funds from one account to two or more accounts. |
|
||||
| `send` | Send funds from one account to another. |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for bank
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx bank --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
title: snrd tx consensus
|
||||
description: Transactions commands for the consensus module
|
||||
---
|
||||
|
||||
# snrd tx consensus
|
||||
|
||||
Transactions commands for the consensus module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx consensus [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for consensus
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx consensus --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,96 @@
|
||||
---
|
||||
title: snrd tx crisis
|
||||
description: Transactions commands for the crisis module
|
||||
---
|
||||
|
||||
# snrd tx crisis
|
||||
|
||||
Transactions commands for the crisis module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx crisis [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx crisis [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `invariant-broken` | Submit proof that an invariant broken |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for crisis
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx crisis --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,107 @@
|
||||
---
|
||||
title: snrd tx did
|
||||
description: Transactions commands for the did module
|
||||
---
|
||||
|
||||
# snrd tx did
|
||||
|
||||
Transactions commands for the did module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx did [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx did [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `add-service` | Add a service endpoint to a DID document |
|
||||
| `add-verification-method` | Add a verification method to a DID document |
|
||||
| `create-did` | Create a new DID document |
|
||||
| `deactivate-did` | Deactivate a DID document |
|
||||
| `issue-credential` | Issue a W3C verifiable credential |
|
||||
| `link-external-wallet` | Execute the LinkExternalWallet RPC method |
|
||||
| `register-web-authn-credential` | Execute the RegisterWebAuthnCredential RPC method |
|
||||
| `remove-service` | Remove a service endpoint from a DID document |
|
||||
| `remove-verification-method` | Remove a verification method from a DID document |
|
||||
| `revoke-credential` | Revoke a W3C verifiable credential |
|
||||
| `update-did` | Update an existing DID document |
|
||||
| `update-params` | Execute the UpdateParams RPC method |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for did
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx did --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: snrd tx distribution
|
||||
description: Distribution transactions subcommands
|
||||
---
|
||||
|
||||
# snrd tx distribution
|
||||
|
||||
Distribution transactions subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx distribution [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx distribution [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `fund-community-pool` | Funds the community pool with the specified amount |
|
||||
| `fund-validator-rewards-pool` | Fund the validator rewards pool with the specified amount |
|
||||
| `set-withdraw-addr` | change the default withdraw address for rewards associated with an address |
|
||||
| `withdraw-all-rewards` | withdraw all delegations rewards for a delegator |
|
||||
| `withdraw-rewards` | Withdraw rewards from a given delegation address, and optionally withdraw validator commission if the delegation address given is a validator operator |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for distribution
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx distribution --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
title: snrd tx dwn
|
||||
description: Transactions commands for the dwn module
|
||||
---
|
||||
|
||||
# snrd tx dwn
|
||||
|
||||
Transactions commands for the dwn module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx dwn [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx dwn [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `permissions-grant` | Grants permissions in the DWN |
|
||||
| `permissions-revoke` | Revokes permissions in the DWN |
|
||||
| `protocols-configure` | Configures a protocol in the DWN |
|
||||
| `records-delete` | Deletes a record from the DWN |
|
||||
| `records-write` | Creates or updates a record in the DWN |
|
||||
| `rotate-vault-keys` | Execute the RotateVaultKeys RPC method |
|
||||
| `update-params` | Execute the UpdateParams RPC method |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for dwn
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx dwn --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: snrd tx feegrant
|
||||
description: Grant and revoke fee allowance for a grantee by a granter
|
||||
---
|
||||
|
||||
# snrd tx feegrant
|
||||
|
||||
Grant and revoke fee allowance for a grantee by a granter
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx feegrant [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx feegrant [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `grant` | Grant Fee allowance to an address |
|
||||
| `prune` | Prune expired allowances |
|
||||
| `revoke` | Revoke a fee grant |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for feegrant
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx feegrant --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
title: snrd tx gov
|
||||
description: Governance transactions subcommands
|
||||
---
|
||||
|
||||
# snrd tx gov
|
||||
|
||||
Governance transactions subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx gov [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx gov [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `cancel-proposal` | Cancel governance proposal before the voting period ends. Must be signed by the proposal creator. |
|
||||
| `deposit` | Deposit tokens for an active proposal |
|
||||
| `draft-proposal` | Generate a draft proposal json file. The generated proposal json contains only one message (skeleton). |
|
||||
| `submit-legacy-proposal` | Submit a legacy proposal along with an initial deposit |
|
||||
| `submit-proposal` | Submit a proposal along with some messages, metadata and deposit |
|
||||
| `vote` | Vote for an active proposal, options: yes/no/no_with_veto/abstain |
|
||||
| `weighted-vote` | Vote for an active proposal, options: yes/no/no_with_veto/abstain |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for gov
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx gov --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,96 @@
|
||||
---
|
||||
title: snrd tx slashing
|
||||
description: Transactions commands for the slashing module
|
||||
---
|
||||
|
||||
# snrd tx slashing
|
||||
|
||||
Transactions commands for the slashing module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx slashing [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx slashing [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `unjail` | Unjail a jailed validator |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for slashing
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx slashing --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,101 @@
|
||||
---
|
||||
title: snrd tx staking
|
||||
description: Staking transaction subcommands
|
||||
---
|
||||
|
||||
# snrd tx staking
|
||||
|
||||
Staking transaction subcommands
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx staking [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx staking [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `cancel-unbond` | Cancel unbonding delegation and delegate back to the validator |
|
||||
| `create-validator` | create new validator initialized with a self-delegation to it |
|
||||
| `delegate` | Delegate liquid tokens to a validator |
|
||||
| `edit-validator` | edit an existing validator account |
|
||||
| `redelegate` | Redelegate illiquid tokens from one validator to another |
|
||||
| `unbond` | Unbond shares from a validator |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for staking
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx staking --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,99 @@
|
||||
---
|
||||
title: snrd tx svc
|
||||
description: Transactions commands for the svc module
|
||||
---
|
||||
|
||||
# snrd tx svc
|
||||
|
||||
Transactions commands for the svc module
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd tx svc [flags]
|
||||
```
|
||||
|
||||
```shell
|
||||
snrd tx svc [command]
|
||||
```
|
||||
|
||||
## Available Commands
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `initiate-domain-verification` | Initiate domain verification by generating a DNS TXT record token |
|
||||
| `register-service` | Register a new service with the specified domain and permissions |
|
||||
| `update-params` | Execute the UpdateParams RPC method |
|
||||
| `verify-domain` | Verify domain ownership by checking DNS TXT records |
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for svc
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
The network chain ID
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Submit transaction
|
||||
|
||||
```shell
|
||||
snrd tx svc --from alice --chain-id sonrtest_1-1
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd tx](./snrd_tx.mdx) - Parent command
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: snrd version
|
||||
description: Print the application binary version information
|
||||
---
|
||||
|
||||
# snrd version
|
||||
|
||||
Print the application binary version information
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
snrd version [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
<ParamField path="help" type="string">
|
||||
for version
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="long" type="string">
|
||||
long version information
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="output" type="string" default="text">
|
||||
Output format (text|json)
|
||||
</ParamField>
|
||||
|
||||
## Global Flags
|
||||
|
||||
<ParamField path="broadcast-mode" type="string" default="sync">
|
||||
Transaction broadcasting mode (sync|async)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="chain-id" type="string">
|
||||
Specify Chain ID for sending Tx
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="fees" type="string">
|
||||
Fees to pay along with transaction; eg: 10aatom
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="from" type="string">
|
||||
Name or address of private key with which to sign
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-adjustment" type="float" default="1">
|
||||
adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="gas-prices" type="string">
|
||||
Gas prices to determine the transaction fee (e.g. 10aatom)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="home" type="string" default="/Users/prad/.sonr">
|
||||
directory for config and data
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="keyring-backend" type="string" default="os">
|
||||
Select keyring's backend
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_format" type="string" default="plain">
|
||||
The logging format (json|plain)
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_level" type="string" default="info">
|
||||
The logging level (trace|debug|info|warn|error|fatal|panic|disabled or '*:<level>,<key>:<level>')
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="log_no_color" type="string">
|
||||
colored logs
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="node" type="string" default="tcp://localhost:26657">
|
||||
<host>:<port> to tendermint rpc interface for this chain
|
||||
</ParamField>
|
||||
|
||||
<ParamField path="trace" type="string">
|
||||
out full stack trace on errors
|
||||
</ParamField>
|
||||
|
||||
## Examples
|
||||
|
||||
### Basic usage
|
||||
|
||||
```shell
|
||||
snrd version
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [snrd](./snrd.mdx) - Parent command
|
||||
@@ -0,0 +1,305 @@
|
||||
---
|
||||
title: Distribution
|
||||
description: SNR token distribution model, allocation strategy, and economic distribution mechanisms
|
||||
sidebarTitle: "Supply & Distribution"
|
||||
icon: "chart-pie"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The SNR token distribution is designed to balance immediate network needs with long-term sustainability, ensuring fair allocation across stakeholders while maintaining sufficient reserves for ecosystem growth.
|
||||
|
||||
**Total Supply: 1,000,000,000 SNR**
|
||||
|
||||
<Note>
|
||||
Token distribution follows a carefully planned vesting schedule to prevent
|
||||
market manipulation and ensure aligned incentives across all participants.
|
||||
</Note>
|
||||
|
||||
## Supply Dynamics
|
||||
|
||||
### Circulating Supply Factors
|
||||
|
||||
The circulating token supply depends on several key factors:
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Initial Circulation">
|
||||
200M SNR at genesis (20% of total supply)
|
||||
</Card>
|
||||
<Card title="Minted Tokens">
|
||||
New tokens created through inflation for rewards and subsidies
|
||||
</Card>
|
||||
<Card title="Vesting Releases">
|
||||
Scheduled releases from locked allocations over time
|
||||
</Card>
|
||||
<Card title="Staked Tokens">
|
||||
Tokens locked in staking reducing effective circulation
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
### Token Velocity
|
||||
|
||||
Token velocity measures how frequently tokens change hands and directly impacts token value:
|
||||
|
||||
```math
|
||||
\text{Token Value} = \frac{\text{Economic Activity}}{\text{Circulating Supply} \times \text{Velocity}}
|
||||
```
|
||||
|
||||
## Allocation Strategy
|
||||
|
||||
### Core Allocations
|
||||
|
||||
The token distribution prioritizes long-term network health through strategic allocations:
|
||||
|
||||
1. **Community & Ecosystem** (35% - 350M SNR)
|
||||
- Airdrop Program: 100M SNR (10%)
|
||||
- Testnet Incentives: 50M SNR (5%)
|
||||
- Staking Rewards Pool: 100M SNR (10%)
|
||||
- Ecosystem Grants: 100M SNR (10%)
|
||||
|
||||
2. **Team & Advisors** (20% - 200M SNR)
|
||||
- Team Allocation: 150M SNR (15%)
|
||||
- Advisors: 50M SNR (5%)
|
||||
|
||||
3. **Investors** (25% - 250M SNR)
|
||||
- Seed Round: 75M SNR (7.5%)
|
||||
- Series A: 100M SNR (10%)
|
||||
- Strategic Round: 75M SNR (7.5%)
|
||||
|
||||
4. **Foundation Treasury** (15% - 150M SNR)
|
||||
- Operations: 75M SNR (7.5%)
|
||||
- Reserve Fund: 75M SNR (7.5%)
|
||||
|
||||
5. **Validator Incentives** (5% - 50M SNR)
|
||||
- Genesis Validators: 30M SNR (3%)
|
||||
- Delegation Program: 20M SNR (2%)
|
||||
|
||||
### Vesting Schedules
|
||||
|
||||
<Warning>
|
||||
All non-circulating allocations follow strict vesting schedules to ensure
|
||||
gradual market entry and prevent supply shocks.
|
||||
</Warning>
|
||||
|
||||
#### Team Vesting
|
||||
|
||||
- **Team**: 12-month cliff, 48-month linear vest
|
||||
- **Advisors**: 6-month cliff, 24-month linear vest
|
||||
- No transfers until cliff periods expire
|
||||
|
||||
#### Investor Vesting
|
||||
|
||||
- **Seed Round**: 6-month cliff, 36-month linear vest
|
||||
- **Series A**: 3-month cliff, 24-month linear vest
|
||||
- **Strategic Round**: 25% immediate, remainder over 18 months
|
||||
|
||||
#### Community Vesting
|
||||
|
||||
- **Airdrop**: 25% immediate, 75% over 12 months
|
||||
- **Testnet**: Distribution over 6-month testnet period
|
||||
- **Ecosystem Grants**: Project milestone-based releases
|
||||
|
||||
#### Foundation Vesting
|
||||
|
||||
- **Operations**: 10% at genesis, 90% over 5 years
|
||||
- **Reserve Fund**: Minimum 3 years lockup, governance approval required
|
||||
|
||||
## Inflation Mechanism
|
||||
|
||||
### Reward Distribution
|
||||
|
||||
The network implements controlled inflation to incentivize participation:
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Validator Rewards">
|
||||
Block rewards for consensus participation distributed pro-rata to stake
|
||||
</Card>
|
||||
<Card title="Highway Services">
|
||||
Compensation for off-chain computation, storage, and routing services
|
||||
</Card>
|
||||
<Card title="Governance Rewards">
|
||||
Incentives for proposal creation and voting participation
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
### Inflation Schedule
|
||||
|
||||
**Year 1**: 15% inflation (aggressive growth)
|
||||
- Focus on network bootstrapping
|
||||
- High rewards for early adopters
|
||||
|
||||
**Year 2**: 12% inflation (continued expansion)
|
||||
- Stabilization period begins
|
||||
- Balanced growth incentives
|
||||
|
||||
**Year 3**: 9% inflation (stabilization)
|
||||
- Network maturation
|
||||
- Sustainable reward levels
|
||||
|
||||
**Year 4+**: 7% inflation (long-term sustainability)
|
||||
- Minimal dilution
|
||||
- Self-sustaining economics
|
||||
|
||||
## Economic Safeguards
|
||||
|
||||
### Anti-Manipulation Measures
|
||||
|
||||
1. **Vesting Cliffs**: Prevent immediate dumps from large holders
|
||||
2. **Staking Lockups**: Reduce liquid supply through validator requirements
|
||||
3. **Governance Delays**: Time-locked treasury withdrawals
|
||||
4. **Slashing Penalties**: Discourage malicious validator behavior
|
||||
|
||||
### Supply Controls
|
||||
|
||||
The network implements several mechanisms to manage token supply:
|
||||
|
||||
- **Fee Burning**: 50% of transaction fees burned (deflationary)
|
||||
- **Treasury Management**: Governance-controlled minting caps
|
||||
- **Dynamic Rewards**: Adjustment based on network participation
|
||||
- **Lock Incentives**: Higher rewards for longer staking periods
|
||||
|
||||
### Centralization Risks
|
||||
|
||||
- No single entity controls >20% at genesis
|
||||
- Team tokens have longest vesting (4 years)
|
||||
- Foundation treasury requires governance approval
|
||||
- Validator set caps prevent concentration
|
||||
|
||||
### Market Stability
|
||||
|
||||
- Staggered vesting prevents supply shocks
|
||||
- Fee burning provides deflationary pressure
|
||||
- Utility demand from identity services
|
||||
- Cross-chain value capture mechanisms
|
||||
|
||||
## Token Utility & Value Accrual
|
||||
|
||||
### Primary Utilities
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Network Security">
|
||||
Staking for validation and delegation
|
||||
</Card>
|
||||
<Card title="Governance">
|
||||
Voting on protocol upgrades and parameters
|
||||
</Card>
|
||||
<Card title="Transaction Fees">
|
||||
Gas payments for network operations
|
||||
</Card>
|
||||
<Card title="Identity Services">
|
||||
Premium features and API access
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
### Value Accrual Mechanisms
|
||||
|
||||
1. **Fee Burning**: 50% of transaction fees burned (deflationary)
|
||||
2. **Staking Yield**: 7-15% APR depending on network participation
|
||||
3. **Identity Revenue**: Enterprise licensing fees distributed to stakers
|
||||
4. **Cross-chain Value**: IBC transfer fees and bridge operations
|
||||
|
||||
### Staking Targets
|
||||
|
||||
- **Target staking ratio**: 65%
|
||||
- **Validator set**: 50-100 active validators
|
||||
- **Minimum stake**: 1M SNR (0.1% of supply)
|
||||
- **Delegation minimum**: 1 SNR (accessible to all)
|
||||
|
||||
### Vesting Schedule Overview
|
||||
|
||||
| Category | Immediate | 6 Months | 12 Months | 24 Months | 36 Months | 48 Months |
|
||||
|----------|-----------|----------|-----------|-----------|-----------|-----------|
|
||||
| Airdrop | 25% | 50% | 75% | 100% | - | - |
|
||||
| Team | 0% | 0% | 12.5% | 37.5% | 62.5% | 100% |
|
||||
| Seed Investors | 0% | 0% | 16.7% | 50% | 83.3% | 100% |
|
||||
| Series A | 0% | 25% | 50% | 100% | - | - |
|
||||
| Foundation | 10% | 28% | 46% | 64% | 82% | 100% |
|
||||
|
||||
<Check>
|
||||
The distribution model prioritizes network security, ecosystem growth, and
|
||||
fair participant rewards while maintaining economic sustainability.
|
||||
</Check>
|
||||
|
||||
## Distribution Timeline
|
||||
|
||||
### Pre-Launch (Months -6 to 0)
|
||||
|
||||
- Team allocation locked
|
||||
- Investor funds raised
|
||||
- Testnet incentives distributed
|
||||
- Airdrop snapshot taken
|
||||
|
||||
### Genesis (Month 0)
|
||||
|
||||
- 200M SNR circulating supply
|
||||
- Genesis validators receive allocation
|
||||
- Foundation treasury initialized
|
||||
- Staking rewards begin
|
||||
|
||||
### Year 1 (Months 1-12)
|
||||
|
||||
- Airdrop vesting releases 75M SNR
|
||||
- Team cliff expires, vesting begins
|
||||
- Series A completes vesting
|
||||
- Ecosystem grants distributed
|
||||
|
||||
### Year 2-3 (Months 13-36)
|
||||
|
||||
- Seed round completes vesting
|
||||
- Team reaches 62.5% vested
|
||||
- Foundation operations fully unlocked
|
||||
- Validator program matured
|
||||
|
||||
## Economic Incentives
|
||||
|
||||
### Genesis Validator Program
|
||||
|
||||
- **Genesis Validators**: 30M SNR (3%)
|
||||
- 50 validators × 600,000 SNR each
|
||||
- 24 months minimum staking lockup
|
||||
- 99%+ uptime and governance participation required
|
||||
|
||||
### Delegation Program
|
||||
|
||||
- **Foundation Delegations**: 20M SNR (2%)
|
||||
- 6-month renewable terms
|
||||
- Performance-based allocation
|
||||
- Support for high-performing validators
|
||||
|
||||
### Maturity Phase (Year 3+)
|
||||
|
||||
- Stabilized inflation rate
|
||||
- Self-sustaining economics
|
||||
- Community-driven allocation
|
||||
|
||||
## Success Metrics
|
||||
|
||||
### Year 1 Targets
|
||||
|
||||
- 50% of supply staked
|
||||
- 50+ active validators
|
||||
- 100k+ active addresses
|
||||
- $10M+ in identity service revenue
|
||||
|
||||
### Year 3 Targets
|
||||
|
||||
- 65% of supply staked
|
||||
- 75+ active validators
|
||||
- 1M+ active addresses
|
||||
- $100M+ total value locked
|
||||
|
||||
### Long-term Vision (5+ years)
|
||||
|
||||
- Self-sustaining network economics
|
||||
- Deflationary token model
|
||||
- Industry-standard identity infrastructure
|
||||
- Billion-dollar ecosystem value
|
||||
|
||||
## Transparency Commitments
|
||||
|
||||
All token distributions are:
|
||||
|
||||
- Publicly verifiable on-chain
|
||||
- Subject to regular audits
|
||||
- Reported in quarterly updates
|
||||
- Governed by smart contracts
|
||||
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: "Governance"
|
||||
sidebarTitle: "Protocol Governance"
|
||||
description: "Governance is the process of making decisions on behalf of a group of people or organization"
|
||||
icon: "landmark"
|
||||
---
|
||||
|
||||
The Demand is rooted from participation in the governance process, determining upgrades to the protocol or allocation of resources, and supply is the result of the tokens eligible to participate in the governance process.
|
||||
On Sonr we will be leveraging a **delegate stake** mechanism in order to **optimize buy-in** for users in the network. It imposes an **excess opportunity cost** if **slashing** is implemented.
|
||||
|
||||
**Seven elements of economic design for governance**
|
||||
|
||||
1. Scope of Decisions
|
||||
2. Stakeholders
|
||||
3. Policy Research & Development
|
||||
4. Proposal Process
|
||||
5. Information Distribution Systems
|
||||
6. Decision Making Procedures
|
||||
7. Implementation & Property Rights
|
||||
|
||||
## Yearly Governance Cycle
|
||||
|
||||
- Two General Elections for proposals yearly
|
||||
- Proposals need at least 20% of all validator approval to move into general election
|
||||
- 51% of General Vote required for proposal to pass
|
||||
- Emergency Voting sessions can be called if requested by 51% of Governance Participants
|
||||
|
||||
### ☀️ Summer Cycle
|
||||
|
||||
| | Start Date | End Date |
|
||||
| ----------------------------- | ---------- | -------- |
|
||||
| Validator Vetting | 5/17 | 5/31 |
|
||||
| Proposals Posted | 6/1 | |
|
||||
| General Election of Proposals | 6/2 | 6/15 |
|
||||
| Results Posted | 6/16 | |
|
||||
|
||||
### ❄️ Winter Cycle
|
||||
|
||||
| | Start Date | End Date |
|
||||
| ----------------------------- | ---------- | -------- |
|
||||
| Validator Vetting | 11/17 | 11/31 |
|
||||
| Proposals Posted | 12/1 | |
|
||||
| General Election of Proposals | 12/2 | 12/15 |
|
||||
| Results Posted | 12/16 | |
|
||||
|
||||
## First Rollout Phase
|
||||
|
||||
These are the measures the core Sonr team will be undertaking prior and during test-net deployment.
|
||||
|
||||
### Establish Community
|
||||
|
||||
Build a loyal community of token holders that represent our platforms stakeholder groups.
|
||||
|
||||
- All of our existing token holders (this includes our founder and early investors) will be staking their Sonr Token in order to be incentivized to hold tokens and participate in voting
|
||||
- We will be actively networking with DeFi projects, blockchain service providers, and etc. in order to participate
|
||||
|
||||
### Build Dashboards
|
||||
|
||||
We are under the process of creating a [dashboard](https://sonrscan.io) in order to provide key metrics to our stakeholders
|
||||
|
||||
- **Technology**: Pricing, total fees paid, total storage used, uptime
|
||||
- **Governance**: Identities, proposal outcomes, community participation
|
||||
|
||||
### Polling System
|
||||
|
||||
Our initial polling system will be token weighted and not enforceable, in order to build engagement.
|
||||
|
||||
- Users will submit qualitative updates to the system and have them up/downvoted
|
||||
- The core team will then assess the submissions and select viable community suggestions into upgrades
|
||||
- Along side this, our team will locate and commission the development of a proposal for any technical upgrades without enforceable code proposals
|
||||
- We will be able to provide clarity, external security, and in applicable cases the economic evaluation from the impacts of proposals to the community.
|
||||
|
||||
## Second Rollout Phase
|
||||
|
||||
Phase 2 will be underway in the months prior to main-net deployment, along with an extensive security audit.
|
||||
|
||||
### On-Chain Execution
|
||||
|
||||
We will be introducing an on-chain, executable code-based governance system in stages with majority rule voting.
|
||||
|
||||
**Stage 1:** Grants Program
|
||||
|
||||
- Incorporate community voting for grant recipient selection
|
||||
- Allow users to submit proposals for grant allocation
|
||||
|
||||
**Stage 2:** Subsidies and Rewards
|
||||
|
||||
- Proposals to update subsidies and rewards can be submitted by Core Sonr Team or third parties
|
||||
- Core Team will be responsible for considering funding security, and economic audits for proposals
|
||||
|
||||
**Stage 3:** Technical Upgrades
|
||||
|
||||
- These include pricing, security, and bug fixes
|
||||
- Proposals will be spearheaded by the Sonr Team and/or its delegates
|
||||
|
||||
### Maintenance
|
||||
|
||||
When on-chain governance has come to fruition, the core Sonr team will be also maintaining the polling-based system with subsidized development to minimize barrier to entry. This will be incorporating governance within the Motor Nebula Widget itself.
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "Rewards"
|
||||
sidebarTitle: "Network Rewards"
|
||||
description: "Incentivizing the Sonr Ecosystem"
|
||||
icon: "gem"
|
||||
---
|
||||
|
||||
In order to maximize buy-in and network availability for the Sonr ecosystem, we will be implementing an empirical Token Rewards mechanism. Rewards are a way to create inflation in order to dilute the token value, resulting in an affordable onboarding and operational experience for the end user. The goal behind Sonr Token rewards is to subsidize Highway based computation, in order to promote value creation and platform growth.
|
||||
|
||||
### Governance Participation
|
||||
|
||||
At the time of Main-net launch, phase one of the Sonr governance rollout will be implemented and will result in a set of rewards for participants.
|
||||
|
||||
**Submission of Proposals**
|
||||
|
||||
Users will be incentivized to submit blockchain improvement or grant proposals to be reviewed by voting participants. In order to prevent game from low quality and out of scope proposals, a clear-cut submission and evaluation process will be put into place on a public facing FAQ website.
|
||||
|
||||
- Proposers are required to stake before submission — _“Application Fee”_
|
||||
|
||||
**Proposal Voting**
|
||||
|
||||
In order to prevent innovation from halting on the Sonr ecosystem, we incentivize all staked users to participate in the polling process for community submitted proposals. Users are then rewarded for good-faith participation in voting, while also sustaining momentum.
|
||||
|
||||
- Existing Stakeholders are rewarded for good-faith participation in voting
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: "Staking"
|
||||
sidebarTitle: "Staking Functions"
|
||||
description: "Understand the staking mechanism on Sonr"
|
||||
icon: "vault"
|
||||
---
|
||||
|
||||
The clear path for the underlying application for staking is utilizing a Delegated Proof of Stake (DPoS) validation mechanism. Down the line Sonr will provide IPFS storage nodes, and governance participation in the staking model.
|
||||
|
||||
<Tip>
|
||||
Demand = Obtain rewards, goods, or services through staking or locking up the token.
|
||||
Supply = Tokens staked or locked up.
|
||||
|
||||
</Tip>
|
||||
|
||||
On Sonr we will be leveraging a **delegate stake** mechanism in order to **optimize buy-in** for users in the network. It imposes an **excess opportunity cost** if **slashing** is implemented.
|
||||
|
||||
With this being said, there are some challenges in implementing staking:
|
||||
|
||||
- The token must already have value
|
||||
- Allocating power or influence via staking gives major edge to wealthy users
|
||||
- They are frequently subject to gaming and coordination problems
|
||||
|
||||
However there is substantial benefit in incorporating a staking mechanism, with the following criteria met we can create a sustainable design:
|
||||
|
||||
1. The upfront capital required to stake should not significantly discourage them to stake
|
||||
2. If a stakeholder group is making decisions that materially harm the network, they would be punished via slashing the stake.
|
||||
3. Stakeholders can make decisions that positively impact the future network health and token price, therefore holding stake can promote positive Sonr growth
|
||||
|
||||
### Validator Nodes for Cosmos ASB
|
||||
|
||||
Sonr is a Cosmos powered blockchain which is powered by a TenderMint validation mechanism. The default consensus for TenderMint is DPoS and works with our current ABCI implementation for Transaction Verification. DPoS is a twist on Proof of Stake consensus that relies upon a group of delegates to validate blocks on behalf of all nodes in the network . Witnesses are elected by stakeholders at a rate of one vote per share per witness . Coin age is irrelevant. All coins that are mature will add the same staking weight (usually 1 in the wallet hover display) Results in stable, consistent interest only for active wallets and only with small inputs.
|
||||
|
||||
### IPFS Storage Nodes (excluding FileCoin)
|
||||
|
||||
When deploying standalone highway nodes, requiring minimum stake would be an additional method to enforce availability requirements. By having a stake we can ensure that the user deploying a node has a base level of buy-in within the ecosystem.
|
||||
|
||||
### Governance Participants
|
||||
|
||||
We will be incorporating a similar strategy to AlgoRand in our governance rollout. This is covered more extensively in the [Governance](https://www.notion.so/Governance-af1251b1b7aa41fab16c53dd9fe6ef63) section.
|
||||
@@ -0,0 +1,201 @@
|
||||
---
|
||||
title: Utility
|
||||
description: Use cases and utility functions of the SNR token including staking, governance, and network operations
|
||||
sidebarTitle: "Network Utility"
|
||||
icon: "cog"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The SNR token serves as the native utility token of the Sonr network, enabling various functions from transaction processing to governance participation. Its multi-faceted utility design ensures sustained demand and value accrual.
|
||||
|
||||
<Note>
|
||||
The SNR token's utility is designed to grow with the network, adding new use
|
||||
cases as the ecosystem expands while maintaining core functions for network
|
||||
security and operations.
|
||||
</Note>
|
||||
|
||||
## Core Utilities
|
||||
|
||||
### 1. Means of Payment
|
||||
|
||||
The primary utility of SNR is facilitating transactions across the Sonr blockchain for user account management and application operations.
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Transaction Fees">
|
||||
All on-chain operations require SNR for gas fees and computational resources
|
||||
</Card>
|
||||
<Card title="Service Payments">
|
||||
Payment for Highway services, storage, and off-chain computation
|
||||
</Card>
|
||||
<Card title="Application Fees">
|
||||
Developers pay SNR to register and update applications on the network
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
### 2. Staking Mechanisms
|
||||
|
||||
SNR tokens enable network security and participation through various staking options:
|
||||
|
||||
#### Validator Staking
|
||||
|
||||
- **Minimum Stake**: Required SNR deposit to run a validator node
|
||||
- **Delegated Staking**: Users can delegate SNR to validators for rewards
|
||||
- **Slashing Protection**: Validators must maintain good behavior or risk stake loss
|
||||
|
||||
#### Service Node Staking
|
||||
|
||||
- **Highway Nodes**: Stake required for running Highway service nodes
|
||||
- **IPFS Storage**: Minimum stake for operating storage infrastructure
|
||||
- **Availability Guarantee**: Staking ensures node uptime and reliability
|
||||
|
||||
<Warning>
|
||||
Staking locks tokens for a specified period, reducing circulating supply while
|
||||
earning rewards for network participation.
|
||||
</Warning>
|
||||
|
||||
### 3. Governance Participation
|
||||
|
||||
SNR tokens grant voting power in the decentralized governance system:
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Proposal Creation">
|
||||
Stake SNR to submit governance proposals with anti-spam mechanisms
|
||||
</Card>
|
||||
<Card title="Voting Rights">
|
||||
One token equals one vote in governance decisions
|
||||
</Card>
|
||||
<Card title="Participation Rewards">
|
||||
Earn SNR for active governance participation and quality proposals
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
## Module-Specific Operations
|
||||
|
||||
### Service Module (x/svc)
|
||||
|
||||
SNR tokens are required for service operations within the decentralized service marketplace:
|
||||
|
||||
- **Service Registration**: Pay SNR registration fees to claim unique TLD domains (e.g., `music.sonr`, `defi.sonr`)
|
||||
- **Capability Requests**: SNR deposits for requesting root capabilities via MPC signing
|
||||
- **Service Updates**: Fees for modifying service metadata or requesting additional permissions
|
||||
- **TLD Management**: Economic safeguards prevent domain squatting through registration fees
|
||||
|
||||
<Note>
|
||||
Service registration fees are burned or sent to the community pool based on
|
||||
governance parameters, creating deflationary pressure.
|
||||
</Note>
|
||||
|
||||
### DWN Module (x/dwn)
|
||||
|
||||
The DWN module enables revolutionary gasless onboarding while using SNR for advanced operations:
|
||||
|
||||
- **Gasless Vault Claiming**: Initial `MsgClaimVault` transactions require no SNR fees
|
||||
- **Vault Configuration**: SNR fees for updating vault settings and WASM runtime upgrades
|
||||
- **MPC Operations**: Transaction fees for multi-party computation within secure enclaves
|
||||
- **Cross-Chain Operations**: SNR payments for bridging assets and multi-chain vault management
|
||||
|
||||
### UCAN Module (x/ucan)
|
||||
|
||||
Authorization operations require SNR for security and spam prevention:
|
||||
|
||||
- **Root Capability Issuance**: SNR fees for initiating MPC threshold signing requests
|
||||
- **Revocation Processing**: Transaction fees for on-chain capability revocations
|
||||
- **Delegation Chain Verification**: Computational costs for validating complex authorization chains
|
||||
- **MPC Signing Participation**: Validator rewards for participating in multi-party computation
|
||||
|
||||
### DID Module (x/did)
|
||||
|
||||
Identity operations use SNR for registration and management:
|
||||
|
||||
- **DID Registration**: Fees for creating new decentralized identifiers
|
||||
- **Authentication Linking**: SNR costs for adding WebAuthn credentials or other auth methods
|
||||
- **Assertion Management**: Fees for linking/unlinking identity claims and verifications
|
||||
- **Transaction Execution**: SNR payments for UCAN-authorized transactions on behalf of DIDs
|
||||
|
||||
## Economic Mechanisms
|
||||
|
||||
### Demand Drivers
|
||||
|
||||
The token's value is driven by multiple demand sources:
|
||||
|
||||
```math
|
||||
\text{Demand} = \text{Transaction Volume} + \text{Staking Locked} + \text{Governance Participation}
|
||||
```
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Network Growth">
|
||||
More users and applications increase transaction demand
|
||||
</Card>
|
||||
<Card title="Staking Returns">
|
||||
Attractive yields encourage long-term token locking
|
||||
</Card>
|
||||
<Card title="Utility Expansion">
|
||||
New features and services create additional use cases
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
### Supply Dynamics
|
||||
|
||||
Effective supply is reduced through:
|
||||
|
||||
- **Staking Lockups**: Validators and delegators lock tokens
|
||||
- **Governance Stakes**: Proposal creation requires token deposits
|
||||
- **Service Collateral**: Service providers stake SNR for TLD registration
|
||||
- **Fee Burns**: Partial fee burning reduces total supply
|
||||
|
||||
## Developer Incentives
|
||||
|
||||
### Service Development
|
||||
|
||||
- **Service Registration Subsidies**: Reduced TLD domain costs for verified developers
|
||||
- **Root Capability Grants**: Free MPC signing for approved service capabilities
|
||||
- **Revenue Sharing**: Earn portion of service interaction fees through UCAN delegation
|
||||
- **Integration Support**: Subsidized vault interaction costs for new services
|
||||
|
||||
### Infrastructure Provision
|
||||
|
||||
- **Validator Operations**: SNR staking rewards for consensus participation and MPC signing
|
||||
- **MPC Node Operations**: Additional rewards for multi-party computation services
|
||||
- **IPFS Storage**: Compensation for decentralized vault configuration storage
|
||||
- **UCAN Verification**: Fees for running delegation chain validation services
|
||||
|
||||
<Check>
|
||||
The SNR token creates a sustainable economic model where users, developers,
|
||||
and infrastructure providers all benefit from network growth.
|
||||
</Check>
|
||||
|
||||
## Future Utilities
|
||||
|
||||
### Enhanced Module Features
|
||||
|
||||
- **Advanced UCAN Features**: Zero-knowledge capability proofs and cross-chain validation
|
||||
- **Vault Upgrades**: Seamless WASM runtime updates and social recovery mechanisms
|
||||
- **Service Marketplace**: Categorized service discovery with reputation systems
|
||||
- **Multi-sig Services**: Shared service ownership through DAO governance
|
||||
|
||||
### Cross-Chain Integration
|
||||
|
||||
- **IBC UCAN Verification**: Cross-chain capability validation fees
|
||||
- **Multi-Chain Vault Operations**: Enhanced cross-chain asset management
|
||||
- **Bridge Service Registration**: Specialized TLD domains for bridge operators
|
||||
- **Interchain DID Resolution**: Cross-chain identity verification services
|
||||
|
||||
### Privacy and Security Enhancements
|
||||
|
||||
- **Privacy-Preserving MPC**: Enhanced secure multi-party computation features
|
||||
- **Conditional Revocations**: Time or event-based capability revocations
|
||||
- **Hardware Vault Support**: Integration with dedicated secure hardware
|
||||
- **AI-Powered Workflows**: Natural language vault command processing
|
||||
|
||||
## Utility Summary
|
||||
|
||||
The SNR token's utility encompasses:
|
||||
|
||||
1. **Essential Operations**: Core network functions and transactions
|
||||
2. **Security Provision**: Staking for network consensus and safety
|
||||
3. **Governance Rights**: Democratic participation in protocol decisions
|
||||
4. **Economic Incentives**: Rewards for valuable contributions
|
||||
5. **Access Control**: Gateway to premium features and services
|
||||
|
||||
This comprehensive utility design ensures the SNR token remains central to the Sonr ecosystem's growth and sustainability.
|
||||
@@ -0,0 +1,235 @@
|
||||
---
|
||||
title: Values
|
||||
description: Value proposition and economic principles underlying the SNR token and its role in the ecosystem
|
||||
sidebarTitle: "Core Values"
|
||||
icon: "heart"
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The SNR token's value derives from fundamental economic principles, network utility, and carefully designed tokenomics. Understanding these value drivers helps participants make informed decisions about their involvement in the Sonr ecosystem.
|
||||
|
||||
<Note>
|
||||
Token value = Fundamental Value + Token-Specific Non-Fundamentals +
|
||||
Market/Industry Non-Fundamentals
|
||||
</Note>
|
||||
|
||||
## Fundamental Value Drivers
|
||||
|
||||
### Economic Activity
|
||||
|
||||
The core value proposition stems from actual network usage across Sonr's core modules:
|
||||
|
||||
```math
|
||||
\text{Fundamental Value} = \frac{\text{Economic Activity}}{\text{Circulating Supply} \times \text{Velocity}}
|
||||
```
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Service Registration">
|
||||
TLD domain fees and capability requests through the Service module
|
||||
</Card>
|
||||
<Card title="Identity Operations">
|
||||
DID registration, authentication linking, and assertion management
|
||||
</Card>
|
||||
<Card title="Authorization Services">
|
||||
UCAN issuance, revocation processing, and MPC signing operations
|
||||
</Card>
|
||||
<Card title="Vault Operations">
|
||||
DWN configuration updates and cross-chain management beyond gasless claiming
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
### Network Effects
|
||||
|
||||
Value increases exponentially with network growth:
|
||||
|
||||
1. **User Growth**: More vault claims and DID registrations increase identity network value
|
||||
2. **Service Adoption**: More TLD registrations create a valuable service namespace
|
||||
3. **Developer Integration**: Services leveraging UCAN authorization expand utility
|
||||
4. **Validator Participation**: MPC signing nodes improve security and capability issuance
|
||||
|
||||
## Property Rights
|
||||
|
||||
The SNR token grants specific rights that create intrinsic value:
|
||||
|
||||
### Governance Rights
|
||||
|
||||
- **Protocol Decisions**: Vote on network upgrades and parameters
|
||||
- **Treasury Management**: Control community fund allocation
|
||||
- **Economic Policy**: Influence inflation and reward distribution
|
||||
|
||||
### Economic Rights
|
||||
|
||||
- **Staking Rewards**: Earn returns for securing the network
|
||||
- **Fee Sharing**: Participate in protocol revenue distribution
|
||||
- **Priority Access**: Enhanced service levels for token holders
|
||||
|
||||
### Network Access
|
||||
|
||||
- **Service Registration**: Required for claiming TLD domains and registering services
|
||||
- **Identity Management**: Essential for DID operations and authentication linking
|
||||
- **Capability Authorization**: Needed for UCAN issuance and delegation chain verification
|
||||
- **Vault Configuration**: Access to advanced vault features beyond gasless claiming
|
||||
|
||||
<Check>
|
||||
The combination of governance, economic, and access rights creates a
|
||||
comprehensive value proposition for SNR holders.
|
||||
</Check>
|
||||
|
||||
## Value Accrual Mechanisms
|
||||
|
||||
### Supply Reduction
|
||||
|
||||
Multiple mechanisms reduce effective token supply:
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Staking Lockups">
|
||||
Validators and delegators lock tokens for rewards
|
||||
</Card>
|
||||
<Card title="Fee Burning">
|
||||
Portion of transaction fees permanently removed
|
||||
</Card>
|
||||
<Card title="Governance Deposits">Tokens locked for proposal creation</Card>
|
||||
<Card title="Service Registration">
|
||||
TLD domain registration fees create deflationary pressure
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
### Demand Growth
|
||||
|
||||
Sustainable demand drivers include:
|
||||
|
||||
1. **Organic Growth**: Natural increase in users and transactions
|
||||
2. **New Use Cases**: Expanding utility through development
|
||||
3. **Partnership Integration**: External protocols adopting SNR
|
||||
4. **Premium Features**: Advanced services requiring SNR payment
|
||||
|
||||
## Economic Sustainability
|
||||
|
||||
### Revenue Model
|
||||
|
||||
The network generates sustainable revenue through module-specific operations:
|
||||
|
||||
- **Service Module**: TLD domain registration fees and capability request deposits
|
||||
- **DID Module**: Identity registration, authentication linking, and assertion management fees
|
||||
- **UCAN Module**: Root capability issuance and revocation processing fees
|
||||
- **DWN Module**: Advanced vault configuration and cross-chain operation fees
|
||||
- **Validator Operations**: MPC signing participation and consensus rewards
|
||||
|
||||
### Cost Structure
|
||||
|
||||
Efficient operations maintain profitability:
|
||||
|
||||
- **MPC Infrastructure**: Multi-party computation hardware and coordination costs
|
||||
- **Module Development**: Ongoing improvements to Service, DID, UCAN, and DWN modules
|
||||
- **Security Audits**: WASM runtime, capability verification, and cryptographic audits
|
||||
- **Gasless Subsidies**: Network-funded vault claiming to remove onboarding barriers
|
||||
|
||||
## Market Dynamics
|
||||
|
||||
### Price Discovery
|
||||
|
||||
Token price reflects multiple factors:
|
||||
|
||||
<Warning>
|
||||
While fundamental value provides a baseline, market sentiment and external
|
||||
factors significantly influence short-term price movements.
|
||||
</Warning>
|
||||
|
||||
### Non-Fundamental Factors
|
||||
|
||||
#### Token-Specific
|
||||
|
||||
- Marketing campaigns and viral growth
|
||||
- Exchange listings and liquidity
|
||||
- Partnership announcements
|
||||
- Technical milestones
|
||||
|
||||
#### Market-Wide
|
||||
|
||||
- Cryptocurrency market cycles
|
||||
- Regulatory developments
|
||||
- Macroeconomic conditions
|
||||
- Technology trends
|
||||
|
||||
## Value Propositions
|
||||
|
||||
### For Users
|
||||
|
||||
1. **Digital Sovereignty**: Control your DID and vault without intermediaries
|
||||
2. **Gasless Onboarding**: Free vault claiming removes barriers to entry
|
||||
3. **Seamless Authentication**: WebAuthn integration with hardware-backed security
|
||||
4. **UCAN Authorization**: Granular, revocable permissions replace dangerous unlimited approvals
|
||||
|
||||
### For Developers
|
||||
|
||||
1. **Service Registration**: Claim unique TLD domains for decentralized services
|
||||
2. **UCAN Integration**: Built-in authorization system with capability delegation
|
||||
3. **Identity Infrastructure**: Native DID support with WebAuthn authentication
|
||||
4. **Revenue Models**: Earn through UCAN-mediated service interactions and fee sharing
|
||||
|
||||
### For Validators
|
||||
|
||||
1. **MPC Signing Rewards**: Additional compensation for multi-party computation participation
|
||||
2. **Capability Issuance**: Central role in root UCAN creation through threshold signing
|
||||
3. **Network Security**: Staking rewards for consensus participation and vault protection
|
||||
4. **Governance Influence**: Vote on protocol parameters and module improvements
|
||||
|
||||
### For Investors
|
||||
|
||||
1. **Module Expansion**: Growing utility across Service, DID, UCAN, and DWN modules
|
||||
2. **Deflationary Pressure**: Service registration fees and transaction burns reduce supply
|
||||
3. **Identity Network Effects**: Value compounds as more DIDs and services join the ecosystem
|
||||
4. **Technical Innovation**: Cutting-edge MPC, WASM, and WebAuthn integration
|
||||
|
||||
## Comparative Advantages
|
||||
|
||||
### vs. Traditional Systems
|
||||
|
||||
- **No Intermediaries**: Direct value transfer
|
||||
- **Global Access**: Permissionless participation
|
||||
- **Transparency**: On-chain verification
|
||||
- **User Control**: Self-sovereign identity
|
||||
|
||||
### vs. Other Blockchains
|
||||
|
||||
- **Native Authorization**: Built-in UCAN capability system replaces external auth
|
||||
- **Gasless Onboarding**: Free vault claiming removes crypto barriers
|
||||
- **MPC Security**: Multi-party computation eliminates single points of failure
|
||||
- **WebAuthn Integration**: Hardware-backed authentication without seed phrase management
|
||||
|
||||
## Long-Term Value Thesis
|
||||
|
||||
### Sustainable Growth
|
||||
|
||||
The SNR token's value proposition centers on:
|
||||
|
||||
1. **Real Utility**: Actual usage drives demand
|
||||
2. **Network Effects**: Growth compounds value
|
||||
3. **Economic Alignment**: All participants benefit
|
||||
4. **Technical Innovation**: Continuous improvement
|
||||
|
||||
### Value Metrics
|
||||
|
||||
Key indicators of fundamental value:
|
||||
|
||||
<CardGroup>
|
||||
<Card title="Vault Claims">
|
||||
Growing number of gasless vault registrations
|
||||
</Card>
|
||||
<Card title="Service Registrations">
|
||||
TLD domain claims and capability requests
|
||||
</Card>
|
||||
<Card title="UCAN Issuance">
|
||||
Authorization activity and delegation chains
|
||||
</Card>
|
||||
<Card title="MPC Participation">
|
||||
Validator involvement in threshold signing
|
||||
</Card>
|
||||
</CardGroup>
|
||||
|
||||
<Note>
|
||||
The SNR token represents ownership in a new paradigm of user-controlled
|
||||
internet infrastructure, with value derived from real utility, network
|
||||
effects, and sustainable economics.
|
||||
</Note>
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
openapi: post /dex.v1.Msg/ProvideLiquidity
|
||||
title: Provide Liquidity to Pool
|
||||
description: Add liquidity to DEX pools and earn LP tokens
|
||||
og:title: Add Liquidity to Cross-Chain Pools
|
||||
tag: x/dex
|
||||
---
|
||||
|
||||
<Info>
|
||||
LP tokens represent your proportional share of the pool and accrue trading fees.
|
||||
</Info>
|
||||
|
||||
<Note>
|
||||
Impermanent loss may occur when providing liquidity. Research the risks before proceeding.
|
||||
</Note>
|
||||
@@ -0,0 +1,16 @@
|
||||
---
|
||||
openapi: post /dex.v1.Msg/CancelOrder
|
||||
title: Cancel Limit Order
|
||||
description: Cancel active orders on remote DEX chains
|
||||
og:title: Cancel Cross-Chain Orders
|
||||
tag: x/dex
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Order cancellation is not instant. There's a small window where the order
|
||||
might still be filled before cancellation is processed.
|
||||
</Warning>
|
||||
|
||||
<Tip>
|
||||
Monitor the IBC packet acknowledgment to confirm successful cancellation.
|
||||
</Tip>
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
openapi: post /dex.v1.Msg/RegisterDEXAccount
|
||||
title: Register Interchain DEX Account
|
||||
description: Create a new ICA account for cross-chain trading operations
|
||||
og:title: Setup Cross-Chain Trading Account
|
||||
tag: x/dex
|
||||
---
|
||||
|
||||
<Note>
|
||||
Account creation is asynchronous. Monitor the IBC packet acknowledgment to confirm the account address.
|
||||
</Note>
|
||||
|
||||
<Warning>
|
||||
Each DID is limited to a maximum number of DEX accounts as configured in module parameters.
|
||||
</Warning>
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
openapi: post /dex.v1.Msg/CreateLimitOrder
|
||||
title: Create Limit Order
|
||||
description: Place limit orders on remote DEX chains
|
||||
og:title: Place Cross-Chain Limit Orders
|
||||
tag: x/dex
|
||||
---
|
||||
|
||||
<Info>
|
||||
Limit orders allow you to specify the exact price at which you want to trade,
|
||||
providing better control over execution prices.
|
||||
</Info>
|
||||
|
||||
<Note>
|
||||
Orders are subject to maker fees on most DEXs. Check the specific DEX documentation
|
||||
for fee structures.
|
||||
</Note>
|
||||
@@ -0,0 +1,16 @@
|
||||
---
|
||||
openapi: post /dex.v1.Msg/ExecuteSwap
|
||||
title: Execute Cross-Chain Swap
|
||||
description: Perform token swaps on remote DEX chains with slippage protection
|
||||
og:title: Cross-Chain Token Swap
|
||||
tag: x/dex
|
||||
---
|
||||
|
||||
<Tip>
|
||||
For better execution prices, consider breaking large swaps into smaller transactions
|
||||
or using the multi-hop routing feature.
|
||||
</Tip>
|
||||
|
||||
<Warning>
|
||||
Platform fees apply to all swaps. Check the current fee structure in module parameters.
|
||||
</Warning>
|
||||
@@ -0,0 +1,16 @@
|
||||
---
|
||||
openapi: post /dex.v1.Msg/RemoveLiquidity
|
||||
title: Remove Liquidity from Pool
|
||||
description: Withdraw assets from DEX pools by burning LP tokens
|
||||
og:title: Withdraw Liquidity from Cross-Chain Pools
|
||||
tag: x/dex
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Removing liquidity during high volatility may result in receiving different asset ratios
|
||||
than initially provided.
|
||||
</Warning>
|
||||
|
||||
<Tip>
|
||||
Set appropriate minimum amounts to protect against unfavorable price movements.
|
||||
</Tip>
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/AddService
|
||||
title: Add Service Endpoint
|
||||
description: Associate services and interaction endpoints with your DID
|
||||
og:title: Add DID Service
|
||||
tag: x/did
|
||||
---
|
||||
|
||||
<Tip>
|
||||
Service endpoints enable others to discover how to interact with
|
||||
your DID for specific purposes (messaging, data exchange, etc.).
|
||||
</Tip>
|
||||
|
||||
<Note>
|
||||
Service URLs should use HTTPS for security. Consider using
|
||||
decentralized storage for resilience.
|
||||
</Note>
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/AddVerificationMethod
|
||||
title: Add Verification Method
|
||||
description: Add cryptographic keys and authentication methods to your DID
|
||||
og:title: Enhance DID Security
|
||||
tag: x/did
|
||||
---
|
||||
|
||||
<Info>
|
||||
Adding multiple verification methods provides redundancy and enables
|
||||
different use cases (signing, encryption, authentication).
|
||||
</Info>
|
||||
|
||||
<Tip>
|
||||
Best practice: Add at least one backup verification method to prevent
|
||||
lockout if your primary method becomes unavailable.
|
||||
</Tip>
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/CreateDID
|
||||
title: Create W3C DID Document
|
||||
description: Create a new decentralized identifier with verification methods and services
|
||||
og:title: Create Decentralized Identity
|
||||
tag: x/did
|
||||
---
|
||||
|
||||
<Note>
|
||||
DID creation requires an existing account with tokens unless using gasless WebAuthn registration.
|
||||
</Note>
|
||||
|
||||
<Tip>
|
||||
Enable auto-vault creation to automatically set up secure credential storage.
|
||||
</Tip>
|
||||
@@ -0,0 +1,18 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/DeactivateDID
|
||||
title: Deactivate DID Document
|
||||
description: Permanently disable a decentralized identifier
|
||||
og:title: Deactivate Digital Identity
|
||||
tag: x/did
|
||||
---
|
||||
|
||||
<Warning>
|
||||
**This operation is PERMANENT and IRREVERSIBLE.**
|
||||
Deactivated DIDs cannot be reactivated. Ensure you have migrated
|
||||
any necessary data before deactivation.
|
||||
</Warning>
|
||||
|
||||
<Info>
|
||||
Deactivation is useful for key compromise scenarios or when
|
||||
transitioning to a new identity.
|
||||
</Info>
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/IssueVerifiableCredential
|
||||
title: Issue W3C Verifiable Credential
|
||||
description: Create cryptographically signed credentials for identity claims
|
||||
og:title: Issue Digital Credentials
|
||||
---
|
||||
|
||||
<Note>
|
||||
Only DIDs with appropriate verification methods can issue credentials.
|
||||
The issuer's reputation affects credential trustworthiness.
|
||||
</Note>
|
||||
|
||||
<Tip>
|
||||
Set reasonable expiration dates for credentials that represent
|
||||
time-bound claims (e.g., memberships, certifications).
|
||||
</Tip>
|
||||
|
||||
<Warning>
|
||||
Issued credentials cannot be modified. To update claims,
|
||||
revoke the old credential and issue a new one.
|
||||
</Warning>
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/LinkExternalWallet
|
||||
title: Link External Wallet to DID
|
||||
description: Connect MetaMask, Keplr, or other wallets to your decentralized identity
|
||||
og:title: External Wallet Integration
|
||||
tag: x/did
|
||||
---
|
||||
|
||||
<Note>
|
||||
Each wallet can only be linked to one DID. Attempting to link the same wallet
|
||||
to multiple DIDs will fail.
|
||||
</Note>
|
||||
|
||||
<Warning>
|
||||
Ensure you have control of the wallet before linking. Lost wallet access
|
||||
means losing this verification method.
|
||||
</Warning>
|
||||
|
||||
<Tip>
|
||||
After linking, you can use your external wallet to sign transactions
|
||||
and authenticate operations on behalf of your DID.
|
||||
</Tip>
|
||||
@@ -0,0 +1,16 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/RemoveService
|
||||
title: Remove Service Endpoint
|
||||
description: Remove service associations from your DID
|
||||
og:title: Remove DID Service
|
||||
tag: x/did
|
||||
---
|
||||
|
||||
<Note>
|
||||
Removing a service doesn't delete the actual service,
|
||||
only its association with the DID.
|
||||
</Note>
|
||||
|
||||
<Tip>
|
||||
Consider deprecation notices before removing widely-used services.
|
||||
</Tip>
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/RemoveVerificationMethod
|
||||
title: Remove Verification Method
|
||||
description: Remove keys and authentication methods from your DID
|
||||
og:title: Remove DID Verification Method
|
||||
tag: x/did
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Ensure you have alternative verification methods before removing.
|
||||
Removing all methods locks you out of your DID.
|
||||
</Warning>
|
||||
|
||||
<Tip>
|
||||
Best practice: Add new verification methods before removing old ones
|
||||
to maintain continuous access.
|
||||
</Tip>
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/RevokeVerifiableCredential
|
||||
title: Revoke Verifiable Credential
|
||||
description: Permanently invalidate an issued credential
|
||||
og:title: Revoke Digital Credential
|
||||
tag: x/did
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Revocation is permanent. Revoked credentials cannot be reinstated.
|
||||
To restore credentials, issue a new one with updated information.
|
||||
</Warning>
|
||||
|
||||
<Info>
|
||||
Always provide a clear revocation reason for transparency and
|
||||
audit trail purposes.
|
||||
</Info>
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/UpdateDID
|
||||
title: Update DID Document
|
||||
description: Modify verification methods, services, and controllers of your DID
|
||||
og:title: Update Decentralized Identity
|
||||
tag: x/did
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Updates are permanent and create a new version. Previous versions
|
||||
remain accessible for historical reference.
|
||||
</Warning>
|
||||
|
||||
<Tip>
|
||||
Use specific add/remove operations for individual changes rather
|
||||
than full document updates when possible.
|
||||
</Tip>
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Update DID Module Parameters
|
||||
description: Modify module parameters for decentralized identifier operations
|
||||
og:title: Update DID Module Parameters
|
||||
tag: x/did
|
||||
openapi: post /did.v1.Msg/UpdateParams
|
||||
---
|
||||
@@ -0,0 +1,75 @@
|
||||
---
|
||||
openapi: post /dwn.v1.Msg/ProtocolsConfigure
|
||||
title: Configure DWN Protocol
|
||||
description: Define structured data models and access patterns for interoperable applications
|
||||
og:title: DWN Protocol Configuration
|
||||
---
|
||||
|
||||
<Info>
|
||||
Protocols are the foundation of data interoperability in DWN, enabling applications to share and understand structured data.
|
||||
</Info>
|
||||
|
||||
## Protocol Architecture
|
||||
|
||||
### Protocol Definition Structure
|
||||
```json
|
||||
{
|
||||
"protocol": "https://protocols.sonr.io/health/v1",
|
||||
"published": true,
|
||||
"types": {
|
||||
"vitals": {
|
||||
"schema": "https://schema.org/VitalSign",
|
||||
"dataFormats": ["application/json"]
|
||||
},
|
||||
"records": {
|
||||
"schema": "https://schema.org/MedicalRecord",
|
||||
"dataFormats": ["application/json", "application/pdf"]
|
||||
}
|
||||
},
|
||||
"structure": {
|
||||
"vitals": {},
|
||||
"records": {
|
||||
"vitals": {}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Key Components
|
||||
|
||||
- **Types**: Define record types with schemas and formats
|
||||
- **Structure**: Specify hierarchical relationships
|
||||
- **Permissions**: Control access patterns
|
||||
- **Actions**: Define allowed operations
|
||||
|
||||
## Publishing Protocols
|
||||
|
||||
<Tip>
|
||||
Set `published: true` to make your protocol discoverable and reusable by the community.
|
||||
</Tip>
|
||||
|
||||
### Benefits of Published Protocols
|
||||
- **Discoverability**: Others can find and adopt your protocol
|
||||
- **Standardization**: Create industry-standard data models
|
||||
- **Ecosystem Growth**: Enable app interoperability
|
||||
|
||||
## Common Protocol Patterns
|
||||
|
||||
### Healthcare Protocol
|
||||
- Patient records hierarchy
|
||||
- Encrypted by default
|
||||
- Granular permission model
|
||||
|
||||
### Social Protocol
|
||||
- Posts, comments, reactions
|
||||
- Public/private content mixing
|
||||
- Media attachments
|
||||
|
||||
### IoT Protocol
|
||||
- Device data streams
|
||||
- Time-series organization
|
||||
- Aggregation rules
|
||||
|
||||
<Warning>
|
||||
Protocol URIs must be unique. Consider using versioned URIs (e.g., `/v1`, `/v2`) for upgrades.
|
||||
</Warning>
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
openapi: post /dwn.v1.Msg/RecordsDelete
|
||||
title: Delete DWN Record
|
||||
description: Remove records from your personal data vault with optional cascading deletion
|
||||
og:title: DWN Record Deletion
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Record deletion is **permanent** and cannot be undone. Ensure you have backups if needed.
|
||||
</Warning>
|
||||
|
||||
## Deletion Options
|
||||
|
||||
### Standard Deletion
|
||||
- Removes only the specified record
|
||||
- Child records remain intact
|
||||
- Preserves hierarchical structure
|
||||
|
||||
### Pruned Deletion (`prune: true`)
|
||||
- Removes the record and all descendants
|
||||
- Cascades through entire subtree
|
||||
- Useful for removing complete data structures
|
||||
|
||||
## Authorization Requirements
|
||||
|
||||
You must have one of the following:
|
||||
- **Owner**: Be the record author
|
||||
- **Permission**: Have explicit delete permission
|
||||
- **Protocol Authority**: Have protocol-level delete rights
|
||||
|
||||
<Note>
|
||||
The `deletedCount` in the response includes all pruned child records.
|
||||
</Note>
|
||||
|
||||
## Safety Considerations
|
||||
|
||||
<Tip>
|
||||
Query child records before pruning to understand the impact:
|
||||
```bash
|
||||
snrd query dwn records-query --parent-id <record_id>
|
||||
```
|
||||
</Tip>
|
||||
@@ -0,0 +1,104 @@
|
||||
---
|
||||
openapi: post /dwn.v1.Msg/PermissionsGrant
|
||||
title: Grant DWN Access Permission
|
||||
description: Authorize other users to access your data with fine-grained control
|
||||
og:title: DWN Permission Management
|
||||
---
|
||||
|
||||
<Info>
|
||||
DWN permissions enable secure data sharing with granular access control down to individual records.
|
||||
</Info>
|
||||
|
||||
## Permission Scopes
|
||||
|
||||
### Interface-Level
|
||||
Grant access to entire interfaces:
|
||||
- **Records**: Read/write any records
|
||||
- **Protocols**: Configure protocols
|
||||
- **Permissions**: Delegate permission management
|
||||
|
||||
### Method-Level
|
||||
Restrict to specific operations:
|
||||
- **Records.Write**: Create/update only
|
||||
- **Records.Query**: Read-only access
|
||||
- **Records.Delete**: Deletion rights
|
||||
|
||||
### Protocol-Level
|
||||
Scope to protocol-compliant records:
|
||||
```json
|
||||
{
|
||||
"protocol": "https://protocols.sonr.io/health/v1",
|
||||
"interfaceName": "Records",
|
||||
"method": "Query"
|
||||
}
|
||||
```
|
||||
|
||||
### Record-Level
|
||||
Grant access to specific records:
|
||||
```json
|
||||
{
|
||||
"recordId": "record_abc123",
|
||||
"method": "Write"
|
||||
}
|
||||
```
|
||||
|
||||
## Conditional Permissions
|
||||
|
||||
<Tip>
|
||||
Use conditions to create dynamic access rules that adapt to context.
|
||||
</Tip>
|
||||
|
||||
### Time-Based Conditions
|
||||
```json
|
||||
{
|
||||
"validFrom": "2024-01-01T00:00:00Z",
|
||||
"validUntil": "2024-12-31T23:59:59Z",
|
||||
"timezone": "UTC"
|
||||
}
|
||||
```
|
||||
|
||||
### Usage Limits
|
||||
```json
|
||||
{
|
||||
"maxReads": 100,
|
||||
"maxWrites": 10,
|
||||
"rateLimit": "10/hour"
|
||||
}
|
||||
```
|
||||
|
||||
### Custom Rules
|
||||
```json
|
||||
{
|
||||
"ipWhitelist": ["192.168.1.0/24"],
|
||||
"requireMFA": true,
|
||||
"allowedActions": ["read", "query"]
|
||||
}
|
||||
```
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
<Warning>
|
||||
Always set expiration times for permissions to limit exposure window.
|
||||
</Warning>
|
||||
|
||||
1. **Principle of Least Privilege**: Grant minimum necessary access
|
||||
2. **Time Limits**: Use `expiresAt` for temporary access
|
||||
3. **Scope Restriction**: Be specific about what's accessible
|
||||
4. **Regular Audits**: Review and revoke unused permissions
|
||||
|
||||
## Common Use Cases
|
||||
|
||||
### Healthcare Data Sharing
|
||||
- Grant doctor temporary access to medical records
|
||||
- Scope to specific record types
|
||||
- Auto-expire after appointment
|
||||
|
||||
### Collaborative Apps
|
||||
- Share project documents with team
|
||||
- Allow comments but not edits
|
||||
- Revoke when project ends
|
||||
|
||||
### IoT Device Access
|
||||
- Grant device write-only permission
|
||||
- Restrict to sensor data protocol
|
||||
- Rate limit submissions
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
openapi: post /dwn.v1.Msg/PermissionsRevoke
|
||||
title: Revoke DWN Permission
|
||||
description: Immediately remove access rights previously granted to other users
|
||||
og:title: DWN Permission Revocation
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Permission revocation takes effect **immediately**. Active sessions using the permission will be terminated.
|
||||
</Warning>
|
||||
|
||||
## Revocation Process
|
||||
|
||||
### Immediate Effects
|
||||
- Permission becomes invalid instantly
|
||||
- Active operations are interrupted
|
||||
- Cached permissions are invalidated
|
||||
- No grace period provided
|
||||
|
||||
### What Gets Revoked
|
||||
- The specific permission identified by `permissionId`
|
||||
- All derived sub-permissions
|
||||
- Any delegated permissions from this grant
|
||||
|
||||
## Finding Permissions to Revoke
|
||||
|
||||
<Tip>
|
||||
Query your active permissions before revoking:
|
||||
```bash
|
||||
snrd query dwn permissions-request --grantor <your_did>
|
||||
```
|
||||
</Tip>
|
||||
|
||||
## Authorization Requirements
|
||||
|
||||
You must be either:
|
||||
- **Original Grantor**: The entity who created the permission
|
||||
- **Admin Permission Holder**: Have permission management rights
|
||||
|
||||
## Revocation Scenarios
|
||||
|
||||
### Security Incident
|
||||
```bash
|
||||
# Revoke all permissions for compromised account
|
||||
snrd tx dwn permissions-revoke --grantee <compromised_did> --all
|
||||
```
|
||||
|
||||
### Project Completion
|
||||
```bash
|
||||
# Revoke team access after project ends
|
||||
snrd tx dwn permissions-revoke --permission-id <team_permission>
|
||||
```
|
||||
|
||||
### Access Audit
|
||||
```bash
|
||||
# Revoke unused permissions discovered in audit
|
||||
snrd tx dwn permissions-revoke --permission-id <unused_permission>
|
||||
```
|
||||
|
||||
<Note>
|
||||
Consider notifying affected users before revoking permissions to avoid disruption.
|
||||
</Note>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user