sonr/x/vault/README.md

# `x/vault`

The Vault module is responsible for the management of IPFS deployed Decentralized Web Nodes (DWNs) and their associated data.

## Concepts

| Concept                                     | Description                                                                                                                                                                           | Reference |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| Decentralized Web Node (DWN)                | A decentralized, distributed, and secure network of nodes that store and share data. It is a decentralized alternative to traditional web hosting services.                           |           |
| Decentralized Identifier (DID)              | A unique identifier that is created, owned, and controlled by the user. It is used to establish a secure and verifiable digital identity.                                             |           |
| HTMX (Hypertext Markup Language eXtensions) | A set of extensions to HTML that allow for the creation of interactive web pages. It is used to enhance the user experience and provide additional functionality to web applications. |           |
| IPFS (InterPlanetary File System)           | A decentralized, peer-to-peer network for storing and sharing data. It is a distributed file system that allows for the creation and sharing of content across a network of nodes.    |           |
| WebAuthn (Web Authentication)               | A set of APIs that allow websites to request user authentication using biometric or non-biometric factors.                                                                            |           |
| WebAssembly (Web Assembly)                  | A binary instruction format for a stack-based virtual machine.                                                                                                                        |           |
| Verifiable Credential (VC)                  | A digital statement that can be cryptographically verified.                                                                                                                           |           |

## Operations

[View on Eraser![](https://app.eraser.io/workspace/ZFigXnzF1bkQR1VBq7Mz/preview?elements=_hAjUxIKPzF4ffIL4Ow_9w&type=embed)](https://app.eraser.io/workspace/ZFigXnzF1bkQR1VBq7Mz?elements=_hAjUxIKPzF4ffIL4Ow_9w)

<a href="https://app.eraser.io/workspace/Q7CKbYyprt9U2VdwCR70?elements=ywrPbfX1Oml1dLOfdEQEiA">View on Eraser<br /><img src="https://app.eraser.io/workspace/Q7CKbYyprt9U2VdwCR70/preview?elements=ywrPbfX1Oml1dLOfdEQEiA&type=embed" /></a>
feature/did accounts (#23) * feat: add support for DID number as primary key for Controllers * refactor: rename pkg/proxy to app/proxy * feat: add vault module keeper tests * feat(vault): add DID keeper to vault module * refactor: move vault client code to its own package * refactor(vault): extract schema definition * refactor: use vaulttypes for MsgAllocateVault * refactor: update vault assembly logic to use new methods * feat: add dwn-proxy command * refactor: remove unused context.go file * refactor: remove unused web-related code * feat: add DWN proxy server * feat: add BuildTx RPC to vault module * fix: Implement BuildTx endpoint * feat: add devbox integration to project 2024-09-25 19:45:28 -04:00			# `x/vault`

			`The Vault module is responsible for the management of IPFS deployed Decentralized Web Nodes (DWNs) and their associated data.`

			`## Concepts`

			`\| Concept \| Description \| Reference \|`
			`\| ------------------------------------------- \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \| --------- \|`
			`\| Decentralized Web Node (DWN) \| A decentralized, distributed, and secure network of nodes that store and share data. It is a decentralized alternative to traditional web hosting services. \| \|`
			`\| Decentralized Identifier (DID) \| A unique identifier that is created, owned, and controlled by the user. It is used to establish a secure and verifiable digital identity. \| \|`
			`\| HTMX (Hypertext Markup Language eXtensions) \| A set of extensions to HTML that allow for the creation of interactive web pages. It is used to enhance the user experience and provide additional functionality to web applications. \| \|`
			`\| IPFS (InterPlanetary File System) \| A decentralized, peer-to-peer network for storing and sharing data. It is a distributed file system that allows for the creation and sharing of content across a network of nodes. \| \|`
			`\| WebAuthn (Web Authentication) \| A set of APIs that allow websites to request user authentication using biometric or non-biometric factors. \| \|`
			`\| WebAssembly (Web Assembly) \| A binary instruction format for a stack-based virtual machine. \| \|`
			`\| Verifiable Credential (VC) \| A digital statement that can be cryptographically verified. \| \|`
docs: add operations section to README 2024-10-07 09:05:55 -04:00
			`## Operations`

			`[View on Eraser![](https://app.eraser.io/workspace/ZFigXnzF1bkQR1VBq7Mz/preview?elements=_hAjUxIKPzF4ffIL4Ow_9w&type=embed)](https://app.eraser.io/workspace/ZFigXnzF1bkQR1VBq7Mz?elements=_hAjUxIKPzF4ffIL4Ow_9w)`
docs: add Eraser link to README 2024-10-07 09:46:25 -04:00
			`<a href="https://app.eraser.io/workspace/Q7CKbYyprt9U2VdwCR70?elements=ywrPbfX1Oml1dLOfdEQEiA">View on Eraser<br /><img src="https://app.eraser.io/workspace/Q7CKbYyprt9U2VdwCR70/preview?elements=ywrPbfX1Oml1dLOfdEQEiA&type=embed" /></a>`