Index (Cashu Voucher Nostr 0.2.0 API)

B C D E F G H I K N P Q R T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

B

backup(List<SignedVoucher>, String) - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Backs up vouchers to Nostr using encrypted DMs to self.
Backup Architecture - Search tag in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Section

C

CASHU_RELAYS - Static variable in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Cashu-specific relay suggestions.
Configuration Categories - Search tag in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Section
connect() - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Connects to all configured relays.
createBackupEvent(List<SignedVoucher>, String, String) - Static method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Creates an encrypted backup event for vouchers.

D

D_TAG_PREFIX - Static variable in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Prefix for 'd' tag identifiers.
DEFAULT_BATCH_SIZE - Static variable in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Default batch size for bulk operations.
DEFAULT_CONNECTION_TIMEOUT_MS - Static variable in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Default connection timeout in milliseconds.
DEFAULT_HEALTH_CHECK_INTERVAL_MS - Static variable in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Default health check interval in milliseconds.
DEFAULT_MAX_CONSECUTIVE_FAILURES - Static variable in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Default maximum consecutive failures before marking relay as unhealthy.
DEFAULT_MAX_RETRIES - Static variable in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Default maximum retry attempts.
DEFAULT_PUBLISH_TIMEOUT_MS - Static variable in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Default publish timeout in milliseconds.
DEFAULT_QUERY_TIMEOUT_MS - Static variable in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Default query timeout in milliseconds.
defaultConfig() - Static method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Creates a default configuration with Cashu relays.
Default Values - Search tag in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Section
Design Philosophy - Search tag in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Section
disconnect() - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Disconnects from all relays.

E

equals(Object) - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig
Error Handling - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Section
Error Handling - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Section
Event Structure - Search tag in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Section
extractVouchers(GenericEvent, String, String) - Static method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Extracts vouchers from an encrypted backup event.

F

Features - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Section
fromVoucher(SignedVoucher, VoucherStatus) - Static method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Creates a VoucherLedgerEvent from a domain voucher and status.

G

getAmount() - Method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Gets the voucher amount from tags.
getConnectedRelayCount() - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Gets the number of currently connected relays.
getConnectedRelays() - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Gets the list of connected relay URLs.
getExpiry() - Method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Gets the expiry timestamp from tags.
getIssuerPublicKey() - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Gets the issuer's public key used for signing events.
getNostrClient() - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Gets the underlying Nostr client adapter.
getNostrClient() - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Gets the underlying Nostr client adapter.
getRelayCount() - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Gets the number of configured relays.
getRelayUrls() - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Gets an unmodifiable copy of the relay URLs.
getStatus() - Method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Gets the voucher status from this event's tags.
getUnit() - Method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Gets the voucher unit from tags.
getVoucherId() - Method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Gets the voucher ID from this event's 'd' tag.

H

hasBackups(String) - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Checks if backups exist for the given user.
hashCode() - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig
hasMinimumRelays() - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Checks if the configuration has at least the minimum required relays.
Hexagonal Architecture - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Section
Hexagonal Architecture - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Section

I

isConnected() - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Checks if currently connected to at least one relay.
isValid() - Method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Checks if this event is a valid voucher ledger event.
isValidBackupEvent(GenericEvent) - Static method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Checks if an event is a valid voucher backup event.

K

Key Features - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Section
Key Features - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Section
KIND_ENCRYPTED_DM - Static variable in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Event kind for encrypted direct messages (NIP-04/NIP-44).
KIND_VOUCHER_LEDGER - Static variable in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Event kind for voucher ledger (NIP-33 parameterized replaceable).

N

NIP-17 + NIP-44 Backup Model - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Section
NIP-33 Storage Model - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Section
NostrClientAdapter - Class in xyz.tcheeric.cashu.voucher.nostr: Adapter for Nostr relay client operations.
NostrClientAdapter(List<String>, long, int) - Constructor for class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Creates a NostrClientAdapter with specified configuration.
NostrRelayConfig - Class in xyz.tcheeric.cashu.voucher.nostr.config: Configuration for Nostr relay connections.
NostrRelayConfig() - Constructor for class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig
NostrRelayConfig.NostrRelayConfigBuilder - Class in xyz.tcheeric.cashu.voucher.nostr.config: Custom builder to support adding relay URLs one at a time.
NostrRelayConfigBuilder() - Constructor for class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig.NostrRelayConfigBuilder
NostrVoucherBackupRepository - Class in xyz.tcheeric.cashu.voucher.nostr: Nostr implementation of the VoucherBackupPort for private voucher backups.
NostrVoucherBackupRepository(NostrClientAdapter) - Constructor for class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Creates a NostrVoucherBackupRepository with default timeouts.
NostrVoucherBackupRepository(NostrClientAdapter, long, long) - Constructor for class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Creates a NostrVoucherBackupRepository with custom timeouts.
NostrVoucherLedgerRepository - Class in xyz.tcheeric.cashu.voucher.nostr: Nostr implementation of the VoucherLedgerPort for public voucher audit trail.
NostrVoucherLedgerRepository(NostrClientAdapter, PublicKey) - Constructor for class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Creates a NostrVoucherLedgerRepository with default timeouts.
NostrVoucherLedgerRepository(NostrClientAdapter, PublicKey, long, long) - Constructor for class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Creates a NostrVoucherLedgerRepository with custom timeouts.

