Skip to content

Commit dfe6c4d

Browse files
committed
Remove vault docs for now, move them to other primitives
1 parent 985293b commit dfe6c4d

4 files changed

Lines changed: 35 additions & 272 deletions

File tree

docs/sdk/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,6 @@ The SDK is organized around these key abstractions:
165165
- [Standard (XCH)](/sdk/primitives/standard) - Working with basic XCH coins
166166
- [CAT](/sdk/primitives/cat) - Issuing and spending custom asset tokens
167167
- [NFT](/sdk/primitives/nft) - Minting and transferring NFTs
168-
- [Vault](/sdk/primitives/vault) - Multi-signature custody
169168

170169
## Relationship to chia-rs
171170

docs/sdk/primitives/other.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,41 @@ title: Other Primitives
55

66
# Other Primitives
77

8-
The SDK includes several additional primitives beyond the core CAT, NFT, and Vault types. This page provides brief overviews of these primitives.
8+
The SDK includes several additional primitives beyond the core CAT and NFT types. This page provides brief overviews of these primitives.
9+
10+
## Vault
11+
12+
Vaults provide multi-signature custody for Chia assets. They enable secure storage patterns where multiple parties or conditions must be satisfied to spend funds.
13+
14+
```rust
15+
use chia_wallet_sdk::prelude::*;
16+
17+
// Vault structure
18+
let vault = Vault {
19+
coin,
20+
launcher_id,
21+
proof,
22+
custody_hash, // Defines spending requirements
23+
};
24+
25+
// Spend a vault with a MIPS (Multi-Input Puzzle Spend)
26+
vault.spend(ctx, &mips_spend)?;
27+
28+
// Compute the child vault after a spend
29+
let child_vault = vault.child(new_custody_hash, new_amount);
30+
```
31+
32+
For vault internals and specification, see [CHIP-0043 (MIPS)](https://github.com/Chia-Network/chips/blob/main/CHIPs/chip-0043.md).
33+
34+
**Use cases:**
35+
- Multi-signature wallets requiring M-of-N approval
36+
- Time-locked custody arrangements
37+
- Institutional custody solutions
38+
- Escrow patterns
39+
40+
For the complete API, see [Vault in docs.rs](https://docs.rs/chia-sdk-driver/latest/chia_sdk_driver/struct.Vault.html).
41+
42+
---
943

1044
## DID (Decentralized Identifiers)
1145

docs/sdk/primitives/vault.md

Lines changed: 0 additions & 269 deletions
This file was deleted.

sidebars.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ const sidebars: SidebarsConfig = {
2626
{ type: "doc", id: "sdk/primitives/standard", label: "Standard (XCH)" },
2727
{ type: "doc", id: "sdk/primitives/cat", label: "CAT" },
2828
{ type: "doc", id: "sdk/primitives/nft", label: "NFT" },
29-
{ type: "doc", id: "sdk/primitives/vault", label: "Vault" },
3029
{ type: "doc", id: "sdk/primitives/other", label: "Other Primitives" },
3130
],
3231
},

0 commit comments

Comments
 (0)