coracle/welshman
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation

Browse Source
This commit is contained in:
Jon Staab
2024-12-13 14:16:38 -08:00
parent 627eb1e36d
commit f7baa54724
940 changed files with 4549 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/util/README.md
+12 -11
View File
@@ -1,14 +1,15 @@
# @welshman/util [![version](https://badgen.net/npm/v/@welshman/util)](https://npmjs.com/package/@welshman/util)
Some nostr-specific utilities. For the most part, these will not have side effects or manage state.
Some nostr-specific utilities. For the most part, these will not have side effects or manage state. Includes:
- `Address` utilities for dealing with nostr addresses.
- `Events` utilities for dealing with nostr events.
- `Filters` utilities for dealing with nostr filters.
- `Kinds` kind constants and related utility functions.
- `Links` utilities for encoding and decoding nostr links.
- `Relay` an implementation of an in-memory nostr relay.
- `Relays` utilities related to relay urls.
- `Router` is a utility for selecting relay urls based on user preferences and protocol hints.
- `Tags` convenient way to access and modify tags.
- `Zaps` utilities related to zaps.
- Event kind constants
- A nostr address class
- Utilities for working with nostr filters and tags
- Helpers for working with zap events and lightning invoices
- A `Encryptable` for ensuring payloads get encrypted
- An implementation of an in-memory relay, backed by an events repository
- Utilities for building events, validating signatures, and checking event type (replaceable, etc.)
- Types and utilities for NIP 89 handlers
- Types and utilities for NIP 51 lists
- Types and utilities for NIP 01 profile metadata
- Types and utilities for NIP 11 relay profiles