P

PAYLOAD_VERSION - Static variable in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Current payload version.
Payload Structure - Search tag in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Section
Privacy Guarantees - Search tag in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Section
productionConfig(List<String>) - Static method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Creates a configuration for production with custom relays.
publish(SignedVoucher, VoucherStatus) - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Publishes a voucher to the Nostr ledger with the given status.
publishEvent(GenericEvent, long) - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Publishes an event to all connected relays.

Q

queryEvents(String, long) - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Queries events from relays matching the given filter.
queryStatus(String) - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Queries the current status of a voucher from the Nostr ledger.
queryVoucher(String) - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Queries the full voucher details from the Nostr ledger.

R

relayUrl(String) - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig.NostrRelayConfigBuilder: Adds a single relay URL to the configuration.
relayUrls(List<String>) - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig.NostrRelayConfigBuilder: Sets multiple relay URLs at once.
restore(String) - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Restores vouchers from Nostr backup events.

T

TAG_AMOUNT - Static variable in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Tag name for face value amount.
TAG_BACKUP - Static variable in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Tag for backup identification.
TAG_EXPIRY - Static variable in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Tag name for expiry timestamp.
TAG_STATUS - Static variable in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Tag name for voucher status.
TAG_UNIT - Static variable in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Tag name for currency/unit.
testConfig() - Static method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Creates a configuration for testing with localhost relay.
Thread Safety - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Section
Thread Safety - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Section
Thread Safety - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Section
Thread Safety - Search tag in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Section
toVoucher() - Method in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Converts this event back to a domain SignedVoucher.

U

updateStatus(String, VoucherStatus) - Method in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Updates the status of an existing voucher in the Nostr ledger.
Usage Example - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrClientAdapter: Section
Usage Example - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Section
Usage Example - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherLedgerRepository: Section
Usage Example - Search tag in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Section
Usage Example - Search tag in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload: Section
Usage Example - Search tag in class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent: Section
useCashuRelays() - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig.NostrRelayConfigBuilder: Uses Cashu-specific relays.
useWellKnownRelays() - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig.NostrRelayConfigBuilder: Uses well-known public relays.

V

validate() - Method in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Validates the configuration.
VoucherBackupPayload - Class in xyz.tcheeric.cashu.voucher.nostr.events: Handles voucher backup payload serialization using NIP-17 private messaging.
VoucherBackupPayload() - Constructor for class xyz.tcheeric.cashu.voucher.nostr.events.VoucherBackupPayload
VoucherLedgerEvent - Class in xyz.tcheeric.cashu.voucher.nostr.events: Nostr event for voucher ledger records (NIP-33 parameterized replaceable).
VoucherLedgerEvent() - Constructor for class xyz.tcheeric.cashu.voucher.nostr.events.VoucherLedgerEvent
VoucherNostrException - Exception Class in xyz.tcheeric.cashu.voucher.nostr: Exception thrown when voucher-specific Nostr operations fail.
VoucherNostrException(String) - Constructor for exception class xyz.tcheeric.cashu.voucher.nostr.VoucherNostrException: Constructs a VoucherNostrException with the specified detail message.
VoucherNostrException(String, Throwable) - Constructor for exception class xyz.tcheeric.cashu.voucher.nostr.VoucherNostrException: Constructs a VoucherNostrException with the specified detail message and cause.
VoucherNostrException(Throwable) - Constructor for exception class xyz.tcheeric.cashu.voucher.nostr.VoucherNostrException: Constructs a VoucherNostrException with the specified cause.

W

WELL_KNOWN_RELAYS - Static variable in class xyz.tcheeric.cashu.voucher.nostr.config.NostrRelayConfig: Well-known public Nostr relays (for convenience).
Why This Matters - Search tag in class xyz.tcheeric.cashu.voucher.nostr.NostrVoucherBackupRepository: Section

X

xyz.tcheeric.cashu.voucher.nostr - package xyz.tcheeric.cashu.voucher.nostr
xyz.tcheeric.cashu.voucher.nostr.config - package xyz.tcheeric.cashu.voucher.nostr.config
xyz.tcheeric.cashu.voucher.nostr.events - package xyz.tcheeric.cashu.voucher.nostr.events

B C D E F G H I K N P Q R T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form