go/sonr
1
0
Fork 0
mirror of https://github.com/sonr-io/sonr.git synced 2026-09-17 07:26:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: migrate to blume docs

Browse Source
This commit is contained in:
Prad Nukala
2026-09-02 16:53:38 -04:00
parent b1a622ea13
commit 432ef49207
163 changed files with 2327 additions and 9908 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/queries/query-dex-get-account.mdx
+6 -6
View File
@@ -1,11 +1,11 @@
---
openapi: get /sonr/dex/v1/account/{did}/{connectionId}
title: Query DEX Account Details
description: Get information about a specific Interchain Account for DEX operations
og:title: DEX Account Information
seo:
title: "DEX Account Information"
---
<Note>
Account addresses are only available after successful IBC acknowledgment.
Pending accounts will have an empty address field.
</Note>
:::note
Account addresses are only available after successful IBC acknowledgment.
Pending accounts will have an empty address field.
:::
docs/reference/queries/query-dex-get-module-parameters.mdx
+6 -6
View File
@@ -1,11 +1,11 @@
---
openapi: get /sonr/dex/v1/params
title: DEX Module Parameters
description: Retrieve current configuration and operational limits for the DEX module
og:title: Query DEX Module Configuration
seo:
title: "Query DEX Module Configuration"
---
<Tip>
Cache parameter responses client-side as they change infrequently.
Refresh periodically or after governance proposals.
</Tip>
:::tip
Cache parameter responses client-side as they change infrequently.
Refresh periodically or after governance proposals.
:::
docs/reference/queries/query-dex-get-pool-information.mdx
+10 -10
View File
@@ -1,16 +1,16 @@
---
openapi: get /sonr/dex/v1/pool/{connectionId}/{poolId}
title: Query Liquidity Pool Details
description: Get comprehensive information about DEX liquidity pools
og:title: Liquidity Pool Information
seo:
title: "Liquidity Pool Information"
---
<Info>
Pool information is essential for calculating optimal liquidity provision
amounts and understanding potential returns.
</Info>
:::info
Pool information is essential for calculating optimal liquidity provision
amounts and understanding potential returns.
:::
<Warning>
Pool compositions can change rapidly. Always fetch current data
before providing liquidity.
</Warning>
:::warning
Pool compositions can change rapidly. Always fetch current data
before providing liquidity.
:::
docs/reference/queries/query-dex-get-remote-chain-balance.mdx
+9 -9
View File
@@ -1,15 +1,15 @@
---
openapi: get /sonr/dex/v1/balance/{did}/{connectionId}
title: Query Remote Chain Balances
description: Check token balances in your ICA account on remote chains
og:title: Cross-Chain Balance Query
seo:
title: "Cross-Chain Balance Query"
---
<Tip>
Use the optional `denom` parameter to check specific token balances
without fetching the entire balance list.
</Tip>
:::tip
Use the optional `denom` parameter to check specific token balances
without fetching the entire balance list.
:::
<Note>
Balances are fetched in real-time from the remote chain via IBC queries.
</Note>
:::note
Balances are fetched in real-time from the remote chain via IBC queries.
:::
docs/reference/queries/query-dex-get-transaction-history.mdx
+14 -14
View File
@@ -1,21 +1,21 @@
---
openapi: get /sonr/dex/v1/history/{did}
title: Query Trading History
description: Access complete cross-chain trading history for a DID
og:title: DEX Transaction History
seo:
title: "DEX Transaction History"
---
<Info>
Transaction history is stored permanently on the Sonr chain,
providing a complete audit trail of all DEX operations.
</Info>
:::info
Transaction history is stored permanently on the Sonr chain,
providing a complete audit trail of all DEX operations.
:::
<Tip>
Export historical data regularly for tax reporting and portfolio analysis.
Use filters to focus on specific time periods or operation types.
</Tip>
:::tip
Export historical data regularly for tax reporting and portfolio analysis.
Use filters to focus on specific time periods or operation types.
:::
<Note>
Large histories may require multiple paginated requests.
Use the pagination key for efficient retrieval.
</Note>
:::note
Large histories may require multiple paginated requests.
Use the pagination key for efficient retrieval.
:::
docs/reference/queries/query-dex-list-all-accounts.mdx
+6 -6
View File
@@ -1,11 +1,11 @@
---
openapi: get /sonr/dex/v1/accounts/{did}
title: List User's DEX Accounts
description: Retrieve all Interchain Accounts associated with a DID
og:title: List Cross-Chain Trading Accounts
seo:
title: "List Cross-Chain Trading Accounts"
---
<Info>
Each DID can have multiple accounts across different chains,
subject to the `maxAccountsPerDid` parameter limit.
</Info>
:::info
Each DID can have multiple accounts across different chains,
subject to the `maxAccountsPerDid` parameter limit.
:::
docs/reference/queries/query-dex-list-orders.mdx
+10 -10
View File
@@ -1,16 +1,16 @@
---
openapi: get /sonr/dex/v1/orders/{did}/{connectionId}
title: List User Orders
description: Retrieve limit orders for a DID on specific DEX chains
og:title: Query Cross-Chain Orders
seo:
title: "Query Cross-Chain Orders"
---
<Tip>
Use the `status` filter to query only active orders for portfolio management
or historical orders for tax reporting.
</Tip>
:::tip
Use the `status` filter to query only active orders for portfolio management
or historical orders for tax reporting.
:::
<Note>
Order history is retained for a limited time on most DEXs.
Archive important order data locally.
</Note>
:::note
Order history is retained for a limited time on most DEXs.
Archive important order data locally.
:::
docs/reference/queries/query-did-get-all-credentials-by-id.mdx
+18 -18
View File
@@ -1,26 +1,26 @@
---
openapi: get /did/v1/credentials/did/{did}
title: Get All DID Credentials
description: Retrieve complete credential portfolio for a decentralized identity
og:title: DID Credential Portfolio
seo:
title: "DID Credential Portfolio"
---
<Info>
This endpoint provides a complete view of all credentials associated
with a DID, useful for identity wallets and credential management.
</Info>
:::info
This endpoint provides a complete view of all credentials associated
with a DID, useful for identity wallets and credential management.
:::
<Note>
WebAuthn credentials are device-specific and cannot be transferred
between devices, unlike verifiable credentials.
</Note>
:::note
WebAuthn credentials are device-specific and cannot be transferred
between devices, unlike verifiable credentials.
:::
<Tip>
Use filter parameters to retrieve only the credential types your
application needs, reducing response size and processing time.
</Tip>
:::tip
Use filter parameters to retrieve only the credential types your
application needs, reducing response size and processing time.
:::
<Warning>
Sensitive credential data may be encrypted when stored in vaults.
Ensure proper decryption keys are available for encrypted credentials.
</Warning>
:::warning
Sensitive credential data may be encrypted when stored in vaults.
Ensure proper decryption keys are available for encrypted credentials.
:::
docs/reference/queries/query-did-get-by-controller.mdx
+10 -10
View File
@@ -1,16 +1,16 @@
---
openapi: get /did/v1/documents/controller/{controller}
title: Query DIDs by Controller
description: Find all decentralized identities controlled by an address
og:title: Controller DID Lookup
seo:
title: "Controller DID Lookup"
---
<Info>
A single address can control multiple DIDs, useful for managing
different identity contexts (personal, professional, etc.).
</Info>
:::info
A single address can control multiple DIDs, useful for managing
different identity contexts (personal, professional, etc.).
:::
<Tip>
Use this endpoint to build identity management interfaces that
show all DIDs a user controls from a single account.
</Tip>
:::tip
Use this endpoint to build identity management interfaces that
show all DIDs a user controls from a single account.
:::
docs/reference/queries/query-did-get-document.mdx
+6 -6
View File
@@ -1,11 +1,11 @@
---
openapi: get /did/v1/document/{did}
title: Get DID Document
description: Retrieve DID document with implementation details
og:title: DID Document Query
seo:
title: "DID Document Query"
---
<Tip>
Use ResolveDID for W3C-compliant resolution. Use this endpoint
when you need Sonr-specific implementation details.
</Tip>
:::tip
Use ResolveDID for W3C-compliant resolution. Use this endpoint
when you need Sonr-specific implementation details.
:::
docs/reference/queries/query-did-get-module-parameters.mdx
+10 -10
View File
@@ -1,16 +1,16 @@
---
openapi: get /did/v1/params
title: DID Module Parameters
description: Retrieve configuration settings and limits for the DID system
og:title: Query DID Module Configuration
seo:
title: "Query DID Module Configuration"
---
<Tip>
Check module parameters before creating DIDs to understand current
limits and supported features.
</Tip>
:::tip
Check module parameters before creating DIDs to understand current
limits and supported features.
:::
<Note>
Parameters can be updated through governance proposals.
Monitor changes that might affect your application.
</Note>
:::note
Parameters can be updated through governance proposals.
Monitor changes that might affect your application.
:::
docs/reference/queries/query-did-get-service-endpoint.mdx
+10 -10
View File
@@ -1,16 +1,16 @@
---
openapi: get /did/v1/service/{did}/{serviceId}
title: Get Service Endpoint
description: Retrieve interaction endpoints and service definitions
og:title: Query DID Service
seo:
title: "Query DID Service"
---
<Info>
Service endpoints tell others how to interact with the DID subject
for specific purposes like messaging or data exchange.
</Info>
:::info
Service endpoints tell others how to interact with the DID subject
for specific purposes like messaging or data exchange.
:::
<Tip>
Check service types to understand the interaction protocol before
attempting to connect to service endpoints.
</Tip>
:::tip
Check service types to understand the interaction protocol before
attempting to connect to service endpoints.
:::
docs/reference/queries/query-did-get-verifiable-credential.mdx
+14 -14
View File
@@ -1,21 +1,21 @@
---
openapi: get /did/v1/credential/{credentialId}
title: Get Verifiable Credential
description: Retrieve W3C verifiable credentials with cryptographic proofs
og:title: Query Digital Credential
seo:
title: "Query Digital Credential"
---
<Info>
Verifiable credentials are cryptographically signed claims that can
be independently verified without contacting the issuer.
</Info>
:::info
Verifiable credentials are cryptographically signed claims that can
be independently verified without contacting the issuer.
:::
<Warning>
Always check the `revoked` field and expiration date before
accepting a credential as valid.
</Warning>
:::warning
Always check the `revoked` field and expiration date before
accepting a credential as valid.
:::
<Tip>
Verify the issuer's DID to ensure the credential comes from a
trusted authority in your trust framework.
</Tip>
:::tip
Verify the issuer's DID to ensure the credential comes from a
trusted authority in your trust framework.
:::
docs/reference/queries/query-did-get-verification-method.mdx
+10 -10
View File
@@ -1,16 +1,16 @@
---
openapi: get /did/v1/verification-method/{did}/{methodId}
title: Get Verification Method
description: Retrieve specific cryptographic keys or authentication methods
og:title: Query DID Verification Method
seo:
title: "Query DID Verification Method"
---
<Note>
Verification methods contain public keys only. Private keys are
never stored on-chain and must be managed securely off-chain.
</Note>
:::note
Verification methods contain public keys only. Private keys are
never stored on-chain and must be managed securely off-chain.
:::
<Tip>
Use this endpoint to retrieve specific keys for signature verification
or encryption operations.
</Tip>
:::tip
Use this endpoint to retrieve specific keys for signature verification
or encryption operations.
:::
docs/reference/queries/query-did-list-all-documents.mdx
+10 -10
View File
@@ -1,16 +1,16 @@
---
openapi: get /did/v1/documents
title: List All DID Documents
description: Browse all decentralized identifiers in the system
og:title: DID Directory
seo:
title: "DID Directory"
---
<Note>
This endpoint returns all DIDs including deactivated ones.
Filter by the `deactivated` field for active DIDs only.
</Note>
:::note
This endpoint returns all DIDs including deactivated ones.
Filter by the `deactivated` field for active DIDs only.
:::
<Tip>
For large systems, use pagination parameters to retrieve documents
in manageable chunks. Start with a reasonable limit like 50-100.
</Tip>
:::tip
For large systems, use pagination parameters to retrieve documents
in manageable chunks. Start with a reasonable limit like 50-100.
:::
docs/reference/queries/query-did-list-verifiable-credentials.mdx
+14 -14
View File
@@ -1,21 +1,21 @@
---
openapi: get /did/v1/credentials
title: List Verifiable Credentials
description: Browse and filter W3C verifiable credentials
og:title: Credential Registry
seo:
title: "Credential Registry"
---
<Note>
By default, revoked credentials are excluded. Set `includeRevoked=true`
to include them in results.
</Note>
:::note
By default, revoked credentials are excluded. Set `includeRevoked=true`
to include them in results.
:::
<Tip>
Use issuer filtering to find all credentials from trusted authorities
in your ecosystem.
</Tip>
:::tip
Use issuer filtering to find all credentials from trusted authorities
in your ecosystem.
:::
<Info>
Large credential sets should use pagination to avoid timeout issues.
Start with a reasonable limit like 50-100 credentials per page.
</Info>
:::info
Large credential sets should use pagination to avoid timeout issues.
Start with a reasonable limit like 50-100 credentials per page.
:::
docs/reference/queries/query-did-resolve.mdx
+14 -14
View File
@@ -1,21 +1,21 @@
---
openapi: get /did/v1/resolve/{did}
title: Resolve W3C DID Document
description: Retrieve complete DID document with verification methods and services
og:title: DID Resolution
seo:
title: "DID Resolution"
---
<Info>
DID resolution is the primary way to discover how to interact with
a decentralized identity, including available keys and services.
</Info>
:::info
DID resolution is the primary way to discover how to interact with
a decentralized identity, including available keys and services.
:::
<Warning>
Deactivated DIDs cannot be resolved. The query will return an error
indicating the DID has been permanently disabled.
</Warning>
:::warning
Deactivated DIDs cannot be resolved. The query will return an error
indicating the DID has been permanently disabled.
:::
<Tip>
Cache resolved DID documents client-side with appropriate TTL based
on your security requirements and update frequency needs.
</Tip>
:::tip
Cache resolved DID documents client-side with appropriate TTL based
on your security requirements and update frequency needs.
:::
docs/reference/queries/query-dwn-encryption-status.mdx
+14 -14
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/encryption/status
title: Query Encryption Status
description: Monitor the health and state of the consensus encryption system
og:title: DWN Encryption System Status
seo:
title: "DWN Encryption System Status"
---
<Info>
The encryption system uses validator consensus to generate keys that no single party controls.
</Info>
:::info
The encryption system uses validator consensus to generate keys that no single party controls.
:::
## System Components
@@ -26,9 +26,9 @@ og:title: DWN Encryption System Status
## Health Monitoring
<Tip>
Set up alerts for upcoming key rotations to ensure smooth operations.
</Tip>
:::tip
Set up alerts for upcoming key rotations to ensure smooth operations.
:::
### Health Checks
@@ -55,9 +55,9 @@ const recordGrowthRate = totalEncryptedRecords / daysSinceLaunch;
- Security incidents
- Validator changes
<Warning>
Key rotation requires sufficient validator participation. Monitor validator set health.
</Warning>
:::warning
Key rotation requires sufficient validator participation. Monitor validator set health.
:::
## Development vs Production
@@ -73,9 +73,9 @@ const recordGrowthRate = totalEncryptedRecords / daysSinceLaunch;
## Monitoring Dashboard
<Note>
Create monitoring dashboards using these metrics for operational visibility.
</Note>
:::note
Create monitoring dashboards using these metrics for operational visibility.
:::
### Key Metrics
```bash
docs/reference/queries/query-dwn-ipfs-content-by-cid.mdx
+11 -11
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/ipfs/{cid}
title: Retrieve IPFS Content
description: Fetch distributed content using its Content Identifier
og:title: IPFS Content Retrieval
seo:
title: "IPFS Content Retrieval"
---
<Info>
Content Identifiers (CIDs) are cryptographic hashes that uniquely identify content in IPFS.
</Info>
:::info
Content Identifiers (CIDs) are cryptographic hashes that uniquely identify content in IPFS.
:::
## CID Resolution
@@ -29,18 +29,18 @@ CIDv1: bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi
## Performance Considerations
<Tip>
Pin frequently accessed content to your local IPFS node for faster retrieval.
</Tip>
:::tip
Pin frequently accessed content to your local IPFS node for faster retrieval.
:::
### Caching Strategy
- Hot data: Keep pinned locally
- Warm data: Cache with TTL
- Cold data: Fetch on demand
<Warning>
Large files may take time to retrieve if not cached locally or on nearby peers.
</Warning>
:::warning
Large files may take time to retrieve if not cached locally or on nearby peers.
:::
## Error Handling
docs/reference/queries/query-dwn-ipfs-status.mdx
+11 -11
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/ipfs
title: Query IPFS Node Status
description: Check connectivity and status of the distributed storage layer
og:title: IPFS Node Information
seo:
title: "IPFS Node Information"
---
<Info>
IPFS provides distributed storage for large objects, vault exports, and encrypted backups.
</Info>
:::info
IPFS provides distributed storage for large objects, vault exports, and encrypted backups.
:::
## IPFS Integration
@@ -23,9 +23,9 @@ og:title: IPFS Node Information
- **Protocol Assets**: Store protocol-related media
- **Public Content**: Distribute public records efficiently
<Tip>
Store only metadata and CIDs on-chain for gas efficiency, with actual data in IPFS.
</Tip>
:::tip
Store only metadata and CIDs on-chain for gas efficiency, with actual data in IPFS.
:::
## Common Patterns
@@ -36,6 +36,6 @@ ipfs add large_file.pdf
snrd tx dwn records-write --data-cid <cid>
```
<Warning>
Ensure IPFS node is running and accessible before storing large objects.
</Warning>
:::warning
Ensure IPFS node is running and accessible before storing large objects.
:::
docs/reference/queries/query-dwn-parameters.mdx
+8 -8
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/params
title: Query DWN Module Parameters
description: Get current configuration settings for the DWN module
og:title: DWN Module Configuration
seo:
title: "DWN Module Configuration"
---
<Info>
Module parameters control the global behavior of all DWN operations on the network.
</Info>
:::info
Module parameters control the global behavior of all DWN operations on the network.
:::
## Parameter Categories
@@ -28,6 +28,6 @@ og:title: DWN Module Configuration
- **encryptedSchemas**: Schemas requiring encryption
- **singleNodeFallback**: Development mode setting
<Tip>
Query parameters before designing your application to ensure compliance with network limits.
</Tip>
:::tip
Query parameters before designing your application to ensure compliance with network limits.
:::
docs/reference/queries/query-dwn-permissions.mdx
+15 -15
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/permissions/{target}
title: Query DWN Permissions
description: Audit and manage access control for your data
og:title: DWN Permission Management
seo:
title: "DWN Permission Management"
---
<Info>
Regular permission audits are essential for maintaining data security and compliance.
</Info>
:::info
Regular permission audits are essential for maintaining data security and compliance.
:::
## Permission Queries
@@ -36,9 +36,9 @@ og:title: DWN Permission Management
## Permission Auditing
<Tip>
Schedule regular audits to review and revoke unnecessary permissions.
</Tip>
:::tip
Schedule regular audits to review and revoke unnecessary permissions.
:::
### Audit Checklist
1. **Review Active Permissions**
@@ -47,7 +47,7 @@ og:title: DWN Permission Management
```
2. **Check Expired Permissions**
- Filter by `expiresAt` < current time
- Filter by `expiresAt` &lt; current time
- Revoke if still active
3. **Verify Grantee Activity**
@@ -70,9 +70,9 @@ og:title: DWN Permission Management
- Past expiration time
- Conditions not met
<Warning>
Permissions with no expiration should be reviewed more frequently.
</Warning>
:::warning
Permissions with no expiration should be reviewed more frequently.
:::
## Security Best Practices
@@ -93,6 +93,6 @@ og:title: DWN Permission Management
?interfaceName=Protocols
```
<Note>
Use `pagination.countTotal=true` to track total permission growth over time.
</Note>
:::note
Use `pagination.countTotal=true` to track total permission growth over time.
:::
docs/reference/queries/query-dwn-protocols.mdx
+14 -14
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/protocols/{target}
title: Query DWN Protocols
description: Discover configured protocols and their data models
og:title: DWN Protocol Discovery
seo:
title: "DWN Protocol Discovery"
---
<Info>
Protocols enable interoperable data structures across applications and users.
</Info>
:::info
Protocols enable interoperable data structures across applications and users.
:::
## Protocol Discovery
@@ -25,9 +25,9 @@ Common protocol namespaces:
## Protocol Adoption
<Tip>
Browse published protocols to find existing standards before creating custom ones.
</Tip>
:::tip
Browse published protocols to find existing standards before creating custom ones.
:::
### Adopting a Protocol
1. Query published protocols
@@ -50,15 +50,15 @@ snrd tx dwn protocols-configure --from <discovered_protocol>
- **Semantic Versioning**: `1.0.0`, `2.0.0`
- **Date Versioning**: `/2024`, `/2025`
<Warning>
Breaking protocol changes should use new URIs to maintain backward compatibility.
</Warning>
:::warning
Breaking protocol changes should use new URIs to maintain backward compatibility.
:::
## Pagination
<Note>
Large DWNs may have many protocols. Use pagination for efficient retrieval.
</Note>
:::note
Large DWNs may have many protocols. Use pagination for efficient retrieval.
:::
```bash
?pagination.limit=10&pagination.offset=0
docs/reference/queries/query-dwn-records.mdx
+14 -14
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/records/{target}
title: Query DWN Records
description: Search and retrieve data records with advanced filtering
og:title: DWN Record Query
seo:
title: "DWN Record Query"
---
<Info>
This endpoint provides powerful querying capabilities for exploring DWN data with multiple filter options.
</Info>
:::info
This endpoint provides powerful querying capabilities for exploring DWN data with multiple filter options.
:::
## Query Filters
@@ -37,9 +37,9 @@ Show only public records:
## Pagination Strategy
<Tip>
Use cursor-based pagination with `pagination.key` for optimal performance on large datasets.
</Tip>
:::tip
Use cursor-based pagination with `pagination.key` for optimal performance on large datasets.
:::
### Efficient Pagination
```bash
@@ -73,9 +73,9 @@ Show only public records:
?parentId=folder_root&pagination.limit=100
```
<Warning>
Encrypted records will return encrypted data unless you have decryption permissions.
</Warning>
:::warning
Encrypted records will return encrypted data unless you have decryption permissions.
:::
## Response Handling
@@ -85,6 +85,6 @@ Show only public records:
- **Encrypted**: Needs decryption keys
- **Deleted**: Tombstone markers
<Note>
Use `pagination.countTotal=true` sparingly as it impacts query performance.
</Note>
:::note
Use `pagination.countTotal=true` sparingly as it impacts query performance.
:::
docs/reference/queries/query-dwn-single-protocol.mdx
+11 -11
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/protocols/{target}/{protocolUri}
title: Query Specific Protocol
description: Get detailed protocol definition and configuration
og:title: DWN Protocol Details
seo:
title: "DWN Protocol Details"
---
<Info>
Protocol definitions specify the complete data model and access rules for structured interactions.
</Info>
:::info
Protocol definitions specify the complete data model and access rules for structured interactions.
:::
## Protocol Structure
@@ -44,9 +44,9 @@ og:title: DWN Protocol Details
## Protocol Analysis
<Tip>
Examine existing protocols to understand best practices before creating your own.
</Tip>
:::tip
Examine existing protocols to understand best practices before creating your own.
:::
### Understanding a Protocol
1. **Review Types**: What data can be stored?
@@ -71,9 +71,9 @@ og:title: DWN Protocol Details
- Time-series data structure
- Rate-limited writes
<Warning>
Protocol URIs must be URL-encoded when used as path parameters.
</Warning>
:::warning
Protocol URIs must be URL-encoded when used as path parameters.
:::
## Integration Example
docs/reference/queries/query-dwn-single-record.mdx
+11 -11
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/records/{target}/{recordId}
title: Query Specific Record
description: Retrieve a single record by its unique identifier
og:title: DWN Record Retrieval
seo:
title: "DWN Record Retrieval"
---
<Info>
Direct record access provides the most efficient way to retrieve known records.
</Info>
:::info
Direct record access provides the most efficient way to retrieve known records.
:::
## Record Components
@@ -30,9 +30,9 @@ og:title: DWN Record Retrieval
## Access Patterns
<Tip>
Cache frequently accessed record IDs to avoid repeated queries.
</Tip>
:::tip
Cache frequently accessed record IDs to avoid repeated queries.
:::
### Public Records
```bash
@@ -52,6 +52,6 @@ snrd query dwn record did:sonr:alice record_private_456
snrd query dwn encrypted-record did:sonr:alice record_encrypted_789
```
<Warning>
404 errors may indicate either non-existence or lack of permissions.
</Warning>
:::warning
404 errors may indicate either non-existence or lack of permissions.
:::
docs/reference/queries/query-dwn-single-vault.mdx
+14 -14
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/vaults/{vaultId}
title: Query Vault Details
description: Get comprehensive information about a secure vault instance
og:title: DWN Vault Information
seo:
title: "DWN Vault Information"
---
<Info>
Vaults provide hardware-backed secure key management through WebAssembly enclaves.
</Info>
:::info
Vaults provide hardware-backed secure key management through WebAssembly enclaves.
:::
## Vault Components
@@ -30,9 +30,9 @@ og:title: DWN Vault Information
## Vault Health Check
<Tip>
Monitor vault refresh intervals to ensure keys are rotated on schedule.
</Tip>
:::tip
Monitor vault refresh intervals to ensure keys are rotated on schedule.
:::
### Health Indicators
```javascript
@@ -58,9 +58,9 @@ const needsRotation = keyAge > keyRotationDays;
- Secure enclave support
- Hardware key storage
<Warning>
Never expose or log vault private data. It's encrypted for a reason.
</Warning>
:::warning
Never expose or log vault private data. It's encrypted for a reason.
:::
## Vault Operations
@@ -82,6 +82,6 @@ snrd tx dwn vault-export vault_alice_123
snrd tx dwn vault-import <ipfs_cid>
```
<Note>
Vault queries return public metadata only. Private keys remain encrypted in the enclave.
</Note>
:::note
Vault queries return public metadata only. Private keys remain encrypted in the enclave.
:::
docs/reference/queries/query-dwn-vault-by-owner.mdx
+14 -14
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/vaults
title: Query Vaults
description: List secure vaults with optional owner filtering
og:title: DWN Vault Listing
seo:
title: "DWN Vault Listing"
---
<Info>
Users typically have one primary vault, but may have multiple for different security contexts.
</Info>
:::info
Users typically have one primary vault, but may have multiple for different security contexts.
:::
## Query Patterns
@@ -24,9 +24,9 @@ og:title: DWN Vault Listing
## Vault Management
<Tip>
Create separate vaults for different security levels (personal, business, high-security).
</Tip>
:::tip
Create separate vaults for different security levels (personal, business, high-security).
:::
### Vault Strategy
@@ -61,9 +61,9 @@ snrd tx dwn vault-create --from alice
snrd query dwn vaults --owner did:sonr:alice
```
<Warning>
Vault creation may be disabled by governance. Check module parameters first.
</Warning>
:::warning
Vault creation may be disabled by governance. Check module parameters first.
:::
## Pagination
@@ -76,6 +76,6 @@ snrd query dwn vaults --owner did:sonr:alice
?owner=did:sonr:alice&pagination.key=<next_key>
```
<Note>
Most users have 1-3 vaults. Pagination is mainly for system-wide queries.
</Note>
:::note
Most users have 1-3 vaults. Pagination is mainly for system-wide queries.
:::
docs/reference/queries/query-dwn-vrf-consensus-contributions.mdx
+14 -14
View File
@@ -1,13 +1,13 @@
---
openapi: get /dwn/v1/encryption/vrf-contributions
title: Query VRF Contributions
description: Monitor validator participation in consensus key generation
og:title: DWN VRF Consensus Tracking
seo:
title: "DWN VRF Consensus Tracking"
---
<Info>
VRF contributions ensure distributed key generation where no single validator knows the complete key.
</Info>
:::info
VRF contributions ensure distributed key generation where no single validator knows the complete key.
:::
## VRF Consensus Process
@@ -28,9 +28,9 @@ og:title: DWN VRF Consensus Tracking
## Query Filters
<Tip>
Filter by validator to track specific node participation.
</Tip>
:::tip
Filter by validator to track specific node participation.
:::
### By Validator
```bash
@@ -63,9 +63,9 @@ og:title: DWN VRF Consensus Tracking
- **receivedContributions**: Current count
- **expiryHeight**: Timeout block height
<Warning>
Rounds expire if threshold isn't met. Monitor contribution progress.
</Warning>
:::warning
Rounds expire if threshold isn't met. Monitor contribution progress.
:::
## Validator Monitoring
@@ -112,9 +112,9 @@ CONTRIBUTIONS=$(snrd query dwn vrf-contributions -o json)
- Prevents minority attacks
- Ensures decentralization
<Note>
VRF contributions are public but the derived key remains secure through threshold cryptography.
</Note>
:::note
VRF contributions are public but the derived key remains secure through threshold cryptography.
:::
## Troubleshooting
docs/reference/queries/query-svc-domain-verification-status.mdx
+11 -11
View File
@@ -1,13 +1,13 @@
---
openapi: get /svc/v1/domain/{domain}
title: Check Domain Verification Status
description: Monitor domain ownership verification progress and status
og:title: Domain Verification Status
seo:
title: "Domain Verification Status"
---
<Info>
Use this endpoint to track your domain verification progress and troubleshoot issues.
</Info>
:::info
Use this endpoint to track your domain verification progress and troubleshoot issues.
:::
## Verification States
@@ -81,9 +81,9 @@ while true; do
done
```
<Tip>
If status remains PENDING after adding DNS record, wait for propagation (5-30 minutes typical).
</Tip>
:::tip
If status remains PENDING after adding DNS record, wait for propagation (5-30 minutes typical).
:::
## Troubleshooting
@@ -98,6 +98,6 @@ done
- Add new token to DNS
- Complete within 7 days
<Warning>
Verification tokens are single-use. Each verification attempt requires a new token.
</Warning>
:::warning
Verification tokens are single-use. Each verification attempt requires a new token.
:::
docs/reference/queries/query-svc-module-parameters.mdx
+8 -8
View File
@@ -1,13 +1,13 @@
---
openapi: get /svc/v1/params
title: Query SVC Module Parameters
description: Get current service registration and domain verification settings
og:title: SVC Module Configuration
seo:
title: "SVC Module Configuration"
---
<Info>
Module parameters define the operational constraints and requirements for all services on the network.
</Info>
:::info
Module parameters define the operational constraints and requirements for all services on the network.
:::
## Parameter Overview
@@ -39,6 +39,6 @@ og:title: SVC Module Configuration
- **maxUpdatesPerBlock**: Update spam prevention
- **maxCapabilityGrantsPerBlock**: Grant spam prevention
<Tip>
Check these parameters before designing your service to ensure compliance with network limits.
</Tip>
:::tip
Check these parameters before designing your service to ensure compliance with network limits.
:::
docs/reference/queries/query-svc-service-by-id.mdx
+11 -11
View File
@@ -1,13 +1,13 @@
---
openapi: get /svc/v1/service/{serviceId}
title: Query Service Details
description: Get comprehensive information about a registered service
og:title: Service Information
seo:
title: "Service Information"
---
<Info>
This endpoint provides complete service details needed for integration and trust verification.
</Info>
:::info
This endpoint provides complete service details needed for integration and trust verification.
:::
## Service Information
@@ -79,9 +79,9 @@ ipfs cat $CID
## Permission Verification
<Tip>
Always verify service permissions match your security requirements before granting access.
</Tip>
:::tip
Always verify service permissions match your security requirements before granting access.
:::
### Common Permission Sets
@@ -122,6 +122,6 @@ if [ "$SERVICE_DOMAIN" = "$EXPECTED" ]; then
fi
```
<Warning>
Never trust a service without verifying its domain binding and active status.
</Warning>
:::warning
Never trust a service without verifying its domain binding and active status.
:::
docs/reference/queries/query-svc-services-by-domain.mdx
+14 -14
View File
@@ -1,13 +1,13 @@
---
openapi: get /svc/v1/services/domain/{domain}
title: Query Services by Domain
description: Discover all services registered under a specific domain
og:title: Domain Service Discovery
seo:
title: "Domain Service Discovery"
---
<Info>
Domain-based discovery helps users find and trust services through verified domain ownership.
</Info>
:::info
Domain-based discovery helps users find and trust services through verified domain ownership.
:::
## Discovery Patterns
@@ -92,9 +92,9 @@ async function discoverServices(domain) {
- `vault@secure.example.com` - Vault manager
- `wallet@finance.example.com` - Wallet service
<Tip>
Use subdomains to organize services by category or security level.
</Tip>
:::tip
Use subdomains to organize services by category or security level.
:::
## Trust Establishment
@@ -142,9 +142,9 @@ Test services on subdomains:
- `staging@dev.example.com` - Staging service
- `prod@example.com` - Production service
<Warning>
Always verify domain ownership status before trusting services bound to that domain.
</Warning>
:::warning
Always verify domain ownership status before trusting services bound to that domain.
:::
## Usage Analytics
@@ -162,6 +162,6 @@ snrd query svc services-by-domain example.com -o json |
jq '[.services[].permissions] | flatten | unique'
```
<Note>
Domains can host multiple services, each with unique IDs and permission sets. Plan your service architecture accordingly.
</Note>
:::note
Domains can host multiple services, each with unique IDs and permission sets. Plan your service architecture accordingly.
:::
docs/reference/queries/query-svc-services-by-owner.mdx
+13 -12
View File
@@ -1,13 +1,13 @@
---
openapi: get /svc/v1/services/owner/{owner}
title: Query Services by Owner
description: List all services registered by a specific account
og:title: Owner Service Portfolio
seo:
title: "Owner Service Portfolio"
---
<Info>
This endpoint helps owners manage their service portfolio and monitor service health.
</Info>
:::info
This endpoint helps owners manage their service portfolio and monitor service health.
:::
## Use Cases
@@ -81,7 +81,8 @@ Returns array of services:
```bash
# Check for non-active services
SERVICES=$(snrd query svc services-by-owner $ADDR -o json)
echo $SERVICES | jq '.services[] | select(.status != "ACTIVE")' ```
echo $SERVICES | jq '.services[] | select(.status != "ACTIVE")'
```
### Permission Audit
```bash
@@ -96,9 +97,9 @@ echo $SERVICES | jq '.services[].permissions' |
echo $SERVICES | jq -r '.services[].domain' | sort | uniq
```
<Tip>
Regularly audit your services to ensure they're active and permissions are appropriate.
</Tip>
:::tip
Regularly audit your services to ensure they're active and permissions are appropriate.
:::
## Limits and Constraints
@@ -113,6 +114,6 @@ echo $SERVICES | jq -r '.services[].domain' | sort | uniq
- **Regular Audits**: Review inactive services
- **Clean Up**: Remove unused services
<Warning>
Approaching the service limit? Consider consolidating services or requesting limit increase through governance.
</Warning>
:::warning
Approaching the service limit? Consider consolidating services or requesting limit increase through governance.
:::