mirror of
https://github.com/sonr-io/sonr.git
synced 2026-09-17 07:26:25 +00:00
feat: migrate to blume docs
This commit is contained in:
Prad Nukala
@@ -1,15 +1,16 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/dex
|
||||
seo:
|
||||
title: "Add Liquidity to Cross-Chain Pools"
|
||||
---
|
||||
|
||||
<Info>
|
||||
LP tokens represent your proportional share of the pool and accrue trading fees.
|
||||
</Info>
|
||||
:::info
|
||||
LP tokens represent your proportional share of the pool and accrue trading fees.
|
||||
:::
|
||||
|
||||
<Note>
|
||||
Impermanent loss may occur when providing liquidity. Research the risks before proceeding.
|
||||
</Note>
|
||||
:::note
|
||||
Impermanent loss may occur when providing liquidity. Research the risks before proceeding.
|
||||
:::
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/dex
|
||||
seo:
|
||||
title: "Cancel Cross-Chain Orders"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Order cancellation is not instant. There's a small window where the order
|
||||
might still be filled before cancellation is processed.
|
||||
</Warning>
|
||||
:::warning
|
||||
Order cancellation is not instant. There's a small window where the order
|
||||
might still be filled before cancellation is processed.
|
||||
:::
|
||||
|
||||
<Tip>
|
||||
Monitor the IBC packet acknowledgment to confirm successful cancellation.
|
||||
</Tip>
|
||||
:::tip
|
||||
Monitor the IBC packet acknowledgment to confirm successful cancellation.
|
||||
:::
|
||||
|
||||
@@ -1,15 +1,16 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/dex
|
||||
seo:
|
||||
title: "Setup Cross-Chain Trading Account"
|
||||
---
|
||||
|
||||
<Note>
|
||||
Account creation is asynchronous. Monitor the IBC packet acknowledgment to confirm the account address.
|
||||
</Note>
|
||||
:::note
|
||||
Account creation is asynchronous. Monitor the IBC packet acknowledgment to confirm the account address.
|
||||
:::
|
||||
|
||||
<Warning>
|
||||
Each DID is limited to a maximum number of DEX accounts as configured in module parameters.
|
||||
</Warning>
|
||||
:::warning
|
||||
Each DID is limited to a maximum number of DEX accounts as configured in module parameters.
|
||||
:::
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/dex
|
||||
seo:
|
||||
title: "Place Cross-Chain Limit Orders"
|
||||
---
|
||||
|
||||
<Info>
|
||||
Limit orders allow you to specify the exact price at which you want to trade,
|
||||
providing better control over execution prices.
|
||||
</Info>
|
||||
:::info
|
||||
Limit orders allow you to specify the exact price at which you want to trade,
|
||||
providing better control over execution prices.
|
||||
:::
|
||||
|
||||
<Note>
|
||||
Orders are subject to maker fees on most DEXs. Check the specific DEX documentation
|
||||
for fee structures.
|
||||
</Note>
|
||||
:::note
|
||||
Orders are subject to maker fees on most DEXs. Check the specific DEX documentation
|
||||
for fee structures.
|
||||
:::
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/dex
|
||||
seo:
|
||||
title: "Cross-Chain Token Swap"
|
||||
---
|
||||
|
||||
<Tip>
|
||||
For better execution prices, consider breaking large swaps into smaller transactions
|
||||
or using the multi-hop routing feature.
|
||||
</Tip>
|
||||
:::tip
|
||||
For better execution prices, consider breaking large swaps into smaller transactions
|
||||
or using the multi-hop routing feature.
|
||||
:::
|
||||
|
||||
<Warning>
|
||||
Platform fees apply to all swaps. Check the current fee structure in module parameters.
|
||||
</Warning>
|
||||
:::warning
|
||||
Platform fees apply to all swaps. Check the current fee structure in module parameters.
|
||||
:::
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/dex
|
||||
seo:
|
||||
title: "Withdraw Liquidity from Cross-Chain Pools"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Removing liquidity during high volatility may result in receiving different asset ratios
|
||||
than initially provided.
|
||||
</Warning>
|
||||
:::warning
|
||||
Removing liquidity during high volatility may result in receiving different asset ratios
|
||||
than initially provided.
|
||||
:::
|
||||
|
||||
<Tip>
|
||||
Set appropriate minimum amounts to protect against unfavorable price movements.
|
||||
</Tip>
|
||||
:::tip
|
||||
Set appropriate minimum amounts to protect against unfavorable price movements.
|
||||
:::
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "Add DID Service"
|
||||
---
|
||||
|
||||
<Tip>
|
||||
Service endpoints enable others to discover how to interact with
|
||||
your DID for specific purposes (messaging, data exchange, etc.).
|
||||
</Tip>
|
||||
:::tip
|
||||
Service endpoints enable others to discover how to interact with
|
||||
your DID for specific purposes (messaging, data exchange, etc.).
|
||||
:::
|
||||
|
||||
<Note>
|
||||
Service URLs should use HTTPS for security. Consider using
|
||||
decentralized storage for resilience.
|
||||
</Note>
|
||||
:::note
|
||||
Service URLs should use HTTPS for security. Consider using
|
||||
decentralized storage for resilience.
|
||||
:::
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "Enhance DID Security"
|
||||
---
|
||||
|
||||
<Info>
|
||||
Adding multiple verification methods provides redundancy and enables
|
||||
different use cases (signing, encryption, authentication).
|
||||
</Info>
|
||||
:::info
|
||||
Adding multiple verification methods provides redundancy and enables
|
||||
different use cases (signing, encryption, authentication).
|
||||
:::
|
||||
|
||||
<Tip>
|
||||
Best practice: Add at least one backup verification method to prevent
|
||||
lockout if your primary method becomes unavailable.
|
||||
</Tip>
|
||||
:::tip
|
||||
Best practice: Add at least one backup verification method to prevent
|
||||
lockout if your primary method becomes unavailable.
|
||||
:::
|
||||
|
||||
@@ -1,15 +1,16 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "Create Decentralized Identity"
|
||||
---
|
||||
|
||||
<Note>
|
||||
DID creation requires an existing account with tokens unless using gasless WebAuthn registration.
|
||||
</Note>
|
||||
:::note
|
||||
DID creation requires an existing account with tokens unless using gasless WebAuthn registration.
|
||||
:::
|
||||
|
||||
<Tip>
|
||||
Enable auto-vault creation to automatically set up secure credential storage.
|
||||
</Tip>
|
||||
:::tip
|
||||
Enable auto-vault creation to automatically set up secure credential storage.
|
||||
:::
|
||||
|
||||
@@ -1,18 +1,19 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/DeactivateDID
|
||||
title: Deactivate DID Document
|
||||
description: Permanently disable a decentralized identifier
|
||||
og:title: Deactivate Digital Identity
|
||||
tag: x/did
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "Deactivate Digital Identity"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
**This operation is PERMANENT and IRREVERSIBLE.**
|
||||
Deactivated DIDs cannot be reactivated. Ensure you have migrated
|
||||
any necessary data before deactivation.
|
||||
</Warning>
|
||||
:::warning
|
||||
**This operation is PERMANENT and IRREVERSIBLE.**
|
||||
Deactivated DIDs cannot be reactivated. Ensure you have migrated
|
||||
any necessary data before deactivation.
|
||||
:::
|
||||
|
||||
<Info>
|
||||
Deactivation is useful for key compromise scenarios or when
|
||||
transitioning to a new identity.
|
||||
</Info>
|
||||
:::info
|
||||
Deactivation is useful for key compromise scenarios or when
|
||||
transitioning to a new identity.
|
||||
:::
|
||||
|
||||
@@ -1,21 +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
|
||||
seo:
|
||||
title: "Issue Digital Credentials"
|
||||
---
|
||||
|
||||
<Note>
|
||||
Only DIDs with appropriate verification methods can issue credentials.
|
||||
The issuer's reputation affects credential trustworthiness.
|
||||
</Note>
|
||||
:::note
|
||||
Only DIDs with appropriate verification methods can issue credentials.
|
||||
The issuer's reputation affects credential trustworthiness.
|
||||
:::
|
||||
|
||||
<Tip>
|
||||
Set reasonable expiration dates for credentials that represent
|
||||
time-bound claims (e.g., memberships, certifications).
|
||||
</Tip>
|
||||
:::tip
|
||||
Set reasonable expiration dates for credentials that represent
|
||||
time-bound claims (e.g., memberships, certifications).
|
||||
:::
|
||||
|
||||
<Warning>
|
||||
Issued credentials cannot be modified. To update claims,
|
||||
revoke the old credential and issue a new one.
|
||||
</Warning>
|
||||
:::warning
|
||||
Issued credentials cannot be modified. To update claims,
|
||||
revoke the old credential and issue a new one.
|
||||
:::
|
||||
|
||||
@@ -1,22 +1,23 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "External Wallet Integration"
|
||||
---
|
||||
|
||||
<Note>
|
||||
Each wallet can only be linked to one DID. Attempting to link the same wallet
|
||||
to multiple DIDs will fail.
|
||||
</Note>
|
||||
:::note
|
||||
Each wallet can only be linked to one DID. Attempting to link the same wallet
|
||||
to multiple DIDs will fail.
|
||||
:::
|
||||
|
||||
<Warning>
|
||||
Ensure you have control of the wallet before linking. Lost wallet access
|
||||
means losing this verification method.
|
||||
</Warning>
|
||||
:::warning
|
||||
Ensure you have control of the wallet before linking. Lost wallet access
|
||||
means losing this verification method.
|
||||
:::
|
||||
|
||||
<Tip>
|
||||
After linking, you can use your external wallet to sign transactions
|
||||
and authenticate operations on behalf of your DID.
|
||||
</Tip>
|
||||
:::tip
|
||||
After linking, you can use your external wallet to sign transactions
|
||||
and authenticate operations on behalf of your DID.
|
||||
:::
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "Remove DID Service"
|
||||
---
|
||||
|
||||
<Note>
|
||||
Removing a service doesn't delete the actual service,
|
||||
only its association with the DID.
|
||||
</Note>
|
||||
:::note
|
||||
Removing a service doesn't delete the actual service,
|
||||
only its association with the DID.
|
||||
:::
|
||||
|
||||
<Tip>
|
||||
Consider deprecation notices before removing widely-used services.
|
||||
</Tip>
|
||||
:::tip
|
||||
Consider deprecation notices before removing widely-used services.
|
||||
:::
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "Remove DID Verification Method"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Ensure you have alternative verification methods before removing.
|
||||
Removing all methods locks you out of your DID.
|
||||
</Warning>
|
||||
:::warning
|
||||
Ensure you have alternative verification methods before removing.
|
||||
Removing all methods locks you out of your DID.
|
||||
:::
|
||||
|
||||
<Tip>
|
||||
Best practice: Add new verification methods before removing old ones
|
||||
to maintain continuous access.
|
||||
</Tip>
|
||||
:::tip
|
||||
Best practice: Add new verification methods before removing old ones
|
||||
to maintain continuous access.
|
||||
:::
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
---
|
||||
openapi: post /did.v1.Msg/RevokeVerifiableCredential
|
||||
title: Revoke Verifiable Credential
|
||||
description: Permanently invalidate an issued credential
|
||||
og:title: Revoke Digital Credential
|
||||
tag: x/did
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "Revoke Digital Credential"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Revocation is permanent. Revoked credentials cannot be reinstated.
|
||||
To restore credentials, issue a new one with updated information.
|
||||
</Warning>
|
||||
:::warning
|
||||
Revocation is permanent. Revoked credentials cannot be reinstated.
|
||||
To restore credentials, issue a new one with updated information.
|
||||
:::
|
||||
|
||||
<Info>
|
||||
Always provide a clear revocation reason for transparency and
|
||||
audit trail purposes.
|
||||
</Info>
|
||||
:::info
|
||||
Always provide a clear revocation reason for transparency and
|
||||
audit trail purposes.
|
||||
:::
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "Update Decentralized Identity"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Updates are permanent and create a new version. Previous versions
|
||||
remain accessible for historical reference.
|
||||
</Warning>
|
||||
:::warning
|
||||
Updates are permanent and create a new version. Previous versions
|
||||
remain accessible for historical reference.
|
||||
:::
|
||||
|
||||
<Tip>
|
||||
Use specific add/remove operations for individual changes rather
|
||||
than full document updates when possible.
|
||||
</Tip>
|
||||
:::tip
|
||||
Use specific add/remove operations for individual changes rather
|
||||
than full document updates when possible.
|
||||
:::
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
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
|
||||
sidebar:
|
||||
badge: x/did
|
||||
seo:
|
||||
title: "Update DID Module Parameters"
|
||||
---
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
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
|
||||
seo:
|
||||
title: "DWN Protocol Configuration"
|
||||
---
|
||||
|
||||
<Info>
|
||||
Protocols are the foundation of data interoperability in DWN, enabling applications to share and understand structured data.
|
||||
</Info>
|
||||
:::info
|
||||
Protocols are the foundation of data interoperability in DWN, enabling applications to share and understand structured data.
|
||||
:::
|
||||
|
||||
## Protocol Architecture
|
||||
|
||||
@@ -44,9 +44,9 @@ og:title: DWN Protocol Configuration
|
||||
|
||||
## Publishing Protocols
|
||||
|
||||
<Tip>
|
||||
Set `published: true` to make your protocol discoverable and reusable by the community.
|
||||
</Tip>
|
||||
:::tip
|
||||
Set `published: true` to make your protocol discoverable and reusable by the community.
|
||||
:::
|
||||
|
||||
### Benefits of Published Protocols
|
||||
- **Discoverability**: Others can find and adopt your protocol
|
||||
@@ -70,6 +70,6 @@ og:title: DWN Protocol Configuration
|
||||
- Time-series organization
|
||||
- Aggregation rules
|
||||
|
||||
<Warning>
|
||||
Protocol URIs must be unique. Consider using versioned URIs (e.g., `/v1`, `/v2`) for upgrades.
|
||||
</Warning>
|
||||
:::warning
|
||||
Protocol URIs must be unique. Consider using versioned URIs (e.g., `/v1`, `/v2`) for upgrades.
|
||||
:::
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
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
|
||||
seo:
|
||||
title: "DWN Record Deletion"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Record deletion is **permanent** and cannot be undone. Ensure you have backups if needed.
|
||||
</Warning>
|
||||
:::warning
|
||||
Record deletion is **permanent** and cannot be undone. Ensure you have backups if needed.
|
||||
:::
|
||||
|
||||
## Deletion Options
|
||||
|
||||
@@ -28,15 +28,15 @@ You must have one of the following:
|
||||
- **Permission**: Have explicit delete permission
|
||||
- **Protocol Authority**: Have protocol-level delete rights
|
||||
|
||||
<Note>
|
||||
The `deletedCount` in the response includes all pruned child records.
|
||||
</Note>
|
||||
:::note
|
||||
The `deletedCount` in the response includes all pruned child records.
|
||||
:::
|
||||
|
||||
## Safety Considerations
|
||||
|
||||
<Tip>
|
||||
Query child records before pruning to understand the impact:
|
||||
```bash
|
||||
snrd query dwn records-query --parent-id <record_id>
|
||||
```
|
||||
</Tip>
|
||||
:::tip
|
||||
Query child records before pruning to understand the impact:
|
||||
```bash
|
||||
snrd query dwn records-query --parent-id <record_id>
|
||||
```
|
||||
:::
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
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
|
||||
seo:
|
||||
title: "DWN Permission Management"
|
||||
---
|
||||
|
||||
<Info>
|
||||
DWN permissions enable secure data sharing with granular access control down to individual records.
|
||||
</Info>
|
||||
:::info
|
||||
DWN permissions enable secure data sharing with granular access control down to individual records.
|
||||
:::
|
||||
|
||||
## Permission Scopes
|
||||
|
||||
@@ -44,9 +44,9 @@ Grant access to specific records:
|
||||
|
||||
## Conditional Permissions
|
||||
|
||||
<Tip>
|
||||
Use conditions to create dynamic access rules that adapt to context.
|
||||
</Tip>
|
||||
:::tip
|
||||
Use conditions to create dynamic access rules that adapt to context.
|
||||
:::
|
||||
|
||||
### Time-Based Conditions
|
||||
```json
|
||||
@@ -77,9 +77,9 @@ Grant access to specific records:
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
<Warning>
|
||||
Always set expiration times for permissions to limit exposure window.
|
||||
</Warning>
|
||||
:::warning
|
||||
Always set expiration times for permissions to limit exposure window.
|
||||
:::
|
||||
|
||||
1. **Principle of Least Privilege**: Grant minimum necessary access
|
||||
2. **Time Limits**: Use `expiresAt` for temporary access
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
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
|
||||
seo:
|
||||
title: "DWN Permission Revocation"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Permission revocation takes effect **immediately**. Active sessions using the permission will be terminated.
|
||||
</Warning>
|
||||
:::warning
|
||||
Permission revocation takes effect **immediately**. Active sessions using the permission will be terminated.
|
||||
:::
|
||||
|
||||
## Revocation Process
|
||||
|
||||
@@ -24,12 +24,12 @@ og:title: DWN Permission Revocation
|
||||
|
||||
## Finding Permissions to Revoke
|
||||
|
||||
<Tip>
|
||||
Query your active permissions before revoking:
|
||||
```bash
|
||||
snrd query dwn permissions-request --grantor <your_did>
|
||||
```
|
||||
</Tip>
|
||||
:::tip
|
||||
Query your active permissions before revoking:
|
||||
```bash
|
||||
snrd query dwn permissions-request --grantor <your_did>
|
||||
```
|
||||
:::
|
||||
|
||||
## Authorization Requirements
|
||||
|
||||
@@ -57,6 +57,6 @@ snrd tx dwn permissions-revoke --permission-id <team_permission>
|
||||
snrd tx dwn permissions-revoke --permission-id <unused_permission>
|
||||
```
|
||||
|
||||
<Note>
|
||||
Consider notifying affected users before revoking permissions to avoid disruption.
|
||||
</Note>
|
||||
:::note
|
||||
Consider notifying affected users before revoking permissions to avoid disruption.
|
||||
:::
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
openapi: post /dwn.v1.Msg/RotateVaultKeys
|
||||
title: Rotate Vault Encryption Keys
|
||||
description: Perform cryptographic key rotation for enhanced vault security
|
||||
og:title: DWN Vault Key Rotation
|
||||
seo:
|
||||
title: "DWN Vault Key Rotation"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
Key rotation is a **critical security operation** that requires validator consensus or governance approval.
|
||||
</Warning>
|
||||
:::warning
|
||||
Key rotation is a **critical security operation** that requires validator consensus or governance approval.
|
||||
:::
|
||||
|
||||
## Key Rotation Architecture
|
||||
|
||||
@@ -43,9 +43,9 @@ og:title: DWN Vault Key Rotation
|
||||
|
||||
## Rotation Process
|
||||
|
||||
<Info>
|
||||
The rotation process is designed to be seamless with zero downtime for users.
|
||||
</Info>
|
||||
:::info
|
||||
The rotation process is designed to be seamless with zero downtime for users.
|
||||
:::
|
||||
|
||||
### Phase 1: Preparation
|
||||
1. Generate new key material in enclave
|
||||
@@ -65,9 +65,9 @@ og:title: DWN Vault Key Rotation
|
||||
## Security Considerations
|
||||
|
||||
### Single-Node Fallback
|
||||
<Note>
|
||||
In development mode with `singleNodeFallback: true`, rotation uses local key generation.
|
||||
</Note>
|
||||
:::note
|
||||
In development mode with `singleNodeFallback: true`, rotation uses local key generation.
|
||||
:::
|
||||
|
||||
### Production Requirements
|
||||
- Minimum validator participation (67% default)
|
||||
@@ -83,13 +83,13 @@ og:title: DWN Vault Key Rotation
|
||||
- New encryptions use latest keys
|
||||
|
||||
### Performance
|
||||
- Slight latency during rotation (< 1s)
|
||||
- Slight latency during rotation (< 1s)
|
||||
- Background re-encryption process
|
||||
- No data availability impact
|
||||
|
||||
<Tip>
|
||||
Monitor rotation events via:
|
||||
```bash
|
||||
snrd query dwn vault-status --vault-id <id>
|
||||
```
|
||||
</Tip>
|
||||
:::tip
|
||||
Monitor rotation events via:
|
||||
```bash
|
||||
snrd query dwn vault-status --vault-id <id>
|
||||
```
|
||||
:::
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
openapi: post /dwn.v1.Msg/UpdateParams
|
||||
title: Update DWN Module Parameters
|
||||
description: Configure module-wide settings for data storage, protocols, and security policies
|
||||
og:title: DWN Module Governance
|
||||
seo:
|
||||
title: "DWN Module Governance"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
This operation requires **governance approval** and is typically executed through on-chain proposals.
|
||||
</Warning>
|
||||
:::warning
|
||||
This operation requires **governance approval** and is typically executed through on-chain proposals.
|
||||
:::
|
||||
|
||||
## Parameter Categories
|
||||
|
||||
@@ -27,6 +27,6 @@ og:title: DWN Module Governance
|
||||
- **encryptedProtocols**: Protocol URIs requiring mandatory encryption
|
||||
- **encryptedSchemas**: Schema URIs requiring mandatory encryption
|
||||
|
||||
<Note>
|
||||
Changes to these parameters affect all DWN operations network-wide.
|
||||
</Note>
|
||||
:::note
|
||||
Changes to these parameters affect all DWN operations network-wide.
|
||||
:::
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
openapi: post /dwn.v1.Msg/RecordsWrite
|
||||
title: Write Data Record to DWN
|
||||
description: Store structured data in your personal data vault with encryption and access control
|
||||
og:title: DWN Record Storage
|
||||
seo:
|
||||
title: "DWN Record Storage"
|
||||
---
|
||||
|
||||
<Info>
|
||||
Records are the fundamental unit of data storage in DWN, supporting any data type with optional encryption.
|
||||
</Info>
|
||||
:::info
|
||||
Records are the fundamental unit of data storage in DWN, supporting any data type with optional encryption.
|
||||
:::
|
||||
|
||||
## Key Features
|
||||
|
||||
@@ -27,9 +27,9 @@ og:title: DWN Record Storage
|
||||
- **Social Content**: Share public posts or media
|
||||
- **Health Records**: Store sensitive medical data with encryption
|
||||
|
||||
<Tip>
|
||||
Use protocol definitions to ensure data interoperability across applications.
|
||||
</Tip>
|
||||
:::tip
|
||||
Use protocol definitions to ensure data interoperability across applications.
|
||||
:::
|
||||
|
||||
## Example Record Types
|
||||
|
||||
@@ -43,6 +43,6 @@ og:title: DWN Record Storage
|
||||
}
|
||||
```
|
||||
|
||||
<Warning>
|
||||
Records exceeding `maxRecordSize` will be rejected. Large files should be stored in IPFS with only metadata on-chain.
|
||||
</Warning>
|
||||
:::warning
|
||||
Records exceeding `maxRecordSize` will be rejected. Large files should be stored in IPFS with only metadata on-chain.
|
||||
:::
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
openapi: post /svc.v1.Msg/VerifyDomain
|
||||
title: Complete Domain Verification
|
||||
description: Validate DNS TXT record to prove domain ownership
|
||||
og:title: Finalize Domain Ownership
|
||||
seo:
|
||||
title: "Finalize Domain Ownership"
|
||||
---
|
||||
|
||||
<Info>
|
||||
This endpoint validates the DNS TXT record to permanently bind the domain to your address.
|
||||
</Info>
|
||||
:::info
|
||||
This endpoint validates the DNS TXT record to permanently bind the domain to your address.
|
||||
:::
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -32,12 +32,12 @@ The system performs these checks:
|
||||
### Common Issues
|
||||
|
||||
#### DNS Not Propagated
|
||||
<Tip>
|
||||
Wait 5-30 minutes after adding the TXT record. Check propagation:
|
||||
```bash
|
||||
dig TXT example.com +short
|
||||
```
|
||||
</Tip>
|
||||
:::tip
|
||||
Wait 5-30 minutes after adding the TXT record. Check propagation:
|
||||
```bash
|
||||
dig TXT example.com +short
|
||||
```
|
||||
:::
|
||||
|
||||
#### Token Mismatch
|
||||
- Ensure exact token from initiation response
|
||||
@@ -57,9 +57,9 @@ Once verified:
|
||||
- **Trust Established**: Domain ownership proven
|
||||
- **No Re-verification**: One-time process per domain
|
||||
|
||||
<Warning>
|
||||
Domain ownership is permanent. Ensure you're verifying with the correct address.
|
||||
</Warning>
|
||||
:::warning
|
||||
Domain ownership is permanent. Ensure you're verifying with the correct address.
|
||||
:::
|
||||
|
||||
## Next Steps
|
||||
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
openapi: post /svc.v1.Msg/InitiateDomainVerification
|
||||
title: Start Domain Verification
|
||||
description: Generate DNS TXT record token for domain ownership proof
|
||||
og:title: Domain Ownership Verification
|
||||
seo:
|
||||
title: "Domain Ownership Verification"
|
||||
---
|
||||
|
||||
<Info>
|
||||
Domain verification ensures only legitimate domain owners can register services, establishing trust in the ecosystem.
|
||||
</Info>
|
||||
:::info
|
||||
Domain verification ensures only legitimate domain owners can register services, establishing trust in the ecosystem.
|
||||
:::
|
||||
|
||||
## Verification Process
|
||||
|
||||
@@ -37,22 +37,22 @@ snrd tx svc verify-domain example.com --from alice
|
||||
### Cloudflare
|
||||
1. Go to DNS settings
|
||||
2. Add record → Type: TXT
|
||||
3. Name: @ → Value: sonr-verification=<token>
|
||||
3. Name: @ → Value: sonr-verification=<token>
|
||||
4. Save and wait for propagation
|
||||
|
||||
### Route53 (AWS)
|
||||
1. Navigate to Hosted zones
|
||||
2. Create record → Type: TXT
|
||||
3. Record name: (leave blank for root)
|
||||
4. Value: "sonr-verification=<token>"
|
||||
4. Value: "sonr-verification=<token>"
|
||||
|
||||
<Tip>
|
||||
Use DNS lookup tools to verify your TXT record is propagated before completing verification:
|
||||
```bash
|
||||
dig TXT example.com
|
||||
nslookup -type=TXT example.com
|
||||
```
|
||||
</Tip>
|
||||
:::tip
|
||||
Use DNS lookup tools to verify your TXT record is propagated before completing verification:
|
||||
```bash
|
||||
dig TXT example.com
|
||||
nslookup -type=TXT example.com
|
||||
```
|
||||
:::
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -61,6 +61,6 @@ snrd tx svc verify-domain example.com --from alice
|
||||
- **Unique Ownership**: Each domain can only have one owner
|
||||
- **Time Limit**: Complete within 7 days of initiation
|
||||
|
||||
<Warning>
|
||||
Verification tokens expire after 7 days. If expired, you must initiate a new verification.
|
||||
</Warning>
|
||||
:::warning
|
||||
Verification tokens expire after 7 days. If expired, you must initiate a new verification.
|
||||
:::
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
openapi: post /svc.v1.Msg/RegisterService
|
||||
title: Register Decentralized Service
|
||||
description: Create a new service with domain binding and UCAN permissions
|
||||
og:title: Service Registration
|
||||
seo:
|
||||
title: "Service Registration"
|
||||
---
|
||||
|
||||
<Info>
|
||||
Services are the foundation of decentralized applications in Sonr, providing trusted interaction points through verified domains.
|
||||
</Info>
|
||||
:::info
|
||||
Services are the foundation of decentralized applications in Sonr, providing trusted interaction points through verified domains.
|
||||
:::
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -68,9 +68,9 @@ Services request permissions users must grant:
|
||||
}
|
||||
```
|
||||
|
||||
<Tip>
|
||||
Request only necessary permissions. Users are more likely to grant minimal permission sets.
|
||||
</Tip>
|
||||
:::tip
|
||||
Request only necessary permissions. Users are more likely to grant minimal permission sets.
|
||||
:::
|
||||
|
||||
## UCAN Integration
|
||||
|
||||
@@ -116,9 +116,9 @@ Provide existing UCAN chain for pre-authorized capabilities.
|
||||
- **Clear Purpose**: Document why each permission
|
||||
- **Future Growth**: Design for expansion
|
||||
|
||||
<Warning>
|
||||
Service registration is permanent. Choose your service ID carefully as it cannot be changed.
|
||||
</Warning>
|
||||
:::warning
|
||||
Service registration is permanent. Choose your service ID carefully as it cannot be changed.
|
||||
:::
|
||||
|
||||
## Post-Registration
|
||||
|
||||
@@ -134,6 +134,6 @@ snrd query svc services-by-domain example.com
|
||||
ipfs cat <root_capability_cid>
|
||||
```
|
||||
|
||||
<Note>
|
||||
Services become immediately discoverable after registration. Ensure your application is ready to handle user interactions.
|
||||
</Note>
|
||||
:::note
|
||||
Services become immediately discoverable after registration. Ensure your application is ready to handle user interactions.
|
||||
:::
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
openapi: post /svc.v1.Msg/UpdateParams
|
||||
title: Update SVC Module Parameters
|
||||
description: Configure service registration limits, domain verification, and UCAN settings
|
||||
og:title: SVC Module Governance
|
||||
seo:
|
||||
title: "SVC Module Governance"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
This operation requires **governance approval** and is typically executed through on-chain proposals.
|
||||
</Warning>
|
||||
:::warning
|
||||
This operation requires **governance approval** and is typically executed through on-chain proposals.
|
||||
:::
|
||||
|
||||
## Parameter Categories
|
||||
|
||||
@@ -31,6 +31,6 @@ og:title: SVC Module Governance
|
||||
- **domainVerificationFee**: Fee for domain verification
|
||||
- **minServiceStake**: Minimum stake to maintain service
|
||||
|
||||
<Note>
|
||||
Changes affect all service operations network-wide. Plan parameter updates carefully.
|
||||
</Note>
|
||||
:::note
|
||||
Changes affect all service operations network-wide. Plan parameter updates carefully.
|
||||
:::
|
||||
|
||||
Reference in New Issue
Block a user