Skip to content

Commit 7dcbf51

Browse files
committed
Update main examples README
1 parent a7c79d7 commit 7dcbf51

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/examples/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,41 @@ Here, you will find a number of common usage examples for the go-sdk.
66
- [Storage Downloader](./storage_downloader/storage_downloader.md) - Download files using UHRP URLs
77
- [Storage Uploader](./storage_uploader/storage_uploader.md) - Upload, manage, and renew files
88

9+
## Keys and Addresses
10+
- [Address From WIF](./address_from_wif/) - Generate an address from a WIF private key.
11+
- [Derive Child Key](./derive_child/) - Derive a child key from a parent HD key.
12+
- [Generate HD Key](./generate_hd_key/) - Generate a new Hierarchical Deterministic (HD) key.
13+
- [HD Key From XPub](./hd_key_from_xpub/) - Create an HD key from an extended public key (xPub).
14+
- [Keyshares PK From Backup](./keyshares_pk_from_backup/) - Reconstruct a private key from key shares backup.
15+
- [Keyshares PK To Backup](./keyshares_pk_to_backup/) - Backup a private key using key shares.
16+
17+
## Transactions
18+
- [Broadcaster](./broadcaster/) - Broadcast a transaction to the network.
19+
- [Create Simple TX](./create_simple_tx/) - Create a basic Bitcoin transaction.
20+
- [Create TX With Inscription](./create_tx_with_inscription/) - Create a transaction with an Ordinal inscription.
21+
- [Create TX With OP_RETURN](./create_tx_with_op_return/) - Create a transaction with an OP_RETURN output.
22+
- [Fee Modeling](./fee_modeling/) - Examples of transaction fee calculation and modeling.
23+
- [Validate SPV](./validate_spv/) - Validate a Simple Payment Verification (SPV) proof.
24+
- [Verify Beef](./verify_beef/) - Verify a B.E.E.F (Bitcoin Extended Envelope Format) transaction.
25+
- [Verify Transaction](./verify_transaction/) - Verify the validity of a Bitcoin transaction.
26+
27+
## Messaging and Authentication
28+
- [Authenticated Messaging](./authenticated_messaging/) - Examples of authenticated messaging between parties.
29+
- [ECIES Electrum Binary](./ecies_electrum_binary/) - ECIES encryption/decryption compatible with Electrum (binary format).
30+
- [ECIES Shared](./ecies_shared/) - Elliptic Curve Integrated Encryption Scheme (ECIES) with a shared secret.
31+
- [ECIES Single](./ecies_single/) - ECIES for single recipient encryption/decryption.
32+
- [Encrypted Message](./encrypted_message/) - Send and receive encrypted messages.
33+
- [Identity Client](./identity_client/) - Client for interacting with identity services.
34+
35+
## Registry
36+
- [Registry Register](./registry_register/) - Register data with a distributed registry.
37+
- [Registry Resolve](./registry_resolve/) - Resolve data from a distributed registry.
38+
39+
## Networking
40+
- [Websocket Peer](./websocket_peer/) - Communicate with a Bitcoin node using WebSockets.
41+
42+
## Cryptography
43+
- [AES](./aes/) - Advanced Encryption Standard (AES) examples.
44+
945
## Additional Example Documents
1046
- [Converting Transactions from go-bt](./GO_BT.md)

0 commit comments

Comments
 (0)